m204wiki - User contributions [en]

https://m204wiki.rocketsoftware.com/api.php?action=feedcontributions&feedformat=atom&user=Heikki m204wiki - User contributions [en] 2026-04-20T00:34:38Z User contributions MediaWiki 1.43.1 https://m204wiki.rocketsoftware.com/index.php?title=Local_and_Common_entities&diff=78434 Local and Common entities 2015-07-23T04:10:50Z

<p>Heikki: /* Using a Common Subroutine */</p> <hr /> <div>Many methods are useful in a wide variety of applications.<br /> System methods usually fall into this category, as they are intended to<br /> provide basic services that are useful in many applications.<br /> Methods that are widely useful will usually be contained in a class,<br /> often as <var>Public</var> or <var>Private</var> methods, but sometimes as [[Enhancement methods|enhancement methods]],<br /> and sometimes as non-enhancement shared methods.<br /> <br /> On the other hand, some methods have only relatively local applicability.<br /> That is, while useful in a specific application context, they are not likely<br /> to be useful in other contexts.<br /> The following are cases where using such essentially-local methods might be beneficial:<br /> <ul><br /> <li>As a substitute for a large block of code in the main line of application processing,<br /> increasing code readability.<br /> <li>As a container for application-specific code that is repeated exactly or almost<br /> exactly several times in a block of code, yet<br /> does not lend itself to a loop construct.<br /> <li>As an alternative way to implement a locally recursive process.<br /> </ul><br /> There are many other situations where locally applicable methods would be useful.<br /> <br /> <br /> <var class="product">SOUL</var> '''local methods''' facilitate the writing<br /> of locally applicable methods. Local methods provide all the functionality of simple subroutines, and more:<br /> <ul><br /> <li>They can be nested inside other methods.<br /> <li>They can have local variables.<br /> <li>They can have access to containing context variables or not as one wishes.<br /> <li>They have all the capabilities of method calls including optional and named<br /> parameters and the ability to return values or even be settable (a property).<br /> <li>They are invoked with object-oriented syntax.<br /> </ul><br /> <br /> Accompanying local methods are additional entities that have local scope:<br /> <br /> <ul><br /> <li>Classes, enumerations, and structures have<br /> [[#Local classes, enumerations, and structures|local counterparts]].<br /> <li>[[#Local aliases|Local aliases]]<br /> are a simplified way to call a non-local method in a local context.<br /> <li>[[#Persistent and Shared local variables|Local variables]]<br /> are variables that can be used only within a local method<br /> but that have greater persistence than simple percent variables.<br /> </ul><br /> <br /> [[#Common methods and aliases|Common methods and aliases]] are variations of<br /> local methods and aliases that are designed to be similar enough to standard<br /> <var class="product">SOUL</var> Common variables and complex subroutines to replace them in existing applications.<br /> <br /> ==Scope and locality==<br /> One important thing to understand about local methods is the concept of<br /> '''scope'''.<br /> A scope is a block of code whose variables are isolated from other scopes.<br /> For example, the outermost scope in <var class="product">SOUL</var>: the block of code inside the <var>Begin</var> and <var>End</var> block for a request, but not inside a method or complex subroutine, is one scope.<br /> <br /> Each complex subroutine is another scope, and each method, yet another.<br /> This means that a particular variable name, say, <code>%foo</code>, can only<br /> be declared once in a given scope, and that variable is distinct from an<br /> identically named variable in another scope.<br /> So, in the following example,<br /> <code>%foo</code> is a <var>Stringlist</var> object variable in the outermost scope, a <var>Unicode</var> variable<br /> in complex subroutine <code>WorkHarder</code>, and a <var>Float</var> variable in function <code>Cipher</code> in class<br /> <code>Neat</code>.<br /> <p class="code">begin<br /> %foo is object stringlist<br /> ...<br /> subroutine workHarder<br /> %foo is unicode<br /> ...<br /> end subroutine<br /> ...<br /> class neat<br /> ...<br /> function cipher is float<br /> %foo is float<br /> ...<br /> end function<br /> ...<br /> end class<br /> ...<br /> end<br /> </p><br /> <br /> Because the outermost, complex subroutine, and method scopes are isolated, there is<br /> no danger of confusion for the <code>%foo</code> variables in the preceding example.<br /> In fact, there is no way to access the outermost scope <code>%foo</code> <var>Stringlist</var> from the inside<br /> of complex subroutine <code>WorkHarder</code> or function <code>Cipher</code>, even if no local <code>%foo</code> had been<br /> defined in these scopes.<br /> Scope applies to what are termed '''local variables''', that is, variables<br /> that are local to the scope.<br /> <br /> Class variables are ''always'' accessed via an object variable of the class,<br /> so they are not affected by local scoping.<br /> That is, a variable in class Clever called Junk can only be accessed via an object<br /> variable of class Clever.<br /> So, if %smart is an object of class Clever, variable Junk could be accessed via<br /> <code>%smart:junk</code>.<br /> <br /> Sometimes, the object variable is implicit.<br /> For example, inside an instance (non-shared) method inside of class Clever, a<br /> %junk would be interpreted as <code>%this:junk</code> if no local variable called %junk were<br /> defined.<br /> Similarly, if function Piggledy on local object variable %higgledy produced a<br /> Clever object, the Junk variable in that object could be accessed via<br /> <code>%higgledy:piggledy:junk</code>.<br /> Again, the Clever class variable is implicit here.<br /> <br /> Shared variables in a class are global in scope, that is, they maintain their<br /> value and can be accessed from inside of any scope.<br /> This can be done using the <code>(<classname>):<variable></code> syntax or<br /> the <code>%<object>:<variable></code> syntax.<br /> Because, the class distinguishes the variable from other identically named variables<br /> in other scopes, there is no need to scope such variables: they can be<br /> accessed from any scope inside a <var class="product">SOUL</var> request.<br /> <br /> Of course, private variables in a class can only be accessed from methods inside<br /> the class.<br /> So, in some sense, a class is, itself, a scope where private variables in the<br /> class might be accessed.<br /> However, for the purposes of most discussion, scope will refer only to the<br /> scope for local variables, so it will only refer to the outermost (<var>Begin</var>/<var>End</var>) scope,<br /> complex subroutine scope, and method scope.<br /> <br /> It is worth mentioning '''common variables''' with regard to scoping.<br /> Common variables, as their name might suggest, can be accessed from many different<br /> scopes.<br /> However, they must be declared as common in each scope in which they are to be<br /> accessed.<br /> <br /> For example, to change the previous example slightly:<br /> <p class="code">begin<br /> %foo is object stringlist common<br /> ...<br /> subroutine workHarder<br /> %foo is unicode<br /> ...<br /> end subroutine<br /> ...<br /> class neat<br /> ...<br /> function cipher is float<br /> %foo is object stringlist common<br /> ...<br /> end function<br /> ...<br /> end class<br /> ...<br /> end<br /> </p><br /> <br /> In this example, the <code>%foo</code> variables in the outermost scope and in the scope<br /> for method <code>Cipher</code> in class <code>Neat</code> reference the same <var>Stringlist</var> object variable.<br /> On the other hand, <code>%foo</code> in the complex subroutine <code>WorkHarder</code> is a local variable,<br /> so the <code>%foo</code> common variable cannot be accessed in that scope.<br /> ==Defining and invoking a local method==<br /> The local method facility lets you create methods that<br /> are ''not'' part of a class and are only available<br /> inside the scope within which their definition is contained.<br /> A local method does not require a separate declaration block before it is defined.<br /> Typically, a local method's declaration begins the method definition.<br /> <br /> Local methods are declared with the keyword <var>Local</var>, followed by the<br /> method type, followed by the method name and description:<br /> ===Local method declaration syntax===<br /> <p class="syntax"><span class="literal">Local </span><span class="term">methodType methodName methodDesc</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>methodType</th><br /> <td>The method type, which has the following syntax:<br /> <p class="syntax"><span class="literal">Subroutine | Function | Property</span><br /> </p><br /> <p><br /> The types of local method are like those of class methods:<br /> <table><br /> <tr><th><var>Subroutine</var> </th><br /> <td>Returns no value. </td></tr><br /> <br /> <tr><th><var>Function</var> </th><br /> <td>Returns a value, but cannot be set to a value. </td></tr><br /> <br /> <tr><th><var>Property</var> </th><br /> <td>Can return a value or be set to a value. </td></tr></table></p><br /> </td></tr><br /> <br /> <tr><th>methodName</th><br /> <td>The method name, which can be any name that follows the rules for <var class="product">SOUL</var> %variables, possibly preceded by the class that the method enhances (locally). However, like variable declarations inside of <var>Class</var> blocks, the name does not start with the percent (<tt>%</tt>) sign.<br /> <p><br /> In addition, the name cannot be the same as a simple percent variable in the same scope (though it can be the same as a class variable or method, as discussed in [[#Using Defer and Expose|"Using Defer and Expose"]]). </p><br /> <p><br /> The method name syntax is: </p><br /> <p class="syntax"><span class="squareb">[</span><span class="literal">(</span><span class="term">className</span><span class="literal">):</span><span class="squareb">]</span> <span class="term">methodname</span><br /> </p> <br /> If a class name is not specified, the method is assumed to be a shared, non-enhancement local method.<br /> </td></tr><br /> <br /> <tr><th>methodDesc</th><br /> <td>The method description, which has exactly the same structure as the method descriptions for class variables. That is, a local method has an optional parameter list which can contain required and optional, named and unnamed parameters, and their types. The parameter list is followed by a method result type (for <var>Functions</var> and <var>Properties</var>) and then possibly by further qualifiers.<br /> <p> <br /> The method description syntax is: </p><br /> <p class="syntax"><span class="squareb">[</span><span class="literal">(</span><span class="term">parameters</span><span class="literal">)</span><span class="squareb">]</span> <span class="squareb">[</span><span class="literal">is </span><span class="term">datatype</span><span class="squareb">] [</span><span class="term">qualifiers</span><span class="squareb">]</span><br /> </p><br /> <p>While most qualifiers can be used for both local and class methods, some qualifiers (such as <var>Public</var>) make no sense in local method declarations, so they are not allowed, while a few others, like <var>Expose</var> (discussed later), only make sense for <var>Local</var> and <var>Common</var> methods. </p><br /> </td></tr><br /> </table><br /> <br /> An example of a local function declaration follows:<br /> <p class="code">local function (float):addAndMult(%what is float) is float<br /> </p><br /> <br /> Unlike class methods, local methods can and must be declared inside some other scope.<br /> And unlike complex subroutines, local methods can be contained inside any scope,<br /> not just the outermost scope.<br /> <br /> Like simple variables, local methods, themselves, have scope.<br /> That is, they can only be called inside the scope in which they are defined.<br /> This is different from complex subroutines, which must be declared in the<br /> outermost scope, but can be called from any scope.<br /> <br /> In general, as in the following example, a local method declaration is followed<br /> by the definition of the method (although as described in [[#Using Defer and Expose|"Using Defer and Expose"]],<br /> you can declare a method and then define it later in the request if need be).<br /> <p class="code">local function (stringlist):bytes is float<br /> %i is float<br /> %bytes is float<br /> for %i from 1 to %this:count<br /> %bytes = %bytes + %this:itemLength(%i)<br /> end for<br /> return %bytes<br /> end function<br /> </p><br /> <br /> When you invoke a local method (that operates on a specific object instance)<br /> you do not qualify the method name with a classname.<br /> The syntax for the invocation is simply:<br /> <p class="syntax"><span class="term">object</span><span class="literal">:</span><span class="term">method</span><br /> </p><br /> <br /> A different syntax is warrented for methods that do not operate<br /> on a specific object instance,<br /> as discussed in [[#Using non-enhancement and recursive local methods|"Using non-enhancement and recursive local methods"]].<br /> <br /> The following request is a simple example that features a local method.<br /> The local function in this program<br /> calculates the number of bytes in all the items in a <var>Stringlist</var>:<br /> <p class="code">b<br /> <br /> local function (stringlist):bytes is float<br /> %i is float<br /> %bytes is float<br /> for %i from 1 to %this:count<br /> %bytes = %bytes + %this:itemLength(%i)<br /> end for<br /> return %bytes<br /> end function<br /> <br /> %sl is object stringlist<br /> %sl = new<br /> text to %sl<br /> The noise<br /> Of worldly fame is but a blast of wind,<br /> That blows from diverse points, and shifts its name,<br /> Shifting the point it blows from.<br /> end text<br /> <br /> printtext {~} = {%sl:bytes}<br /> <br /> end<br /> </p><br /> <br /> ===Using Defer and Expose===<br /> As described in the previous section,<br /> a local method does not require a declaration separate from its definition.<br /> However, you can do so in a situation where it is warranted<br /> to declare a method before defining it (because method A<br /> calls method B which calls method A).<br /> In such a case, you specify a separate method declaration, append the<br /> keyword <var>Defer</var> to it, then repeat the declaration later in the<br /> program as part of the method definition:<br /> <br /> <p class="code">local function (stringlist):bytes is float defer<br /> ...<br /> &'italic(other code)<br /> ...<br /> local function (stringlist):bytes is float<br /> %i is float<br /> %bytes is float<br /> for %i from 1 to %this:count<br /> %bytes = %bytes + %this:itemLength(%i)<br /> end for<br /> return %bytes<br /> end function<br /> </p><br /> <br /> A local method has its own scope and its variables are not visible to the containing<br /> code.<br /> Similarly, variables in the containing code are not visible to the local method<br /> &mdash; unless the keyword <var>Expose</var> is specified on the method declaration.<br /> In the following example, the <code>Multiply</code> local method references the <code>%multiplier</code><br /> variable in the containing code:<br /> <p class="code">b<br /> <br /> %multiplier is float<br /> <br /> local function (float):multiply is float expose<br /> return %multiplier * %this<br /> end function<br /> <br /> %multiplier = 1.5<br /> printtext {~} = {17:multiply}<br /> <br /> end<br /> </p><br /> <br /> When you specify <code>Expose</code>, the %variables (and local methods)<br /> that are exposed are<br /> those in the containing context that are declared before the<br /> method definition.<br /> Labels, images, and screens are '''not''' exposed.<br /> <br /> A percent variable inside an<br /> exposed method "hides" a same-named variable in the exposed context.<br /> In the following request,<br /> the <code>%multiplier</code> inside the local <code>Multiply</code> method is<br /> the one that is used inside the method &mdash; not the <code>%multiplier</code> declared<br /> in the exposed context and assigned later:<br /> <p class="code">b<br /> <br /> %multiplier is float<br /> <br /> local function (float):multiply is float expose<br /> %multiplier is float initial(1.2)<br /> return %multiplier * %this<br /> end function<br /> <br /> %multiplier = 1.5<br /> printtext {~} = {17:multiply}<br /> <br /> end<br /> </p><br /> <br /> You are allowed to reference a hidden variable<br /> before it is hidden, as in this example:<br /> <p class="code">b<br /> <br /> %multiplier is float<br /> <br /> local function (float):multiply is float expose<br /> printText {~} = {%multiplier}<br /> %multiplier is float initial(1.2)<br /> printText {~} = {%multiplier}<br /> return %multiplier * %this<br /> end function<br /> <br /> %multiplier = 1.5<br /> printtext {~} = {17:multiply}<br /> <br /> end<br /> </p><br /> <br /> The first <code>PrintText</code> statement in the <code>Multiply</code> method prints the <code>%multiplier</code>.<br /> in the exposed context.<br /> The second <code>PrintText</code> statement prints the <code>%multiplier</code> declared in the <code>Multiply</code> method.<br /> <br /> While the value of this tactic in a small local method like the one above<br /> may be questionable, it might be useful in a larger local method.<br /> You might want to access a containing context's<br /> data after writing a great deal of code that uses the same variable name internally<br /> for something else.<br /> <br /> Local methods that expose the containing context are nestable.<br /> Consider the following fragment:<br /> <p class="code">b<br /> ...<br /> local subroutine (stringlist):a expose<br /> ...<br /> local subroutine (stringlist):b<br /> ...<br /> local subroutine (stringlist):c expose<br /> ...<br /> local subroutine (stringlist):d expose<br /> </p><br /> <br /> In this example, method <code>A</code> can access the outermost scope's variables.<br /> Neither methods <code>B</code>, <code>C</code>, nor <code>D</code> can access the outermost scope's variables,<br /> nor can they access method <code>A</code>'s because method <code>B</code> is not exposed.<br /> Methods <code>C</code> and <code>D</code> can both access method <code>B</code>'s variables, and method <code>D</code> can access method <code>C</code>'s.<br /> Probably this level of nesting will be quite rare.<br /> <br /> ===Using non-enhancement and recursive local methods===<br /> In all the examples in the preceding subsection, the local methods are<br /> enhancement methods, which is likely to be the most common type of local method.<br /> Local methods can enhance intrinsic, system, or user-defined classes.<br /> You can also define a non-enhancement local method.<br /> <br /> If you define a non-enhancement local method, you can<br /> invoke it in either of two ways:<br /> <ul><br /> <li>With <code>%(local):</code>, the syntax for invoking a [[Notation conventions for methods#Shared members|shared]] method with<br /> the term <var>Local</var> in parentheses instead of a class name.<br /> <li>With simply a percent sign (<tt>%</tt>) preceding the method name.<br /> </ul><br /> <br /> Here is an example:<br /> <p class="code">b<br /> <br /> %a is float<br /> %b is longstring<br /> %c is fixed dp 2<br /> <br /> local subroutine debug expose<br /> printText {~} = {%a}<br /> printText {~} = '{%b}'<br /> printText {~} = {%c}<br /> end subroutine<br /> <br /> %(local):debug<br /> <br /> %a = 12<br /> %b = 'north'<br /> %c = .99<br /> <br /> call %debug<br /> <br /> end<br /> </p><br /> <br /> The result is:<br /> <p class="code">%a = 0<br /> %b = ''<br /> %c = 0.00<br /> %a = 12<br /> %b = 'north'<br /> %c = 0.99<br /> </p><br /> '''Note:'''<br /> <ul><br /> <li>For a local subroutine as in the example above, the keyword <var>Call</var><br /> is also legal before <code>%(local):</code>, but it is required if using just<br /> the <code>%</code>.<br /> <br /> <li>The name <var>Local</var> is not allowed as a class name.<br /> <br /> <br /> <li>As stated earlier, the name of a local method cannot be the same as a percent variable<br /> in the same scope.<br /> </ul><br /> <br /> As a special case to support recursive local methods,<br /> unexposed methods are allowed to call themselves.<br /> The following definition is valid:<br /> <p class="code">local function (float):factorial is float<br /> if %this le 1 then<br /> return %this<br /> end if<br /> return %this * (%this - 1):factorial<br /> end function<br /> </p><br /> <br /> ===Using locally inherited methods===<br /> Like enhancement methods, local methods ''never'' automatically apply<br /> to any extension classes.<br /> For example, if the declaration of local function <code>bytes</code> is:<br /> <p class="code">local function (stringlist):bytes is float<br /> </p><br /> <br /> Simply applying <code>bytes</code> to object <code>%foolist</code> (<code>%foolist:bytes</code>)<br /> is ''not'' allowed if<br /> object <code>%foolist</code> is of class <code>MyStringlist</code> which extends <var>Stringlist</var>.<br /> But the following ''is valid'':<br /> <p class="code">%foolist:(stringlist)bytes<br /> </p><br /> <br /> You can use <code>%foolist:bytes</code>,<br /> however, if you first specify an explicit <var>Local Inherit</var> statement, as described below.<br /> <br /> ====Local Inherit statement syntax====<br /> <p class="syntax"><span class="literal">Local Inherit (</span><span class="term">extensionClass</span><span class="literal">)::</span><span class="term">method</span> <span class="literal">From </span><span class="term">baseclass</span> <span class="squareb">[</span><span class="term">baseMethod</span><span class="squareb">]</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>extensionClass<br /> </th><td>The name of the extended class for which you want the local method to be inherited.<br /> </td></tr><br /> <tr><th>method<br /> </th><td>The name of the local enhancement method that you want to be inherited for <var class="term">extensionClass</var>.<br /> </td></tr><br /> <tr><th>baseClass<br /> </th><td>The class that <var class="term">extensionClass</var> extends.<br /> </td></tr><br /> <tr><th>baseMethod<br /> </th><td>The base method name, which is assumed to be the same as <var class="term">method</var>, the inherited name.<br /> </td></tr></table><br /> <br /> In the case of the preceding example, the appropriate <var>Local Inherit</var> statement is:<br /> <p class="code">local inherit (myStringlist):bytes from stringlist<br /> </p><br /> <br /> Then the local <code>(stringlist):bytes</code> method is invoked by:<br /> <p class="code">%foolist:bytes<br /> </p><br /> <br /> If you want to use a different name, say <code>characters</code>,<br /> for the inherited method (<code>bytes</code>, above), you specify:<br /> <p class="code">local inherit (myStringlist):characters from stringlist bytes<br /> </p><br /> <br /> And to invoke the method, you specify:<br /> <p class="code">%foolist:characters<br /> </p><br /> <p class="note">'''Note:'''<br /> You can only locally inherit local methods. </p><br /> <br /> <div id="persistVars"></div><br /> ==Persistent and Shared local variables==<br /> <br /> <br /> <br /> These method-specific variables can be used only within a local method.<br /> They have local scope:<br /> they can only be accessed<br /> inside the local method in which they are declared, and they<br /> have no meaning outside that method.<br /> <br /> A '''Persistent local variable''' is set<br /> to its initial value every time the method<br /> that contains the local method is invoked.<br /> This unusual characteristic is elaborated further, below.<br /> <br /> A '''Shared local variable''' is never reset to its initial value; it<br /> maintains its<br /> value over the entire request (everything between <var>Begin</var> and <var>End</var>) regardless of where<br /> it is contained.<br /> <br /> A simple %variable in a local method is initialized (and stacked<br /> as needed) every time the local method is entered.<br /> A <var>Persistent</var> local variable, however, is<br /> initialized and stacked during entry to the ''context that contains'' the<br /> local method that contains the variable.<br /> This context may be<br /> a method (local or not), a non-OO <var class="product">SOUL</var> complex subroutine, or a <var>Begin</var>/<var>End</var> block.<br /> <br /> For example,<br /> when the <code>Sleep</code> method below is called, <code>%timesSnored</code> is initialized to 0:<br /> <p class="code">class person<br /> ...<br /> subroutine sleep<br /> ...<br /> local function snore is float<br /> %timesSnored is float persistent<br /> %consecutive is float<br /> ...<br /> %timesSnored = %timesSnored + 1<br /> return %timesSnored<br /> end function<br /> ...<br /> </p><br /> <br /> If <code>Snore</code> is called:<br /> <ul><br /> <li><code>%timesSnored</code> is '''not''' initialized.<br /> <li>The <code>Sleep</code> method is '''not''' initialized (that would<br /> make it useless for counting snores).<br /> <li>Simple local variable <code>%consecutive</code> '''is''' initialized.<br /> </ul><br /> <br /> If <code>Sleep</code> is called recursively, however, the current value of <code>%timesSnored</code><br /> is stacked, as are all simple variables within <code>Sleep</code>'s context.<br /> They are then restored upon the return from the recursive call.<br /> <br /> If you do want a local variable to persist over recursion, you declare it<br /> a <var>Shared</var> variable, and like a <var>Common</var> %variable, it will never be<br /> reinitialized or stacked:<br /> <p class="code">local function snore is float<br /> %timesSnored is float shared<br /> ...<br /> %timesSnored = %timesSnored + 1<br /> return %timesSnored<br /> end function<br /> </p><br /> <p class="note">'''Note:'''<br /> If the code that contains the local method that contains a <var>Persistent</var> variable<br /> is the <var>Begin</var>/<var>End</var> block or a complex subroutine, no variable value re-initialization occurs &mdash; in this case,<br /> there is no difference between a <var>Persistent</var> local variable and a<br /> <var>Shared</var> local variable. </p><br /> <br /> ===Syntax for Persistent or Shared===<br /> The syntax for declaring a <var>Persistent</var> or <var>Shared</var> local variable is:<br /> <p class="syntax"><span class="literal">%</span><span class="term">name</span> <span class="literal">Is </span><span class="term">type</span> <span class="squareb">[</span><span class="literal">Persistent | Shared</span><span class="squareb">]</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>name<br /> </th><td>The name of the local variable.<br /> </td></tr><br /> <tr><th>type<br /> </th><td>The variable's datatype definition.<br /> </td></tr></table><br /> <blockquote class="note"><br /> <b>Notes:</b><br /> <ul><br /> <li>The <var>Persistent</var> and <var>Shared</var> keywords must be the last keywords on the %variable declaration.<br /> <br /> <li><var>Persistent</var> and <var>Shared</var> local variables may be declared<br /> inside a <var>Local Property</var> block but outside the <var>Get</var>/<var>Set</var> blocks, as shown in the following example:<br /> <p class="code">local property concat is longstring<br /> %shadow is longstring persistent<br /> set<br /> %shadow = %shadow with %concat<br /> end set<br /> get<br /> return %shadow<br /> end get<br /> end property<br /> </p><br /> <br /> Prior to the introduction of <var>Persistent</var> variables,<br /> only the <var>Get</var>/<var>Set</var> blocks were allowed inside a <var>Property</var> block.<br /> </ul><br /> </blockquote><br /> <br /> ===Working with Persistent variables===<br /> <var>Persistent</var> variables provide a<br /> way for a method to locally maintain some value that needs to be remembered<br /> from call to call.<br /> The following examples show how this capability can be used to<br /> make local variables and properties interchangeable.<br /> <br /> For example, suppose one subroutine locally manipulates <code>%balance</code>,<br /> and a local function <code>BalanceChange</code> returns the change since the last time<br /> you checked:<br /> <p class="code">subroutine calculate<br /> ...<br /> %balance is float<br /> ...<br /> local function balanceChange is float expose<br /> %lastBalance is float persistent<br /> %return is float<br /> %return = %balance - %lastBalance<br /> %lastBalance = %balance<br /> return %return<br /> end function<br /> ...<br /> </p><br /> <br /> <var>Persistent</var> variable <code>%lastBalance</code> in <code>balanceChange</code> gets initialized to 0 whenever<br /> <code>Calculate</code> is entered, at the same time that <code>%balance</code> gets initialized.<br /> <br /> Now, suppose you want to change <code>%balance</code>, as above,<br /> into a <var>Property</var>.<br /> You can use <var>Persistent</var> variable <code>shadow</code> to maintain the value of <code>%balance</code>:<br /> <p class="code">subroutine calculate<br /> ...<br /> local property balance is float<br /> %shadow is float persistent<br /> get<br /> return %shadow<br /> end get<br /> set<br /> %shadow = %balance<br /> end set<br /> end property<br /> ...<br /> </p><br /> <br /> Once you have the local property definition above, then inside subroutine <code>Calculate</code>,<br /> references to the <code>Balance</code> property can simply use a percent sign instead of<br /> using a <code>%(local)</code> qualifier (introduced in [[#Using non-enhancement and recursive local methods|"Using non-enhancement and recursive local methods"]]).<br /> For example:<br /> <p class="code">%balance = %balance + %adjustment<br /> </p><br /> <br /> Consequently, you can change a local variable to a property and vice versa<br /> without affecting any of the code that uses the property.<br /> <br /> Carrying this reversibilty concept further, you could<br /> also readily change a <var>Common</var> variable to a <var>Property</var>.<br /> For example, to turn <var>Common</var> variable <code>%foo</code> into a property, you might do something<br /> like the following:<br /> <p class="code">class common<br /> public shared<br /> property foo is longstring<br /> ...<br /> end public shared<br /> ...<br /> end class<br /> </p><br /> <br /> Where you want to access the property locally as <code>%foo</code>, you specify<br /> a [[#Local aliases|local alias]]:<br /> <p class="code">local alias foo for (common):foo<br /> </p><br /> <br /> Then when you type <code>%foo</code> in that scope, you access the<br /> property <code>(common):foo</code>.<br /> <br /> ===Using Persistent versus exposing the local method===<br /> A <var>Persistent</var> variable<br /> maintains its value across subsequent invocations of the local method<br /> that contains it, but only until the next time the container of that method<br /> is called.<br /> A <var>Shared</var> variable maintains its value for the duration of the request.<br /> <br /> Consider the method called <code>MonthlyPayment</code>:<br /> <p class="code">class labor<br /> public<br /> ...<br /> function monthlyPayment is float<br /> ...<br /> end public<br /> ...<br /> end class<br /> </p><br /> <br /> Suppose inside <code>MonthlyPayment</code> you want a local property to keep track<br /> of the total payments, but which will never return a value larger than 2000.<br /> The property might look like:<br /> <p class="code">class labor<br /> ...<br /> function monthlyPayment is float<br /> ...<br /> local property amount is float<br /> %currentAmount is float persistent<br /> get<br /> if %currentAmount gt 2000 then<br /> return 2000<br /> end if<br /> return %currentAmount<br /> end get<br /> set<br /> %currentAmount = %amount<br /> end set<br /> end property<br /> ...<br /> end function<br /> ...<br /> end class<br /> </p><br /> <br /> Because <code>%currentAmount</code> is <var>Persistent</var>, it will get set to 0 every time <code>MonthlyPayment</code><br /> is entered.<br /> If it was <var>Shared</var>, its value would be preserved between invocations of<br /> <code>MonthlyPayment</code>, which is not what is wanted here.<br /> And if it was<br /> a simple local variable inside <code>Amount</code>, it would<br /> get set to 0 every time <code>Amount</code> was invoked.<br /> <br /> Compare the solution above to the following alternative.<br /> You can accomplish the same end if you make <code>%currentAmount</code><br /> a simple variable inside of <code>MonthlyPayment</code>, and if you make <code>Amount</code><br /> an "exposed" method (introduced in [[#Using Defer and Expose|"Using Defer and Expose"]]):<br /> <p class="code">class labor<br /> ...<br /> function monthlyPayment is float<br /> ...<br /> %currentAmount is float<br /> ...<br /> local property amount is float exposed<br /> get<br /> if %currentAmount gt 2000 then<br /> return 2000<br /> end if<br /> return %currentAmount<br /> end get<br /> set<br /> %currentAmount = %amount<br /> end set<br /> end property<br /> ...<br /> end function<br /> ...<br /> end class<br /> </p><br /> <br /> But this approach has weaknesses:<br /> <ul><br /> <li><code>%currentAmount</code> can<br /> be set or retrieved throughout <code>MonthlyPayment</code>, which may be inviting a problem.<br /> <li>Making <code>Amount</code> exposed opens the door to problems<br /> or bugs caused by variables shared between <code>Amount</code> and <code>MonthlyPayment</code>.<br /> </ul><br /> <br /> The latter of these is not necessarily a weakness &mdash;<br /> you might prefer that<br /> <code>Amount</code> is able to see <code>MonthlyPayment</code>'s variables, or you might<br /> want <code>%currentAmount</code> to be manipulated in code outside of <code>Amount</code>.<br /> But <var>Persistent</var> can occasionally be a superior way<br /> to provide just the right level of isolation of a local variable.<br /> <br /> ==Local classes, enumerations, and structures==<br /> It may be advantageous in rare cases to define an entire class for use<br /> for a local scope.<br /> <var class="product">SOUL</var> support for local tools <br /> includes '''local classes''', as well as for '''local enumerations''',<br /> and '''local structures'''.<br /> <br /> A local class is a class whose members and objects are available only<br /> inside the scope within which their definition is contained.<br /> For example, within the definition of a method in a class, you might<br /> want to make use of a local class:<br /> <p class="code">class myclass<br /> ...<br /> public<br /> function foobar is float<br /> end public<br /> ...<br /> function foobar is float<br /> ...<br /> '''local class mumble'''<br /> public<br /> subroutine spec5(%newval is float)<br /> end public<br /> <br /> subroutine spec5(%newval is float)<br /> ...<br /> end subroutine<br /> '''end class mumble'''<br /> ...<br /> call spec5(19)<br /> ...<br /> end function<br /> ...<br /> end class myclass<br /> </p><br /> <br /> A local class block is no different from a normal class block (as described<br /> in [[Classes and Objects|"Classes and Objects"]]) except that the class name must be preceded<br /> by the keywords <var>Local Class</var>.<br /> <br /> You may define a local class in any scope in a program, including within<br /> a local method and within the outermost scope (directly within <var>Begin</var> and<br /> <var>End</var> statements).<br /> A local class in the<br /> outer scope is different from a normal class in that it can only be<br /> referenced by outer scope code, simple<br /> subroutines, and local "exposed" subroutines.<br /> <br /> A local class "hides" any same-named class in the global scope.<br /> That is, within the local scope,<br /> local class member and variable names take precedence, and out-of-scope same-named<br /> methods and variables cannot be accessed.<br /> Similar hiding was discussed for variables in local methods (see [[#Using Defer and Expose|"Using Defer and Expose"]]),<br /> but unlike local methods, which have a workaround for this hiding,<br /> there is no way to unhide a hidden class.<br /> <br /> ==Local structures and enumerations==<br /> Just as you can prepend the keyword <var>Local</var> to a class block,<br /> define the class,<br /> then apply the class contents in the local scope, you can also<br /> define a locally-scoped enumeration or a locally-scoped structure. <br /> <br /> Within a method or complex subroutine, only such a local<br /> enumeration or structure is allowed: the keyword <var>Local</var><br /> is required for any enumeration or structure block you declare<br /> inside a method or complex subroutine.<br /> <br /> The syntax of an enumeration block is described in<br /> [[Enumerations#User Language enumerations|User Language enumerations]].<br /> The syntax of a structure block is described in [[Structures]].<br /> <br /> <div id="aliases"></div><br /> <br /> ==Local aliases==<br /> <br /> <br /> In certain circumstances, you can improve code readability and possibly<br /> coding efficiency by<br /> mapping an alternative name to an existing method for a local scope.<br /> You do this by declaring a '''local alias'''.<br /> <br /> For example, consider a case where you have a class named <code>Utility</code> that<br /> contains an enhancement method named <code>Shift</code> that operates on strings:<br /> <p class="code">class utility<br /> public shared<br /> function (string):shift(%number is float) is longstring<br /> ...<br /> end public shared<br /> end class<br /> </p><br /> <br /> Suppose that in some context in your program, you use many statements like these<br /> to operate on objects that belong to another class:<br /> <p class="code">%a = %b:(+utility)shift(1)<br /> %c = %d:(+utility)shift(2)<br /> %e = %f:(+utility)shift(3)<br /> </p><br /> <br /> As a way to eliminate the repetition of the qualifying classname,<br /> you can define an alias:<br /> <p class="code">local alias (string):shift for (+utility)shift<br /> </p><br /> <br /> Then the statements above that are in the same local scope as the alias statement<br /> can be shortened to:<br /> <p class="code">%a = %b:shift(1)<br /> %c = %d:shift(2)<br /> %e = %f:shift(3)<br /> </p><br /> <br /> An alternative way to accomplish the same economy with a little more effort<br /> is to define a local function:<br /> <p class="code">local function (string):shift(%number is float) is longstring<br /> return %this:(+utility)shift(%number)<br /> end function<br /> </p><br /> <br /> Although you can declare and use a local alias for system and user class methods,<br /> they are probably most suited for [[Enhancement methods|enhancement]] methods.<br /> Because of the potential confusion caused by aliases, you probably should<br /> use them sparingly.<br /> <br /> ===Local alias declaration syntax===<br /> Formally, the syntax for an alias declaration is:<br /> <p class="syntax"><span class="literal">Local Alias </span><span class="squareb">[</span><span class="literal">(</span><span class="term">class</span><span class="literal">):</span><span class="squareb">]</span><span class="term">alias</span> <span class="literal">For</span> -<br /> <span class="squareb">[</span><span class="literal">(+</span><span class="term">enhancingClass</span><span class="literal">) | (</span><span class="term">containingClass</span><span class="literal">):</span><span class="squareb">]</span><span class="term">method</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>class<br /> </th><td>The class of the objects on which the actual method, <var class="term">method</var>, is defined to operate.<br /> <p><br /> If the alias is for an instance method, you must specify the class before the alias name. If for a shared, non-enhancement method, you do not specify a class before the alias name. </p><br /> </td></tr><br /> <tr><th>alias<br /> </th><td>The name of the method alias. This name typically is the same as <var class="term">method</var>, but it does not have to be.<br /> </td></tr><br /> <tr><th><var>+</var>enhancingClass<br /> </th><td>The name of the class in which <var class="term">method</var> is a member. Specify this class if <var class="term">method</var> is an enhancement method.<br /> </td></tr><br /> <tr><th>containingClass<br /> </th><td>The name of the class in which <var class="term">method</var> is a member. Specify this class if <var class="term">method</var> is a shared method.<br /> </td></tr><br /> <tr><th>method<br /> </th><td>The name of the actual method for which the alias is to be used.<br /> </td></tr></table><br /> <br /> ==Examples==<br /> <br /> The following series of examples demonstrates how to use<br /> local aliases in a variety of contexts.<br /> <ol><br /> <li>The following fragment shows an alias for an instance method<br /> (<var>Stringlist</var> <var>Count</var>):<br /> <p class="code">local alias (stringlist):number for count<br /> ...<br /> %sl is object stringlist<br /> ...<br /> print %sl:number<br /> </p><br /> <li>In the following example, local alias <code>Foolish</code> is used for<br /> public subroutine <code>Silly</code> in class <code>Absurd</code>:<br /> <p class="code">class absurd<br /> ...<br /> public<br /> ...<br /> subroutine silly<br /> ...<br /> end public<br /> ...<br /> end class<br /> ...<br /> local alias (absurd):foolish for silly<br /> ...<br /> %whacky is object silly<br /> ...<br /> %whacky:foolish<br /> </p><br /> <li>In the following example, a local alias is used for<br /> an enhancement method in class <code>Util</code> for <var>Stringlists</var>.<br /> This is likely an atypical case where the local alias name<br /> is ''not'' the same as the enhancement method name.<br /> <p class="code">class util<br /> ...<br /> public shared<br /> ...<br /> function (stringlist):hash is longstring<br /> ...<br /> end public shred<br /> ...<br /> end class<br /> ...<br /> local alias (stringlist):digest for (+util)hash<br /> ...<br /> %sl is object stringlist<br /> ...<br /> print %sl:digest<br /> </p><br /> <br /> <li>As shown in this example for the <var>System</var> class method <var>[[Arguments (System function)|Arguments]]</var>,<br /> a local alias statement for a non-enhancement, shared method must ''not''<br /> have a class name preceding the alias name:<br /> <p class="code">local alias args for (system):arguments<br /> ...<br /> printtext Input arguments: {%args}<br /> </p><br /> <p><br /> Note that a non-instance alias is simply accessed by the alias name preceded by<br /> a percent sign (<code>%args</code>) &mdash; just like a local non-instance method<br /> (see [[#Using non-enhancement and recursive local methods|"Using non-enhancement and recursive local methods"]], for example).<br /> The alternative access to this is to use the keyword <code>Local</code>, as in: </p><br /> <p class="code">printtext Input arguments: {%(local):args}<br /> </p><br /> <p><br /> You can also use the simple percent-sign access for an alias for a non-instance<br /> user-defined method, as in the following: </p><br /> <br /> <p class="code">class foobar<br /> ...<br /> public shared<br /> ...<br /> property mostFoo is float<br /> ...<br /> end public shared<br /> ...<br /> end class<br /> ...<br /> local alias maxFoo for (foobar):mostFoo<br /> ...<br /> %maxFoo = 77<br /> ...<br /> print %maxFoo<br /> </p><br /> <br /> <li>You can also use a local alias to provide an alias for a hidden method.<br /> For example, suppose your program has many <var>Stringlist</var> <var>[[Add (Stringlist function)|Add]]</var> calls in a local context,<br /> and you are required to make the same modification to each of those <var>Add</var> calls.<br /> Rather than changing each <var>Add</var> call "by hand," a convenient solution is to<br /> create a local <var>Add</var> method that applies the modification:<br /> <p class="code">local function (stringlist):add(%what is longstring) -<br /> is float<br /> ...<br /> end function<br /> </p><br /> <p><br /> To call the system <var>Stringlist</var> <var>Add</var> method from within the local <var>Add</var> function,<br /> you can use an alias like the following &mdash; otherwise an <var>Add</var> call inside the<br /> function is a recursive call to itself: </p><br /> <p class="code">local function (stringlist):add(%what is longstring) -<br /> is float<br /> local alias (stringlist):realAdd for add<br /> ...<br /> return %this:realAdd(%what)<br /> end function<br /> </p><br /> </ol><br /> <br /> ==Common methods and aliases==<br /> <br /> You can define '''Common methods''' and '''Common aliases'''.<br /> The only methods you can<br /> declare as <var>Common</var> are properties and subroutines.<br /> The only <var>Common</var> alias you can declare is for a <var>Shared Property</var>.<br /> <br /> <var>Common</var> properties and <var>Common</var> subroutines are designed to ease the<br /> migration of existing <var class="product">SOUL</var> code elements to comparable <var class="product">SOUL</var><br /> object-oriented constructs.<br /> You can define<br /> a <var>Common</var> property, for example, that is largely interchangeable with a non-OO <var class="product">SOUL</var> <var>Common</var> variable.<br /> Similarly, a <var>Common</var> subroutine can be used interchangeably with a non-OO <var class="product">SOUL</var><br /> complex subroutine.<br /> <var>Common</var> functions do not exist, because prior to <var class="product">SOUL</var><br /> there were no user-created <var class="product">User Language</var> functions (so no functions to migrate).<br /> <br /> ===Declaring and invoking a Common method===<br /> Like a <var>Local</var> method, a <var>Common</var> method is<br /> not part of a class and<br /> its contents are not visible to the containing code.<br /> A <var>Common Property</var> is only available<br /> inside the scope within which its definition is contained,<br /> but a <var>Common Subroutine</var> (which must be at the outermost scope) is available throughout the request.<br /> <br /> A <var>Common</var> method does not allow a separate declaration block before it is defined;<br /> its declaration always begins the method definition.<br /> Its declaration syntax is like that for a <var>Local</var> method ([[#Defining and invoking a local method|Defining and invoking a local method]]).<br /> <br /> ===Common method declaration syntax===<br /> A <var>Common</var> method is declared with the keyword <var>Common</var>, followed by the<br /> method type, followed by the method name and description:<br /> <p class="syntax"><span class="literal">Common </span><span class="term">methodType methodName methodDesc</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>methodType<br /> </th><td>The method type, which has the following syntax:<br /> <p class="syntax"><span class="literal">Subroutine | Property</span><br /> </p><br /> <br /> </td></tr><br /> <tr><th>methodName<br /> </th><td>The method name, which can be any name that follows the rules for <var class="product">SOUL</var> %variables, but it cannot be the same as a simple percent variable in the same scope.<br /> </td></tr><br /> <tr><th>methodDesc<br /> </th><td>The method description, which has the same structure as the method descriptions for <var>Local</var> methods:<br /> <p class="syntax"><span class="squareb">[</span><span class="literal">(</span><span class="term">parameters</span><span class="literal">)</span><span class="squareb">] [</span><span class="literal">is </span><span class="term">datatype</span><span class="squareb">] [</span><span class="term">qualifiers</span><span class="squareb">]</span><br /> </p><br /> <p><br /> An <var>Initial</var> clause is not allowed. The qualifier <var>Defer</var> is ''not'' allowed. The qualifier <var>Expose</var> is allowed only for <var>Common</var> subroutines. </p><br /> </td></tr></table><br /> <br /> An example of a <var>Common</var> property declaration follows:<br /> <p class="code">common property foo is float<br /> </p><br /> <br /> A <var>Common Property</var> may be contained inside any scope in a request; a <var>Common</var><br /> <var>Subroutine</var> must be contained in the outermost scope.<br /> A <var>Common Property</var> must be called inside the scope in which it is defined.<br /> A <var>Common Subroutine</var> may be called from any scope.<br /> <br /> The way you invoke a <var>Common</var> method depends on whether the method<br /> is a <var>Property</var> or a <var>Subroutine</var>, as described in [[#Using a Common Property|"Using a Common Property"]]<br /> and [[#Using a Common Subroutine|"Using a Common Subroutine"]].<br /> <br /> ===Using a Common Property===<br /> The principle<br /> reason for the existence of <var>Common</var> properties and aliases is to enable a <var>Common</var><br /> variable declaration to be converted into a <var>Common Property</var> declaration without<br /> changing the code.<br /> You can only declare a <var>Common</var> property that has no parameters,<br /> but unlike common subroutines, you can declare a <var>Common</var> property<br /> within any scope in a request.<br /> <br /> As an example, consider the following <var>Common</var> property definition:<br /> <p class="code">common property notSmall is float<br /> %shadow is float shared<br /> set<br /> if %notSmall gt 10 then<br /> %shadow = %notSmall<br /> else<br /> %shadow = 10<br /> end if<br /> end set<br /> get<br /> return %shadow<br /> end get<br /> end property<br /> </p><br /> <br /> To access this property, since it is not a member of a class,<br /> you must declare as <var>Common</var> within a scope<br /> a variable with the same name as the property name:<br /> <p class="code">%notSmall is common<br /> </p><br /> <br /> Declaring a same-named <var>Common</var> variable is necessary<br /> even in the scope in which the <var>Common</var> property is defined.<br /> If you specify datatype attributes on the <var>Common</var> variable declaration, they must<br /> match the property datatype:<br /> <p class="code">%notSmall is float common<br /> </p><br /> <br /> If you are converting <var>Common</var> variables to properties,<br /> the <var>Common Property</var> definition block may well be in one<br /> <var>Included</var> procedure while the common variable declaration is in another.<br /> Or you might<br /> want a <var>Common</var> variable that is declared in some standard<br /> <var>Include</var> block to be a <var>Property</var> in a particular request.<br /> You might just have the<br /> <var>Common Property</var> block at the top of the request (after the <var>Begin</var>) and let the<br /> <var>Common</var> variable be used wherever it is already declared.<br /> <br /> For an additional example featuring <var>Common</var> properties and variables,<br /> see [[#Using Common aliases|"Using Common aliases"]].<br /> <br /> ===Using a Common Subroutine===<br /> Just as <var>Common</var> properties enable a fairly straightforward<br /> conversion of standard <var class="product">SOUL</var> <var>Common</var> variables to properties, so <var>Common</var> subroutines<br /> simplify the conversion of <var class="product">SOUL</var> non-OO complex subroutines to <var class="product">SOUL</var> OO subroutines.<br /> Such a subroutine conversion is advantageous because,<br /> without having to change the<br /> invocation of a formerly complex, now <var>Common</var>, subroutine, you gain<br /> the benefits of object-oriented methods:<br /> <ul><br /> <li>Automatic initialization of local variables.<br /> <li>Optional and named parameters.<br /> <li>Better recursion behavior.<br /> </ul><br /> <br /> Note however that unlike complex subroutines, common subroutines must be defined before they are called (or alternatively have an earlier declaration using the [[#Using Defer and Expose|defer]] keyword).<br /> <br /> Since <var>Local</var> subroutines are tightly scoped and restricted to the scope in which<br /> they are defined, they are not suited to the conversion task because<br /> complex subroutines are available throughout the request, that is,<br /> essentially common.<br /> <br /> A <var>Common</var> <var>Subroutine</var> is like a <var>Local</var> <var>Subroutine</var> except:<br /> <ul><br /> <li>It is invoked like a complex subroutine:<br /> <p class="syntax"><span class="literal">Call </span><span class="term">subroutineName</span><br /> </p><br /> <p><br /> Note that ''no'' percent sign (<tt>%</tt>) precedes the subroutine name. </p><br /> <li>It may be contained only in the outermost (<var>Begin</var>/<var>End</var>) scope of a request; it<br /> cannot be nested.<br /> <li>It is in the same namespace as complex subroutines, so <var>Common</var><br /> and complex subroutines may not have the same name.<br /> </ul><br /> <br /> Invoking a <var>Local</var> method that has the same name as a <var>Common</var> subroutine does not<br /> preempt (hide) the invocation of the subroutine, because the <var>Common</var><br /> subroutine must be preceded by the <var>Call</var> keyword.<br /> This is true even if the <var>Local</var> method is a subroutine.<br /> <br /> For example, <var>Common</var> subroutine <code>Jiggle</code> is<br /> followed by a <var>Local</var> subroutine with the same name.<br /> The <code>Call Jiggle</code> statement will call the <var>Common</var> <code>Jiggle</code>:<br /> <p class="code">common subroutine jiggle<br /> ...<br /> end subroutine<br /> ...<br /> function wiggle is float<br /> local subroutine jiggle<br /> ...<br /> end subroutine jiggle<br /> ...<br /> call jiggle<br /> ...<br /> end subroutine wiggle<br /> </p><br /> <br /> A <code>Call %jiggle</code> statement will call the <var>Local</var> <code>Jiggle</code>,<br /> as will <code>Call %(local):jiggle</code> or<br /> even <code>%(local):jiggle</code>.<br /> <br /> ==Common Expose==<br /> <br /> You can easily replace simple subroutines with <var>Common</var> subroutines.<br /> Where your code calls a simple subroutine<br /> from inside a complex subroutine or method, you can use<br /> an "exposed" <var>Common</var> subroutine.<br /> <br /> For example, suppose your site uses simple subroutines<br /> containing the application code, like the following:<br /> <p class="code">TALLY: SUBROUTINE<br /> <br /> ...<br /> <br /> END SUBROUTINE<br /> </p><br /> <br /> In the application code, you can change the way<br /> the above subroutine is initially generated to this:<br /> <p class="code">common subroutine tally expose<br /> <br /> ...<br /> <br /> end subroutine<br /> </p><br /> <br /> Your existing <code>CALL TALLY</code> statements will subsequently<br /> invoke the <code>tally</code> method.<br /> The keyword <var>Expose</var> gives the <code>tally</code> method<br /> access to the variables in the request that are declared outside and<br /> prior to <code>tally</code>.<br /> <br /> Exposed <var>Common</var> subroutines are better than simple<br /> subroutines, which essentially they replace.<br /> The specific advantage of this is that you can formally differentiate between<br /> those variables that have entire program scope versus those that are truly<br /> local to the common subroutine.<br /> <br /> ===Using Common aliases===<br /> <br /> You can declare a <var>Common Alias</var> for a shared, non-enhancement property.<br /> The most likely use of this alias is to provide a property inside a class that<br /> replaces a common variable.<br /> This might be advantageous by providing access to private class variables<br /> from within the property:<br /> <p class="code">class util<br /> public shared<br /> ...<br /> property goofy is longstring<br /> ...<br /> end public shared<br /> ...<br /> end class<br /> ...<br /> common alias pluto for (util):goofy<br /> ...<br /> %pluto is common<br /> ...<br /> </p><br /> <br /> ====Common alias declaration syntax====<br /> The format of the <var>Common Alias</var> statement is straightforward:<br /> <p class="syntax"><span class="literal">Common Alias </span><span class="term">aliasName</span><span class="literal"> For (</span><span class="term">class</span><span class="literal">):</span><span class="term">sharedProperty</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>aliasName</th><br /> <td>The name of the shared method alias.</td></tr><br /> <tr><th>class</th><br /> <td>The name of the class in which <var class="term">sharedProperty</var> is a member.</td></tr><br /> <tr><th>sharedProperty</th><br /> <td>The name of the <var>Property</var> for which the alias is to be used.</td></tr></table><br /> <br /> The following example shows two common properties sharing<br /> private data via a class.<br /> In the example, you enforce a condition that the<br /> request is cancelled if the sum of two common variables exceeds 100:<br /> <p class="code">b<br /> <br /> class util<br /> public shared<br /> property foo is float<br /> property bar is float<br /> end public shared<br /> private shared<br /> variable shadowFoo is float<br /> variable shadowBar is float<br /> end private shared<br /> property foo is float<br /> get<br /> return %shadowFoo<br /> end get<br /> set<br /> assert (%foo + %shadowBar) le 100<br /> %shadowFoo = %foo<br /> end set<br /> end property<br /> property bar is float<br /> get<br /> return %shadowBar<br /> end get<br /> set<br /> assert (%bar + %shadowFoo) le 100<br /> %shadowBar = %bar<br /> end set<br /> end property<br /> end class<br /> <br /> common alias foo for (util):foo<br /> common alias bar for (util):bar<br /> <br /> %foo is common<br /> %bar is common<br /> <br /> %foo = 22<br /> %bar = 33<br /> printText {~} = {%foo}, {~} = {%bar}<br /> <br /> %foo = 44<br /> %bar = 55<br /> printText {~} = {%foo}, {~} = {%bar}<br /> <br /> %foo = 66<br /> %bar = 77<br /> printText {~} = {%foo}, {~} = {%bar}<br /> <br /> end<br /> </p><br /> <br /> The result is:<br /> <p class="output">%foo = 22, %bar = 33<br /> %foo = 44, %bar = 55<br /> &#42;** 1 CANCELLING REQUEST: MSIR.0491: Assert: line 17 ...<br /> </p><br /> <br /> ==See also==<br /> <ul><br /> <li>[[Classes and Objects]]<br /> <li>[[Global and session objects]]<br /> <li>[[Methods]]<br /> <li>[[Object oriented programming in SOUL]]<br /> </ul><br /> <br /> [[Category:Overviews]]<br /> [[Category:SOUL object-oriented programming topics]]</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Local_and_Common_entities&diff=78433 Local and Common entities 2015-07-23T04:03:58Z

<p>Heikki: /* Using a Common Subroutine */</p> <hr /> <div>Many methods are useful in a wide variety of applications.<br /> System methods usually fall into this category, as they are intended to<br /> provide basic services that are useful in many applications.<br /> Methods that are widely useful will usually be contained in a class,<br /> often as <var>Public</var> or <var>Private</var> methods, but sometimes as [[Enhancement methods|enhancement methods]],<br /> and sometimes as non-enhancement shared methods.<br /> <br /> On the other hand, some methods have only relatively local applicability.<br /> That is, while useful in a specific application context, they are not likely<br /> to be useful in other contexts.<br /> The following are cases where using such essentially-local methods might be beneficial:<br /> <ul><br /> <li>As a substitute for a large block of code in the main line of application processing,<br /> increasing code readability.<br /> <li>As a container for application-specific code that is repeated exactly or almost<br /> exactly several times in a block of code, yet<br /> does not lend itself to a loop construct.<br /> <li>As an alternative way to implement a locally recursive process.<br /> </ul><br /> There are many other situations where locally applicable methods would be useful.<br /> <br /> <br /> <var class="product">SOUL</var> '''local methods''' facilitate the writing<br /> of locally applicable methods. Local methods provide all the functionality of simple subroutines, and more:<br /> <ul><br /> <li>They can be nested inside other methods.<br /> <li>They can have local variables.<br /> <li>They can have access to containing context variables or not as one wishes.<br /> <li>They have all the capabilities of method calls including optional and named<br /> parameters and the ability to return values or even be settable (a property).<br /> <li>They are invoked with object-oriented syntax.<br /> </ul><br /> <br /> Accompanying local methods are additional entities that have local scope:<br /> <br /> <ul><br /> <li>Classes, enumerations, and structures have<br /> [[#Local classes, enumerations, and structures|local counterparts]].<br /> <li>[[#Local aliases|Local aliases]]<br /> are a simplified way to call a non-local method in a local context.<br /> <li>[[#Persistent and Shared local variables|Local variables]]<br /> are variables that can be used only within a local method<br /> but that have greater persistence than simple percent variables.<br /> </ul><br /> <br /> [[#Common methods and aliases|Common methods and aliases]] are variations of<br /> local methods and aliases that are designed to be similar enough to standard<br /> <var class="product">SOUL</var> Common variables and complex subroutines to replace them in existing applications.<br /> <br /> ==Scope and locality==<br /> One important thing to understand about local methods is the concept of<br /> '''scope'''.<br /> A scope is a block of code whose variables are isolated from other scopes.<br /> For example, the outermost scope in <var class="product">SOUL</var>: the block of code inside the <var>Begin</var> and <var>End</var> block for a request, but not inside a method or complex subroutine, is one scope.<br /> <br /> Each complex subroutine is another scope, and each method, yet another.<br /> This means that a particular variable name, say, <code>%foo</code>, can only<br /> be declared once in a given scope, and that variable is distinct from an<br /> identically named variable in another scope.<br /> So, in the following example,<br /> <code>%foo</code> is a <var>Stringlist</var> object variable in the outermost scope, a <var>Unicode</var> variable<br /> in complex subroutine <code>WorkHarder</code>, and a <var>Float</var> variable in function <code>Cipher</code> in class<br /> <code>Neat</code>.<br /> <p class="code">begin<br /> %foo is object stringlist<br /> ...<br /> subroutine workHarder<br /> %foo is unicode<br /> ...<br /> end subroutine<br /> ...<br /> class neat<br /> ...<br /> function cipher is float<br /> %foo is float<br /> ...<br /> end function<br /> ...<br /> end class<br /> ...<br /> end<br /> </p><br /> <br /> Because the outermost, complex subroutine, and method scopes are isolated, there is<br /> no danger of confusion for the <code>%foo</code> variables in the preceding example.<br /> In fact, there is no way to access the outermost scope <code>%foo</code> <var>Stringlist</var> from the inside<br /> of complex subroutine <code>WorkHarder</code> or function <code>Cipher</code>, even if no local <code>%foo</code> had been<br /> defined in these scopes.<br /> Scope applies to what are termed '''local variables''', that is, variables<br /> that are local to the scope.<br /> <br /> Class variables are ''always'' accessed via an object variable of the class,<br /> so they are not affected by local scoping.<br /> That is, a variable in class Clever called Junk can only be accessed via an object<br /> variable of class Clever.<br /> So, if %smart is an object of class Clever, variable Junk could be accessed via<br /> <code>%smart:junk</code>.<br /> <br /> Sometimes, the object variable is implicit.<br /> For example, inside an instance (non-shared) method inside of class Clever, a<br /> %junk would be interpreted as <code>%this:junk</code> if no local variable called %junk were<br /> defined.<br /> Similarly, if function Piggledy on local object variable %higgledy produced a<br /> Clever object, the Junk variable in that object could be accessed via<br /> <code>%higgledy:piggledy:junk</code>.<br /> Again, the Clever class variable is implicit here.<br /> <br /> Shared variables in a class are global in scope, that is, they maintain their<br /> value and can be accessed from inside of any scope.<br /> This can be done using the <code>(<classname>):<variable></code> syntax or<br /> the <code>%<object>:<variable></code> syntax.<br /> Because, the class distinguishes the variable from other identically named variables<br /> in other scopes, there is no need to scope such variables: they can be<br /> accessed from any scope inside a <var class="product">SOUL</var> request.<br /> <br /> Of course, private variables in a class can only be accessed from methods inside<br /> the class.<br /> So, in some sense, a class is, itself, a scope where private variables in the<br /> class might be accessed.<br /> However, for the purposes of most discussion, scope will refer only to the<br /> scope for local variables, so it will only refer to the outermost (<var>Begin</var>/<var>End</var>) scope,<br /> complex subroutine scope, and method scope.<br /> <br /> It is worth mentioning '''common variables''' with regard to scoping.<br /> Common variables, as their name might suggest, can be accessed from many different<br /> scopes.<br /> However, they must be declared as common in each scope in which they are to be<br /> accessed.<br /> <br /> For example, to change the previous example slightly:<br /> <p class="code">begin<br /> %foo is object stringlist common<br /> ...<br /> subroutine workHarder<br /> %foo is unicode<br /> ...<br /> end subroutine<br /> ...<br /> class neat<br /> ...<br /> function cipher is float<br /> %foo is object stringlist common<br /> ...<br /> end function<br /> ...<br /> end class<br /> ...<br /> end<br /> </p><br /> <br /> In this example, the <code>%foo</code> variables in the outermost scope and in the scope<br /> for method <code>Cipher</code> in class <code>Neat</code> reference the same <var>Stringlist</var> object variable.<br /> On the other hand, <code>%foo</code> in the complex subroutine <code>WorkHarder</code> is a local variable,<br /> so the <code>%foo</code> common variable cannot be accessed in that scope.<br /> ==Defining and invoking a local method==<br /> The local method facility lets you create methods that<br /> are ''not'' part of a class and are only available<br /> inside the scope within which their definition is contained.<br /> A local method does not require a separate declaration block before it is defined.<br /> Typically, a local method's declaration begins the method definition.<br /> <br /> Local methods are declared with the keyword <var>Local</var>, followed by the<br /> method type, followed by the method name and description:<br /> ===Local method declaration syntax===<br /> <p class="syntax"><span class="literal">Local </span><span class="term">methodType methodName methodDesc</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>methodType</th><br /> <td>The method type, which has the following syntax:<br /> <p class="syntax"><span class="literal">Subroutine | Function | Property</span><br /> </p><br /> <p><br /> The types of local method are like those of class methods:<br /> <table><br /> <tr><th><var>Subroutine</var> </th><br /> <td>Returns no value. </td></tr><br /> <br /> <tr><th><var>Function</var> </th><br /> <td>Returns a value, but cannot be set to a value. </td></tr><br /> <br /> <tr><th><var>Property</var> </th><br /> <td>Can return a value or be set to a value. </td></tr></table></p><br /> </td></tr><br /> <br /> <tr><th>methodName</th><br /> <td>The method name, which can be any name that follows the rules for <var class="product">SOUL</var> %variables, possibly preceded by the class that the method enhances (locally). However, like variable declarations inside of <var>Class</var> blocks, the name does not start with the percent (<tt>%</tt>) sign.<br /> <p><br /> In addition, the name cannot be the same as a simple percent variable in the same scope (though it can be the same as a class variable or method, as discussed in [[#Using Defer and Expose|"Using Defer and Expose"]]). </p><br /> <p><br /> The method name syntax is: </p><br /> <p class="syntax"><span class="squareb">[</span><span class="literal">(</span><span class="term">className</span><span class="literal">):</span><span class="squareb">]</span> <span class="term">methodname</span><br /> </p> <br /> If a class name is not specified, the method is assumed to be a shared, non-enhancement local method.<br /> </td></tr><br /> <br /> <tr><th>methodDesc</th><br /> <td>The method description, which has exactly the same structure as the method descriptions for class variables. That is, a local method has an optional parameter list which can contain required and optional, named and unnamed parameters, and their types. The parameter list is followed by a method result type (for <var>Functions</var> and <var>Properties</var>) and then possibly by further qualifiers.<br /> <p> <br /> The method description syntax is: </p><br /> <p class="syntax"><span class="squareb">[</span><span class="literal">(</span><span class="term">parameters</span><span class="literal">)</span><span class="squareb">]</span> <span class="squareb">[</span><span class="literal">is </span><span class="term">datatype</span><span class="squareb">] [</span><span class="term">qualifiers</span><span class="squareb">]</span><br /> </p><br /> <p>While most qualifiers can be used for both local and class methods, some qualifiers (such as <var>Public</var>) make no sense in local method declarations, so they are not allowed, while a few others, like <var>Expose</var> (discussed later), only make sense for <var>Local</var> and <var>Common</var> methods. </p><br /> </td></tr><br /> </table><br /> <br /> An example of a local function declaration follows:<br /> <p class="code">local function (float):addAndMult(%what is float) is float<br /> </p><br /> <br /> Unlike class methods, local methods can and must be declared inside some other scope.<br /> And unlike complex subroutines, local methods can be contained inside any scope,<br /> not just the outermost scope.<br /> <br /> Like simple variables, local methods, themselves, have scope.<br /> That is, they can only be called inside the scope in which they are defined.<br /> This is different from complex subroutines, which must be declared in the<br /> outermost scope, but can be called from any scope.<br /> <br /> In general, as in the following example, a local method declaration is followed<br /> by the definition of the method (although as described in [[#Using Defer and Expose|"Using Defer and Expose"]],<br /> you can declare a method and then define it later in the request if need be).<br /> <p class="code">local function (stringlist):bytes is float<br /> %i is float<br /> %bytes is float<br /> for %i from 1 to %this:count<br /> %bytes = %bytes + %this:itemLength(%i)<br /> end for<br /> return %bytes<br /> end function<br /> </p><br /> <br /> When you invoke a local method (that operates on a specific object instance)<br /> you do not qualify the method name with a classname.<br /> The syntax for the invocation is simply:<br /> <p class="syntax"><span class="term">object</span><span class="literal">:</span><span class="term">method</span><br /> </p><br /> <br /> A different syntax is warrented for methods that do not operate<br /> on a specific object instance,<br /> as discussed in [[#Using non-enhancement and recursive local methods|"Using non-enhancement and recursive local methods"]].<br /> <br /> The following request is a simple example that features a local method.<br /> The local function in this program<br /> calculates the number of bytes in all the items in a <var>Stringlist</var>:<br /> <p class="code">b<br /> <br /> local function (stringlist):bytes is float<br /> %i is float<br /> %bytes is float<br /> for %i from 1 to %this:count<br /> %bytes = %bytes + %this:itemLength(%i)<br /> end for<br /> return %bytes<br /> end function<br /> <br /> %sl is object stringlist<br /> %sl = new<br /> text to %sl<br /> The noise<br /> Of worldly fame is but a blast of wind,<br /> That blows from diverse points, and shifts its name,<br /> Shifting the point it blows from.<br /> end text<br /> <br /> printtext {~} = {%sl:bytes}<br /> <br /> end<br /> </p><br /> <br /> ===Using Defer and Expose===<br /> As described in the previous section,<br /> a local method does not require a declaration separate from its definition.<br /> However, you can do so in a situation where it is warranted<br /> to declare a method before defining it (because method A<br /> calls method B which calls method A).<br /> In such a case, you specify a separate method declaration, append the<br /> keyword <var>Defer</var> to it, then repeat the declaration later in the<br /> program as part of the method definition:<br /> <br /> <p class="code">local function (stringlist):bytes is float defer<br /> ...<br /> &'italic(other code)<br /> ...<br /> local function (stringlist):bytes is float<br /> %i is float<br /> %bytes is float<br /> for %i from 1 to %this:count<br /> %bytes = %bytes + %this:itemLength(%i)<br /> end for<br /> return %bytes<br /> end function<br /> </p><br /> <br /> A local method has its own scope and its variables are not visible to the containing<br /> code.<br /> Similarly, variables in the containing code are not visible to the local method<br /> &mdash; unless the keyword <var>Expose</var> is specified on the method declaration.<br /> In the following example, the <code>Multiply</code> local method references the <code>%multiplier</code><br /> variable in the containing code:<br /> <p class="code">b<br /> <br /> %multiplier is float<br /> <br /> local function (float):multiply is float expose<br /> return %multiplier * %this<br /> end function<br /> <br /> %multiplier = 1.5<br /> printtext {~} = {17:multiply}<br /> <br /> end<br /> </p><br /> <br /> When you specify <code>Expose</code>, the %variables (and local methods)<br /> that are exposed are<br /> those in the containing context that are declared before the<br /> method definition.<br /> Labels, images, and screens are '''not''' exposed.<br /> <br /> A percent variable inside an<br /> exposed method "hides" a same-named variable in the exposed context.<br /> In the following request,<br /> the <code>%multiplier</code> inside the local <code>Multiply</code> method is<br /> the one that is used inside the method &mdash; not the <code>%multiplier</code> declared<br /> in the exposed context and assigned later:<br /> <p class="code">b<br /> <br /> %multiplier is float<br /> <br /> local function (float):multiply is float expose<br /> %multiplier is float initial(1.2)<br /> return %multiplier * %this<br /> end function<br /> <br /> %multiplier = 1.5<br /> printtext {~} = {17:multiply}<br /> <br /> end<br /> </p><br /> <br /> You are allowed to reference a hidden variable<br /> before it is hidden, as in this example:<br /> <p class="code">b<br /> <br /> %multiplier is float<br /> <br /> local function (float):multiply is float expose<br /> printText {~} = {%multiplier}<br /> %multiplier is float initial(1.2)<br /> printText {~} = {%multiplier}<br /> return %multiplier * %this<br /> end function<br /> <br /> %multiplier = 1.5<br /> printtext {~} = {17:multiply}<br /> <br /> end<br /> </p><br /> <br /> The first <code>PrintText</code> statement in the <code>Multiply</code> method prints the <code>%multiplier</code>.<br /> in the exposed context.<br /> The second <code>PrintText</code> statement prints the <code>%multiplier</code> declared in the <code>Multiply</code> method.<br /> <br /> While the value of this tactic in a small local method like the one above<br /> may be questionable, it might be useful in a larger local method.<br /> You might want to access a containing context's<br /> data after writing a great deal of code that uses the same variable name internally<br /> for something else.<br /> <br /> Local methods that expose the containing context are nestable.<br /> Consider the following fragment:<br /> <p class="code">b<br /> ...<br /> local subroutine (stringlist):a expose<br /> ...<br /> local subroutine (stringlist):b<br /> ...<br /> local subroutine (stringlist):c expose<br /> ...<br /> local subroutine (stringlist):d expose<br /> </p><br /> <br /> In this example, method <code>A</code> can access the outermost scope's variables.<br /> Neither methods <code>B</code>, <code>C</code>, nor <code>D</code> can access the outermost scope's variables,<br /> nor can they access method <code>A</code>'s because method <code>B</code> is not exposed.<br /> Methods <code>C</code> and <code>D</code> can both access method <code>B</code>'s variables, and method <code>D</code> can access method <code>C</code>'s.<br /> Probably this level of nesting will be quite rare.<br /> <br /> ===Using non-enhancement and recursive local methods===<br /> In all the examples in the preceding subsection, the local methods are<br /> enhancement methods, which is likely to be the most common type of local method.<br /> Local methods can enhance intrinsic, system, or user-defined classes.<br /> You can also define a non-enhancement local method.<br /> <br /> If you define a non-enhancement local method, you can<br /> invoke it in either of two ways:<br /> <ul><br /> <li>With <code>%(local):</code>, the syntax for invoking a [[Notation conventions for methods#Shared members|shared]] method with<br /> the term <var>Local</var> in parentheses instead of a class name.<br /> <li>With simply a percent sign (<tt>%</tt>) preceding the method name.<br /> </ul><br /> <br /> Here is an example:<br /> <p class="code">b<br /> <br /> %a is float<br /> %b is longstring<br /> %c is fixed dp 2<br /> <br /> local subroutine debug expose<br /> printText {~} = {%a}<br /> printText {~} = '{%b}'<br /> printText {~} = {%c}<br /> end subroutine<br /> <br /> %(local):debug<br /> <br /> %a = 12<br /> %b = 'north'<br /> %c = .99<br /> <br /> call %debug<br /> <br /> end<br /> </p><br /> <br /> The result is:<br /> <p class="code">%a = 0<br /> %b = ''<br /> %c = 0.00<br /> %a = 12<br /> %b = 'north'<br /> %c = 0.99<br /> </p><br /> '''Note:'''<br /> <ul><br /> <li>For a local subroutine as in the example above, the keyword <var>Call</var><br /> is also legal before <code>%(local):</code>, but it is required if using just<br /> the <code>%</code>.<br /> <br /> <li>The name <var>Local</var> is not allowed as a class name.<br /> <br /> <br /> <li>As stated earlier, the name of a local method cannot be the same as a percent variable<br /> in the same scope.<br /> </ul><br /> <br /> As a special case to support recursive local methods,<br /> unexposed methods are allowed to call themselves.<br /> The following definition is valid:<br /> <p class="code">local function (float):factorial is float<br /> if %this le 1 then<br /> return %this<br /> end if<br /> return %this * (%this - 1):factorial<br /> end function<br /> </p><br /> <br /> ===Using locally inherited methods===<br /> Like enhancement methods, local methods ''never'' automatically apply<br /> to any extension classes.<br /> For example, if the declaration of local function <code>bytes</code> is:<br /> <p class="code">local function (stringlist):bytes is float<br /> </p><br /> <br /> Simply applying <code>bytes</code> to object <code>%foolist</code> (<code>%foolist:bytes</code>)<br /> is ''not'' allowed if<br /> object <code>%foolist</code> is of class <code>MyStringlist</code> which extends <var>Stringlist</var>.<br /> But the following ''is valid'':<br /> <p class="code">%foolist:(stringlist)bytes<br /> </p><br /> <br /> You can use <code>%foolist:bytes</code>,<br /> however, if you first specify an explicit <var>Local Inherit</var> statement, as described below.<br /> <br /> ====Local Inherit statement syntax====<br /> <p class="syntax"><span class="literal">Local Inherit (</span><span class="term">extensionClass</span><span class="literal">)::</span><span class="term">method</span> <span class="literal">From </span><span class="term">baseclass</span> <span class="squareb">[</span><span class="term">baseMethod</span><span class="squareb">]</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>extensionClass<br /> </th><td>The name of the extended class for which you want the local method to be inherited.<br /> </td></tr><br /> <tr><th>method<br /> </th><td>The name of the local enhancement method that you want to be inherited for <var class="term">extensionClass</var>.<br /> </td></tr><br /> <tr><th>baseClass<br /> </th><td>The class that <var class="term">extensionClass</var> extends.<br /> </td></tr><br /> <tr><th>baseMethod<br /> </th><td>The base method name, which is assumed to be the same as <var class="term">method</var>, the inherited name.<br /> </td></tr></table><br /> <br /> In the case of the preceding example, the appropriate <var>Local Inherit</var> statement is:<br /> <p class="code">local inherit (myStringlist):bytes from stringlist<br /> </p><br /> <br /> Then the local <code>(stringlist):bytes</code> method is invoked by:<br /> <p class="code">%foolist:bytes<br /> </p><br /> <br /> If you want to use a different name, say <code>characters</code>,<br /> for the inherited method (<code>bytes</code>, above), you specify:<br /> <p class="code">local inherit (myStringlist):characters from stringlist bytes<br /> </p><br /> <br /> And to invoke the method, you specify:<br /> <p class="code">%foolist:characters<br /> </p><br /> <p class="note">'''Note:'''<br /> You can only locally inherit local methods. </p><br /> <br /> <div id="persistVars"></div><br /> ==Persistent and Shared local variables==<br /> <br /> <br /> <br /> These method-specific variables can be used only within a local method.<br /> They have local scope:<br /> they can only be accessed<br /> inside the local method in which they are declared, and they<br /> have no meaning outside that method.<br /> <br /> A '''Persistent local variable''' is set<br /> to its initial value every time the method<br /> that contains the local method is invoked.<br /> This unusual characteristic is elaborated further, below.<br /> <br /> A '''Shared local variable''' is never reset to its initial value; it<br /> maintains its<br /> value over the entire request (everything between <var>Begin</var> and <var>End</var>) regardless of where<br /> it is contained.<br /> <br /> A simple %variable in a local method is initialized (and stacked<br /> as needed) every time the local method is entered.<br /> A <var>Persistent</var> local variable, however, is<br /> initialized and stacked during entry to the ''context that contains'' the<br /> local method that contains the variable.<br /> This context may be<br /> a method (local or not), a non-OO <var class="product">SOUL</var> complex subroutine, or a <var>Begin</var>/<var>End</var> block.<br /> <br /> For example,<br /> when the <code>Sleep</code> method below is called, <code>%timesSnored</code> is initialized to 0:<br /> <p class="code">class person<br /> ...<br /> subroutine sleep<br /> ...<br /> local function snore is float<br /> %timesSnored is float persistent<br /> %consecutive is float<br /> ...<br /> %timesSnored = %timesSnored + 1<br /> return %timesSnored<br /> end function<br /> ...<br /> </p><br /> <br /> If <code>Snore</code> is called:<br /> <ul><br /> <li><code>%timesSnored</code> is '''not''' initialized.<br /> <li>The <code>Sleep</code> method is '''not''' initialized (that would<br /> make it useless for counting snores).<br /> <li>Simple local variable <code>%consecutive</code> '''is''' initialized.<br /> </ul><br /> <br /> If <code>Sleep</code> is called recursively, however, the current value of <code>%timesSnored</code><br /> is stacked, as are all simple variables within <code>Sleep</code>'s context.<br /> They are then restored upon the return from the recursive call.<br /> <br /> If you do want a local variable to persist over recursion, you declare it<br /> a <var>Shared</var> variable, and like a <var>Common</var> %variable, it will never be<br /> reinitialized or stacked:<br /> <p class="code">local function snore is float<br /> %timesSnored is float shared<br /> ...<br /> %timesSnored = %timesSnored + 1<br /> return %timesSnored<br /> end function<br /> </p><br /> <p class="note">'''Note:'''<br /> If the code that contains the local method that contains a <var>Persistent</var> variable<br /> is the <var>Begin</var>/<var>End</var> block or a complex subroutine, no variable value re-initialization occurs &mdash; in this case,<br /> there is no difference between a <var>Persistent</var> local variable and a<br /> <var>Shared</var> local variable. </p><br /> <br /> ===Syntax for Persistent or Shared===<br /> The syntax for declaring a <var>Persistent</var> or <var>Shared</var> local variable is:<br /> <p class="syntax"><span class="literal">%</span><span class="term">name</span> <span class="literal">Is </span><span class="term">type</span> <span class="squareb">[</span><span class="literal">Persistent | Shared</span><span class="squareb">]</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>name<br /> </th><td>The name of the local variable.<br /> </td></tr><br /> <tr><th>type<br /> </th><td>The variable's datatype definition.<br /> </td></tr></table><br /> <blockquote class="note"><br /> <b>Notes:</b><br /> <ul><br /> <li>The <var>Persistent</var> and <var>Shared</var> keywords must be the last keywords on the %variable declaration.<br /> <br /> <li><var>Persistent</var> and <var>Shared</var> local variables may be declared<br /> inside a <var>Local Property</var> block but outside the <var>Get</var>/<var>Set</var> blocks, as shown in the following example:<br /> <p class="code">local property concat is longstring<br /> %shadow is longstring persistent<br /> set<br /> %shadow = %shadow with %concat<br /> end set<br /> get<br /> return %shadow<br /> end get<br /> end property<br /> </p><br /> <br /> Prior to the introduction of <var>Persistent</var> variables,<br /> only the <var>Get</var>/<var>Set</var> blocks were allowed inside a <var>Property</var> block.<br /> </ul><br /> </blockquote><br /> <br /> ===Working with Persistent variables===<br /> <var>Persistent</var> variables provide a<br /> way for a method to locally maintain some value that needs to be remembered<br /> from call to call.<br /> The following examples show how this capability can be used to<br /> make local variables and properties interchangeable.<br /> <br /> For example, suppose one subroutine locally manipulates <code>%balance</code>,<br /> and a local function <code>BalanceChange</code> returns the change since the last time<br /> you checked:<br /> <p class="code">subroutine calculate<br /> ...<br /> %balance is float<br /> ...<br /> local function balanceChange is float expose<br /> %lastBalance is float persistent<br /> %return is float<br /> %return = %balance - %lastBalance<br /> %lastBalance = %balance<br /> return %return<br /> end function<br /> ...<br /> </p><br /> <br /> <var>Persistent</var> variable <code>%lastBalance</code> in <code>balanceChange</code> gets initialized to 0 whenever<br /> <code>Calculate</code> is entered, at the same time that <code>%balance</code> gets initialized.<br /> <br /> Now, suppose you want to change <code>%balance</code>, as above,<br /> into a <var>Property</var>.<br /> You can use <var>Persistent</var> variable <code>shadow</code> to maintain the value of <code>%balance</code>:<br /> <p class="code">subroutine calculate<br /> ...<br /> local property balance is float<br /> %shadow is float persistent<br /> get<br /> return %shadow<br /> end get<br /> set<br /> %shadow = %balance<br /> end set<br /> end property<br /> ...<br /> </p><br /> <br /> Once you have the local property definition above, then inside subroutine <code>Calculate</code>,<br /> references to the <code>Balance</code> property can simply use a percent sign instead of<br /> using a <code>%(local)</code> qualifier (introduced in [[#Using non-enhancement and recursive local methods|"Using non-enhancement and recursive local methods"]]).<br /> For example:<br /> <p class="code">%balance = %balance + %adjustment<br /> </p><br /> <br /> Consequently, you can change a local variable to a property and vice versa<br /> without affecting any of the code that uses the property.<br /> <br /> Carrying this reversibilty concept further, you could<br /> also readily change a <var>Common</var> variable to a <var>Property</var>.<br /> For example, to turn <var>Common</var> variable <code>%foo</code> into a property, you might do something<br /> like the following:<br /> <p class="code">class common<br /> public shared<br /> property foo is longstring<br /> ...<br /> end public shared<br /> ...<br /> end class<br /> </p><br /> <br /> Where you want to access the property locally as <code>%foo</code>, you specify<br /> a [[#Local aliases|local alias]]:<br /> <p class="code">local alias foo for (common):foo<br /> </p><br /> <br /> Then when you type <code>%foo</code> in that scope, you access the<br /> property <code>(common):foo</code>.<br /> <br /> ===Using Persistent versus exposing the local method===<br /> A <var>Persistent</var> variable<br /> maintains its value across subsequent invocations of the local method<br /> that contains it, but only until the next time the container of that method<br /> is called.<br /> A <var>Shared</var> variable maintains its value for the duration of the request.<br /> <br /> Consider the method called <code>MonthlyPayment</code>:<br /> <p class="code">class labor<br /> public<br /> ...<br /> function monthlyPayment is float<br /> ...<br /> end public<br /> ...<br /> end class<br /> </p><br /> <br /> Suppose inside <code>MonthlyPayment</code> you want a local property to keep track<br /> of the total payments, but which will never return a value larger than 2000.<br /> The property might look like:<br /> <p class="code">class labor<br /> ...<br /> function monthlyPayment is float<br /> ...<br /> local property amount is float<br /> %currentAmount is float persistent<br /> get<br /> if %currentAmount gt 2000 then<br /> return 2000<br /> end if<br /> return %currentAmount<br /> end get<br /> set<br /> %currentAmount = %amount<br /> end set<br /> end property<br /> ...<br /> end function<br /> ...<br /> end class<br /> </p><br /> <br /> Because <code>%currentAmount</code> is <var>Persistent</var>, it will get set to 0 every time <code>MonthlyPayment</code><br /> is entered.<br /> If it was <var>Shared</var>, its value would be preserved between invocations of<br /> <code>MonthlyPayment</code>, which is not what is wanted here.<br /> And if it was<br /> a simple local variable inside <code>Amount</code>, it would<br /> get set to 0 every time <code>Amount</code> was invoked.<br /> <br /> Compare the solution above to the following alternative.<br /> You can accomplish the same end if you make <code>%currentAmount</code><br /> a simple variable inside of <code>MonthlyPayment</code>, and if you make <code>Amount</code><br /> an "exposed" method (introduced in [[#Using Defer and Expose|"Using Defer and Expose"]]):<br /> <p class="code">class labor<br /> ...<br /> function monthlyPayment is float<br /> ...<br /> %currentAmount is float<br /> ...<br /> local property amount is float exposed<br /> get<br /> if %currentAmount gt 2000 then<br /> return 2000<br /> end if<br /> return %currentAmount<br /> end get<br /> set<br /> %currentAmount = %amount<br /> end set<br /> end property<br /> ...<br /> end function<br /> ...<br /> end class<br /> </p><br /> <br /> But this approach has weaknesses:<br /> <ul><br /> <li><code>%currentAmount</code> can<br /> be set or retrieved throughout <code>MonthlyPayment</code>, which may be inviting a problem.<br /> <li>Making <code>Amount</code> exposed opens the door to problems<br /> or bugs caused by variables shared between <code>Amount</code> and <code>MonthlyPayment</code>.<br /> </ul><br /> <br /> The latter of these is not necessarily a weakness &mdash;<br /> you might prefer that<br /> <code>Amount</code> is able to see <code>MonthlyPayment</code>'s variables, or you might<br /> want <code>%currentAmount</code> to be manipulated in code outside of <code>Amount</code>.<br /> But <var>Persistent</var> can occasionally be a superior way<br /> to provide just the right level of isolation of a local variable.<br /> <br /> ==Local classes, enumerations, and structures==<br /> It may be advantageous in rare cases to define an entire class for use<br /> for a local scope.<br /> <var class="product">SOUL</var> support for local tools <br /> includes '''local classes''', as well as for '''local enumerations''',<br /> and '''local structures'''.<br /> <br /> A local class is a class whose members and objects are available only<br /> inside the scope within which their definition is contained.<br /> For example, within the definition of a method in a class, you might<br /> want to make use of a local class:<br /> <p class="code">class myclass<br /> ...<br /> public<br /> function foobar is float<br /> end public<br /> ...<br /> function foobar is float<br /> ...<br /> '''local class mumble'''<br /> public<br /> subroutine spec5(%newval is float)<br /> end public<br /> <br /> subroutine spec5(%newval is float)<br /> ...<br /> end subroutine<br /> '''end class mumble'''<br /> ...<br /> call spec5(19)<br /> ...<br /> end function<br /> ...<br /> end class myclass<br /> </p><br /> <br /> A local class block is no different from a normal class block (as described<br /> in [[Classes and Objects|"Classes and Objects"]]) except that the class name must be preceded<br /> by the keywords <var>Local Class</var>.<br /> <br /> You may define a local class in any scope in a program, including within<br /> a local method and within the outermost scope (directly within <var>Begin</var> and<br /> <var>End</var> statements).<br /> A local class in the<br /> outer scope is different from a normal class in that it can only be<br /> referenced by outer scope code, simple<br /> subroutines, and local "exposed" subroutines.<br /> <br /> A local class "hides" any same-named class in the global scope.<br /> That is, within the local scope,<br /> local class member and variable names take precedence, and out-of-scope same-named<br /> methods and variables cannot be accessed.<br /> Similar hiding was discussed for variables in local methods (see [[#Using Defer and Expose|"Using Defer and Expose"]]),<br /> but unlike local methods, which have a workaround for this hiding,<br /> there is no way to unhide a hidden class.<br /> <br /> ==Local structures and enumerations==<br /> Just as you can prepend the keyword <var>Local</var> to a class block,<br /> define the class,<br /> then apply the class contents in the local scope, you can also<br /> define a locally-scoped enumeration or a locally-scoped structure. <br /> <br /> Within a method or complex subroutine, only such a local<br /> enumeration or structure is allowed: the keyword <var>Local</var><br /> is required for any enumeration or structure block you declare<br /> inside a method or complex subroutine.<br /> <br /> The syntax of an enumeration block is described in<br /> [[Enumerations#User Language enumerations|User Language enumerations]].<br /> The syntax of a structure block is described in [[Structures]].<br /> <br /> <div id="aliases"></div><br /> <br /> ==Local aliases==<br /> <br /> <br /> In certain circumstances, you can improve code readability and possibly<br /> coding efficiency by<br /> mapping an alternative name to an existing method for a local scope.<br /> You do this by declaring a '''local alias'''.<br /> <br /> For example, consider a case where you have a class named <code>Utility</code> that<br /> contains an enhancement method named <code>Shift</code> that operates on strings:<br /> <p class="code">class utility<br /> public shared<br /> function (string):shift(%number is float) is longstring<br /> ...<br /> end public shared<br /> end class<br /> </p><br /> <br /> Suppose that in some context in your program, you use many statements like these<br /> to operate on objects that belong to another class:<br /> <p class="code">%a = %b:(+utility)shift(1)<br /> %c = %d:(+utility)shift(2)<br /> %e = %f:(+utility)shift(3)<br /> </p><br /> <br /> As a way to eliminate the repetition of the qualifying classname,<br /> you can define an alias:<br /> <p class="code">local alias (string):shift for (+utility)shift<br /> </p><br /> <br /> Then the statements above that are in the same local scope as the alias statement<br /> can be shortened to:<br /> <p class="code">%a = %b:shift(1)<br /> %c = %d:shift(2)<br /> %e = %f:shift(3)<br /> </p><br /> <br /> An alternative way to accomplish the same economy with a little more effort<br /> is to define a local function:<br /> <p class="code">local function (string):shift(%number is float) is longstring<br /> return %this:(+utility)shift(%number)<br /> end function<br /> </p><br /> <br /> Although you can declare and use a local alias for system and user class methods,<br /> they are probably most suited for [[Enhancement methods|enhancement]] methods.<br /> Because of the potential confusion caused by aliases, you probably should<br /> use them sparingly.<br /> <br /> ===Local alias declaration syntax===<br /> Formally, the syntax for an alias declaration is:<br /> <p class="syntax"><span class="literal">Local Alias </span><span class="squareb">[</span><span class="literal">(</span><span class="term">class</span><span class="literal">):</span><span class="squareb">]</span><span class="term">alias</span> <span class="literal">For</span> -<br /> <span class="squareb">[</span><span class="literal">(+</span><span class="term">enhancingClass</span><span class="literal">) | (</span><span class="term">containingClass</span><span class="literal">):</span><span class="squareb">]</span><span class="term">method</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>class<br /> </th><td>The class of the objects on which the actual method, <var class="term">method</var>, is defined to operate.<br /> <p><br /> If the alias is for an instance method, you must specify the class before the alias name. If for a shared, non-enhancement method, you do not specify a class before the alias name. </p><br /> </td></tr><br /> <tr><th>alias<br /> </th><td>The name of the method alias. This name typically is the same as <var class="term">method</var>, but it does not have to be.<br /> </td></tr><br /> <tr><th><var>+</var>enhancingClass<br /> </th><td>The name of the class in which <var class="term">method</var> is a member. Specify this class if <var class="term">method</var> is an enhancement method.<br /> </td></tr><br /> <tr><th>containingClass<br /> </th><td>The name of the class in which <var class="term">method</var> is a member. Specify this class if <var class="term">method</var> is a shared method.<br /> </td></tr><br /> <tr><th>method<br /> </th><td>The name of the actual method for which the alias is to be used.<br /> </td></tr></table><br /> <br /> ==Examples==<br /> <br /> The following series of examples demonstrates how to use<br /> local aliases in a variety of contexts.<br /> <ol><br /> <li>The following fragment shows an alias for an instance method<br /> (<var>Stringlist</var> <var>Count</var>):<br /> <p class="code">local alias (stringlist):number for count<br /> ...<br /> %sl is object stringlist<br /> ...<br /> print %sl:number<br /> </p><br /> <li>In the following example, local alias <code>Foolish</code> is used for<br /> public subroutine <code>Silly</code> in class <code>Absurd</code>:<br /> <p class="code">class absurd<br /> ...<br /> public<br /> ...<br /> subroutine silly<br /> ...<br /> end public<br /> ...<br /> end class<br /> ...<br /> local alias (absurd):foolish for silly<br /> ...<br /> %whacky is object silly<br /> ...<br /> %whacky:foolish<br /> </p><br /> <li>In the following example, a local alias is used for<br /> an enhancement method in class <code>Util</code> for <var>Stringlists</var>.<br /> This is likely an atypical case where the local alias name<br /> is ''not'' the same as the enhancement method name.<br /> <p class="code">class util<br /> ...<br /> public shared<br /> ...<br /> function (stringlist):hash is longstring<br /> ...<br /> end public shred<br /> ...<br /> end class<br /> ...<br /> local alias (stringlist):digest for (+util)hash<br /> ...<br /> %sl is object stringlist<br /> ...<br /> print %sl:digest<br /> </p><br /> <br /> <li>As shown in this example for the <var>System</var> class method <var>[[Arguments (System function)|Arguments]]</var>,<br /> a local alias statement for a non-enhancement, shared method must ''not''<br /> have a class name preceding the alias name:<br /> <p class="code">local alias args for (system):arguments<br /> ...<br /> printtext Input arguments: {%args}<br /> </p><br /> <p><br /> Note that a non-instance alias is simply accessed by the alias name preceded by<br /> a percent sign (<code>%args</code>) &mdash; just like a local non-instance method<br /> (see [[#Using non-enhancement and recursive local methods|"Using non-enhancement and recursive local methods"]], for example).<br /> The alternative access to this is to use the keyword <code>Local</code>, as in: </p><br /> <p class="code">printtext Input arguments: {%(local):args}<br /> </p><br /> <p><br /> You can also use the simple percent-sign access for an alias for a non-instance<br /> user-defined method, as in the following: </p><br /> <br /> <p class="code">class foobar<br /> ...<br /> public shared<br /> ...<br /> property mostFoo is float<br /> ...<br /> end public shared<br /> ...<br /> end class<br /> ...<br /> local alias maxFoo for (foobar):mostFoo<br /> ...<br /> %maxFoo = 77<br /> ...<br /> print %maxFoo<br /> </p><br /> <br /> <li>You can also use a local alias to provide an alias for a hidden method.<br /> For example, suppose your program has many <var>Stringlist</var> <var>[[Add (Stringlist function)|Add]]</var> calls in a local context,<br /> and you are required to make the same modification to each of those <var>Add</var> calls.<br /> Rather than changing each <var>Add</var> call "by hand," a convenient solution is to<br /> create a local <var>Add</var> method that applies the modification:<br /> <p class="code">local function (stringlist):add(%what is longstring) -<br /> is float<br /> ...<br /> end function<br /> </p><br /> <p><br /> To call the system <var>Stringlist</var> <var>Add</var> method from within the local <var>Add</var> function,<br /> you can use an alias like the following &mdash; otherwise an <var>Add</var> call inside the<br /> function is a recursive call to itself: </p><br /> <p class="code">local function (stringlist):add(%what is longstring) -<br /> is float<br /> local alias (stringlist):realAdd for add<br /> ...<br /> return %this:realAdd(%what)<br /> end function<br /> </p><br /> </ol><br /> <br /> ==Common methods and aliases==<br /> <br /> You can define '''Common methods''' and '''Common aliases'''.<br /> The only methods you can<br /> declare as <var>Common</var> are properties and subroutines.<br /> The only <var>Common</var> alias you can declare is for a <var>Shared Property</var>.<br /> <br /> <var>Common</var> properties and <var>Common</var> subroutines are designed to ease the<br /> migration of existing <var class="product">SOUL</var> code elements to comparable <var class="product">SOUL</var><br /> object-oriented constructs.<br /> You can define<br /> a <var>Common</var> property, for example, that is largely interchangeable with a non-OO <var class="product">SOUL</var> <var>Common</var> variable.<br /> Similarly, a <var>Common</var> subroutine can be used interchangeably with a non-OO <var class="product">SOUL</var><br /> complex subroutine.<br /> <var>Common</var> functions do not exist, because prior to <var class="product">SOUL</var><br /> there were no user-created <var class="product">User Language</var> functions (so no functions to migrate).<br /> <br /> ===Declaring and invoking a Common method===<br /> Like a <var>Local</var> method, a <var>Common</var> method is<br /> not part of a class and<br /> its contents are not visible to the containing code.<br /> A <var>Common Property</var> is only available<br /> inside the scope within which its definition is contained,<br /> but a <var>Common Subroutine</var> (which must be at the outermost scope) is available throughout the request.<br /> <br /> A <var>Common</var> method does not allow a separate declaration block before it is defined;<br /> its declaration always begins the method definition.<br /> Its declaration syntax is like that for a <var>Local</var> method ([[#Defining and invoking a local method|Defining and invoking a local method]]).<br /> <br /> ===Common method declaration syntax===<br /> A <var>Common</var> method is declared with the keyword <var>Common</var>, followed by the<br /> method type, followed by the method name and description:<br /> <p class="syntax"><span class="literal">Common </span><span class="term">methodType methodName methodDesc</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>methodType<br /> </th><td>The method type, which has the following syntax:<br /> <p class="syntax"><span class="literal">Subroutine | Property</span><br /> </p><br /> <br /> </td></tr><br /> <tr><th>methodName<br /> </th><td>The method name, which can be any name that follows the rules for <var class="product">SOUL</var> %variables, but it cannot be the same as a simple percent variable in the same scope.<br /> </td></tr><br /> <tr><th>methodDesc<br /> </th><td>The method description, which has the same structure as the method descriptions for <var>Local</var> methods:<br /> <p class="syntax"><span class="squareb">[</span><span class="literal">(</span><span class="term">parameters</span><span class="literal">)</span><span class="squareb">] [</span><span class="literal">is </span><span class="term">datatype</span><span class="squareb">] [</span><span class="term">qualifiers</span><span class="squareb">]</span><br /> </p><br /> <p><br /> An <var>Initial</var> clause is not allowed. The qualifier <var>Defer</var> is ''not'' allowed. The qualifier <var>Expose</var> is allowed only for <var>Common</var> subroutines. </p><br /> </td></tr></table><br /> <br /> An example of a <var>Common</var> property declaration follows:<br /> <p class="code">common property foo is float<br /> </p><br /> <br /> A <var>Common Property</var> may be contained inside any scope in a request; a <var>Common</var><br /> <var>Subroutine</var> must be contained in the outermost scope.<br /> A <var>Common Property</var> must be called inside the scope in which it is defined.<br /> A <var>Common Subroutine</var> may be called from any scope.<br /> <br /> The way you invoke a <var>Common</var> method depends on whether the method<br /> is a <var>Property</var> or a <var>Subroutine</var>, as described in [[#Using a Common Property|"Using a Common Property"]]<br /> and [[#Using a Common Subroutine|"Using a Common Subroutine"]].<br /> <br /> ===Using a Common Property===<br /> The principle<br /> reason for the existence of <var>Common</var> properties and aliases is to enable a <var>Common</var><br /> variable declaration to be converted into a <var>Common Property</var> declaration without<br /> changing the code.<br /> You can only declare a <var>Common</var> property that has no parameters,<br /> but unlike common subroutines, you can declare a <var>Common</var> property<br /> within any scope in a request.<br /> <br /> As an example, consider the following <var>Common</var> property definition:<br /> <p class="code">common property notSmall is float<br /> %shadow is float shared<br /> set<br /> if %notSmall gt 10 then<br /> %shadow = %notSmall<br /> else<br /> %shadow = 10<br /> end if<br /> end set<br /> get<br /> return %shadow<br /> end get<br /> end property<br /> </p><br /> <br /> To access this property, since it is not a member of a class,<br /> you must declare as <var>Common</var> within a scope<br /> a variable with the same name as the property name:<br /> <p class="code">%notSmall is common<br /> </p><br /> <br /> Declaring a same-named <var>Common</var> variable is necessary<br /> even in the scope in which the <var>Common</var> property is defined.<br /> If you specify datatype attributes on the <var>Common</var> variable declaration, they must<br /> match the property datatype:<br /> <p class="code">%notSmall is float common<br /> </p><br /> <br /> If you are converting <var>Common</var> variables to properties,<br /> the <var>Common Property</var> definition block may well be in one<br /> <var>Included</var> procedure while the common variable declaration is in another.<br /> Or you might<br /> want a <var>Common</var> variable that is declared in some standard<br /> <var>Include</var> block to be a <var>Property</var> in a particular request.<br /> You might just have the<br /> <var>Common Property</var> block at the top of the request (after the <var>Begin</var>) and let the<br /> <var>Common</var> variable be used wherever it is already declared.<br /> <br /> For an additional example featuring <var>Common</var> properties and variables,<br /> see [[#Using Common aliases|"Using Common aliases"]].<br /> <br /> ===Using a Common Subroutine===<br /> Just as <var>Common</var> properties enable a fairly straightforward<br /> conversion of standard <var class="product">SOUL</var> <var>Common</var> variables to properties, so <var>Common</var> subroutines<br /> simplify the conversion of <var class="product">SOUL</var> non-OO complex subroutines to <var class="product">SOUL</var> OO subroutines.<br /> Such a subroutine conversion is advantageous because,<br /> without having to change the<br /> invocation of a formerly complex, now <var>Common</var>, subroutine, you gain<br /> the benefits of object-oriented methods:<br /> <ul><br /> <li>Automatic initialization of local variables.<br /> <li>Optional and named parameters.<br /> <li>Better recursion behavior.<br /> </ul><br /> <br /> Note however that unlike complex subroutines, common subroutines must be defined before they are called (or alternatively have an earlier declaration using the [[Using Defer and Expose|defer]] keyword).<br /> <br /> Since <var>Local</var> subroutines are tightly scoped and restricted to the scope in which<br /> they are defined, they are not suited to the conversion task because<br /> complex subroutines are available throughout the request, that is,<br /> essentially common.<br /> <br /> A <var>Common</var> <var>Subroutine</var> is like a <var>Local</var> <var>Subroutine</var> except:<br /> <ul><br /> <li>It is invoked like a complex subroutine:<br /> <p class="syntax"><span class="literal">Call </span><span class="term">subroutineName</span><br /> </p><br /> <p><br /> Note that ''no'' percent sign (<tt>%</tt>) precedes the subroutine name. </p><br /> <li>It may be contained only in the outermost (<var>Begin</var>/<var>End</var>) scope of a request; it<br /> cannot be nested.<br /> <li>It is in the same namespace as complex subroutines, so <var>Common</var><br /> and complex subroutines may not have the same name.<br /> </ul><br /> <br /> Invoking a <var>Local</var> method that has the same name as a <var>Common</var> subroutine does not<br /> preempt (hide) the invocation of the subroutine, because the <var>Common</var><br /> subroutine must be preceded by the <var>Call</var> keyword.<br /> This is true even if the <var>Local</var> method is a subroutine.<br /> <br /> For example, <var>Common</var> subroutine <code>Jiggle</code> is<br /> followed by a <var>Local</var> subroutine with the same name.<br /> The <code>Call Jiggle</code> statement will call the <var>Common</var> <code>Jiggle</code>:<br /> <p class="code">common subroutine jiggle<br /> ...<br /> end subroutine<br /> ...<br /> function wiggle is float<br /> local subroutine jiggle<br /> ...<br /> end subroutine jiggle<br /> ...<br /> call jiggle<br /> ...<br /> end subroutine wiggle<br /> </p><br /> <br /> A <code>Call %jiggle</code> statement will call the <var>Local</var> <code>Jiggle</code>,<br /> as will <code>Call %(local):jiggle</code> or<br /> even <code>%(local):jiggle</code>.<br /> <br /> ==Common Expose==<br /> <br /> You can easily replace simple subroutines with <var>Common</var> subroutines.<br /> Where your code calls a simple subroutine<br /> from inside a complex subroutine or method, you can use<br /> an "exposed" <var>Common</var> subroutine.<br /> <br /> For example, suppose your site uses simple subroutines<br /> containing the application code, like the following:<br /> <p class="code">TALLY: SUBROUTINE<br /> <br /> ...<br /> <br /> END SUBROUTINE<br /> </p><br /> <br /> In the application code, you can change the way<br /> the above subroutine is initially generated to this:<br /> <p class="code">common subroutine tally expose<br /> <br /> ...<br /> <br /> end subroutine<br /> </p><br /> <br /> Your existing <code>CALL TALLY</code> statements will subsequently<br /> invoke the <code>tally</code> method.<br /> The keyword <var>Expose</var> gives the <code>tally</code> method<br /> access to the variables in the request that are declared outside and<br /> prior to <code>tally</code>.<br /> <br /> Exposed <var>Common</var> subroutines are better than simple<br /> subroutines, which essentially they replace.<br /> The specific advantage of this is that you can formally differentiate between<br /> those variables that have entire program scope versus those that are truly<br /> local to the common subroutine.<br /> <br /> ===Using Common aliases===<br /> <br /> You can declare a <var>Common Alias</var> for a shared, non-enhancement property.<br /> The most likely use of this alias is to provide a property inside a class that<br /> replaces a common variable.<br /> This might be advantageous by providing access to private class variables<br /> from within the property:<br /> <p class="code">class util<br /> public shared<br /> ...<br /> property goofy is longstring<br /> ...<br /> end public shared<br /> ...<br /> end class<br /> ...<br /> common alias pluto for (util):goofy<br /> ...<br /> %pluto is common<br /> ...<br /> </p><br /> <br /> ====Common alias declaration syntax====<br /> The format of the <var>Common Alias</var> statement is straightforward:<br /> <p class="syntax"><span class="literal">Common Alias </span><span class="term">aliasName</span><span class="literal"> For (</span><span class="term">class</span><span class="literal">):</span><span class="term">sharedProperty</span><br /> </p><br /> <br /> Where:<br /> <table class="syntaxTable"><br /> <tr><th>aliasName</th><br /> <td>The name of the shared method alias.</td></tr><br /> <tr><th>class</th><br /> <td>The name of the class in which <var class="term">sharedProperty</var> is a member.</td></tr><br /> <tr><th>sharedProperty</th><br /> <td>The name of the <var>Property</var> for which the alias is to be used.</td></tr></table><br /> <br /> The following example shows two common properties sharing<br /> private data via a class.<br /> In the example, you enforce a condition that the<br /> request is cancelled if the sum of two common variables exceeds 100:<br /> <p class="code">b<br /> <br /> class util<br /> public shared<br /> property foo is float<br /> property bar is float<br /> end public shared<br /> private shared<br /> variable shadowFoo is float<br /> variable shadowBar is float<br /> end private shared<br /> property foo is float<br /> get<br /> return %shadowFoo<br /> end get<br /> set<br /> assert (%foo + %shadowBar) le 100<br /> %shadowFoo = %foo<br /> end set<br /> end property<br /> property bar is float<br /> get<br /> return %shadowBar<br /> end get<br /> set<br /> assert (%bar + %shadowFoo) le 100<br /> %shadowBar = %bar<br /> end set<br /> end property<br /> end class<br /> <br /> common alias foo for (util):foo<br /> common alias bar for (util):bar<br /> <br /> %foo is common<br /> %bar is common<br /> <br /> %foo = 22<br /> %bar = 33<br /> printText {~} = {%foo}, {~} = {%bar}<br /> <br /> %foo = 44<br /> %bar = 55<br /> printText {~} = {%foo}, {~} = {%bar}<br /> <br /> %foo = 66<br /> %bar = 77<br /> printText {~} = {%foo}, {~} = {%bar}<br /> <br /> end<br /> </p><br /> <br /> The result is:<br /> <p class="output">%foo = 22, %bar = 33<br /> %foo = 44, %bar = 55<br /> &#42;** 1 CANCELLING REQUEST: MSIR.0491: Assert: line 17 ...<br /> </p><br /> <br /> ==See also==<br /> <ul><br /> <li>[[Classes and Objects]]<br /> <li>[[Global and session objects]]<br /> <li>[[Methods]]<br /> <li>[[Object oriented programming in SOUL]]<br /> </ul><br /> <br /> [[Category:Overviews]]<br /> [[Category:SOUL object-oriented programming topics]]</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Subroutines&diff=78432 Subroutines 2015-07-23T03:45:37Z

<p>Heikki: /* Example 3 */</p> <hr /> <div><div class="toclimit-3"><br /> <br /> ==Overview==<br /> <p><br /> User Language lets you treat a single set of statements as a simple or complex subroutine. You can:</p><br /> <ul><br /> <li>Execute simple subroutines a number of times from different locations within a request.</li><br /> <li>Use complex subroutines as you would simple subroutines. </li><br /> </ul><br /> In addition, you can:<br /> <ul><br /> <li>Pass parameters via parameter lists.</li><br /> <li>Declare variables locally.</li><br /> </ul><br /> <br /> ===Common elements===<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when you declare that element as COMMON.</p><br /> <br /> ===ON units===<br /> <p><br /> An ON unit specifies a response action to a triggering event: for example, the terminal operator pressing one of the ATTENTION identifier (AID) keys. ON units let an application override the normal system response.</p><br /> <br /> ==Simple subroutines==<br /> <br /> ===Outlining a simple subroutine===<br /> <p><br /> The following statements are used in simple subroutines within a request:</p><br /> <table><br /> <tr class="head"><br /> <th>Statement</th><br /> <th>Purpose</th></tr><br /> <br /> <tr><br /> <td><var>CALL</var></td><br /> <td>Transfers control to the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>END SUBROUTINE</var></td><br /> <td>Indicates the end of the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>JUMP TO</var></td><br /> <td>Transfers control to another statement in the request.</td></tr><br /> <br /> <tr><br /> <td><var>RETURN</var></td><br /> <td>Returns control to the statement immediately following the CALL statement. </td></tr><br /> <br /> <tr><br /> <td><var>SUBROUTINE</var></td><br /> <td>Indicates the beginning of a subroutine. </td></tr><br /> </table><br /> <p><br /> The statements are coded in the following sequence, so they are described in order of usage.</p><br /> <ol><br /> <li><var>SUBROUTINE</var> statement</li><br /> <li><var>JUMP TO</var> and <var>RETURN</var> statements as appropriate</li><br /> <li><var>END SUBROUTINE</var> statement</li><br /> <li><var>CALL</var> statement</li><br /> </ol><br /> <br /> ===SUBROUTINE statement===<br /> <p><br /> A simple subroutine consists of a sequence of SOUL statements that must begin with a <var>SUBROUTINE</var> statement. The body of the subroutine is composed of the statements immediately following the <var>SUBROUTINE</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>SUBROUTINE</var> statement is: </p><br /> <p class="syntax"><span class="term">label</span>: SUBROUTINE<br /> </p><br /> <p><br /> A simple subroutine must be labeled; without a label it cannot be executed. You cannot use field names in the subroutine, except within a FOR loop, even if the subroutine is always called from within a record loop.</p><br /> <br /> ====Example of a simple subroutine====<br /> <p><br /> The following request uses two subroutines. </p><br /> <p class="note"><b>Note:</b> Simple subroutine statements in the following example are described more fully after this example.</p><br /> <p><br /> The first subroutine, <code>TOTAL</code>, accumulates a total in the %variable named <code>%TOTAL.MUSTANGS</code>. The second subroutine, <code>PRINT.TOTAL</code>, prints a literal that varies depending on the total accumulated. </p><br /> <p class="code">BEGIN<br /> MUSTANGS: FIND ALL RECORDS FOR WHICH<br /> MODEL = MUSTANG<br /> END FIND<br /> FOR EACH RECORD IN MUSTANGS<br /> CALL TOTAL<br /> END FOR<br /> CALL PRINT.TOTAL<br /> TOTAL: SUBROUTINE<br /> %TOTAL.MUSTANGS = %TOTAL.MUSTANGS + 1<br /> RETURN<br /> END SUBROUTINE TOTAL<br /> PRINT.TOTAL: SUBROUTINE<br /> IF %TOTAL.MUSTANGS LE 10 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 10'<br /> ELSEIF %TOTAL.MUSTANGS LE 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 50'<br /> ELSEIF %TOTAL.MUSTANGS GT 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> GREATER THAN 50'<br /> END IF<br /> RETURN<br /> END SUBROUTINE PRINT.TOTAL<br /> END<br /> </p><br /> <br /> ===JUMP TO statements===<br /> <p><br /> <var class="product">Model&nbsp;204</var> compiles subroutines only after they are called, regardless of where they are in your program.</p><br /> <p><br /> If you use a <var>JUMP TO</var> statement, its destination must be within the same subroutine. You cannot jump into a subroutine from outside of a subroutine.</p><br /> <br /> ===RETURN statement===<br /> <p><br /> The <var>RETURN</var> statement returns control from the subroutine to the statement following the most recent <var>CALL</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>RETURN</var> statement is: </p><br /> <p class="syntax">RETURN<br /> </p><br /> <p><br /> The <var>RETURN</var> statement can appear only within the body of a subroutine. Use of the <var>RETURN</var> statement inside of an <var>ON</var> unit terminates compilation, the procedure cannot run, and the following message is produced: </p><br /> <p class="code">M204.1779 RETURN IS INVALID IN ON UNITS, USE BYPASS STATEMENT<br /> </p><br /> <p><br /> <var class="product">Model&nbsp;204</var> automatically generates a return at the end of a subroutine, if you do not specify one. </p><br /> <p><br /> For more information, see [[#ON units|ON units]] and [[#Passing control to and from ON units|Passing control to and from ON units]].</p><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> You can end a subroutine using an <var>END SUBROUTINE</var> statement or an <var>END BLOCK</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The END SUBROUTINE statement is formatted as follows: </p><br /> <p class="syntax">END SUBROUTINE <span class="squareb">[</span><span class="term">label</span><span class="squareb">]</span><br /> </p><br /> <br /> ===CALL statement===<br /> <p><br /> The <var>CALL</var> statement transfers control to the subroutine. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>CALL</var> statement is:</p><br /> <p class="syntax">CALL <span class="term">label</span><br /> </p><br /> <br /> ====Example====<br /> <p><br /> This statement:</p><br /> <p class="code">CALL.SUB: CALL COMPUTE.PREMIUM<br /> </p><br /> <p><br /> transfers control to the following statement:</p><br /> <p class="code">COMPUTE.PREMIUM: SUBROUTINE<br /> </p><br /> <p><br /> When you use a simple subroutine, no arguments are passed in subroutine calls. Instead, input and output values are implicitly passed in %variables or global variables. If you want field values as arguments, you must assign the values to %variables before the call, or the subroutine must contain its own <var>FOR EACH RECORD</var> loop on the set of records to be processed.</p><br /> <p><br /> Processing continues sequentially from that statement until another control transfer statement &mdash; a <var>CALL</var>, <var>IF</var>, <var>JUMP TO</var>, <var>RETURN</var>, or <var>STOP</var> statement &mdash; is encountered. </p><br /> <br /> ==Complex subroutines==<br /> <p><br /> Complex subroutines perform all the operations of a simple subroutine. In addition, a complex subroutine can pass parameters via parameter lists and can declare local variables. </p><br /> <p class="note"><b>Note:</b> The format of the <var>SUBROUTINE</var> statement changes for a complex subroutine and the <var>CALL</var> statement is also more complex.</p><br /> <br /> ===Symbolic parameter passing===<br /> <p><br /> You can specify positional parameters on the <var>CALL</var> statement for a complex subroutine. These parameters are substituted for symbolic parameters used within the subroutine during execution. You can use the following elements as parameters to a complex subroutine:</p><br /> <ul><br /> <li>Scalar %variables</li><br /> <br /> <li>%variable arrays</li><br /> <br /> <li>Lists of records</li><br /> </ul><br /> <br /> ===Local variable declaration===<br /> <p><br /> Labels, %variables, and other elements in a complex subroutine are local to the subroutine; they do not conflict with elements of the same name in the request or in other complex subroutines. This allows the same element to be used in different portions of a request, and for the same name to describe different elements in each portion.</p><br /> <br /> ===Processing===<br /> <p><br /> All data within the subroutine is statically allocated. When the subroutine is called, the values of all found sets, counts, noted values, and variables are as they were when the subroutine was last executed. Recursive calls to the same subroutine do not allocate separate storage for each subroutine local variable. Local variables are allocated only one time.</p><br /> <br /> ====OPEN statement within a complex subroutine====<br /> <p><br /> A SOUL <var>OPEN</var> statement &mdash; an <var>OPEN</var> statement inside a <var>BEGIN/END</var> &mdash; when used within a complex subroutine on a file that is not defined to the region produces the following counting error and the request is not compiled:</p><br /> <p class="code">M204.1521: <i>entity-name</i> DOES NOT EXIST OR REQUESTED ACCESS NOT AUTHORIZED<br /> </p><br /> <br /> ===SUBROUTINE statement for complex subroutines===<br /> <p><br /> Complex subroutines begin with the following form of the <var>SUBROUTINE</var> statement: </p><br /> <p class="syntax">SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">formal-parameter</span> <br /> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span><br /> </p><br /> Where:<br /> <p><br /> <var class="term">subname</var> is the name of the subroutine.</p><br /> <p><br /> <var class="term">formal-parameter</var> is the declaration of a symbolic parameter used within the subroutine. The parameter list is comprised of the <var class="term">formal-parameter</var> and subsequent input-options. The parameter list is enclosed in parentheses, and it contains declarations for each parameter separated by commas. The parameter list must be specified on one logical line. Null parameters are not allowed.</p><br /> <p><br /> <var class="term">formal-parameter</var> specifies the name and type of element to be used within the subroutine and can be any of the following:</p><br /> <ul><br /> <li>Scalar (nonarray) %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] {[STRING] [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] <br /> <span class="squareb">|</span> [FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT]}<br /> </p><br /> <p><br /> For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE (%W IS STRING DP * -<br /> %X IS STRING LEN 40, -<br /> %Y IS STRING LEN 10 DP 2, -<br /> %Z IS FLOAT, -<br /> %A IS FIXED DP 4)<br /> </p></li><br /> <br /> <li>Array %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] [[STRING] [LEN <span class="term">n</span>] [DP {<span class="term">n</span> | *}] <br /> [ARRAY(* [,*[,*]])] [NO FIELD SAVE] <br /> <span class="squareb">|</span> <span class="squareb">{</span>FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT<span class="squareb">}</span> [ARRAY(* [,*[,*]])]]<br /> </p><br /> <p><br /> The number of dimensions must be specified in the subroutine declaration, but the exact size of each dimension is not specified. An asterisk (*) is used instead of the dimension size. For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE(%ARR IS STRING LEN 10 - ARRAY(*,*))<br /> </p></li><br /> <br /> <li>A list of records formatted as:<br /> <p class="syntax">[LIST] <span class="term">listname</span> [IN [FILE | [PERM | TEMP] GROUP]] <span class="term">name</span> <br /> </p><br /> <p><br /> The context of the list is restricted to a single file or group. For example:</p><br /> <p class="code">SUBROUTINE GENERAL(LIST TOTRECS IN FILE VEHICLES)<br /> </p></li><br /> </ul><br /> <p><br /> <var class="term">inout-option</var> specifies whether a formal-parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are as follows:</p><br /> <br /> <table><br /> <tr class="head"><br /> <th>Option</th><br /> <th>Data can be...</th><br /> </tr><br /> <br /> <tr><br /> <td>INPUT<br><br /> (the default)</td><br /> <td>Passed into, but not out of, a subroutine. In addition, data conversions are performed automatically, in the same manner as an assignment statement. All references to <var>INPUT</var> parameters that update the parameter, for example, assignment statements, result in compiler errors.</td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>INPUT OUTPUT</td><br /> <td>This option is equivalent to the OUTPUT option. </td><br /> </tr><br /> <br /> <tr><br /> <td>OUTPUT</td><br /> <td><br /> <p><br /> Returned from a subroutine. No data conversions are performed.</p><br /> <p><br /> The lengths of complex subroutine string OUTPUT parameters are inherited from calling parameters. If the lengths are specified in the subroutine declaration, the following message is written to the audit trail: </p><br /> <p class="code">M204.1981 LENGTH IGNORED FOR OUTPUT PARAMETER<br /> </p><br /> <p><br /> Compilation and evaluation of the procedure continues, with the inherited length.</p><br /> </td><br /> </tr><br /> </table><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> Like simple subroutines, a complex subroutine ends with an <var>END SUBROUTINE</var> statement. However, unlike simple subroutines, you must not label the <var>SUBROUTINE</var> statement. </p><br /> <p><br /> All declarations and statements compiled after the <var>SUBROUTINE</var> statement become a part of the subroutine until the <var>END SUBROUTINE</var> statement is encountered or until the request is ended with the <var>END</var> statement. </p><br /> <br /> ===CALL statement===<br /> <p><br /> The execution of a <var>CALL</var> statement passes control to a complex subroutine. The first time a subroutine is called, all elements in the subroutine are initialized. Subsequently, each time the subroutine is called, all elements in the subroutine remain in the same state as they were when the subroutine was last exited. You are responsible for reinitializing the elements within the subroutine.</p><br /> <br /> ====Syntax====<br /> <p><br /> A complex subroutine is invoked with this form of the <var>CALL</var> statement:</p><br /> <p class="syntax">CALL <span class="term">subname</span> [(<span class="term">actual-parameter</span> [, ...])]<br /> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">actual-parameter</var> specifies the actual data that replaces the symbolic formal-parameter within the subroutine. At execution time, the value of each actual-parameter is substituted, based on the order in which it appears, for a formal-parameter declared for the subroutine. The correspondence of each formal-parameter in the <var>SUBROUTINE</var> statement to an actual-parameter in the <var>CALL</var> statement is by position rather than by name.<br /> <p><br /> An actual-parameter can be any of the following:</p><br /> <ul><br /> <li>%variable or expression<br /> <p><br /> Expressions can contain field names, screen items, image items, and constants.</p></li><br /> <br /> <li>Array %variable<br /> <p><br /> When an entire array is passed as a parameter, the %variable name is used with the percent (%) sign, but no parenthesis or subscript expressions follow it. For example:</p><br /> <p class="code">BEGIN<br /> %A IS FLOAT ARRAY(10,10)<br /> DECLARE SUBROUTINE FDO(FLOAT ARRAY(*,*))<br /> .<br /> .<br /> .<br /> CALL FDO (%A)<br /> .<br /> .<br /> .<br /> SUBROUTINE FDO (%B IS FLOAT ARRAY(*,*))<br /> PRINT %B(1,1)<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> The <var>[[$ArrSize]]</var> function can be used to determine the number of elements in a particular dimension of an array. </p></li><br /> <br /> <li>A list<br /> <p><br /> An actual-parameter can be a list, optionally preceded by the word LIST to distinguish it from a field name. </p><br /> <p><br /> If the compiler already knows of the formal-parameter list because the subroutine is already compiled or declared, the LIST keyword is unnecessary. </p><br /> <p><br /> If the list has never been declared in the request, a compilation error results. </p><br /> </li></ul><br /> </li></ul><br /> <br /> ====Additional rules for parameters====<br /> <p><br /> The following additional rules apply to actual-parameters and parameter passing:</p><br /> <ul><br /> <li>The maximum number of parameters that can be passed in complex subroutines is 63.</li><br /> <br /> <li>If the formal-parameter is specified as an OUTPUT parameter, the corresponding actual-parameter must match type.</li><br /> <br /> <li>The INPUT parameters of a %variable array requires that the type of the array &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; the <var>DP</var> specification, and the number of dimensions match the actual-parameter. In addition, if the <var>NO FIELD SAVE</var> (<var>NO FS</var>) option is specified for a <var>STRING</var> formal-parameter, it also must be specified for the corresponding actual-parameter and vice versa. All checking of array bounds within subroutines occurs during evaluation.</li><br /> <br /> <li>The INPUT parameters of a list requires the same file or group context as the actual-parameter.<br /> </li><br /> <br /> <li>An INPUT parameter of a scalar %variable can be called with an actual-parameter that is an expression or %variable of a differing type. <var class="product">Model&nbsp;204</var> converts the actual-parameter to the type required by the subroutine, according to the rules of the assignment statement. The converted value has a separate storage location from the original variable or expression.<br /> <p><br /> Passing arguments to INPUT parameters might involve truncation where the number of decimal places is different, or conversion to 0 for non-numeric strings.</p><br /> </li><br /> <br /> <li>OUTPUT parameters of lists and %variable arrays follow the same rules as INPUT parameters for lists and %variable arrays.</li><br /> </li><br /> <br /> <li>OUTPUT parameters of scalar %variables require that the actual-parameter supplied in the <var>CALL</var> statement be another scalar %variable (no constants or expressions) of the same type &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; and that the number of decimal places be the same, or the following message is issued by <var class="product">Model&nbsp;204</var>:<br /> <p class="code">M204.1725 PARAMETER NUMBER <i>n</i> IS TYPE INCOMPATIBLE<br /> </p><br /> <p><br /> Strings can be of any length. The length used is that of the actual input parameter. </p><br /> </li><br /> </ul><br /> <br /> ===Processing complex subroutines===<br /> <p><br /> Checking for the validity of parameter lists occurs during compilation. When the SUBROUTINE statement is compiled, the types of parameters are saved by the compiler, and any subsequent CALL statements are verified as to whether the actual parameter is consistent with the type of formal parameter.</p><br /> <p><br /> When a CALL statement is compiled and the subroutine to which it refers has not been compiled, the compiler verifies whether the actual parameter list is compatible with other CALL statements for the subroutine that it has already compiled. </p><br /> <p><br /> The compiler cannot verify that the actual parameters are compatible with the SUBROUTINE statement until that SUBROUTINE statement is compiled. If the compiler then detects a CALL statement that is not compatible with the SUBROUTINE statement, an error is issued at that time. Checking is done at compile time, so a statement that is not executed during evaluation can still generate an error. </p><br /> <br /> ===DECLARE SUBROUTINE statement===<br /> <p><br /> The DECLARE statement for a complex subroutine is similar to the SUBROUTINE statement, except that the parameter names are omitted. </p><br /> <br /> ====Syntax====<br /> The complete syntax for the DECLARE SUBROUTINE statement is:<br /> <p class="syntax">DECLARE SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">type</span> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">type</var> is one of the following:<br /> <ul><br /> <li>Scalar %variable of the following format:<br /> <p class="syntax">{STRING [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] | [FIXED [DP <span class="term">n</span>] | FLOAT]}<br /> </p></li><br /> <br /> <li>Array %variable of the following format:<br /> <p class="syntax">{STRING [LEN <span class="term">n</span>] [DP [<span class="term">n</span> | *}] [ARRAY(* [,*[,*]]) [NO FIELD SAVE]]<br /> | [FIXED [DP <span class="term">n</span>] | FLOAT] [ARRAY(* [,*[,*]])]}<br /> </p></li><br /> <br /> <li>A list of records of the following format:<br /> <p class="code">[LIST] [IN {FILE | [PERM | TEMP] GROUP} <span class="term">name</span>]<br /> </p></li><br /> </ul></li><br /> <br /> <li><br /> <var class="term">inout-option</var> specifies whether each formal parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are the same as those that can be specified on the SUBROUTINE statement: INPUT, OUTPUT, or INPUT OUTPUT. </li><br /> </ul><br /> <br /> ====DECLARE before CALL====<br /> When a <var>CALL</var> statement refers to a subroutine that has not yet been compiled, the error checking capabilities of the compiler are limited, because the number and type of formal parameters are not known to the compiler. If the first <var>CALL</var> statement for a particular subroutine is not correctly coded, then a large number of error messages can be generated when compiling subsequent <var>CALL</var> statements, although these statements might be correctly coded.<br /> <br /> You can avoid this problem in one of the following ways:<br /> <ul><br /> <li>Declare the formal parameter list with the <var>DECLARE</var> statement. When the <var>DECLARE</var> statement precedes the first <var>CALL</var>, the compiler generates the correct error messages, if problems are encountered. </li><br /> <br /> <li>Place the subroutine before the first <var>CALL</var> statement.</li><br /> </ul><br /> <br /> ====Specifying a list of records====<br /> <p><br /> If you specify a <var>LIST</var> (of records), you must also specify <var>FILE</var> or <var>GROUP</var>. For example:</p><br /> <p class="code">OPEN METADATA<br /> password<br /> <br /> BEGIN<br /> DECLARE LIST ORIG IN METADATA<br /> DECLARE SUBROUTINE THE.SUB(LIST IN FILE METADATA INOUT)<br /> .<br /> .<br /> CALL THE.SUB (LIST ORIG)<br /> .<br /> .<br /> SUBROUTINE THE.SUB(LIST ORIG IN METADATA INOUT)<br /> .<br /> .<br /> END SUBROUTINE THE.SUB<br /> END<br /> </p><br /> <p><br /> If you do not specify <var>FILE</var> or <var>GROUP</var> in the code, you receive the following error message:</p><br /> <p class="code">M204.1725: PARAMETER NUMBER n IS TYPE INCOMPATIBLE<br /> </p><br /> <br /> ====DECLARE parameters and CALL parameters====<br /> <p><br /> In the following example, note that the <var>DECLARE</var> statement lists the formal parameters, while the <var>CALL</var> statement lists the actual parameters:</p><br /> <p class="code">DECLARE SUBROUTINE SUB1(FLOAT, FIXED DP 2, STRING, STRING DP *)<br /> .<br /> .<br /> CALL SUB1(%INCREASE,%WAGES,%NAME,%DEPT)<br /> .<br /> .<br /> SUBROUTINE SUB1(%A IS FLOAT,<br /> %B IS FIXED DP 2,<br /> %C IS STRING,<br /> %D IS STRING DP *)<br /> END SUBROUTINE<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Impact on CALL and SUBROUTINE statements====<br /> <p><br /> The <var>CALL</var> and <var>SUBROUTINE</var> statements are not overridden when a <var>DECLARE SUBROUTINE</var> statement is present. The <var>DECLARE SUBROUTINE</var> statement does not cause the compiler to use more table space, nor does it alter the way in which the compiler output is generated.</p><br /> <p><br /> Rocket Software recommends that you use a <var>DECLARE SUBROUTINE</var> statement before the <var>CALL</var> statement for a subroutine or that you place the subroutine itself before the <var>CALL</var> statement. Error reporting will be more complete and specific to the subroutine.</p><br /> <br /> ===Exiting the subroutine===<br /> <p><br /> The <var>RETURN</var> statement returns control to the statement immediately following the most recent <var>CALL</var> statement. If an <var>END SUBROUTINE</var> or <var>END</var> statement is encountered without a <var>RETURN</var> statement, <var>RETURN</var> processing is implied and automatically added by the compiler. More than one <var>RETURN</var> statement can be specified in a subroutine.</p><br /> <p><br /> If a <var>JUMP</var> statement is used within a subroutine, its destination must be within the same subroutine. You cannot jump into a subroutine. </p><br /> <p><br /> A <var>STOP</var> statement, when executed inside a subroutine, terminates the request in the same manner as it does when executed outside a subroutine. </p><br /> <br /> ===Examples using complex subroutines===<br /> <p><br /> In the following example, an employee name with regular and overtime hours is passed to the subroutine <code>CALC.WAGES</code>. The total pay is returned and a list of records processed by the routine is updated.</p><br /> <p class="code">BEGIN<br /> DECLARE SUBROUTINE CALC.WAGES(FIXED DP 2, -<br /> FIXED DP 2, STRING, FIXED DP 2 OUTPUT, -<br /> LIST IN FILE EMPLOYEE INOUT)<br /> .<br /> .<br /> .<br /> CALL CALC.WAGES(%R.HRS, %OT.HRS, %NAME, -<br /> %TOTAL.PAY, LIST EMPLST)<br /> .<br /> .<br /> .<br /> SUBROUTINE CALC.WAGES(%REG IS FIXED DP 2, -<br /> %OT IS FIXED DP 2, -<br /> %E.NAME IS STRING, -<br /> %TOTAL IS FIXED DP 2 OUTPUT, -<br /> LIST EMPLIST IN FILE EMPLOYEE INOUT)<br /> <br /> %TEMP IS FIXED DP 2<br /> <br /> WAGES1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> NAME = %E.NAME<br /> END FIND<br /> FOR EACH RECORD IN WAGES1<br /> %TEMP = (RATE * %REG)<br /> %TOTAL = %TEMP + (RATE * 1.5 * %OT)<br /> END FOR<br /> PLACE RECORDS IN WAGES1 ON LIST EMPLIST<br /> RETURN<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the following example, an entire array is passed as a single subroutine parameter:</p><br /> <p class="code">BEGIN<br /> %NUMBERS IS FLOAT ARRAY(10,10)<br /> %MAX IS FLOAT<br /> DECLARE SUBROUTINE MAXIMUM(FLOAT ARRAY(*,*), -<br /> FLOAT OUTPUT)<br /> .<br /> .<br /> .<br /> CALL MAXIMUM(%NUMBERS,%MAX)<br /> .<br /> .<br /> .<br /> <br /> SUBROUTINE MAXIMUM(%ARR IS FLOAT ARRAY(*,*), -<br /> %M IS FLOAT OUTPUT)<br /> %I IS FIXED<br /> %J IS FIXED<br /> %M = 0<br /> FOR %I FROM 1 TO $arrsize('%ARR',1)<br /> FOR %J FROM 1 TO $arrsize('%ARR',2)<br /> IF %ARR(%I,%J) GT %M THEN<br /> %M = %ARR(%I,%J)<br /> END IF<br /> END FOR<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ==Sharing common elements==<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when it is declared as a common element. A common element is created by using the DECLARE statement or by using the COMMON keyword on a %variable IS declaration. For an element to be shared, it must be declared as common in every place (each separate scope) in which it is used. </p><br /> <br /> ===Scope of elements===<br /> <p><br /> The scope of an element refers to the area within a request in which an element has a particular meaning. In User Language, complex subroutines have a different scope than the remainder of the request (the elements of a complex subroutine differ from the elements outside the subroutine even when they have the same name). This concept applies to labels, lists, %variables and %variable arrays, menus, screens, and images.</p><br /> <p><br /> The elements of the main request (the statements not enclosed by any SUBROUTINE/END SUBROUTINE statements) and the elements of all simple subroutines share the same scope. Simple subroutines share the same elements with the main request and all other simple subroutines within the request. </p><br /> <br /> ===Shareable elements===<br /> <p><br /> The following elements can be shared if they are declared as common:</p><br /> <br /> ====%variables and %variable arrays====<br /> <p><br /> You can share %variables if a DECLARE %variable or a %variable IS statement that declares the %variable as common is present in each portion of the request where you use the %variable. The %variable must have the same type, length, number of decimal places, and FIELD SAVE option in each declaration. </p><br /> <br /> ====Lists of records====<br /> <p><br /> You can share a list if a DECLARE statement that declares the list as common is contained in each place where you use the list. The declaration of the list must precede the first reference to that list, or <var class="product">Model&nbsp;204</var> declares the list implicitly without the common attribute.</p><br /> <br /> ====Found sets====<br /> <p><br /> You can share found sets if the label of the FIND statement is declared as common. To effectively share a found set, follow these steps:</p><br /> <ol><br /> <li>Add a DECLARE statement that declares the statement label as common before the actual label in the portion of the request where the FIND statement will be executed.</li><br /> <li>Add a DECLARE statement that declares the label as common to any parts of the request that require access to that found set. These parts, however, cannot contain a label with the same name, or a compiler error occurs. </li><br /> </ol><br /> <p><br /> After execution of the FIND statement, you can access the record set in any portion of the request that contains the proper DECLARE statement. </p><br /> <br /> ====Menus and screens====<br /> <p><br /> You can share a menu or screen as common under the following conditions: </p><br /> <ul><br /> <li>The first reference to the menu or screen must be the complete definition of the menu or screen, with the COMMON keyword following the MENU or SCREEN statement.</li><br /> </li><br /> <li>Other parts of the request can reference the same menu or screen by using an abbreviated declaration of the form:</li><br /> <p class="code">DECLARE [MENU menuname | SCREEN screenname] COMMON<br /> </p><br /> <p><br /> If the complete definition of the menu or screen exists, and if that definition was declared as common, the menu or screen is shared. If not, a compiler error results. Two or more complete menu or screen definitions with the COMMON keyword also result in a compiler error.</p><br /> <p><br /> If you use a menu or screen %variable (:%variable) within a complex subroutine to refer to a COMMON screen element, you must include a common declaration for each possible value of the menu or screen name. </p><br /> </li><br /> </ul><br /> <br /> ====Images====<br /> <p><br /> The sharing of images follows the same rules used for the sharing of menus and screens. If multiple images are contained within the same block, then the following rules also apply:</p><br /> <ul><br /> <li>You can use the COMMON keyword on only the first IMAGE statement of a block. All other images within the same block are automatically considered as candidates for sharing as common data.</li><br /> </li><br /> <br /> <li>All other parts of the request that access common images must contain the following abbreviated form of the DECLARE statement for each image to which access is required: </li><br /> <p class="code">DECLARE IMAGE imagename COMMON<br /> </p></li><br /> </ul><br /> <br /> <br /> ===DECLARE statement===<br /> <p><br /> You can use the DECLARE statement to perform the following functions: </p><br /> <ul><br /> <li>Specify subroutine formal parameter types.</li><br /> </li><br /> <br /> <li>Specify variables, labels, lists, menus, screens, and images as COMMON.</li><br /> </li><br /> </ul><br /> <p><br /> Menus and screens are discussed in detail in [[Full-screen feature]]. </p><br /> <p><br /> Images are discussed in detail in [[Images]].</p><br /> <br /> <ul><br /> <li>To declare lists without having to use an <code>IN filename CLEAR LIST listname</code> clause. See [[Lists#Creating and clearing a list|Creating and clearing a list]].</li><br /> <br /> <li>To declare %variables, see [[Using variables and values in computation]]. </li><br /> </ul><br /> <br /> ====Syntax====<br /> <p><br /> The format of the DECLARE statement is as follows:</p><br /> <p class="syntax">DECLARE <span class="term">declaration</span><br /> </p><br /> <p><br /> where <span class="term">declaration</span> is one of the following:</p><br /> <p class="syntax">LABEL <span class="term">label</span> COMMON<br /> <br /> [LIST] <span class="term">listname</span> [IN [FILE [PERM | TEMP] GROUP] <span class="term">name</span>]<br /> [COMMON]<br /> <br /> IMAGE <span class="term">imagename</span> COMMON<br /> <br /> MENU <span class="term">menuname</span> COMMON<br /> <br /> SCREEN <span class="term">screenname</span> COMMON<br /> <br /> <span class="term">%variable</span> [IS] {FIXED [DP <span class="term">n</span>] | FLOAT}<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [COMMON]<br /> <br /> <span class="term">%variable</span> [IS] STRING [LEN <span class="term">n</span>] [DP {<span class="term">dn1</span> | *}]<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [NO FIELD SAVE] [COMMON]<br /> <br /> SUBROUTINE <span class="term">subname</span>[(<span class="term">type</span> [<span class="term">inout-option</span>] [,...]) ]<br /> </p><br /> <br /> ====Example====<br /> <p><br /> For example, the DECLARE statement declares the list RECNAMES in the following request:</p><br /> <p class="code">BEGIN<br /> DECLARE LIST RECNAMES<br /> DECLARE SUBROUTINE REGION(LIST OUTPUT, STRING)<br /> .<br /> .<br /> .<br /> CALL REGION(LIST RECNAMES, 'NORTHEAST')<br /> .<br /> .<br /> .<br /> SUBROUTINE REGION(LIST RGNLST OUTPUT, -<br /> %REGION IS STRING)<br /> <br /> R1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> REGION = %REGION<br /> R2: PLACE RECORDS IN R1 ON LIST RGNLIST<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ===Defining common variables===<br /> <p><br /> You can define common variables at the beginning of all programs without later redefinitions. The syntax lets you use the %VAR IS COMMON clause without duplicating the previous attributes.</p><br /> <p><br /> However, if attributes, such as STRING or LEN, are included in the redefinition, which differ from those previously defined, a compilation error occurs. In addition, if the variable is not previously defined, it is allocated based on the current default variable definition. </p><br /> <p><br /> For example, </p><br /> <p class="code">BEGIN<br /> VARIABLES ARE STRING LEN 20 <br /> %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON <br /> SUBROUTINE A<br /> * full definition on next line no longer required<br /> ** %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON<br /> * new syntax on next line replaces previous line<br /> %X IS COMMON /? defaults to previous %X definition ?/<br /> CALL B<br /> END SUBROUTINE<br /> <br /> SUBROUTINE B<br /> * But next line will fail compile since %X already exists<br /> %X IS STRING LEN 4 COMMON /? compiler error ?/<br /> * And the next line will result in a default definition<br /> * since %Y is not previously defined.<br /> %Y IS COMMON<br /> END SUBROUTINE<br /> PRINT %X<br /> CALL A<br /> END<br /> </p><br /> <br /> ===Shared common element examples===<br /> <p><br /> The following examples illustrate the differences between data that is locally scoped and data that is shared using the COMMON keyword. </p><br /> <br /> ====Example 1====<br /> <p><br /> In this example, the variable %I assumes different values depending upon which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> %I IS FIXED<br /> DECLARE SUBROUTINE SUBR1(STRING)<br /> .<br /> .<br /> .<br /> FOR %I FROM 1 TO 10<br /> CALL SUBR1(%ARR(%I))<br /> END FOR<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%A IS STRING)<br /> %I IS FIXED<br /> FOR %I FROM 1 TO 10<br /> PRINT %I and %A<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ====Example 2====<br /> <p><br /> In this example, the screen EXAMPLE and the %A and %B variables retain the same values no matter which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> SCREEN EXAMDEF COMMON<br /> TITLE 'THIS IS A COMMON SCREEN DEFINITION'<br /> PROMPT 'ENTER VALUE'<br /> INPUT FLD1 AT 10 LEN 20 PAD '_'<br /> END SCREEN<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> DECLARE SUBROUTINE SUBR1(STRING LEN 10)<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%Z IS STRING LEN 10)<br /> DECLARE SCREEN EXAMDEF COMMON<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> .<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Example 3====<br /> <p><br /> In this example, the main request and the subroutine share the common data of an array and a found set:</p><br /> <p class="code">BEGIN<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> DECLARE SUBROUTINE EXAMPLE<br /> .<br /> .<br /> .<br /> ALL.RECS: FIND ALL RECORDS<br /> END FIND<br /> %I = 0<br /> %J = 1<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD<br /> END FOR<br /> CALL EXAMPLE<br /> STOP<br /> <br /> SUBROUTINE EXAMPLE<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> %I = 0<br /> %J = 2<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD2<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the preceding example, the main request updates column 1 of the array %COMM.ARRAY with the contents of FLD. The subroutine, EXAMPLE, updates column 2 of the same array with the contents of FLD2. Both the array %COM.ARRAY and the found set ALL.RECS are shared by using the COMMON keyword. %I and %J are both local variables. %I is local because it was declared without the COMMON keyword; %J is local because it was not declared at all. </p><br /> <br /> <div id="On statement"></div> <br /> <br /> ==On units== <br /> <p><br /> An <var>On</var> unit lets you specify a course of action following a triggering event, such as the terminal operator pressing one of the <var>Attention</var> identifier (AID) keys. The <var>On</var> unit provides an application with a way to override the normal system response. </p><br /> <br /> ====Syntax====<br /> <p><br /> To define an <var>On</var> unit, use an <var>On</var> block in the following format:</p><br /> <p class="syntax">[<span class="term">label</span>] On <span class="term">unittype</span><br /> <span class="term">statement</span><br /> <span class="literal">...</span><br /> End On<br /> </p><br /> <p><br /> where <var class="term">unittype</var> is one of the following:</p><br /> <table><br /> <tr class="head"><br /> <th>unittype</th><br /> <th>You can specify the course of action to take if...</th><br /> </tr><br /> <br /> <tr><br /> <td>ATTENTION</td><br /> <td>The end user invokes the attention feature (for example, presses the <var>BREAK, ATTN,</var> or <var>PA1</var> key, or enters <var>*CANCEL</var>). </td><br /> </tr><br /> <br /> <tr><br /> <td>ERROR</td><br /> <td><var class="product">Model&nbsp;204</var> cancels a request. Before a request is canceled or, for transaction backout files, after the current transaction is backed out, the ON ERROR unit is processed instead of returning control to the terminal command level. For more information on transaction backout files, see [[Data recovery]]. </td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>FIELD CONSTRAINT<br /> CONFLICT (FCC)</td><br /> <td>There are field level constraint conflicts. Violating the UNIQUE and AT-MOST-ONE attributes causes field-level conflicts.*</td><br /> </tr><br /> <br /> <tr><br /> <td>FIND CONFLICT</td><br /> <td>A conflict arises evaluating a FIND statement or a FOR EACH RECORD statement used for retrieval.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING FILE</td><br /> <td>A remote file is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING MEMBER</td><br /> <td>A remote optional member is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>RECORD LOCKING CONFLICT</td><br /> <td>A conflict arises during a record locking attempt.</td><br /> </tr><br /> </table><br /> <p><br /> *If you have procedures written for <var class="product">Model&nbsp;204</var> V2R1.0 that use ON FCC for UNIQUE fields, and you are planning to use ON FCC for AT-MOST-ONE fields, you might need to rewrite the ON FCC unit to take the new value of $UPDSTAT (2 for AT-MOST-ONE) into account. </p><br /> <p><br /> Several $functions provide information about conflicts. They are:</p><br /> <table><br /> <tr><br /> <td>[[$UpdFile]]</td><br /> <td>[[$UpdFld]]</td><br /> <td>[[$UpdOval]]</td><br /> <td>[[$UpdRec]]</td><br /> </tr><br /> <tr><br /> <td>[[$UpdStat]]</td><br /> <td>[[$UpdStmt]]</td><br /> <td>[[$UpdVal]]</td><br /> <td>[[$UnqRec]]</td><br /> </tr><br /> </table><br /> <br /> ===Body of an ON unit===<br /> <p><br /> The body of the ON unit consists of statements immediately following the ON statement. Any User Language statement can appear within an ON unit except the SUBROUTINE statement.</p><br /> <br /> ===Ending an ON unit===<br /> <p><br /> You must conclude an ON unit with either an END ON statement or an END BLOCK statement. The format of the END ON statement is as follows:</p><br /> <p class="syntax">END ON [<span class="term">label</span>]<br /> </p><br /> <p><br /> where <var class="term">label</var> is the label of the statement that began the ON statement. </p><br /> <br /> ===Processing an ON unit===<br /> <p><br /> When an ON statement is evaluated, <var class="product">Model&nbsp;204</var> remembers the location of the ON unit body (the statement after the ON statement and within the unit), but does not immediately evaluate the body. Instead, it passes control to the statement immediately following the ON unit. The ON unit body is evaluated only when the triggering event takes place.</p><br /> <br /> ===Usage guidelines for ON units===<br /> <p><br /> Note the following considerations when using ON units:</p><br /> <ul><br /> <li>You must define the ON unit before it is invoked (that is, you should typically place the ON unit near the beginning of your procedure). </li><br /> <br /> <li>A subsequent definition of an ON unit of the same kind replaces the previous one. For example, if you define two ON ATTN units, the second one becomes the current one.</li><br /> <br /> <li>You can jump to destinations within the same ON unit. </li><br /> <br /> <li>You can jump out of an ON unit only to unnested, labeled statements.</li><br /> <br /> <li>You cannot jump into an ON unit.</li><br /> <br /> <li>You can jump outside of an ON unit only if the ON unit is part of a main routine or part of a complex subroutine. </li><br /> <br /> <li>You cannot jump out of an ON unit contained in a simple subroutine, regardless of whether the destination is within the subroutine or back in the mainline program, because ON units are part of the mainline program; hence, there is no scoping of ON units. This restriction ensures that the ON unit is executed and the control returned to the main routine.</li><br /> <br /> <li>An ON unit definition is not preserved when a request is continued with an END MORE statement and a MORE command. Each new request continuation must define its own ON units. (See [[Large request considerations#Rules for request continuation|Rules for request continuation]].)</li><br /> <br /> <li>For complex subroutines, an active ON unit is temporarily disabled when a subroutine is called that contains an ON UNIT of the same type; it is restored when the subroutine returns. Any ON unit enabled during the execution of a subroutine is replaced by the active ON unit at the time of the last CALL statement as soon as the RETURN statement is evaluated.</li><br /> <br /> <li>ON units coded inside complex subroutines can contain JUMP statements that specify a destination outside the ON unit. The destination must be to an unnested labeled statement within the complex subroutine. Also, if the ON unit is to be jumped out of, the condition that causes the ON unit to be invoked must be raised in the subroutine that contains the ON unit.<br /> <p><br /> This prevents a lower level subroutine from returning inadvertently by raising a condition for which there is an ON unit coded in a higher level subroutine. If the inadvertent return is attempted, the request is canceled. </p><br /> </li><br /> <br /> <li>ON units do not have their own local data and labels. They inherit the scope of the part of the program in which they are compiled. An ON unit that is compiled within a complex subroutine is considered part of only that subroutine. <br /> </li><br /> </ul><br /> <br /> ====Example====<br /> <p><br /> In the following example, if the user presses the<var> ATTN</var> key instead of entering a response to the prompt in the GET.REC.TYPE statement, the ON ATTENTION unit sets %FLAG to 1. The FLAG.SET statement tests %FLAG. If %FLAG is set, the request branches to END.REQUEST and the FIND statement is not executed. </p><br /> <p class="code">%FLAG=0<br /> ON ATTENTION<br /> %FLAG=1<br /> BYPASS<br /> END ON<br /> GET.REC.TYPE: %TYPE=$READ('ENTER RECORD TYPE')<br /> FLAG.SET: IF %FLAG=1 THEN<br /> JUMP TO END.REQUEST<br /> END IF<br /> FIND.RECS: FIND ALL RECORDS FOR WHICH<br /> TYPE = %TYPE<br /> END FIND<br /> .<br /> .<br /> .<br /> END.REQUEST:<br /> END<br /> </p><br /> <br /> ===Only one ON unit at a time===<br /> <p><br /> Only one ON unit of each kind is active at a time. For example, the processing of a second ON ERROR statement resets the current ON ERROR unit, but does not affect the current ON ATTENTION unit. Thus, you can redefine what to do in a variety of cases by having several ON statements and units within a request. An ON unit can be redefined within another ON unit.</p><br /> <br /> ===Passing control to and from ON units===<br /> <p><br /> <var class="product">Model&nbsp;204</var> passes control to an ON unit when the triggering event occurs. For example, an ON ATTENTION unit receives control when a user presses one of the ATTENTION identifier (AID) keys at the terminal during the execution of a request. Use one of the following statements to return control to the body of the request. </p><br /> <br /> ====BYPASS statement====<br /> <p><br /> The BYPASS statement handles the various unittypes of an ON statement as follows:</p><br /> <table><br /> <tr class="head"><br /> <th>For unittype...</th><br /> <th>The BYPASS statement...</th><br /> </tr><br /> <tr><br /> <td>ON MISSING FILE<br><br /> ON MISSING MEMBER</td><br /> <td>Returns control to the statement immediately after the END FOR statement that closes the current FOR loop. </td><br /> </tr><br /> <tr><br /> <td>ON ERROR</td><br /> <td>Ends the request.</td><br /> </tr><br /> <tr><br /> <td nowrap>ON ATTENTION<br><br /> ON FIND CONFLICT<br><br /> ON RECORD LOCKING CONFLICT</td><br /> <td>Returns control to the statement immediately after the statement that invoked the ON unit.</td><br /> </tr><br /> </table><br /> <p><br /> The format of the BYPASS statement is as follows:</p><br /> <p class="syntax">BYPASS [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the PENDING STATEMENT keyword is optional. If the ON unit is not ended with a BYPASS statement, <var class="product">Model&nbsp;204</var> automatically generates a STOP statement at the end of the unit. </p><br /> <br /> ====CONTINUE statement====<br /> <p><br /> The CONTINUE statement is supported only with the Parallel Query Option. If you lose access to a group member that is an optional file during FOR processing, the CONTINUE statement continues FOR processing with the next available file, and skips any other unavailable files.</p><br /> <br /> ====JUMP TO statement====<br /> <p><br /> The JUMP statement, when used to jump to a labeled statement outside the ON unit, causes the request to continue at that point. There are restrictions pertaining to jumps; see [[Flow of control in User Language#Branching statements|Branching statements]] and [[#Simple subroutines|Simple subroutines]]. </p><br /> <br /> ====RETRY statement====<br /> <p><br /> The RETRY statement passes control to the statement that invoked the ON unit, thereby retrying that statement. The RETRY statement is not valid in an ON ERROR unit.</p><br /> <p><br /> The format of the RETRY statement is as follows:</p><br /> <p class="syntax">RETRY [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the <var>PENDING STATEMENT</var> keyword is optional.</p><br /> <br /> ====STOP statement====<br /> <p><br /> The STOP statement is used to end the request. </p><br /> <br /> ===Clearing ON units===<br /> <p><br /> You can issue the following statement to clear the definition of an ON unit: </p><br /> <p class="syntax">CLEAR ON <span class="term">unittype</span><br /> </p><br /> <p><br /> This statement clears any defined ON unit of the type specified. Clearing an ON unit produces the following results:</p><br /> <br /> <ul><br /> <li>After a CLEAR ON ATTENTION, pressing one of the ATTENTION identifier (AID) keys at the terminal does not invoke the ON ATTENTION unit.</li><br /> <br /> <li>After a CLEAR ON ERROR, a request cancellation error does not invoke the ON ERROR unit. </li><br /> </ul><br /> <p><br /> An ON unit can be defined, cleared, and then redefined. </p><br /> <br /> ===Pausing during the request===<br /> <p><br /> The PAUSE statement can be used with ON units to cause the request to wait a specified time and then to retry the statement that caused the evaluation of the ON unit. PAUSE is typically used with the other ON unit types (RECORD LOCKING CONFLICT and ON FIND CONFLICT) and is discussed in [[Record level locking and concurrency control]]. </p><br /> <br /> </div> <br /> <br /> [[Category:SOUL]]</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Subroutines&diff=78431 Subroutines 2015-07-23T03:44:45Z

<p>Heikki: /* Defining common variables */</p> <hr /> <div><div class="toclimit-3"><br /> <br /> ==Overview==<br /> <p><br /> User Language lets you treat a single set of statements as a simple or complex subroutine. You can:</p><br /> <ul><br /> <li>Execute simple subroutines a number of times from different locations within a request.</li><br /> <li>Use complex subroutines as you would simple subroutines. </li><br /> </ul><br /> In addition, you can:<br /> <ul><br /> <li>Pass parameters via parameter lists.</li><br /> <li>Declare variables locally.</li><br /> </ul><br /> <br /> ===Common elements===<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when you declare that element as COMMON.</p><br /> <br /> ===ON units===<br /> <p><br /> An ON unit specifies a response action to a triggering event: for example, the terminal operator pressing one of the ATTENTION identifier (AID) keys. ON units let an application override the normal system response.</p><br /> <br /> ==Simple subroutines==<br /> <br /> ===Outlining a simple subroutine===<br /> <p><br /> The following statements are used in simple subroutines within a request:</p><br /> <table><br /> <tr class="head"><br /> <th>Statement</th><br /> <th>Purpose</th></tr><br /> <br /> <tr><br /> <td><var>CALL</var></td><br /> <td>Transfers control to the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>END SUBROUTINE</var></td><br /> <td>Indicates the end of the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>JUMP TO</var></td><br /> <td>Transfers control to another statement in the request.</td></tr><br /> <br /> <tr><br /> <td><var>RETURN</var></td><br /> <td>Returns control to the statement immediately following the CALL statement. </td></tr><br /> <br /> <tr><br /> <td><var>SUBROUTINE</var></td><br /> <td>Indicates the beginning of a subroutine. </td></tr><br /> </table><br /> <p><br /> The statements are coded in the following sequence, so they are described in order of usage.</p><br /> <ol><br /> <li><var>SUBROUTINE</var> statement</li><br /> <li><var>JUMP TO</var> and <var>RETURN</var> statements as appropriate</li><br /> <li><var>END SUBROUTINE</var> statement</li><br /> <li><var>CALL</var> statement</li><br /> </ol><br /> <br /> ===SUBROUTINE statement===<br /> <p><br /> A simple subroutine consists of a sequence of SOUL statements that must begin with a <var>SUBROUTINE</var> statement. The body of the subroutine is composed of the statements immediately following the <var>SUBROUTINE</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>SUBROUTINE</var> statement is: </p><br /> <p class="syntax"><span class="term">label</span>: SUBROUTINE<br /> </p><br /> <p><br /> A simple subroutine must be labeled; without a label it cannot be executed. You cannot use field names in the subroutine, except within a FOR loop, even if the subroutine is always called from within a record loop.</p><br /> <br /> ====Example of a simple subroutine====<br /> <p><br /> The following request uses two subroutines. </p><br /> <p class="note"><b>Note:</b> Simple subroutine statements in the following example are described more fully after this example.</p><br /> <p><br /> The first subroutine, <code>TOTAL</code>, accumulates a total in the %variable named <code>%TOTAL.MUSTANGS</code>. The second subroutine, <code>PRINT.TOTAL</code>, prints a literal that varies depending on the total accumulated. </p><br /> <p class="code">BEGIN<br /> MUSTANGS: FIND ALL RECORDS FOR WHICH<br /> MODEL = MUSTANG<br /> END FIND<br /> FOR EACH RECORD IN MUSTANGS<br /> CALL TOTAL<br /> END FOR<br /> CALL PRINT.TOTAL<br /> TOTAL: SUBROUTINE<br /> %TOTAL.MUSTANGS = %TOTAL.MUSTANGS + 1<br /> RETURN<br /> END SUBROUTINE TOTAL<br /> PRINT.TOTAL: SUBROUTINE<br /> IF %TOTAL.MUSTANGS LE 10 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 10'<br /> ELSEIF %TOTAL.MUSTANGS LE 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 50'<br /> ELSEIF %TOTAL.MUSTANGS GT 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> GREATER THAN 50'<br /> END IF<br /> RETURN<br /> END SUBROUTINE PRINT.TOTAL<br /> END<br /> </p><br /> <br /> ===JUMP TO statements===<br /> <p><br /> <var class="product">Model&nbsp;204</var> compiles subroutines only after they are called, regardless of where they are in your program.</p><br /> <p><br /> If you use a <var>JUMP TO</var> statement, its destination must be within the same subroutine. You cannot jump into a subroutine from outside of a subroutine.</p><br /> <br /> ===RETURN statement===<br /> <p><br /> The <var>RETURN</var> statement returns control from the subroutine to the statement following the most recent <var>CALL</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>RETURN</var> statement is: </p><br /> <p class="syntax">RETURN<br /> </p><br /> <p><br /> The <var>RETURN</var> statement can appear only within the body of a subroutine. Use of the <var>RETURN</var> statement inside of an <var>ON</var> unit terminates compilation, the procedure cannot run, and the following message is produced: </p><br /> <p class="code">M204.1779 RETURN IS INVALID IN ON UNITS, USE BYPASS STATEMENT<br /> </p><br /> <p><br /> <var class="product">Model&nbsp;204</var> automatically generates a return at the end of a subroutine, if you do not specify one. </p><br /> <p><br /> For more information, see [[#ON units|ON units]] and [[#Passing control to and from ON units|Passing control to and from ON units]].</p><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> You can end a subroutine using an <var>END SUBROUTINE</var> statement or an <var>END BLOCK</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The END SUBROUTINE statement is formatted as follows: </p><br /> <p class="syntax">END SUBROUTINE <span class="squareb">[</span><span class="term">label</span><span class="squareb">]</span><br /> </p><br /> <br /> ===CALL statement===<br /> <p><br /> The <var>CALL</var> statement transfers control to the subroutine. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>CALL</var> statement is:</p><br /> <p class="syntax">CALL <span class="term">label</span><br /> </p><br /> <br /> ====Example====<br /> <p><br /> This statement:</p><br /> <p class="code">CALL.SUB: CALL COMPUTE.PREMIUM<br /> </p><br /> <p><br /> transfers control to the following statement:</p><br /> <p class="code">COMPUTE.PREMIUM: SUBROUTINE<br /> </p><br /> <p><br /> When you use a simple subroutine, no arguments are passed in subroutine calls. Instead, input and output values are implicitly passed in %variables or global variables. If you want field values as arguments, you must assign the values to %variables before the call, or the subroutine must contain its own <var>FOR EACH RECORD</var> loop on the set of records to be processed.</p><br /> <p><br /> Processing continues sequentially from that statement until another control transfer statement &mdash; a <var>CALL</var>, <var>IF</var>, <var>JUMP TO</var>, <var>RETURN</var>, or <var>STOP</var> statement &mdash; is encountered. </p><br /> <br /> ==Complex subroutines==<br /> <p><br /> Complex subroutines perform all the operations of a simple subroutine. In addition, a complex subroutine can pass parameters via parameter lists and can declare local variables. </p><br /> <p class="note"><b>Note:</b> The format of the <var>SUBROUTINE</var> statement changes for a complex subroutine and the <var>CALL</var> statement is also more complex.</p><br /> <br /> ===Symbolic parameter passing===<br /> <p><br /> You can specify positional parameters on the <var>CALL</var> statement for a complex subroutine. These parameters are substituted for symbolic parameters used within the subroutine during execution. You can use the following elements as parameters to a complex subroutine:</p><br /> <ul><br /> <li>Scalar %variables</li><br /> <br /> <li>%variable arrays</li><br /> <br /> <li>Lists of records</li><br /> </ul><br /> <br /> ===Local variable declaration===<br /> <p><br /> Labels, %variables, and other elements in a complex subroutine are local to the subroutine; they do not conflict with elements of the same name in the request or in other complex subroutines. This allows the same element to be used in different portions of a request, and for the same name to describe different elements in each portion.</p><br /> <br /> ===Processing===<br /> <p><br /> All data within the subroutine is statically allocated. When the subroutine is called, the values of all found sets, counts, noted values, and variables are as they were when the subroutine was last executed. Recursive calls to the same subroutine do not allocate separate storage for each subroutine local variable. Local variables are allocated only one time.</p><br /> <br /> ====OPEN statement within a complex subroutine====<br /> <p><br /> A SOUL <var>OPEN</var> statement &mdash; an <var>OPEN</var> statement inside a <var>BEGIN/END</var> &mdash; when used within a complex subroutine on a file that is not defined to the region produces the following counting error and the request is not compiled:</p><br /> <p class="code">M204.1521: <i>entity-name</i> DOES NOT EXIST OR REQUESTED ACCESS NOT AUTHORIZED<br /> </p><br /> <br /> ===SUBROUTINE statement for complex subroutines===<br /> <p><br /> Complex subroutines begin with the following form of the <var>SUBROUTINE</var> statement: </p><br /> <p class="syntax">SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">formal-parameter</span> <br /> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span><br /> </p><br /> Where:<br /> <p><br /> <var class="term">subname</var> is the name of the subroutine.</p><br /> <p><br /> <var class="term">formal-parameter</var> is the declaration of a symbolic parameter used within the subroutine. The parameter list is comprised of the <var class="term">formal-parameter</var> and subsequent input-options. The parameter list is enclosed in parentheses, and it contains declarations for each parameter separated by commas. The parameter list must be specified on one logical line. Null parameters are not allowed.</p><br /> <p><br /> <var class="term">formal-parameter</var> specifies the name and type of element to be used within the subroutine and can be any of the following:</p><br /> <ul><br /> <li>Scalar (nonarray) %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] {[STRING] [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] <br /> <span class="squareb">|</span> [FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT]}<br /> </p><br /> <p><br /> For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE (%W IS STRING DP * -<br /> %X IS STRING LEN 40, -<br /> %Y IS STRING LEN 10 DP 2, -<br /> %Z IS FLOAT, -<br /> %A IS FIXED DP 4)<br /> </p></li><br /> <br /> <li>Array %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] [[STRING] [LEN <span class="term">n</span>] [DP {<span class="term">n</span> | *}] <br /> [ARRAY(* [,*[,*]])] [NO FIELD SAVE] <br /> <span class="squareb">|</span> <span class="squareb">{</span>FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT<span class="squareb">}</span> [ARRAY(* [,*[,*]])]]<br /> </p><br /> <p><br /> The number of dimensions must be specified in the subroutine declaration, but the exact size of each dimension is not specified. An asterisk (*) is used instead of the dimension size. For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE(%ARR IS STRING LEN 10 - ARRAY(*,*))<br /> </p></li><br /> <br /> <li>A list of records formatted as:<br /> <p class="syntax">[LIST] <span class="term">listname</span> [IN [FILE | [PERM | TEMP] GROUP]] <span class="term">name</span> <br /> </p><br /> <p><br /> The context of the list is restricted to a single file or group. For example:</p><br /> <p class="code">SUBROUTINE GENERAL(LIST TOTRECS IN FILE VEHICLES)<br /> </p></li><br /> </ul><br /> <p><br /> <var class="term">inout-option</var> specifies whether a formal-parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are as follows:</p><br /> <br /> <table><br /> <tr class="head"><br /> <th>Option</th><br /> <th>Data can be...</th><br /> </tr><br /> <br /> <tr><br /> <td>INPUT<br><br /> (the default)</td><br /> <td>Passed into, but not out of, a subroutine. In addition, data conversions are performed automatically, in the same manner as an assignment statement. All references to <var>INPUT</var> parameters that update the parameter, for example, assignment statements, result in compiler errors.</td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>INPUT OUTPUT</td><br /> <td>This option is equivalent to the OUTPUT option. </td><br /> </tr><br /> <br /> <tr><br /> <td>OUTPUT</td><br /> <td><br /> <p><br /> Returned from a subroutine. No data conversions are performed.</p><br /> <p><br /> The lengths of complex subroutine string OUTPUT parameters are inherited from calling parameters. If the lengths are specified in the subroutine declaration, the following message is written to the audit trail: </p><br /> <p class="code">M204.1981 LENGTH IGNORED FOR OUTPUT PARAMETER<br /> </p><br /> <p><br /> Compilation and evaluation of the procedure continues, with the inherited length.</p><br /> </td><br /> </tr><br /> </table><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> Like simple subroutines, a complex subroutine ends with an <var>END SUBROUTINE</var> statement. However, unlike simple subroutines, you must not label the <var>SUBROUTINE</var> statement. </p><br /> <p><br /> All declarations and statements compiled after the <var>SUBROUTINE</var> statement become a part of the subroutine until the <var>END SUBROUTINE</var> statement is encountered or until the request is ended with the <var>END</var> statement. </p><br /> <br /> ===CALL statement===<br /> <p><br /> The execution of a <var>CALL</var> statement passes control to a complex subroutine. The first time a subroutine is called, all elements in the subroutine are initialized. Subsequently, each time the subroutine is called, all elements in the subroutine remain in the same state as they were when the subroutine was last exited. You are responsible for reinitializing the elements within the subroutine.</p><br /> <br /> ====Syntax====<br /> <p><br /> A complex subroutine is invoked with this form of the <var>CALL</var> statement:</p><br /> <p class="syntax">CALL <span class="term">subname</span> [(<span class="term">actual-parameter</span> [, ...])]<br /> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">actual-parameter</var> specifies the actual data that replaces the symbolic formal-parameter within the subroutine. At execution time, the value of each actual-parameter is substituted, based on the order in which it appears, for a formal-parameter declared for the subroutine. The correspondence of each formal-parameter in the <var>SUBROUTINE</var> statement to an actual-parameter in the <var>CALL</var> statement is by position rather than by name.<br /> <p><br /> An actual-parameter can be any of the following:</p><br /> <ul><br /> <li>%variable or expression<br /> <p><br /> Expressions can contain field names, screen items, image items, and constants.</p></li><br /> <br /> <li>Array %variable<br /> <p><br /> When an entire array is passed as a parameter, the %variable name is used with the percent (%) sign, but no parenthesis or subscript expressions follow it. For example:</p><br /> <p class="code">BEGIN<br /> %A IS FLOAT ARRAY(10,10)<br /> DECLARE SUBROUTINE FDO(FLOAT ARRAY(*,*))<br /> .<br /> .<br /> .<br /> CALL FDO (%A)<br /> .<br /> .<br /> .<br /> SUBROUTINE FDO (%B IS FLOAT ARRAY(*,*))<br /> PRINT %B(1,1)<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> The <var>[[$ArrSize]]</var> function can be used to determine the number of elements in a particular dimension of an array. </p></li><br /> <br /> <li>A list<br /> <p><br /> An actual-parameter can be a list, optionally preceded by the word LIST to distinguish it from a field name. </p><br /> <p><br /> If the compiler already knows of the formal-parameter list because the subroutine is already compiled or declared, the LIST keyword is unnecessary. </p><br /> <p><br /> If the list has never been declared in the request, a compilation error results. </p><br /> </li></ul><br /> </li></ul><br /> <br /> ====Additional rules for parameters====<br /> <p><br /> The following additional rules apply to actual-parameters and parameter passing:</p><br /> <ul><br /> <li>The maximum number of parameters that can be passed in complex subroutines is 63.</li><br /> <br /> <li>If the formal-parameter is specified as an OUTPUT parameter, the corresponding actual-parameter must match type.</li><br /> <br /> <li>The INPUT parameters of a %variable array requires that the type of the array &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; the <var>DP</var> specification, and the number of dimensions match the actual-parameter. In addition, if the <var>NO FIELD SAVE</var> (<var>NO FS</var>) option is specified for a <var>STRING</var> formal-parameter, it also must be specified for the corresponding actual-parameter and vice versa. All checking of array bounds within subroutines occurs during evaluation.</li><br /> <br /> <li>The INPUT parameters of a list requires the same file or group context as the actual-parameter.<br /> </li><br /> <br /> <li>An INPUT parameter of a scalar %variable can be called with an actual-parameter that is an expression or %variable of a differing type. <var class="product">Model&nbsp;204</var> converts the actual-parameter to the type required by the subroutine, according to the rules of the assignment statement. The converted value has a separate storage location from the original variable or expression.<br /> <p><br /> Passing arguments to INPUT parameters might involve truncation where the number of decimal places is different, or conversion to 0 for non-numeric strings.</p><br /> </li><br /> <br /> <li>OUTPUT parameters of lists and %variable arrays follow the same rules as INPUT parameters for lists and %variable arrays.</li><br /> </li><br /> <br /> <li>OUTPUT parameters of scalar %variables require that the actual-parameter supplied in the <var>CALL</var> statement be another scalar %variable (no constants or expressions) of the same type &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; and that the number of decimal places be the same, or the following message is issued by <var class="product">Model&nbsp;204</var>:<br /> <p class="code">M204.1725 PARAMETER NUMBER <i>n</i> IS TYPE INCOMPATIBLE<br /> </p><br /> <p><br /> Strings can be of any length. The length used is that of the actual input parameter. </p><br /> </li><br /> </ul><br /> <br /> ===Processing complex subroutines===<br /> <p><br /> Checking for the validity of parameter lists occurs during compilation. When the SUBROUTINE statement is compiled, the types of parameters are saved by the compiler, and any subsequent CALL statements are verified as to whether the actual parameter is consistent with the type of formal parameter.</p><br /> <p><br /> When a CALL statement is compiled and the subroutine to which it refers has not been compiled, the compiler verifies whether the actual parameter list is compatible with other CALL statements for the subroutine that it has already compiled. </p><br /> <p><br /> The compiler cannot verify that the actual parameters are compatible with the SUBROUTINE statement until that SUBROUTINE statement is compiled. If the compiler then detects a CALL statement that is not compatible with the SUBROUTINE statement, an error is issued at that time. Checking is done at compile time, so a statement that is not executed during evaluation can still generate an error. </p><br /> <br /> ===DECLARE SUBROUTINE statement===<br /> <p><br /> The DECLARE statement for a complex subroutine is similar to the SUBROUTINE statement, except that the parameter names are omitted. </p><br /> <br /> ====Syntax====<br /> The complete syntax for the DECLARE SUBROUTINE statement is:<br /> <p class="syntax">DECLARE SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">type</span> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">type</var> is one of the following:<br /> <ul><br /> <li>Scalar %variable of the following format:<br /> <p class="syntax">{STRING [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] | [FIXED [DP <span class="term">n</span>] | FLOAT]}<br /> </p></li><br /> <br /> <li>Array %variable of the following format:<br /> <p class="syntax">{STRING [LEN <span class="term">n</span>] [DP [<span class="term">n</span> | *}] [ARRAY(* [,*[,*]]) [NO FIELD SAVE]]<br /> | [FIXED [DP <span class="term">n</span>] | FLOAT] [ARRAY(* [,*[,*]])]}<br /> </p></li><br /> <br /> <li>A list of records of the following format:<br /> <p class="code">[LIST] [IN {FILE | [PERM | TEMP] GROUP} <span class="term">name</span>]<br /> </p></li><br /> </ul></li><br /> <br /> <li><br /> <var class="term">inout-option</var> specifies whether each formal parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are the same as those that can be specified on the SUBROUTINE statement: INPUT, OUTPUT, or INPUT OUTPUT. </li><br /> </ul><br /> <br /> ====DECLARE before CALL====<br /> When a <var>CALL</var> statement refers to a subroutine that has not yet been compiled, the error checking capabilities of the compiler are limited, because the number and type of formal parameters are not known to the compiler. If the first <var>CALL</var> statement for a particular subroutine is not correctly coded, then a large number of error messages can be generated when compiling subsequent <var>CALL</var> statements, although these statements might be correctly coded.<br /> <br /> You can avoid this problem in one of the following ways:<br /> <ul><br /> <li>Declare the formal parameter list with the <var>DECLARE</var> statement. When the <var>DECLARE</var> statement precedes the first <var>CALL</var>, the compiler generates the correct error messages, if problems are encountered. </li><br /> <br /> <li>Place the subroutine before the first <var>CALL</var> statement.</li><br /> </ul><br /> <br /> ====Specifying a list of records====<br /> <p><br /> If you specify a <var>LIST</var> (of records), you must also specify <var>FILE</var> or <var>GROUP</var>. For example:</p><br /> <p class="code">OPEN METADATA<br /> password<br /> <br /> BEGIN<br /> DECLARE LIST ORIG IN METADATA<br /> DECLARE SUBROUTINE THE.SUB(LIST IN FILE METADATA INOUT)<br /> .<br /> .<br /> CALL THE.SUB (LIST ORIG)<br /> .<br /> .<br /> SUBROUTINE THE.SUB(LIST ORIG IN METADATA INOUT)<br /> .<br /> .<br /> END SUBROUTINE THE.SUB<br /> END<br /> </p><br /> <p><br /> If you do not specify <var>FILE</var> or <var>GROUP</var> in the code, you receive the following error message:</p><br /> <p class="code">M204.1725: PARAMETER NUMBER n IS TYPE INCOMPATIBLE<br /> </p><br /> <br /> ====DECLARE parameters and CALL parameters====<br /> <p><br /> In the following example, note that the <var>DECLARE</var> statement lists the formal parameters, while the <var>CALL</var> statement lists the actual parameters:</p><br /> <p class="code">DECLARE SUBROUTINE SUB1(FLOAT, FIXED DP 2, STRING, STRING DP *)<br /> .<br /> .<br /> CALL SUB1(%INCREASE,%WAGES,%NAME,%DEPT)<br /> .<br /> .<br /> SUBROUTINE SUB1(%A IS FLOAT,<br /> %B IS FIXED DP 2,<br /> %C IS STRING,<br /> %D IS STRING DP *)<br /> END SUBROUTINE<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Impact on CALL and SUBROUTINE statements====<br /> <p><br /> The <var>CALL</var> and <var>SUBROUTINE</var> statements are not overridden when a <var>DECLARE SUBROUTINE</var> statement is present. The <var>DECLARE SUBROUTINE</var> statement does not cause the compiler to use more table space, nor does it alter the way in which the compiler output is generated.</p><br /> <p><br /> Rocket Software recommends that you use a <var>DECLARE SUBROUTINE</var> statement before the <var>CALL</var> statement for a subroutine or that you place the subroutine itself before the <var>CALL</var> statement. Error reporting will be more complete and specific to the subroutine.</p><br /> <br /> ===Exiting the subroutine===<br /> <p><br /> The <var>RETURN</var> statement returns control to the statement immediately following the most recent <var>CALL</var> statement. If an <var>END SUBROUTINE</var> or <var>END</var> statement is encountered without a <var>RETURN</var> statement, <var>RETURN</var> processing is implied and automatically added by the compiler. More than one <var>RETURN</var> statement can be specified in a subroutine.</p><br /> <p><br /> If a <var>JUMP</var> statement is used within a subroutine, its destination must be within the same subroutine. You cannot jump into a subroutine. </p><br /> <p><br /> A <var>STOP</var> statement, when executed inside a subroutine, terminates the request in the same manner as it does when executed outside a subroutine. </p><br /> <br /> ===Examples using complex subroutines===<br /> <p><br /> In the following example, an employee name with regular and overtime hours is passed to the subroutine <code>CALC.WAGES</code>. The total pay is returned and a list of records processed by the routine is updated.</p><br /> <p class="code">BEGIN<br /> DECLARE SUBROUTINE CALC.WAGES(FIXED DP 2, -<br /> FIXED DP 2, STRING, FIXED DP 2 OUTPUT, -<br /> LIST IN FILE EMPLOYEE INOUT)<br /> .<br /> .<br /> .<br /> CALL CALC.WAGES(%R.HRS, %OT.HRS, %NAME, -<br /> %TOTAL.PAY, LIST EMPLST)<br /> .<br /> .<br /> .<br /> SUBROUTINE CALC.WAGES(%REG IS FIXED DP 2, -<br /> %OT IS FIXED DP 2, -<br /> %E.NAME IS STRING, -<br /> %TOTAL IS FIXED DP 2 OUTPUT, -<br /> LIST EMPLIST IN FILE EMPLOYEE INOUT)<br /> <br /> %TEMP IS FIXED DP 2<br /> <br /> WAGES1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> NAME = %E.NAME<br /> END FIND<br /> FOR EACH RECORD IN WAGES1<br /> %TEMP = (RATE * %REG)<br /> %TOTAL = %TEMP + (RATE * 1.5 * %OT)<br /> END FOR<br /> PLACE RECORDS IN WAGES1 ON LIST EMPLIST<br /> RETURN<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the following example, an entire array is passed as a single subroutine parameter:</p><br /> <p class="code">BEGIN<br /> %NUMBERS IS FLOAT ARRAY(10,10)<br /> %MAX IS FLOAT<br /> DECLARE SUBROUTINE MAXIMUM(FLOAT ARRAY(*,*), -<br /> FLOAT OUTPUT)<br /> .<br /> .<br /> .<br /> CALL MAXIMUM(%NUMBERS,%MAX)<br /> .<br /> .<br /> .<br /> <br /> SUBROUTINE MAXIMUM(%ARR IS FLOAT ARRAY(*,*), -<br /> %M IS FLOAT OUTPUT)<br /> %I IS FIXED<br /> %J IS FIXED<br /> %M = 0<br /> FOR %I FROM 1 TO $arrsize('%ARR',1)<br /> FOR %J FROM 1 TO $arrsize('%ARR',2)<br /> IF %ARR(%I,%J) GT %M THEN<br /> %M = %ARR(%I,%J)<br /> END IF<br /> END FOR<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ==Sharing common elements==<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when it is declared as a common element. A common element is created by using the DECLARE statement or by using the COMMON keyword on a %variable IS declaration. For an element to be shared, it must be declared as common in every place (each separate scope) in which it is used. </p><br /> <br /> ===Scope of elements===<br /> <p><br /> The scope of an element refers to the area within a request in which an element has a particular meaning. In User Language, complex subroutines have a different scope than the remainder of the request (the elements of a complex subroutine differ from the elements outside the subroutine even when they have the same name). This concept applies to labels, lists, %variables and %variable arrays, menus, screens, and images.</p><br /> <p><br /> The elements of the main request (the statements not enclosed by any SUBROUTINE/END SUBROUTINE statements) and the elements of all simple subroutines share the same scope. Simple subroutines share the same elements with the main request and all other simple subroutines within the request. </p><br /> <br /> ===Shareable elements===<br /> <p><br /> The following elements can be shared if they are declared as common:</p><br /> <br /> ====%variables and %variable arrays====<br /> <p><br /> You can share %variables if a DECLARE %variable or a %variable IS statement that declares the %variable as common is present in each portion of the request where you use the %variable. The %variable must have the same type, length, number of decimal places, and FIELD SAVE option in each declaration. </p><br /> <br /> ====Lists of records====<br /> <p><br /> You can share a list if a DECLARE statement that declares the list as common is contained in each place where you use the list. The declaration of the list must precede the first reference to that list, or <var class="product">Model&nbsp;204</var> declares the list implicitly without the common attribute.</p><br /> <br /> ====Found sets====<br /> <p><br /> You can share found sets if the label of the FIND statement is declared as common. To effectively share a found set, follow these steps:</p><br /> <ol><br /> <li>Add a DECLARE statement that declares the statement label as common before the actual label in the portion of the request where the FIND statement will be executed.</li><br /> <li>Add a DECLARE statement that declares the label as common to any parts of the request that require access to that found set. These parts, however, cannot contain a label with the same name, or a compiler error occurs. </li><br /> </ol><br /> <p><br /> After execution of the FIND statement, you can access the record set in any portion of the request that contains the proper DECLARE statement. </p><br /> <br /> ====Menus and screens====<br /> <p><br /> You can share a menu or screen as common under the following conditions: </p><br /> <ul><br /> <li>The first reference to the menu or screen must be the complete definition of the menu or screen, with the COMMON keyword following the MENU or SCREEN statement.</li><br /> </li><br /> <li>Other parts of the request can reference the same menu or screen by using an abbreviated declaration of the form:</li><br /> <p class="code">DECLARE [MENU menuname | SCREEN screenname] COMMON<br /> </p><br /> <p><br /> If the complete definition of the menu or screen exists, and if that definition was declared as common, the menu or screen is shared. If not, a compiler error results. Two or more complete menu or screen definitions with the COMMON keyword also result in a compiler error.</p><br /> <p><br /> If you use a menu or screen %variable (:%variable) within a complex subroutine to refer to a COMMON screen element, you must include a common declaration for each possible value of the menu or screen name. </p><br /> </li><br /> </ul><br /> <br /> ====Images====<br /> <p><br /> The sharing of images follows the same rules used for the sharing of menus and screens. If multiple images are contained within the same block, then the following rules also apply:</p><br /> <ul><br /> <li>You can use the COMMON keyword on only the first IMAGE statement of a block. All other images within the same block are automatically considered as candidates for sharing as common data.</li><br /> </li><br /> <br /> <li>All other parts of the request that access common images must contain the following abbreviated form of the DECLARE statement for each image to which access is required: </li><br /> <p class="code">DECLARE IMAGE imagename COMMON<br /> </p></li><br /> </ul><br /> <br /> <br /> ===DECLARE statement===<br /> <p><br /> You can use the DECLARE statement to perform the following functions: </p><br /> <ul><br /> <li>Specify subroutine formal parameter types.</li><br /> </li><br /> <br /> <li>Specify variables, labels, lists, menus, screens, and images as COMMON.</li><br /> </li><br /> </ul><br /> <p><br /> Menus and screens are discussed in detail in [[Full-screen feature]]. </p><br /> <p><br /> Images are discussed in detail in [[Images]].</p><br /> <br /> <ul><br /> <li>To declare lists without having to use an <code>IN filename CLEAR LIST listname</code> clause. See [[Lists#Creating and clearing a list|Creating and clearing a list]].</li><br /> <br /> <li>To declare %variables, see [[Using variables and values in computation]]. </li><br /> </ul><br /> <br /> ====Syntax====<br /> <p><br /> The format of the DECLARE statement is as follows:</p><br /> <p class="syntax">DECLARE <span class="term">declaration</span><br /> </p><br /> <p><br /> where <span class="term">declaration</span> is one of the following:</p><br /> <p class="syntax">LABEL <span class="term">label</span> COMMON<br /> <br /> [LIST] <span class="term">listname</span> [IN [FILE [PERM | TEMP] GROUP] <span class="term">name</span>]<br /> [COMMON]<br /> <br /> IMAGE <span class="term">imagename</span> COMMON<br /> <br /> MENU <span class="term">menuname</span> COMMON<br /> <br /> SCREEN <span class="term">screenname</span> COMMON<br /> <br /> <span class="term">%variable</span> [IS] {FIXED [DP <span class="term">n</span>] | FLOAT}<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [COMMON]<br /> <br /> <span class="term">%variable</span> [IS] STRING [LEN <span class="term">n</span>] [DP {<span class="term">dn1</span> | *}]<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [NO FIELD SAVE] [COMMON]<br /> <br /> SUBROUTINE <span class="term">subname</span>[(<span class="term">type</span> [<span class="term">inout-option</span>] [,...]) ]<br /> </p><br /> <br /> ====Example====<br /> <p><br /> For example, the DECLARE statement declares the list RECNAMES in the following request:</p><br /> <p class="code">BEGIN<br /> DECLARE LIST RECNAMES<br /> DECLARE SUBROUTINE REGION(LIST OUTPUT, STRING)<br /> .<br /> .<br /> .<br /> CALL REGION(LIST RECNAMES, 'NORTHEAST')<br /> .<br /> .<br /> .<br /> SUBROUTINE REGION(LIST RGNLST OUTPUT, -<br /> %REGION IS STRING)<br /> <br /> R1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> REGION = %REGION<br /> R2: PLACE RECORDS IN R1 ON LIST RGNLIST<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ===Defining common variables===<br /> <p><br /> You can define common variables at the beginning of all programs without later redefinitions. The syntax lets you use the %VAR IS COMMON clause without duplicating the previous attributes.</p><br /> <p><br /> However, if attributes, such as STRING or LEN, are included in the redefinition, which differ from those previously defined, a compilation error occurs. In addition, if the variable is not previously defined, it is allocated based on the current default variable definition. </p><br /> <p><br /> For example, </p><br /> <p class="code">BEGIN<br /> VARIABLES ARE STRING LEN 20 <br /> %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON <br /> SUBROUTINE A<br /> * full definition on next line no longer required<br /> ** %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON<br /> * new syntax on next line replaces previous line<br /> %X IS COMMON /? defaults to previous %X definition ?/<br /> CALL B<br /> END SUBROUTINE<br /> <br /> SUBROUTINE B<br /> * But next line will fail compile since %X already exists<br /> %X IS STRING LEN 4 COMMON /? compiler error ?/<br /> * And the next line will result in a default definition<br /> * since %Y is not previously defined.<br /> %Y IS COMMON<br /> END SUBROUTINE<br /> PRINT %X<br /> CALL A<br /> END<br /> </p><br /> <br /> ===Shared common element examples===<br /> <p><br /> The following examples illustrate the differences between data that is locally scoped and data that is shared using the COMMON keyword. </p><br /> <br /> ====Example 1====<br /> <p><br /> In this example, the variable %I assumes different values depending upon which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> %I IS FIXED<br /> DECLARE SUBROUTINE SUBR1(STRING)<br /> .<br /> .<br /> .<br /> FOR %I FROM 1 TO 10<br /> CALL SUBR1(%ARR(%I))<br /> END FOR<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%A IS STRING)<br /> %I IS FIXED<br /> FOR %I FROM 1 TO 10<br /> PRINT %I and %A<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ====Example 2====<br /> <p><br /> In this example, the screen EXAMPLE and the %A and %B variables retain the same values no matter which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> SCREEN EXAMDEF COMMON<br /> TITLE 'THIS IS A COMMON SCREEN DEFINITION'<br /> PROMPT 'ENTER VALUE'<br /> INPUT FLD1 AT 10 LEN 20 PAD '_'<br /> END SCREEN<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> DECLARE SUBROUTINE SUBR1(STRING LEN 10)<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%Z IS STRING LEN 10)<br /> DECLARE SCREEN EXAMDEF COMMON<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> .<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Example 3====<br /> <p><br /> In this example, the main request and the subroutine share the common data of an array and a found set:</p><br /> <p class="code">BEGIN<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> DECLARE SUBROUTINE EXAMPLE<br /> .<br /> .<br /> .<br /> ALL.RECS: FIND ALL RECORDS<br /> END FIND<br /> %I = 0<br /> %J = 1<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD<br /> END FOR<br /> CALL EXAMPLE<br /> STOP<br /> <br /> SUBROUTINE EXAMPLE<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> %I = 0<br /> %J = 2<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD2<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the preceding example, the main request updates column 1 of the array %COMM.ARRAY with the contents of FLD. The subroutine, EXAMPLE, updates column 2 of the same array with the contents of FLD2. Both the array %COM.ARRAY and the found set ALL.RECS are shared by using the COMMON keyword. %I and %J are both local variables. %I is local because it was declared without the COMMON keyword; %J is local because it was not declared at all. </p><br /> <br /> <div id="On statement"></div> <br /> ==On units== <br /> <p><br /> An <var>On</var> unit lets you specify a course of action following a triggering event, such as the terminal operator pressing one of the <var>Attention</var> identifier (AID) keys. The <var>On</var> unit provides an application with a way to override the normal system response. </p><br /> <br /> ====Syntax====<br /> <p><br /> To define an <var>On</var> unit, use an <var>On</var> block in the following format:</p><br /> <p class="syntax">[<span class="term">label</span>] On <span class="term">unittype</span><br /> <span class="term">statement</span><br /> <span class="literal">...</span><br /> End On<br /> </p><br /> <p><br /> where <var class="term">unittype</var> is one of the following:</p><br /> <table><br /> <tr class="head"><br /> <th>unittype</th><br /> <th>You can specify the course of action to take if...</th><br /> </tr><br /> <br /> <tr><br /> <td>ATTENTION</td><br /> <td>The end user invokes the attention feature (for example, presses the <var>BREAK, ATTN,</var> or <var>PA1</var> key, or enters <var>*CANCEL</var>). </td><br /> </tr><br /> <br /> <tr><br /> <td>ERROR</td><br /> <td><var class="product">Model&nbsp;204</var> cancels a request. Before a request is canceled or, for transaction backout files, after the current transaction is backed out, the ON ERROR unit is processed instead of returning control to the terminal command level. For more information on transaction backout files, see [[Data recovery]]. </td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>FIELD CONSTRAINT<br /> CONFLICT (FCC)</td><br /> <td>There are field level constraint conflicts. Violating the UNIQUE and AT-MOST-ONE attributes causes field-level conflicts.*</td><br /> </tr><br /> <br /> <tr><br /> <td>FIND CONFLICT</td><br /> <td>A conflict arises evaluating a FIND statement or a FOR EACH RECORD statement used for retrieval.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING FILE</td><br /> <td>A remote file is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING MEMBER</td><br /> <td>A remote optional member is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>RECORD LOCKING CONFLICT</td><br /> <td>A conflict arises during a record locking attempt.</td><br /> </tr><br /> </table><br /> <p><br /> *If you have procedures written for <var class="product">Model&nbsp;204</var> V2R1.0 that use ON FCC for UNIQUE fields, and you are planning to use ON FCC for AT-MOST-ONE fields, you might need to rewrite the ON FCC unit to take the new value of $UPDSTAT (2 for AT-MOST-ONE) into account. </p><br /> <p><br /> Several $functions provide information about conflicts. They are:</p><br /> <table><br /> <tr><br /> <td>[[$UpdFile]]</td><br /> <td>[[$UpdFld]]</td><br /> <td>[[$UpdOval]]</td><br /> <td>[[$UpdRec]]</td><br /> </tr><br /> <tr><br /> <td>[[$UpdStat]]</td><br /> <td>[[$UpdStmt]]</td><br /> <td>[[$UpdVal]]</td><br /> <td>[[$UnqRec]]</td><br /> </tr><br /> </table><br /> <br /> ===Body of an ON unit===<br /> <p><br /> The body of the ON unit consists of statements immediately following the ON statement. Any User Language statement can appear within an ON unit except the SUBROUTINE statement.</p><br /> <br /> ===Ending an ON unit===<br /> <p><br /> You must conclude an ON unit with either an END ON statement or an END BLOCK statement. The format of the END ON statement is as follows:</p><br /> <p class="syntax">END ON [<span class="term">label</span>]<br /> </p><br /> <p><br /> where <var class="term">label</var> is the label of the statement that began the ON statement. </p><br /> <br /> ===Processing an ON unit===<br /> <p><br /> When an ON statement is evaluated, <var class="product">Model&nbsp;204</var> remembers the location of the ON unit body (the statement after the ON statement and within the unit), but does not immediately evaluate the body. Instead, it passes control to the statement immediately following the ON unit. The ON unit body is evaluated only when the triggering event takes place.</p><br /> <br /> ===Usage guidelines for ON units===<br /> <p><br /> Note the following considerations when using ON units:</p><br /> <ul><br /> <li>You must define the ON unit before it is invoked (that is, you should typically place the ON unit near the beginning of your procedure). </li><br /> <br /> <li>A subsequent definition of an ON unit of the same kind replaces the previous one. For example, if you define two ON ATTN units, the second one becomes the current one.</li><br /> <br /> <li>You can jump to destinations within the same ON unit. </li><br /> <br /> <li>You can jump out of an ON unit only to unnested, labeled statements.</li><br /> <br /> <li>You cannot jump into an ON unit.</li><br /> <br /> <li>You can jump outside of an ON unit only if the ON unit is part of a main routine or part of a complex subroutine. </li><br /> <br /> <li>You cannot jump out of an ON unit contained in a simple subroutine, regardless of whether the destination is within the subroutine or back in the mainline program, because ON units are part of the mainline program; hence, there is no scoping of ON units. This restriction ensures that the ON unit is executed and the control returned to the main routine.</li><br /> <br /> <li>An ON unit definition is not preserved when a request is continued with an END MORE statement and a MORE command. Each new request continuation must define its own ON units. (See [[Large request considerations#Rules for request continuation|Rules for request continuation]].)</li><br /> <br /> <li>For complex subroutines, an active ON unit is temporarily disabled when a subroutine is called that contains an ON UNIT of the same type; it is restored when the subroutine returns. Any ON unit enabled during the execution of a subroutine is replaced by the active ON unit at the time of the last CALL statement as soon as the RETURN statement is evaluated.</li><br /> <br /> <li>ON units coded inside complex subroutines can contain JUMP statements that specify a destination outside the ON unit. The destination must be to an unnested labeled statement within the complex subroutine. Also, if the ON unit is to be jumped out of, the condition that causes the ON unit to be invoked must be raised in the subroutine that contains the ON unit.<br /> <p><br /> This prevents a lower level subroutine from returning inadvertently by raising a condition for which there is an ON unit coded in a higher level subroutine. If the inadvertent return is attempted, the request is canceled. </p><br /> </li><br /> <br /> <li>ON units do not have their own local data and labels. They inherit the scope of the part of the program in which they are compiled. An ON unit that is compiled within a complex subroutine is considered part of only that subroutine. <br /> </li><br /> </ul><br /> <br /> ====Example====<br /> <p><br /> In the following example, if the user presses the<var> ATTN</var> key instead of entering a response to the prompt in the GET.REC.TYPE statement, the ON ATTENTION unit sets %FLAG to 1. The FLAG.SET statement tests %FLAG. If %FLAG is set, the request branches to END.REQUEST and the FIND statement is not executed. </p><br /> <p class="code">%FLAG=0<br /> ON ATTENTION<br /> %FLAG=1<br /> BYPASS<br /> END ON<br /> GET.REC.TYPE: %TYPE=$READ('ENTER RECORD TYPE')<br /> FLAG.SET: IF %FLAG=1 THEN<br /> JUMP TO END.REQUEST<br /> END IF<br /> FIND.RECS: FIND ALL RECORDS FOR WHICH<br /> TYPE = %TYPE<br /> END FIND<br /> .<br /> .<br /> .<br /> END.REQUEST:<br /> END<br /> </p><br /> <br /> ===Only one ON unit at a time===<br /> <p><br /> Only one ON unit of each kind is active at a time. For example, the processing of a second ON ERROR statement resets the current ON ERROR unit, but does not affect the current ON ATTENTION unit. Thus, you can redefine what to do in a variety of cases by having several ON statements and units within a request. An ON unit can be redefined within another ON unit.</p><br /> <br /> ===Passing control to and from ON units===<br /> <p><br /> <var class="product">Model&nbsp;204</var> passes control to an ON unit when the triggering event occurs. For example, an ON ATTENTION unit receives control when a user presses one of the ATTENTION identifier (AID) keys at the terminal during the execution of a request. Use one of the following statements to return control to the body of the request. </p><br /> <br /> ====BYPASS statement====<br /> <p><br /> The BYPASS statement handles the various unittypes of an ON statement as follows:</p><br /> <table><br /> <tr class="head"><br /> <th>For unittype...</th><br /> <th>The BYPASS statement...</th><br /> </tr><br /> <tr><br /> <td>ON MISSING FILE<br><br /> ON MISSING MEMBER</td><br /> <td>Returns control to the statement immediately after the END FOR statement that closes the current FOR loop. </td><br /> </tr><br /> <tr><br /> <td>ON ERROR</td><br /> <td>Ends the request.</td><br /> </tr><br /> <tr><br /> <td nowrap>ON ATTENTION<br><br /> ON FIND CONFLICT<br><br /> ON RECORD LOCKING CONFLICT</td><br /> <td>Returns control to the statement immediately after the statement that invoked the ON unit.</td><br /> </tr><br /> </table><br /> <p><br /> The format of the BYPASS statement is as follows:</p><br /> <p class="syntax">BYPASS [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the PENDING STATEMENT keyword is optional. If the ON unit is not ended with a BYPASS statement, <var class="product">Model&nbsp;204</var> automatically generates a STOP statement at the end of the unit. </p><br /> <br /> ====CONTINUE statement====<br /> <p><br /> The CONTINUE statement is supported only with the Parallel Query Option. If you lose access to a group member that is an optional file during FOR processing, the CONTINUE statement continues FOR processing with the next available file, and skips any other unavailable files.</p><br /> <br /> ====JUMP TO statement====<br /> <p><br /> The JUMP statement, when used to jump to a labeled statement outside the ON unit, causes the request to continue at that point. There are restrictions pertaining to jumps; see [[Flow of control in User Language#Branching statements|Branching statements]] and [[#Simple subroutines|Simple subroutines]]. </p><br /> <br /> ====RETRY statement====<br /> <p><br /> The RETRY statement passes control to the statement that invoked the ON unit, thereby retrying that statement. The RETRY statement is not valid in an ON ERROR unit.</p><br /> <p><br /> The format of the RETRY statement is as follows:</p><br /> <p class="syntax">RETRY [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the <var>PENDING STATEMENT</var> keyword is optional.</p><br /> <br /> ====STOP statement====<br /> <p><br /> The STOP statement is used to end the request. </p><br /> <br /> ===Clearing ON units===<br /> <p><br /> You can issue the following statement to clear the definition of an ON unit: </p><br /> <p class="syntax">CLEAR ON <span class="term">unittype</span><br /> </p><br /> <p><br /> This statement clears any defined ON unit of the type specified. Clearing an ON unit produces the following results:</p><br /> <br /> <ul><br /> <li>After a CLEAR ON ATTENTION, pressing one of the ATTENTION identifier (AID) keys at the terminal does not invoke the ON ATTENTION unit.</li><br /> <br /> <li>After a CLEAR ON ERROR, a request cancellation error does not invoke the ON ERROR unit. </li><br /> </ul><br /> <p><br /> An ON unit can be defined, cleared, and then redefined. </p><br /> <br /> ===Pausing during the request===<br /> <p><br /> The PAUSE statement can be used with ON units to cause the request to wait a specified time and then to retry the statement that caused the evaluation of the ON unit. PAUSE is typically used with the other ON unit types (RECORD LOCKING CONFLICT and ON FIND CONFLICT) and is discussed in [[Record level locking and concurrency control]]. </p><br /> <br /> </div> <br /> <br /> [[Category:SOUL]]</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Subroutines&diff=78430 Subroutines 2015-07-23T03:43:32Z

<p>Heikki: /* Defining common variables */</p> <hr /> <div><div class="toclimit-3"><br /> <br /> ==Overview==<br /> <p><br /> User Language lets you treat a single set of statements as a simple or complex subroutine. You can:</p><br /> <ul><br /> <li>Execute simple subroutines a number of times from different locations within a request.</li><br /> <li>Use complex subroutines as you would simple subroutines. </li><br /> </ul><br /> In addition, you can:<br /> <ul><br /> <li>Pass parameters via parameter lists.</li><br /> <li>Declare variables locally.</li><br /> </ul><br /> <br /> ===Common elements===<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when you declare that element as COMMON.</p><br /> <br /> ===ON units===<br /> <p><br /> An ON unit specifies a response action to a triggering event: for example, the terminal operator pressing one of the ATTENTION identifier (AID) keys. ON units let an application override the normal system response.</p><br /> <br /> ==Simple subroutines==<br /> <br /> ===Outlining a simple subroutine===<br /> <p><br /> The following statements are used in simple subroutines within a request:</p><br /> <table><br /> <tr class="head"><br /> <th>Statement</th><br /> <th>Purpose</th></tr><br /> <br /> <tr><br /> <td><var>CALL</var></td><br /> <td>Transfers control to the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>END SUBROUTINE</var></td><br /> <td>Indicates the end of the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>JUMP TO</var></td><br /> <td>Transfers control to another statement in the request.</td></tr><br /> <br /> <tr><br /> <td><var>RETURN</var></td><br /> <td>Returns control to the statement immediately following the CALL statement. </td></tr><br /> <br /> <tr><br /> <td><var>SUBROUTINE</var></td><br /> <td>Indicates the beginning of a subroutine. </td></tr><br /> </table><br /> <p><br /> The statements are coded in the following sequence, so they are described in order of usage.</p><br /> <ol><br /> <li><var>SUBROUTINE</var> statement</li><br /> <li><var>JUMP TO</var> and <var>RETURN</var> statements as appropriate</li><br /> <li><var>END SUBROUTINE</var> statement</li><br /> <li><var>CALL</var> statement</li><br /> </ol><br /> <br /> ===SUBROUTINE statement===<br /> <p><br /> A simple subroutine consists of a sequence of SOUL statements that must begin with a <var>SUBROUTINE</var> statement. The body of the subroutine is composed of the statements immediately following the <var>SUBROUTINE</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>SUBROUTINE</var> statement is: </p><br /> <p class="syntax"><span class="term">label</span>: SUBROUTINE<br /> </p><br /> <p><br /> A simple subroutine must be labeled; without a label it cannot be executed. You cannot use field names in the subroutine, except within a FOR loop, even if the subroutine is always called from within a record loop.</p><br /> <br /> ====Example of a simple subroutine====<br /> <p><br /> The following request uses two subroutines. </p><br /> <p class="note"><b>Note:</b> Simple subroutine statements in the following example are described more fully after this example.</p><br /> <p><br /> The first subroutine, <code>TOTAL</code>, accumulates a total in the %variable named <code>%TOTAL.MUSTANGS</code>. The second subroutine, <code>PRINT.TOTAL</code>, prints a literal that varies depending on the total accumulated. </p><br /> <p class="code">BEGIN<br /> MUSTANGS: FIND ALL RECORDS FOR WHICH<br /> MODEL = MUSTANG<br /> END FIND<br /> FOR EACH RECORD IN MUSTANGS<br /> CALL TOTAL<br /> END FOR<br /> CALL PRINT.TOTAL<br /> TOTAL: SUBROUTINE<br /> %TOTAL.MUSTANGS = %TOTAL.MUSTANGS + 1<br /> RETURN<br /> END SUBROUTINE TOTAL<br /> PRINT.TOTAL: SUBROUTINE<br /> IF %TOTAL.MUSTANGS LE 10 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 10'<br /> ELSEIF %TOTAL.MUSTANGS LE 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 50'<br /> ELSEIF %TOTAL.MUSTANGS GT 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> GREATER THAN 50'<br /> END IF<br /> RETURN<br /> END SUBROUTINE PRINT.TOTAL<br /> END<br /> </p><br /> <br /> ===JUMP TO statements===<br /> <p><br /> <var class="product">Model&nbsp;204</var> compiles subroutines only after they are called, regardless of where they are in your program.</p><br /> <p><br /> If you use a <var>JUMP TO</var> statement, its destination must be within the same subroutine. You cannot jump into a subroutine from outside of a subroutine.</p><br /> <br /> ===RETURN statement===<br /> <p><br /> The <var>RETURN</var> statement returns control from the subroutine to the statement following the most recent <var>CALL</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>RETURN</var> statement is: </p><br /> <p class="syntax">RETURN<br /> </p><br /> <p><br /> The <var>RETURN</var> statement can appear only within the body of a subroutine. Use of the <var>RETURN</var> statement inside of an <var>ON</var> unit terminates compilation, the procedure cannot run, and the following message is produced: </p><br /> <p class="code">M204.1779 RETURN IS INVALID IN ON UNITS, USE BYPASS STATEMENT<br /> </p><br /> <p><br /> <var class="product">Model&nbsp;204</var> automatically generates a return at the end of a subroutine, if you do not specify one. </p><br /> <p><br /> For more information, see [[#ON units|ON units]] and [[#Passing control to and from ON units|Passing control to and from ON units]].</p><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> You can end a subroutine using an <var>END SUBROUTINE</var> statement or an <var>END BLOCK</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The END SUBROUTINE statement is formatted as follows: </p><br /> <p class="syntax">END SUBROUTINE <span class="squareb">[</span><span class="term">label</span><span class="squareb">]</span><br /> </p><br /> <br /> ===CALL statement===<br /> <p><br /> The <var>CALL</var> statement transfers control to the subroutine. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>CALL</var> statement is:</p><br /> <p class="syntax">CALL <span class="term">label</span><br /> </p><br /> <br /> ====Example====<br /> <p><br /> This statement:</p><br /> <p class="code">CALL.SUB: CALL COMPUTE.PREMIUM<br /> </p><br /> <p><br /> transfers control to the following statement:</p><br /> <p class="code">COMPUTE.PREMIUM: SUBROUTINE<br /> </p><br /> <p><br /> When you use a simple subroutine, no arguments are passed in subroutine calls. Instead, input and output values are implicitly passed in %variables or global variables. If you want field values as arguments, you must assign the values to %variables before the call, or the subroutine must contain its own <var>FOR EACH RECORD</var> loop on the set of records to be processed.</p><br /> <p><br /> Processing continues sequentially from that statement until another control transfer statement &mdash; a <var>CALL</var>, <var>IF</var>, <var>JUMP TO</var>, <var>RETURN</var>, or <var>STOP</var> statement &mdash; is encountered. </p><br /> <br /> ==Complex subroutines==<br /> <p><br /> Complex subroutines perform all the operations of a simple subroutine. In addition, a complex subroutine can pass parameters via parameter lists and can declare local variables. </p><br /> <p class="note"><b>Note:</b> The format of the <var>SUBROUTINE</var> statement changes for a complex subroutine and the <var>CALL</var> statement is also more complex.</p><br /> <br /> ===Symbolic parameter passing===<br /> <p><br /> You can specify positional parameters on the <var>CALL</var> statement for a complex subroutine. These parameters are substituted for symbolic parameters used within the subroutine during execution. You can use the following elements as parameters to a complex subroutine:</p><br /> <ul><br /> <li>Scalar %variables</li><br /> <br /> <li>%variable arrays</li><br /> <br /> <li>Lists of records</li><br /> </ul><br /> <br /> ===Local variable declaration===<br /> <p><br /> Labels, %variables, and other elements in a complex subroutine are local to the subroutine; they do not conflict with elements of the same name in the request or in other complex subroutines. This allows the same element to be used in different portions of a request, and for the same name to describe different elements in each portion.</p><br /> <br /> ===Processing===<br /> <p><br /> All data within the subroutine is statically allocated. When the subroutine is called, the values of all found sets, counts, noted values, and variables are as they were when the subroutine was last executed. Recursive calls to the same subroutine do not allocate separate storage for each subroutine local variable. Local variables are allocated only one time.</p><br /> <br /> ====OPEN statement within a complex subroutine====<br /> <p><br /> A SOUL <var>OPEN</var> statement &mdash; an <var>OPEN</var> statement inside a <var>BEGIN/END</var> &mdash; when used within a complex subroutine on a file that is not defined to the region produces the following counting error and the request is not compiled:</p><br /> <p class="code">M204.1521: <i>entity-name</i> DOES NOT EXIST OR REQUESTED ACCESS NOT AUTHORIZED<br /> </p><br /> <br /> ===SUBROUTINE statement for complex subroutines===<br /> <p><br /> Complex subroutines begin with the following form of the <var>SUBROUTINE</var> statement: </p><br /> <p class="syntax">SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">formal-parameter</span> <br /> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span><br /> </p><br /> Where:<br /> <p><br /> <var class="term">subname</var> is the name of the subroutine.</p><br /> <p><br /> <var class="term">formal-parameter</var> is the declaration of a symbolic parameter used within the subroutine. The parameter list is comprised of the <var class="term">formal-parameter</var> and subsequent input-options. The parameter list is enclosed in parentheses, and it contains declarations for each parameter separated by commas. The parameter list must be specified on one logical line. Null parameters are not allowed.</p><br /> <p><br /> <var class="term">formal-parameter</var> specifies the name and type of element to be used within the subroutine and can be any of the following:</p><br /> <ul><br /> <li>Scalar (nonarray) %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] {[STRING] [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] <br /> <span class="squareb">|</span> [FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT]}<br /> </p><br /> <p><br /> For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE (%W IS STRING DP * -<br /> %X IS STRING LEN 40, -<br /> %Y IS STRING LEN 10 DP 2, -<br /> %Z IS FLOAT, -<br /> %A IS FIXED DP 4)<br /> </p></li><br /> <br /> <li>Array %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] [[STRING] [LEN <span class="term">n</span>] [DP {<span class="term">n</span> | *}] <br /> [ARRAY(* [,*[,*]])] [NO FIELD SAVE] <br /> <span class="squareb">|</span> <span class="squareb">{</span>FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT<span class="squareb">}</span> [ARRAY(* [,*[,*]])]]<br /> </p><br /> <p><br /> The number of dimensions must be specified in the subroutine declaration, but the exact size of each dimension is not specified. An asterisk (*) is used instead of the dimension size. For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE(%ARR IS STRING LEN 10 - ARRAY(*,*))<br /> </p></li><br /> <br /> <li>A list of records formatted as:<br /> <p class="syntax">[LIST] <span class="term">listname</span> [IN [FILE | [PERM | TEMP] GROUP]] <span class="term">name</span> <br /> </p><br /> <p><br /> The context of the list is restricted to a single file or group. For example:</p><br /> <p class="code">SUBROUTINE GENERAL(LIST TOTRECS IN FILE VEHICLES)<br /> </p></li><br /> </ul><br /> <p><br /> <var class="term">inout-option</var> specifies whether a formal-parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are as follows:</p><br /> <br /> <table><br /> <tr class="head"><br /> <th>Option</th><br /> <th>Data can be...</th><br /> </tr><br /> <br /> <tr><br /> <td>INPUT<br><br /> (the default)</td><br /> <td>Passed into, but not out of, a subroutine. In addition, data conversions are performed automatically, in the same manner as an assignment statement. All references to <var>INPUT</var> parameters that update the parameter, for example, assignment statements, result in compiler errors.</td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>INPUT OUTPUT</td><br /> <td>This option is equivalent to the OUTPUT option. </td><br /> </tr><br /> <br /> <tr><br /> <td>OUTPUT</td><br /> <td><br /> <p><br /> Returned from a subroutine. No data conversions are performed.</p><br /> <p><br /> The lengths of complex subroutine string OUTPUT parameters are inherited from calling parameters. If the lengths are specified in the subroutine declaration, the following message is written to the audit trail: </p><br /> <p class="code">M204.1981 LENGTH IGNORED FOR OUTPUT PARAMETER<br /> </p><br /> <p><br /> Compilation and evaluation of the procedure continues, with the inherited length.</p><br /> </td><br /> </tr><br /> </table><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> Like simple subroutines, a complex subroutine ends with an <var>END SUBROUTINE</var> statement. However, unlike simple subroutines, you must not label the <var>SUBROUTINE</var> statement. </p><br /> <p><br /> All declarations and statements compiled after the <var>SUBROUTINE</var> statement become a part of the subroutine until the <var>END SUBROUTINE</var> statement is encountered or until the request is ended with the <var>END</var> statement. </p><br /> <br /> ===CALL statement===<br /> <p><br /> The execution of a <var>CALL</var> statement passes control to a complex subroutine. The first time a subroutine is called, all elements in the subroutine are initialized. Subsequently, each time the subroutine is called, all elements in the subroutine remain in the same state as they were when the subroutine was last exited. You are responsible for reinitializing the elements within the subroutine.</p><br /> <br /> ====Syntax====<br /> <p><br /> A complex subroutine is invoked with this form of the <var>CALL</var> statement:</p><br /> <p class="syntax">CALL <span class="term">subname</span> [(<span class="term">actual-parameter</span> [, ...])]<br /> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">actual-parameter</var> specifies the actual data that replaces the symbolic formal-parameter within the subroutine. At execution time, the value of each actual-parameter is substituted, based on the order in which it appears, for a formal-parameter declared for the subroutine. The correspondence of each formal-parameter in the <var>SUBROUTINE</var> statement to an actual-parameter in the <var>CALL</var> statement is by position rather than by name.<br /> <p><br /> An actual-parameter can be any of the following:</p><br /> <ul><br /> <li>%variable or expression<br /> <p><br /> Expressions can contain field names, screen items, image items, and constants.</p></li><br /> <br /> <li>Array %variable<br /> <p><br /> When an entire array is passed as a parameter, the %variable name is used with the percent (%) sign, but no parenthesis or subscript expressions follow it. For example:</p><br /> <p class="code">BEGIN<br /> %A IS FLOAT ARRAY(10,10)<br /> DECLARE SUBROUTINE FDO(FLOAT ARRAY(*,*))<br /> .<br /> .<br /> .<br /> CALL FDO (%A)<br /> .<br /> .<br /> .<br /> SUBROUTINE FDO (%B IS FLOAT ARRAY(*,*))<br /> PRINT %B(1,1)<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> The <var>[[$ArrSize]]</var> function can be used to determine the number of elements in a particular dimension of an array. </p></li><br /> <br /> <li>A list<br /> <p><br /> An actual-parameter can be a list, optionally preceded by the word LIST to distinguish it from a field name. </p><br /> <p><br /> If the compiler already knows of the formal-parameter list because the subroutine is already compiled or declared, the LIST keyword is unnecessary. </p><br /> <p><br /> If the list has never been declared in the request, a compilation error results. </p><br /> </li></ul><br /> </li></ul><br /> <br /> ====Additional rules for parameters====<br /> <p><br /> The following additional rules apply to actual-parameters and parameter passing:</p><br /> <ul><br /> <li>The maximum number of parameters that can be passed in complex subroutines is 63.</li><br /> <br /> <li>If the formal-parameter is specified as an OUTPUT parameter, the corresponding actual-parameter must match type.</li><br /> <br /> <li>The INPUT parameters of a %variable array requires that the type of the array &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; the <var>DP</var> specification, and the number of dimensions match the actual-parameter. In addition, if the <var>NO FIELD SAVE</var> (<var>NO FS</var>) option is specified for a <var>STRING</var> formal-parameter, it also must be specified for the corresponding actual-parameter and vice versa. All checking of array bounds within subroutines occurs during evaluation.</li><br /> <br /> <li>The INPUT parameters of a list requires the same file or group context as the actual-parameter.<br /> </li><br /> <br /> <li>An INPUT parameter of a scalar %variable can be called with an actual-parameter that is an expression or %variable of a differing type. <var class="product">Model&nbsp;204</var> converts the actual-parameter to the type required by the subroutine, according to the rules of the assignment statement. The converted value has a separate storage location from the original variable or expression.<br /> <p><br /> Passing arguments to INPUT parameters might involve truncation where the number of decimal places is different, or conversion to 0 for non-numeric strings.</p><br /> </li><br /> <br /> <li>OUTPUT parameters of lists and %variable arrays follow the same rules as INPUT parameters for lists and %variable arrays.</li><br /> </li><br /> <br /> <li>OUTPUT parameters of scalar %variables require that the actual-parameter supplied in the <var>CALL</var> statement be another scalar %variable (no constants or expressions) of the same type &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; and that the number of decimal places be the same, or the following message is issued by <var class="product">Model&nbsp;204</var>:<br /> <p class="code">M204.1725 PARAMETER NUMBER <i>n</i> IS TYPE INCOMPATIBLE<br /> </p><br /> <p><br /> Strings can be of any length. The length used is that of the actual input parameter. </p><br /> </li><br /> </ul><br /> <br /> ===Processing complex subroutines===<br /> <p><br /> Checking for the validity of parameter lists occurs during compilation. When the SUBROUTINE statement is compiled, the types of parameters are saved by the compiler, and any subsequent CALL statements are verified as to whether the actual parameter is consistent with the type of formal parameter.</p><br /> <p><br /> When a CALL statement is compiled and the subroutine to which it refers has not been compiled, the compiler verifies whether the actual parameter list is compatible with other CALL statements for the subroutine that it has already compiled. </p><br /> <p><br /> The compiler cannot verify that the actual parameters are compatible with the SUBROUTINE statement until that SUBROUTINE statement is compiled. If the compiler then detects a CALL statement that is not compatible with the SUBROUTINE statement, an error is issued at that time. Checking is done at compile time, so a statement that is not executed during evaluation can still generate an error. </p><br /> <br /> ===DECLARE SUBROUTINE statement===<br /> <p><br /> The DECLARE statement for a complex subroutine is similar to the SUBROUTINE statement, except that the parameter names are omitted. </p><br /> <br /> ====Syntax====<br /> The complete syntax for the DECLARE SUBROUTINE statement is:<br /> <p class="syntax">DECLARE SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">type</span> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">type</var> is one of the following:<br /> <ul><br /> <li>Scalar %variable of the following format:<br /> <p class="syntax">{STRING [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] | [FIXED [DP <span class="term">n</span>] | FLOAT]}<br /> </p></li><br /> <br /> <li>Array %variable of the following format:<br /> <p class="syntax">{STRING [LEN <span class="term">n</span>] [DP [<span class="term">n</span> | *}] [ARRAY(* [,*[,*]]) [NO FIELD SAVE]]<br /> | [FIXED [DP <span class="term">n</span>] | FLOAT] [ARRAY(* [,*[,*]])]}<br /> </p></li><br /> <br /> <li>A list of records of the following format:<br /> <p class="code">[LIST] [IN {FILE | [PERM | TEMP] GROUP} <span class="term">name</span>]<br /> </p></li><br /> </ul></li><br /> <br /> <li><br /> <var class="term">inout-option</var> specifies whether each formal parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are the same as those that can be specified on the SUBROUTINE statement: INPUT, OUTPUT, or INPUT OUTPUT. </li><br /> </ul><br /> <br /> ====DECLARE before CALL====<br /> When a <var>CALL</var> statement refers to a subroutine that has not yet been compiled, the error checking capabilities of the compiler are limited, because the number and type of formal parameters are not known to the compiler. If the first <var>CALL</var> statement for a particular subroutine is not correctly coded, then a large number of error messages can be generated when compiling subsequent <var>CALL</var> statements, although these statements might be correctly coded.<br /> <br /> You can avoid this problem in one of the following ways:<br /> <ul><br /> <li>Declare the formal parameter list with the <var>DECLARE</var> statement. When the <var>DECLARE</var> statement precedes the first <var>CALL</var>, the compiler generates the correct error messages, if problems are encountered. </li><br /> <br /> <li>Place the subroutine before the first <var>CALL</var> statement.</li><br /> </ul><br /> <br /> ====Specifying a list of records====<br /> <p><br /> If you specify a <var>LIST</var> (of records), you must also specify <var>FILE</var> or <var>GROUP</var>. For example:</p><br /> <p class="code">OPEN METADATA<br /> password<br /> <br /> BEGIN<br /> DECLARE LIST ORIG IN METADATA<br /> DECLARE SUBROUTINE THE.SUB(LIST IN FILE METADATA INOUT)<br /> .<br /> .<br /> CALL THE.SUB (LIST ORIG)<br /> .<br /> .<br /> SUBROUTINE THE.SUB(LIST ORIG IN METADATA INOUT)<br /> .<br /> .<br /> END SUBROUTINE THE.SUB<br /> END<br /> </p><br /> <p><br /> If you do not specify <var>FILE</var> or <var>GROUP</var> in the code, you receive the following error message:</p><br /> <p class="code">M204.1725: PARAMETER NUMBER n IS TYPE INCOMPATIBLE<br /> </p><br /> <br /> ====DECLARE parameters and CALL parameters====<br /> <p><br /> In the following example, note that the <var>DECLARE</var> statement lists the formal parameters, while the <var>CALL</var> statement lists the actual parameters:</p><br /> <p class="code">DECLARE SUBROUTINE SUB1(FLOAT, FIXED DP 2, STRING, STRING DP *)<br /> .<br /> .<br /> CALL SUB1(%INCREASE,%WAGES,%NAME,%DEPT)<br /> .<br /> .<br /> SUBROUTINE SUB1(%A IS FLOAT,<br /> %B IS FIXED DP 2,<br /> %C IS STRING,<br /> %D IS STRING DP *)<br /> END SUBROUTINE<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Impact on CALL and SUBROUTINE statements====<br /> <p><br /> The <var>CALL</var> and <var>SUBROUTINE</var> statements are not overridden when a <var>DECLARE SUBROUTINE</var> statement is present. The <var>DECLARE SUBROUTINE</var> statement does not cause the compiler to use more table space, nor does it alter the way in which the compiler output is generated.</p><br /> <p><br /> Rocket Software recommends that you use a <var>DECLARE SUBROUTINE</var> statement before the <var>CALL</var> statement for a subroutine or that you place the subroutine itself before the <var>CALL</var> statement. Error reporting will be more complete and specific to the subroutine.</p><br /> <br /> ===Exiting the subroutine===<br /> <p><br /> The <var>RETURN</var> statement returns control to the statement immediately following the most recent <var>CALL</var> statement. If an <var>END SUBROUTINE</var> or <var>END</var> statement is encountered without a <var>RETURN</var> statement, <var>RETURN</var> processing is implied and automatically added by the compiler. More than one <var>RETURN</var> statement can be specified in a subroutine.</p><br /> <p><br /> If a <var>JUMP</var> statement is used within a subroutine, its destination must be within the same subroutine. You cannot jump into a subroutine. </p><br /> <p><br /> A <var>STOP</var> statement, when executed inside a subroutine, terminates the request in the same manner as it does when executed outside a subroutine. </p><br /> <br /> ===Examples using complex subroutines===<br /> <p><br /> In the following example, an employee name with regular and overtime hours is passed to the subroutine <code>CALC.WAGES</code>. The total pay is returned and a list of records processed by the routine is updated.</p><br /> <p class="code">BEGIN<br /> DECLARE SUBROUTINE CALC.WAGES(FIXED DP 2, -<br /> FIXED DP 2, STRING, FIXED DP 2 OUTPUT, -<br /> LIST IN FILE EMPLOYEE INOUT)<br /> .<br /> .<br /> .<br /> CALL CALC.WAGES(%R.HRS, %OT.HRS, %NAME, -<br /> %TOTAL.PAY, LIST EMPLST)<br /> .<br /> .<br /> .<br /> SUBROUTINE CALC.WAGES(%REG IS FIXED DP 2, -<br /> %OT IS FIXED DP 2, -<br /> %E.NAME IS STRING, -<br /> %TOTAL IS FIXED DP 2 OUTPUT, -<br /> LIST EMPLIST IN FILE EMPLOYEE INOUT)<br /> <br /> %TEMP IS FIXED DP 2<br /> <br /> WAGES1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> NAME = %E.NAME<br /> END FIND<br /> FOR EACH RECORD IN WAGES1<br /> %TEMP = (RATE * %REG)<br /> %TOTAL = %TEMP + (RATE * 1.5 * %OT)<br /> END FOR<br /> PLACE RECORDS IN WAGES1 ON LIST EMPLIST<br /> RETURN<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the following example, an entire array is passed as a single subroutine parameter:</p><br /> <p class="code">BEGIN<br /> %NUMBERS IS FLOAT ARRAY(10,10)<br /> %MAX IS FLOAT<br /> DECLARE SUBROUTINE MAXIMUM(FLOAT ARRAY(*,*), -<br /> FLOAT OUTPUT)<br /> .<br /> .<br /> .<br /> CALL MAXIMUM(%NUMBERS,%MAX)<br /> .<br /> .<br /> .<br /> <br /> SUBROUTINE MAXIMUM(%ARR IS FLOAT ARRAY(*,*), -<br /> %M IS FLOAT OUTPUT)<br /> %I IS FIXED<br /> %J IS FIXED<br /> %M = 0<br /> FOR %I FROM 1 TO $arrsize('%ARR',1)<br /> FOR %J FROM 1 TO $arrsize('%ARR',2)<br /> IF %ARR(%I,%J) GT %M THEN<br /> %M = %ARR(%I,%J)<br /> END IF<br /> END FOR<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ==Sharing common elements==<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when it is declared as a common element. A common element is created by using the DECLARE statement or by using the COMMON keyword on a %variable IS declaration. For an element to be shared, it must be declared as common in every place (each separate scope) in which it is used. </p><br /> <br /> ===Scope of elements===<br /> <p><br /> The scope of an element refers to the area within a request in which an element has a particular meaning. In User Language, complex subroutines have a different scope than the remainder of the request (the elements of a complex subroutine differ from the elements outside the subroutine even when they have the same name). This concept applies to labels, lists, %variables and %variable arrays, menus, screens, and images.</p><br /> <p><br /> The elements of the main request (the statements not enclosed by any SUBROUTINE/END SUBROUTINE statements) and the elements of all simple subroutines share the same scope. Simple subroutines share the same elements with the main request and all other simple subroutines within the request. </p><br /> <br /> ===Shareable elements===<br /> <p><br /> The following elements can be shared if they are declared as common:</p><br /> <br /> ====%variables and %variable arrays====<br /> <p><br /> You can share %variables if a DECLARE %variable or a %variable IS statement that declares the %variable as common is present in each portion of the request where you use the %variable. The %variable must have the same type, length, number of decimal places, and FIELD SAVE option in each declaration. </p><br /> <br /> ====Lists of records====<br /> <p><br /> You can share a list if a DECLARE statement that declares the list as common is contained in each place where you use the list. The declaration of the list must precede the first reference to that list, or <var class="product">Model&nbsp;204</var> declares the list implicitly without the common attribute.</p><br /> <br /> ====Found sets====<br /> <p><br /> You can share found sets if the label of the FIND statement is declared as common. To effectively share a found set, follow these steps:</p><br /> <ol><br /> <li>Add a DECLARE statement that declares the statement label as common before the actual label in the portion of the request where the FIND statement will be executed.</li><br /> <li>Add a DECLARE statement that declares the label as common to any parts of the request that require access to that found set. These parts, however, cannot contain a label with the same name, or a compiler error occurs. </li><br /> </ol><br /> <p><br /> After execution of the FIND statement, you can access the record set in any portion of the request that contains the proper DECLARE statement. </p><br /> <br /> ====Menus and screens====<br /> <p><br /> You can share a menu or screen as common under the following conditions: </p><br /> <ul><br /> <li>The first reference to the menu or screen must be the complete definition of the menu or screen, with the COMMON keyword following the MENU or SCREEN statement.</li><br /> </li><br /> <li>Other parts of the request can reference the same menu or screen by using an abbreviated declaration of the form:</li><br /> <p class="code">DECLARE [MENU menuname | SCREEN screenname] COMMON<br /> </p><br /> <p><br /> If the complete definition of the menu or screen exists, and if that definition was declared as common, the menu or screen is shared. If not, a compiler error results. Two or more complete menu or screen definitions with the COMMON keyword also result in a compiler error.</p><br /> <p><br /> If you use a menu or screen %variable (:%variable) within a complex subroutine to refer to a COMMON screen element, you must include a common declaration for each possible value of the menu or screen name. </p><br /> </li><br /> </ul><br /> <br /> ====Images====<br /> <p><br /> The sharing of images follows the same rules used for the sharing of menus and screens. If multiple images are contained within the same block, then the following rules also apply:</p><br /> <ul><br /> <li>You can use the COMMON keyword on only the first IMAGE statement of a block. All other images within the same block are automatically considered as candidates for sharing as common data.</li><br /> </li><br /> <br /> <li>All other parts of the request that access common images must contain the following abbreviated form of the DECLARE statement for each image to which access is required: </li><br /> <p class="code">DECLARE IMAGE imagename COMMON<br /> </p></li><br /> </ul><br /> <br /> <br /> ===DECLARE statement===<br /> <p><br /> You can use the DECLARE statement to perform the following functions: </p><br /> <ul><br /> <li>Specify subroutine formal parameter types.</li><br /> </li><br /> <br /> <li>Specify variables, labels, lists, menus, screens, and images as COMMON.</li><br /> </li><br /> </ul><br /> <p><br /> Menus and screens are discussed in detail in [[Full-screen feature]]. </p><br /> <p><br /> Images are discussed in detail in [[Images]].</p><br /> <br /> <ul><br /> <li>To declare lists without having to use an <code>IN filename CLEAR LIST listname</code> clause. See [[Lists#Creating and clearing a list|Creating and clearing a list]].</li><br /> <br /> <li>To declare %variables, see [[Using variables and values in computation]]. </li><br /> </ul><br /> <br /> ====Syntax====<br /> <p><br /> The format of the DECLARE statement is as follows:</p><br /> <p class="syntax">DECLARE <span class="term">declaration</span><br /> </p><br /> <p><br /> where <span class="term">declaration</span> is one of the following:</p><br /> <p class="syntax">LABEL <span class="term">label</span> COMMON<br /> <br /> [LIST] <span class="term">listname</span> [IN [FILE [PERM | TEMP] GROUP] <span class="term">name</span>]<br /> [COMMON]<br /> <br /> IMAGE <span class="term">imagename</span> COMMON<br /> <br /> MENU <span class="term">menuname</span> COMMON<br /> <br /> SCREEN <span class="term">screenname</span> COMMON<br /> <br /> <span class="term">%variable</span> [IS] {FIXED [DP <span class="term">n</span>] | FLOAT}<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [COMMON]<br /> <br /> <span class="term">%variable</span> [IS] STRING [LEN <span class="term">n</span>] [DP {<span class="term">dn1</span> | *}]<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [NO FIELD SAVE] [COMMON]<br /> <br /> SUBROUTINE <span class="term">subname</span>[(<span class="term">type</span> [<span class="term">inout-option</span>] [,...]) ]<br /> </p><br /> <br /> ====Example====<br /> <p><br /> For example, the DECLARE statement declares the list RECNAMES in the following request:</p><br /> <p class="code">BEGIN<br /> DECLARE LIST RECNAMES<br /> DECLARE SUBROUTINE REGION(LIST OUTPUT, STRING)<br /> .<br /> .<br /> .<br /> CALL REGION(LIST RECNAMES, 'NORTHEAST')<br /> .<br /> .<br /> .<br /> SUBROUTINE REGION(LIST RGNLST OUTPUT, -<br /> %REGION IS STRING)<br /> <br /> R1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> REGION = %REGION<br /> R2: PLACE RECORDS IN R1 ON LIST RGNLIST<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ===Defining common variables===<br /> <p><br /> You can define common variables at the beginning of all programs without later redefinitions. The syntax lets you use the %VAR IS COMMON clause without duplicating the previous attributes.</p><br /> <p><br /> However, if attributes, such as STRING or LEN, are included in the redefinition, which differ from those previously defined, a compilation error occurs. In addition, if the variable is not previously defined, it is allocated based on the current default variable definition. </p><br /> <p><br /> For example, </p><br /> <p class="code">BEGIN<br /> VARIABLES ARE STRING LEN 20 <br /> %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON <br /> SUBROUTINE A<br /> * full definition on next line no longer required<br /> ** %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON<br /> * new syntax on next line replaces previous line<br /> %X IS COMMON /? defaults to previous %X definition ?/<br /> CALL B<br /> END SUBROUTINE<br /> <br /> SUBROUTINE B<br /> * But next line will fail compile since %X already exists<br /> %X IS STRING LEN 4 COMMON /? compiler error ?/<br /> * And the next line will result in a default definition<br /> * since %Y is not previously defined.<br /> %Y IS COMMON<br /> END SUBROUTINE<br /> PRINT %X<br /> CALL A<br /> END<br /> </p><br /> <br /> ===Shared common element examples===<br /> <p><br /> The following examples illustrate the differences between data that is locally scoped and data that is shared using the COMMON keyword. </p><br /> <br /> ====Example 1====<br /> <p><br /> In this example, the variable %I assumes different values depending upon which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> %I IS FIXED<br /> DECLARE SUBROUTINE SUBR1(STRING)<br /> .<br /> .<br /> .<br /> FOR %I FROM 1 TO 10<br /> CALL SUBR1(%ARR(%I))<br /> END FOR<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%A IS STRING)<br /> %I IS FIXED<br /> FOR %I FROM 1 TO 10<br /> PRINT %I and %A<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ====Example 2====<br /> <p><br /> In this example, the screen EXAMPLE and the %A and %B variables retain the same values no matter which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> SCREEN EXAMDEF COMMON<br /> TITLE 'THIS IS A COMMON SCREEN DEFINITION'<br /> PROMPT 'ENTER VALUE'<br /> INPUT FLD1 AT 10 LEN 20 PAD '_'<br /> END SCREEN<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> DECLARE SUBROUTINE SUBR1(STRING LEN 10)<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%Z IS STRING LEN 10)<br /> DECLARE SCREEN EXAMDEF COMMON<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> .<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Example 3====<br /> <p><br /> In this example, the main request and the subroutine share the common data of an array and a found set:</p><br /> <p class="code">BEGIN<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> DECLARE SUBROUTINE EXAMPLE<br /> .<br /> .<br /> .<br /> ALL.RECS: FIND ALL RECORDS<br /> END FIND<br /> %I = 0<br /> %J = 1<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD<br /> END FOR<br /> CALL EXAMPLE<br /> STOP<br /> <br /> SUBROUTINE EXAMPLE<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> %I = 0<br /> %J = 2<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD2<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the preceding example, the main request updates column 1 of the array %COMM.ARRAY with the contents of FLD. The subroutine, EXAMPLE, updates column 2 of the same array with the contents of FLD2. Both the array %COM.ARRAY and the found set ALL.RECS are shared by using the COMMON keyword. %I and %J are both local variables. %I is local because it was declared without the COMMON keyword; %J is local because it was not declared at all. </p><br /> <br /> <div id="On statement"></div> <br /> ==On units== <br /> <p><br /> An <var>On</var> unit lets you specify a course of action following a triggering event, such as the terminal operator pressing one of the <var>Attention</var> identifier (AID) keys. The <var>On</var> unit provides an application with a way to override the normal system response. </p><br /> <br /> ====Syntax====<br /> <p><br /> To define an <var>On</var> unit, use an <var>On</var> block in the following format:</p><br /> <p class="syntax">[<span class="term">label</span>] On <span class="term">unittype</span><br /> <span class="term">statement</span><br /> <span class="literal">...</span><br /> End On<br /> </p><br /> <p><br /> where <var class="term">unittype</var> is one of the following:</p><br /> <table><br /> <tr class="head"><br /> <th>unittype</th><br /> <th>You can specify the course of action to take if...</th><br /> </tr><br /> <br /> <tr><br /> <td>ATTENTION</td><br /> <td>The end user invokes the attention feature (for example, presses the <var>BREAK, ATTN,</var> or <var>PA1</var> key, or enters <var>*CANCEL</var>). </td><br /> </tr><br /> <br /> <tr><br /> <td>ERROR</td><br /> <td><var class="product">Model&nbsp;204</var> cancels a request. Before a request is canceled or, for transaction backout files, after the current transaction is backed out, the ON ERROR unit is processed instead of returning control to the terminal command level. For more information on transaction backout files, see [[Data recovery]]. </td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>FIELD CONSTRAINT<br /> CONFLICT (FCC)</td><br /> <td>There are field level constraint conflicts. Violating the UNIQUE and AT-MOST-ONE attributes causes field-level conflicts.*</td><br /> </tr><br /> <br /> <tr><br /> <td>FIND CONFLICT</td><br /> <td>A conflict arises evaluating a FIND statement or a FOR EACH RECORD statement used for retrieval.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING FILE</td><br /> <td>A remote file is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING MEMBER</td><br /> <td>A remote optional member is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>RECORD LOCKING CONFLICT</td><br /> <td>A conflict arises during a record locking attempt.</td><br /> </tr><br /> </table><br /> <p><br /> *If you have procedures written for <var class="product">Model&nbsp;204</var> V2R1.0 that use ON FCC for UNIQUE fields, and you are planning to use ON FCC for AT-MOST-ONE fields, you might need to rewrite the ON FCC unit to take the new value of $UPDSTAT (2 for AT-MOST-ONE) into account. </p><br /> <p><br /> Several $functions provide information about conflicts. They are:</p><br /> <table><br /> <tr><br /> <td>[[$UpdFile]]</td><br /> <td>[[$UpdFld]]</td><br /> <td>[[$UpdOval]]</td><br /> <td>[[$UpdRec]]</td><br /> </tr><br /> <tr><br /> <td>[[$UpdStat]]</td><br /> <td>[[$UpdStmt]]</td><br /> <td>[[$UpdVal]]</td><br /> <td>[[$UnqRec]]</td><br /> </tr><br /> </table><br /> <br /> ===Body of an ON unit===<br /> <p><br /> The body of the ON unit consists of statements immediately following the ON statement. Any User Language statement can appear within an ON unit except the SUBROUTINE statement.</p><br /> <br /> ===Ending an ON unit===<br /> <p><br /> You must conclude an ON unit with either an END ON statement or an END BLOCK statement. The format of the END ON statement is as follows:</p><br /> <p class="syntax">END ON [<span class="term">label</span>]<br /> </p><br /> <p><br /> where <var class="term">label</var> is the label of the statement that began the ON statement. </p><br /> <br /> ===Processing an ON unit===<br /> <p><br /> When an ON statement is evaluated, <var class="product">Model&nbsp;204</var> remembers the location of the ON unit body (the statement after the ON statement and within the unit), but does not immediately evaluate the body. Instead, it passes control to the statement immediately following the ON unit. The ON unit body is evaluated only when the triggering event takes place.</p><br /> <br /> ===Usage guidelines for ON units===<br /> <p><br /> Note the following considerations when using ON units:</p><br /> <ul><br /> <li>You must define the ON unit before it is invoked (that is, you should typically place the ON unit near the beginning of your procedure). </li><br /> <br /> <li>A subsequent definition of an ON unit of the same kind replaces the previous one. For example, if you define two ON ATTN units, the second one becomes the current one.</li><br /> <br /> <li>You can jump to destinations within the same ON unit. </li><br /> <br /> <li>You can jump out of an ON unit only to unnested, labeled statements.</li><br /> <br /> <li>You cannot jump into an ON unit.</li><br /> <br /> <li>You can jump outside of an ON unit only if the ON unit is part of a main routine or part of a complex subroutine. </li><br /> <br /> <li>You cannot jump out of an ON unit contained in a simple subroutine, regardless of whether the destination is within the subroutine or back in the mainline program, because ON units are part of the mainline program; hence, there is no scoping of ON units. This restriction ensures that the ON unit is executed and the control returned to the main routine.</li><br /> <br /> <li>An ON unit definition is not preserved when a request is continued with an END MORE statement and a MORE command. Each new request continuation must define its own ON units. (See [[Large request considerations#Rules for request continuation|Rules for request continuation]].)</li><br /> <br /> <li>For complex subroutines, an active ON unit is temporarily disabled when a subroutine is called that contains an ON UNIT of the same type; it is restored when the subroutine returns. Any ON unit enabled during the execution of a subroutine is replaced by the active ON unit at the time of the last CALL statement as soon as the RETURN statement is evaluated.</li><br /> <br /> <li>ON units coded inside complex subroutines can contain JUMP statements that specify a destination outside the ON unit. The destination must be to an unnested labeled statement within the complex subroutine. Also, if the ON unit is to be jumped out of, the condition that causes the ON unit to be invoked must be raised in the subroutine that contains the ON unit.<br /> <p><br /> This prevents a lower level subroutine from returning inadvertently by raising a condition for which there is an ON unit coded in a higher level subroutine. If the inadvertent return is attempted, the request is canceled. </p><br /> </li><br /> <br /> <li>ON units do not have their own local data and labels. They inherit the scope of the part of the program in which they are compiled. An ON unit that is compiled within a complex subroutine is considered part of only that subroutine. <br /> </li><br /> </ul><br /> <br /> ====Example====<br /> <p><br /> In the following example, if the user presses the<var> ATTN</var> key instead of entering a response to the prompt in the GET.REC.TYPE statement, the ON ATTENTION unit sets %FLAG to 1. The FLAG.SET statement tests %FLAG. If %FLAG is set, the request branches to END.REQUEST and the FIND statement is not executed. </p><br /> <p class="code">%FLAG=0<br /> ON ATTENTION<br /> %FLAG=1<br /> BYPASS<br /> END ON<br /> GET.REC.TYPE: %TYPE=$READ('ENTER RECORD TYPE')<br /> FLAG.SET: IF %FLAG=1 THEN<br /> JUMP TO END.REQUEST<br /> END IF<br /> FIND.RECS: FIND ALL RECORDS FOR WHICH<br /> TYPE = %TYPE<br /> END FIND<br /> .<br /> .<br /> .<br /> END.REQUEST:<br /> END<br /> </p><br /> <br /> ===Only one ON unit at a time===<br /> <p><br /> Only one ON unit of each kind is active at a time. For example, the processing of a second ON ERROR statement resets the current ON ERROR unit, but does not affect the current ON ATTENTION unit. Thus, you can redefine what to do in a variety of cases by having several ON statements and units within a request. An ON unit can be redefined within another ON unit.</p><br /> <br /> ===Passing control to and from ON units===<br /> <p><br /> <var class="product">Model&nbsp;204</var> passes control to an ON unit when the triggering event occurs. For example, an ON ATTENTION unit receives control when a user presses one of the ATTENTION identifier (AID) keys at the terminal during the execution of a request. Use one of the following statements to return control to the body of the request. </p><br /> <br /> ====BYPASS statement====<br /> <p><br /> The BYPASS statement handles the various unittypes of an ON statement as follows:</p><br /> <table><br /> <tr class="head"><br /> <th>For unittype...</th><br /> <th>The BYPASS statement...</th><br /> </tr><br /> <tr><br /> <td>ON MISSING FILE<br><br /> ON MISSING MEMBER</td><br /> <td>Returns control to the statement immediately after the END FOR statement that closes the current FOR loop. </td><br /> </tr><br /> <tr><br /> <td>ON ERROR</td><br /> <td>Ends the request.</td><br /> </tr><br /> <tr><br /> <td nowrap>ON ATTENTION<br><br /> ON FIND CONFLICT<br><br /> ON RECORD LOCKING CONFLICT</td><br /> <td>Returns control to the statement immediately after the statement that invoked the ON unit.</td><br /> </tr><br /> </table><br /> <p><br /> The format of the BYPASS statement is as follows:</p><br /> <p class="syntax">BYPASS [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the PENDING STATEMENT keyword is optional. If the ON unit is not ended with a BYPASS statement, <var class="product">Model&nbsp;204</var> automatically generates a STOP statement at the end of the unit. </p><br /> <br /> ====CONTINUE statement====<br /> <p><br /> The CONTINUE statement is supported only with the Parallel Query Option. If you lose access to a group member that is an optional file during FOR processing, the CONTINUE statement continues FOR processing with the next available file, and skips any other unavailable files.</p><br /> <br /> ====JUMP TO statement====<br /> <p><br /> The JUMP statement, when used to jump to a labeled statement outside the ON unit, causes the request to continue at that point. There are restrictions pertaining to jumps; see [[Flow of control in User Language#Branching statements|Branching statements]] and [[#Simple subroutines|Simple subroutines]]. </p><br /> <br /> ====RETRY statement====<br /> <p><br /> The RETRY statement passes control to the statement that invoked the ON unit, thereby retrying that statement. The RETRY statement is not valid in an ON ERROR unit.</p><br /> <p><br /> The format of the RETRY statement is as follows:</p><br /> <p class="syntax">RETRY [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the <var>PENDING STATEMENT</var> keyword is optional.</p><br /> <br /> ====STOP statement====<br /> <p><br /> The STOP statement is used to end the request. </p><br /> <br /> ===Clearing ON units===<br /> <p><br /> You can issue the following statement to clear the definition of an ON unit: </p><br /> <p class="syntax">CLEAR ON <span class="term">unittype</span><br /> </p><br /> <p><br /> This statement clears any defined ON unit of the type specified. Clearing an ON unit produces the following results:</p><br /> <br /> <ul><br /> <li>After a CLEAR ON ATTENTION, pressing one of the ATTENTION identifier (AID) keys at the terminal does not invoke the ON ATTENTION unit.</li><br /> <br /> <li>After a CLEAR ON ERROR, a request cancellation error does not invoke the ON ERROR unit. </li><br /> </ul><br /> <p><br /> An ON unit can be defined, cleared, and then redefined. </p><br /> <br /> ===Pausing during the request===<br /> <p><br /> The PAUSE statement can be used with ON units to cause the request to wait a specified time and then to retry the statement that caused the evaluation of the ON unit. PAUSE is typically used with the other ON unit types (RECORD LOCKING CONFLICT and ON FIND CONFLICT) and is discussed in [[Record level locking and concurrency control]]. </p><br /> <br /> </div> <br /> <br /> [[Category:SOUL]]</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Subroutines&diff=78429 Subroutines 2015-07-23T03:40:47Z

<p>Heikki: /* Defining common variables */</p> <hr /> <div><div class="toclimit-3"><br /> <br /> ==Overview==<br /> <p><br /> User Language lets you treat a single set of statements as a simple or complex subroutine. You can:</p><br /> <ul><br /> <li>Execute simple subroutines a number of times from different locations within a request.</li><br /> <li>Use complex subroutines as you would simple subroutines. </li><br /> </ul><br /> In addition, you can:<br /> <ul><br /> <li>Pass parameters via parameter lists.</li><br /> <li>Declare variables locally.</li><br /> </ul><br /> <br /> ===Common elements===<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when you declare that element as COMMON.</p><br /> <br /> ===ON units===<br /> <p><br /> An ON unit specifies a response action to a triggering event: for example, the terminal operator pressing one of the ATTENTION identifier (AID) keys. ON units let an application override the normal system response.</p><br /> <br /> ==Simple subroutines==<br /> <br /> ===Outlining a simple subroutine===<br /> <p><br /> The following statements are used in simple subroutines within a request:</p><br /> <table><br /> <tr class="head"><br /> <th>Statement</th><br /> <th>Purpose</th></tr><br /> <br /> <tr><br /> <td><var>CALL</var></td><br /> <td>Transfers control to the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>END SUBROUTINE</var></td><br /> <td>Indicates the end of the subroutine.</td></tr><br /> <br /> <tr><br /> <td><var>JUMP TO</var></td><br /> <td>Transfers control to another statement in the request.</td></tr><br /> <br /> <tr><br /> <td><var>RETURN</var></td><br /> <td>Returns control to the statement immediately following the CALL statement. </td></tr><br /> <br /> <tr><br /> <td><var>SUBROUTINE</var></td><br /> <td>Indicates the beginning of a subroutine. </td></tr><br /> </table><br /> <p><br /> The statements are coded in the following sequence, so they are described in order of usage.</p><br /> <ol><br /> <li><var>SUBROUTINE</var> statement</li><br /> <li><var>JUMP TO</var> and <var>RETURN</var> statements as appropriate</li><br /> <li><var>END SUBROUTINE</var> statement</li><br /> <li><var>CALL</var> statement</li><br /> </ol><br /> <br /> ===SUBROUTINE statement===<br /> <p><br /> A simple subroutine consists of a sequence of SOUL statements that must begin with a <var>SUBROUTINE</var> statement. The body of the subroutine is composed of the statements immediately following the <var>SUBROUTINE</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>SUBROUTINE</var> statement is: </p><br /> <p class="syntax"><span class="term">label</span>: SUBROUTINE<br /> </p><br /> <p><br /> A simple subroutine must be labeled; without a label it cannot be executed. You cannot use field names in the subroutine, except within a FOR loop, even if the subroutine is always called from within a record loop.</p><br /> <br /> ====Example of a simple subroutine====<br /> <p><br /> The following request uses two subroutines. </p><br /> <p class="note"><b>Note:</b> Simple subroutine statements in the following example are described more fully after this example.</p><br /> <p><br /> The first subroutine, <code>TOTAL</code>, accumulates a total in the %variable named <code>%TOTAL.MUSTANGS</code>. The second subroutine, <code>PRINT.TOTAL</code>, prints a literal that varies depending on the total accumulated. </p><br /> <p class="code">BEGIN<br /> MUSTANGS: FIND ALL RECORDS FOR WHICH<br /> MODEL = MUSTANG<br /> END FIND<br /> FOR EACH RECORD IN MUSTANGS<br /> CALL TOTAL<br /> END FOR<br /> CALL PRINT.TOTAL<br /> TOTAL: SUBROUTINE<br /> %TOTAL.MUSTANGS = %TOTAL.MUSTANGS + 1<br /> RETURN<br /> END SUBROUTINE TOTAL<br /> PRINT.TOTAL: SUBROUTINE<br /> IF %TOTAL.MUSTANGS LE 10 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 10'<br /> ELSEIF %TOTAL.MUSTANGS LE 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> NOT GREATER THAN 50'<br /> ELSEIF %TOTAL.MUSTANGS GT 50 THEN<br /> PRINT 'TOTAL MUSTANG POLICIES -<br /> GREATER THAN 50'<br /> END IF<br /> RETURN<br /> END SUBROUTINE PRINT.TOTAL<br /> END<br /> </p><br /> <br /> ===JUMP TO statements===<br /> <p><br /> <var class="product">Model&nbsp;204</var> compiles subroutines only after they are called, regardless of where they are in your program.</p><br /> <p><br /> If you use a <var>JUMP TO</var> statement, its destination must be within the same subroutine. You cannot jump into a subroutine from outside of a subroutine.</p><br /> <br /> ===RETURN statement===<br /> <p><br /> The <var>RETURN</var> statement returns control from the subroutine to the statement following the most recent <var>CALL</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>RETURN</var> statement is: </p><br /> <p class="syntax">RETURN<br /> </p><br /> <p><br /> The <var>RETURN</var> statement can appear only within the body of a subroutine. Use of the <var>RETURN</var> statement inside of an <var>ON</var> unit terminates compilation, the procedure cannot run, and the following message is produced: </p><br /> <p class="code">M204.1779 RETURN IS INVALID IN ON UNITS, USE BYPASS STATEMENT<br /> </p><br /> <p><br /> <var class="product">Model&nbsp;204</var> automatically generates a return at the end of a subroutine, if you do not specify one. </p><br /> <p><br /> For more information, see [[#ON units|ON units]] and [[#Passing control to and from ON units|Passing control to and from ON units]].</p><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> You can end a subroutine using an <var>END SUBROUTINE</var> statement or an <var>END BLOCK</var> statement. </p><br /> <br /> ====Syntax====<br /> <p><br /> The END SUBROUTINE statement is formatted as follows: </p><br /> <p class="syntax">END SUBROUTINE <span class="squareb">[</span><span class="term">label</span><span class="squareb">]</span><br /> </p><br /> <br /> ===CALL statement===<br /> <p><br /> The <var>CALL</var> statement transfers control to the subroutine. </p><br /> <br /> ====Syntax====<br /> <p><br /> The format of the <var>CALL</var> statement is:</p><br /> <p class="syntax">CALL <span class="term">label</span><br /> </p><br /> <br /> ====Example====<br /> <p><br /> This statement:</p><br /> <p class="code">CALL.SUB: CALL COMPUTE.PREMIUM<br /> </p><br /> <p><br /> transfers control to the following statement:</p><br /> <p class="code">COMPUTE.PREMIUM: SUBROUTINE<br /> </p><br /> <p><br /> When you use a simple subroutine, no arguments are passed in subroutine calls. Instead, input and output values are implicitly passed in %variables or global variables. If you want field values as arguments, you must assign the values to %variables before the call, or the subroutine must contain its own <var>FOR EACH RECORD</var> loop on the set of records to be processed.</p><br /> <p><br /> Processing continues sequentially from that statement until another control transfer statement &mdash; a <var>CALL</var>, <var>IF</var>, <var>JUMP TO</var>, <var>RETURN</var>, or <var>STOP</var> statement &mdash; is encountered. </p><br /> <br /> ==Complex subroutines==<br /> <p><br /> Complex subroutines perform all the operations of a simple subroutine. In addition, a complex subroutine can pass parameters via parameter lists and can declare local variables. </p><br /> <p class="note"><b>Note:</b> The format of the <var>SUBROUTINE</var> statement changes for a complex subroutine and the <var>CALL</var> statement is also more complex.</p><br /> <br /> ===Symbolic parameter passing===<br /> <p><br /> You can specify positional parameters on the <var>CALL</var> statement for a complex subroutine. These parameters are substituted for symbolic parameters used within the subroutine during execution. You can use the following elements as parameters to a complex subroutine:</p><br /> <ul><br /> <li>Scalar %variables</li><br /> <br /> <li>%variable arrays</li><br /> <br /> <li>Lists of records</li><br /> </ul><br /> <br /> ===Local variable declaration===<br /> <p><br /> Labels, %variables, and other elements in a complex subroutine are local to the subroutine; they do not conflict with elements of the same name in the request or in other complex subroutines. This allows the same element to be used in different portions of a request, and for the same name to describe different elements in each portion.</p><br /> <br /> ===Processing===<br /> <p><br /> All data within the subroutine is statically allocated. When the subroutine is called, the values of all found sets, counts, noted values, and variables are as they were when the subroutine was last executed. Recursive calls to the same subroutine do not allocate separate storage for each subroutine local variable. Local variables are allocated only one time.</p><br /> <br /> ====OPEN statement within a complex subroutine====<br /> <p><br /> A SOUL <var>OPEN</var> statement &mdash; an <var>OPEN</var> statement inside a <var>BEGIN/END</var> &mdash; when used within a complex subroutine on a file that is not defined to the region produces the following counting error and the request is not compiled:</p><br /> <p class="code">M204.1521: <i>entity-name</i> DOES NOT EXIST OR REQUESTED ACCESS NOT AUTHORIZED<br /> </p><br /> <br /> ===SUBROUTINE statement for complex subroutines===<br /> <p><br /> Complex subroutines begin with the following form of the <var>SUBROUTINE</var> statement: </p><br /> <p class="syntax">SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">formal-parameter</span> <br /> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span><br /> </p><br /> Where:<br /> <p><br /> <var class="term">subname</var> is the name of the subroutine.</p><br /> <p><br /> <var class="term">formal-parameter</var> is the declaration of a symbolic parameter used within the subroutine. The parameter list is comprised of the <var class="term">formal-parameter</var> and subsequent input-options. The parameter list is enclosed in parentheses, and it contains declarations for each parameter separated by commas. The parameter list must be specified on one logical line. Null parameters are not allowed.</p><br /> <p><br /> <var class="term">formal-parameter</var> specifies the name and type of element to be used within the subroutine and can be any of the following:</p><br /> <ul><br /> <li>Scalar (nonarray) %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] {[STRING] [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] <br /> <span class="squareb">|</span> [FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT]}<br /> </p><br /> <p><br /> For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE (%W IS STRING DP * -<br /> %X IS STRING LEN 40, -<br /> %Y IS STRING LEN 10 DP 2, -<br /> %Z IS FLOAT, -<br /> %A IS FIXED DP 4)<br /> </p></li><br /> <br /> <li>Array %variable formatted as:</li><br /> <p class="syntax"><span class="term">%variable</span> [IS] [[STRING] [LEN <span class="term">n</span>] [DP {<span class="term">n</span> | *}] <br /> [ARRAY(* [,*[,*]])] [NO FIELD SAVE] <br /> <span class="squareb">|</span> <span class="squareb">{</span>FIXED [DP <span class="term">n</span>] <span class="squareb">|</span> FLOAT<span class="squareb">}</span> [ARRAY(* [,*[,*]])]]<br /> </p><br /> <p><br /> The number of dimensions must be specified in the subroutine declaration, but the exact size of each dimension is not specified. An asterisk (*) is used instead of the dimension size. For example:</p><br /> <p class="code">SUBROUTINE EXAMPLE(%ARR IS STRING LEN 10 - ARRAY(*,*))<br /> </p></li><br /> <br /> <li>A list of records formatted as:<br /> <p class="syntax">[LIST] <span class="term">listname</span> [IN [FILE | [PERM | TEMP] GROUP]] <span class="term">name</span> <br /> </p><br /> <p><br /> The context of the list is restricted to a single file or group. For example:</p><br /> <p class="code">SUBROUTINE GENERAL(LIST TOTRECS IN FILE VEHICLES)<br /> </p></li><br /> </ul><br /> <p><br /> <var class="term">inout-option</var> specifies whether a formal-parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are as follows:</p><br /> <br /> <table><br /> <tr class="head"><br /> <th>Option</th><br /> <th>Data can be...</th><br /> </tr><br /> <br /> <tr><br /> <td>INPUT<br><br /> (the default)</td><br /> <td>Passed into, but not out of, a subroutine. In addition, data conversions are performed automatically, in the same manner as an assignment statement. All references to <var>INPUT</var> parameters that update the parameter, for example, assignment statements, result in compiler errors.</td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>INPUT OUTPUT</td><br /> <td>This option is equivalent to the OUTPUT option. </td><br /> </tr><br /> <br /> <tr><br /> <td>OUTPUT</td><br /> <td><br /> <p><br /> Returned from a subroutine. No data conversions are performed.</p><br /> <p><br /> The lengths of complex subroutine string OUTPUT parameters are inherited from calling parameters. If the lengths are specified in the subroutine declaration, the following message is written to the audit trail: </p><br /> <p class="code">M204.1981 LENGTH IGNORED FOR OUTPUT PARAMETER<br /> </p><br /> <p><br /> Compilation and evaluation of the procedure continues, with the inherited length.</p><br /> </td><br /> </tr><br /> </table><br /> <br /> ===END SUBROUTINE statement===<br /> <p><br /> Like simple subroutines, a complex subroutine ends with an <var>END SUBROUTINE</var> statement. However, unlike simple subroutines, you must not label the <var>SUBROUTINE</var> statement. </p><br /> <p><br /> All declarations and statements compiled after the <var>SUBROUTINE</var> statement become a part of the subroutine until the <var>END SUBROUTINE</var> statement is encountered or until the request is ended with the <var>END</var> statement. </p><br /> <br /> ===CALL statement===<br /> <p><br /> The execution of a <var>CALL</var> statement passes control to a complex subroutine. The first time a subroutine is called, all elements in the subroutine are initialized. Subsequently, each time the subroutine is called, all elements in the subroutine remain in the same state as they were when the subroutine was last exited. You are responsible for reinitializing the elements within the subroutine.</p><br /> <br /> ====Syntax====<br /> <p><br /> A complex subroutine is invoked with this form of the <var>CALL</var> statement:</p><br /> <p class="syntax">CALL <span class="term">subname</span> [(<span class="term">actual-parameter</span> [, ...])]<br /> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">actual-parameter</var> specifies the actual data that replaces the symbolic formal-parameter within the subroutine. At execution time, the value of each actual-parameter is substituted, based on the order in which it appears, for a formal-parameter declared for the subroutine. The correspondence of each formal-parameter in the <var>SUBROUTINE</var> statement to an actual-parameter in the <var>CALL</var> statement is by position rather than by name.<br /> <p><br /> An actual-parameter can be any of the following:</p><br /> <ul><br /> <li>%variable or expression<br /> <p><br /> Expressions can contain field names, screen items, image items, and constants.</p></li><br /> <br /> <li>Array %variable<br /> <p><br /> When an entire array is passed as a parameter, the %variable name is used with the percent (%) sign, but no parenthesis or subscript expressions follow it. For example:</p><br /> <p class="code">BEGIN<br /> %A IS FLOAT ARRAY(10,10)<br /> DECLARE SUBROUTINE FDO(FLOAT ARRAY(*,*))<br /> .<br /> .<br /> .<br /> CALL FDO (%A)<br /> .<br /> .<br /> .<br /> SUBROUTINE FDO (%B IS FLOAT ARRAY(*,*))<br /> PRINT %B(1,1)<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> The <var>[[$ArrSize]]</var> function can be used to determine the number of elements in a particular dimension of an array. </p></li><br /> <br /> <li>A list<br /> <p><br /> An actual-parameter can be a list, optionally preceded by the word LIST to distinguish it from a field name. </p><br /> <p><br /> If the compiler already knows of the formal-parameter list because the subroutine is already compiled or declared, the LIST keyword is unnecessary. </p><br /> <p><br /> If the list has never been declared in the request, a compilation error results. </p><br /> </li></ul><br /> </li></ul><br /> <br /> ====Additional rules for parameters====<br /> <p><br /> The following additional rules apply to actual-parameters and parameter passing:</p><br /> <ul><br /> <li>The maximum number of parameters that can be passed in complex subroutines is 63.</li><br /> <br /> <li>If the formal-parameter is specified as an OUTPUT parameter, the corresponding actual-parameter must match type.</li><br /> <br /> <li>The INPUT parameters of a %variable array requires that the type of the array &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; the <var>DP</var> specification, and the number of dimensions match the actual-parameter. In addition, if the <var>NO FIELD SAVE</var> (<var>NO FS</var>) option is specified for a <var>STRING</var> formal-parameter, it also must be specified for the corresponding actual-parameter and vice versa. All checking of array bounds within subroutines occurs during evaluation.</li><br /> <br /> <li>The INPUT parameters of a list requires the same file or group context as the actual-parameter.<br /> </li><br /> <br /> <li>An INPUT parameter of a scalar %variable can be called with an actual-parameter that is an expression or %variable of a differing type. <var class="product">Model&nbsp;204</var> converts the actual-parameter to the type required by the subroutine, according to the rules of the assignment statement. The converted value has a separate storage location from the original variable or expression.<br /> <p><br /> Passing arguments to INPUT parameters might involve truncation where the number of decimal places is different, or conversion to 0 for non-numeric strings.</p><br /> </li><br /> <br /> <li>OUTPUT parameters of lists and %variable arrays follow the same rules as INPUT parameters for lists and %variable arrays.</li><br /> </li><br /> <br /> <li>OUTPUT parameters of scalar %variables require that the actual-parameter supplied in the <var>CALL</var> statement be another scalar %variable (no constants or expressions) of the same type &mdash; <var>FLOAT</var>, <var>FIXED</var>, or <var>STRING</var> &mdash; and that the number of decimal places be the same, or the following message is issued by <var class="product">Model&nbsp;204</var>:<br /> <p class="code">M204.1725 PARAMETER NUMBER <i>n</i> IS TYPE INCOMPATIBLE<br /> </p><br /> <p><br /> Strings can be of any length. The length used is that of the actual input parameter. </p><br /> </li><br /> </ul><br /> <br /> ===Processing complex subroutines===<br /> <p><br /> Checking for the validity of parameter lists occurs during compilation. When the SUBROUTINE statement is compiled, the types of parameters are saved by the compiler, and any subsequent CALL statements are verified as to whether the actual parameter is consistent with the type of formal parameter.</p><br /> <p><br /> When a CALL statement is compiled and the subroutine to which it refers has not been compiled, the compiler verifies whether the actual parameter list is compatible with other CALL statements for the subroutine that it has already compiled. </p><br /> <p><br /> The compiler cannot verify that the actual parameters are compatible with the SUBROUTINE statement until that SUBROUTINE statement is compiled. If the compiler then detects a CALL statement that is not compatible with the SUBROUTINE statement, an error is issued at that time. Checking is done at compile time, so a statement that is not executed during evaluation can still generate an error. </p><br /> <br /> ===DECLARE SUBROUTINE statement===<br /> <p><br /> The DECLARE statement for a complex subroutine is similar to the SUBROUTINE statement, except that the parameter names are omitted. </p><br /> <br /> ====Syntax====<br /> The complete syntax for the DECLARE SUBROUTINE statement is:<br /> <p class="syntax">DECLARE SUBROUTINE <span class="term">subname</span> <span class="squareb">[</span>(<span class="term">type</span> <span class="squareb">[</span><span class="term">inout-option</span><span class="squareb">]</span> <span class="squareb">[</span>, ...<span class="squareb">]</span>)<span class="squareb">]</span> </p><br /> Where:<br /> <ul><br /> <li><var class="term">subname</var> is the name of the subroutine.</li><br /> <br /> <li><var class="term">type</var> is one of the following:<br /> <ul><br /> <li>Scalar %variable of the following format:<br /> <p class="syntax">{STRING [LEN] <span class="term">n</span> [DP {<span class="term">n</span> | *}] | [FIXED [DP <span class="term">n</span>] | FLOAT]}<br /> </p></li><br /> <br /> <li>Array %variable of the following format:<br /> <p class="syntax">{STRING [LEN <span class="term">n</span>] [DP [<span class="term">n</span> | *}] [ARRAY(* [,*[,*]]) [NO FIELD SAVE]]<br /> | [FIXED [DP <span class="term">n</span>] | FLOAT] [ARRAY(* [,*[,*]])]}<br /> </p></li><br /> <br /> <li>A list of records of the following format:<br /> <p class="code">[LIST] [IN {FILE | [PERM | TEMP] GROUP} <span class="term">name</span>]<br /> </p></li><br /> </ul></li><br /> <br /> <li><br /> <var class="term">inout-option</var> specifies whether each formal parameter is to be used as input to the subroutine or passed as output from the subroutine. Options are the same as those that can be specified on the SUBROUTINE statement: INPUT, OUTPUT, or INPUT OUTPUT. </li><br /> </ul><br /> <br /> ====DECLARE before CALL====<br /> When a <var>CALL</var> statement refers to a subroutine that has not yet been compiled, the error checking capabilities of the compiler are limited, because the number and type of formal parameters are not known to the compiler. If the first <var>CALL</var> statement for a particular subroutine is not correctly coded, then a large number of error messages can be generated when compiling subsequent <var>CALL</var> statements, although these statements might be correctly coded.<br /> <br /> You can avoid this problem in one of the following ways:<br /> <ul><br /> <li>Declare the formal parameter list with the <var>DECLARE</var> statement. When the <var>DECLARE</var> statement precedes the first <var>CALL</var>, the compiler generates the correct error messages, if problems are encountered. </li><br /> <br /> <li>Place the subroutine before the first <var>CALL</var> statement.</li><br /> </ul><br /> <br /> ====Specifying a list of records====<br /> <p><br /> If you specify a <var>LIST</var> (of records), you must also specify <var>FILE</var> or <var>GROUP</var>. For example:</p><br /> <p class="code">OPEN METADATA<br /> password<br /> <br /> BEGIN<br /> DECLARE LIST ORIG IN METADATA<br /> DECLARE SUBROUTINE THE.SUB(LIST IN FILE METADATA INOUT)<br /> .<br /> .<br /> CALL THE.SUB (LIST ORIG)<br /> .<br /> .<br /> SUBROUTINE THE.SUB(LIST ORIG IN METADATA INOUT)<br /> .<br /> .<br /> END SUBROUTINE THE.SUB<br /> END<br /> </p><br /> <p><br /> If you do not specify <var>FILE</var> or <var>GROUP</var> in the code, you receive the following error message:</p><br /> <p class="code">M204.1725: PARAMETER NUMBER n IS TYPE INCOMPATIBLE<br /> </p><br /> <br /> ====DECLARE parameters and CALL parameters====<br /> <p><br /> In the following example, note that the <var>DECLARE</var> statement lists the formal parameters, while the <var>CALL</var> statement lists the actual parameters:</p><br /> <p class="code">DECLARE SUBROUTINE SUB1(FLOAT, FIXED DP 2, STRING, STRING DP *)<br /> .<br /> .<br /> CALL SUB1(%INCREASE,%WAGES,%NAME,%DEPT)<br /> .<br /> .<br /> SUBROUTINE SUB1(%A IS FLOAT,<br /> %B IS FIXED DP 2,<br /> %C IS STRING,<br /> %D IS STRING DP *)<br /> END SUBROUTINE<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Impact on CALL and SUBROUTINE statements====<br /> <p><br /> The <var>CALL</var> and <var>SUBROUTINE</var> statements are not overridden when a <var>DECLARE SUBROUTINE</var> statement is present. The <var>DECLARE SUBROUTINE</var> statement does not cause the compiler to use more table space, nor does it alter the way in which the compiler output is generated.</p><br /> <p><br /> Rocket Software recommends that you use a <var>DECLARE SUBROUTINE</var> statement before the <var>CALL</var> statement for a subroutine or that you place the subroutine itself before the <var>CALL</var> statement. Error reporting will be more complete and specific to the subroutine.</p><br /> <br /> ===Exiting the subroutine===<br /> <p><br /> The <var>RETURN</var> statement returns control to the statement immediately following the most recent <var>CALL</var> statement. If an <var>END SUBROUTINE</var> or <var>END</var> statement is encountered without a <var>RETURN</var> statement, <var>RETURN</var> processing is implied and automatically added by the compiler. More than one <var>RETURN</var> statement can be specified in a subroutine.</p><br /> <p><br /> If a <var>JUMP</var> statement is used within a subroutine, its destination must be within the same subroutine. You cannot jump into a subroutine. </p><br /> <p><br /> A <var>STOP</var> statement, when executed inside a subroutine, terminates the request in the same manner as it does when executed outside a subroutine. </p><br /> <br /> ===Examples using complex subroutines===<br /> <p><br /> In the following example, an employee name with regular and overtime hours is passed to the subroutine <code>CALC.WAGES</code>. The total pay is returned and a list of records processed by the routine is updated.</p><br /> <p class="code">BEGIN<br /> DECLARE SUBROUTINE CALC.WAGES(FIXED DP 2, -<br /> FIXED DP 2, STRING, FIXED DP 2 OUTPUT, -<br /> LIST IN FILE EMPLOYEE INOUT)<br /> .<br /> .<br /> .<br /> CALL CALC.WAGES(%R.HRS, %OT.HRS, %NAME, -<br /> %TOTAL.PAY, LIST EMPLST)<br /> .<br /> .<br /> .<br /> SUBROUTINE CALC.WAGES(%REG IS FIXED DP 2, -<br /> %OT IS FIXED DP 2, -<br /> %E.NAME IS STRING, -<br /> %TOTAL IS FIXED DP 2 OUTPUT, -<br /> LIST EMPLIST IN FILE EMPLOYEE INOUT)<br /> <br /> %TEMP IS FIXED DP 2<br /> <br /> WAGES1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> NAME = %E.NAME<br /> END FIND<br /> FOR EACH RECORD IN WAGES1<br /> %TEMP = (RATE * %REG)<br /> %TOTAL = %TEMP + (RATE * 1.5 * %OT)<br /> END FOR<br /> PLACE RECORDS IN WAGES1 ON LIST EMPLIST<br /> RETURN<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the following example, an entire array is passed as a single subroutine parameter:</p><br /> <p class="code">BEGIN<br /> %NUMBERS IS FLOAT ARRAY(10,10)<br /> %MAX IS FLOAT<br /> DECLARE SUBROUTINE MAXIMUM(FLOAT ARRAY(*,*), -<br /> FLOAT OUTPUT)<br /> .<br /> .<br /> .<br /> CALL MAXIMUM(%NUMBERS,%MAX)<br /> .<br /> .<br /> .<br /> <br /> SUBROUTINE MAXIMUM(%ARR IS FLOAT ARRAY(*,*), -<br /> %M IS FLOAT OUTPUT)<br /> %I IS FIXED<br /> %J IS FIXED<br /> %M = 0<br /> FOR %I FROM 1 TO $arrsize('%ARR',1)<br /> FOR %J FROM 1 TO $arrsize('%ARR',2)<br /> IF %ARR(%I,%J) GT %M THEN<br /> %M = %ARR(%I,%J)<br /> END IF<br /> END FOR<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ==Sharing common elements==<br /> <p><br /> An element that is not passed as a parameter can be shared between complex subroutines, or between a complex subroutine and the main request, when it is declared as a common element. A common element is created by using the DECLARE statement or by using the COMMON keyword on a %variable IS declaration. For an element to be shared, it must be declared as common in every place (each separate scope) in which it is used. </p><br /> <br /> ===Scope of elements===<br /> <p><br /> The scope of an element refers to the area within a request in which an element has a particular meaning. In User Language, complex subroutines have a different scope than the remainder of the request (the elements of a complex subroutine differ from the elements outside the subroutine even when they have the same name). This concept applies to labels, lists, %variables and %variable arrays, menus, screens, and images.</p><br /> <p><br /> The elements of the main request (the statements not enclosed by any SUBROUTINE/END SUBROUTINE statements) and the elements of all simple subroutines share the same scope. Simple subroutines share the same elements with the main request and all other simple subroutines within the request. </p><br /> <br /> ===Shareable elements===<br /> <p><br /> The following elements can be shared if they are declared as common:</p><br /> <br /> ====%variables and %variable arrays====<br /> <p><br /> You can share %variables if a DECLARE %variable or a %variable IS statement that declares the %variable as common is present in each portion of the request where you use the %variable. The %variable must have the same type, length, number of decimal places, and FIELD SAVE option in each declaration. </p><br /> <br /> ====Lists of records====<br /> <p><br /> You can share a list if a DECLARE statement that declares the list as common is contained in each place where you use the list. The declaration of the list must precede the first reference to that list, or <var class="product">Model&nbsp;204</var> declares the list implicitly without the common attribute.</p><br /> <br /> ====Found sets====<br /> <p><br /> You can share found sets if the label of the FIND statement is declared as common. To effectively share a found set, follow these steps:</p><br /> <ol><br /> <li>Add a DECLARE statement that declares the statement label as common before the actual label in the portion of the request where the FIND statement will be executed.</li><br /> <li>Add a DECLARE statement that declares the label as common to any parts of the request that require access to that found set. These parts, however, cannot contain a label with the same name, or a compiler error occurs. </li><br /> </ol><br /> <p><br /> After execution of the FIND statement, you can access the record set in any portion of the request that contains the proper DECLARE statement. </p><br /> <br /> ====Menus and screens====<br /> <p><br /> You can share a menu or screen as common under the following conditions: </p><br /> <ul><br /> <li>The first reference to the menu or screen must be the complete definition of the menu or screen, with the COMMON keyword following the MENU or SCREEN statement.</li><br /> </li><br /> <li>Other parts of the request can reference the same menu or screen by using an abbreviated declaration of the form:</li><br /> <p class="code">DECLARE [MENU menuname | SCREEN screenname] COMMON<br /> </p><br /> <p><br /> If the complete definition of the menu or screen exists, and if that definition was declared as common, the menu or screen is shared. If not, a compiler error results. Two or more complete menu or screen definitions with the COMMON keyword also result in a compiler error.</p><br /> <p><br /> If you use a menu or screen %variable (:%variable) within a complex subroutine to refer to a COMMON screen element, you must include a common declaration for each possible value of the menu or screen name. </p><br /> </li><br /> </ul><br /> <br /> ====Images====<br /> <p><br /> The sharing of images follows the same rules used for the sharing of menus and screens. If multiple images are contained within the same block, then the following rules also apply:</p><br /> <ul><br /> <li>You can use the COMMON keyword on only the first IMAGE statement of a block. All other images within the same block are automatically considered as candidates for sharing as common data.</li><br /> </li><br /> <br /> <li>All other parts of the request that access common images must contain the following abbreviated form of the DECLARE statement for each image to which access is required: </li><br /> <p class="code">DECLARE IMAGE imagename COMMON<br /> </p></li><br /> </ul><br /> <br /> <br /> ===DECLARE statement===<br /> <p><br /> You can use the DECLARE statement to perform the following functions: </p><br /> <ul><br /> <li>Specify subroutine formal parameter types.</li><br /> </li><br /> <br /> <li>Specify variables, labels, lists, menus, screens, and images as COMMON.</li><br /> </li><br /> </ul><br /> <p><br /> Menus and screens are discussed in detail in [[Full-screen feature]]. </p><br /> <p><br /> Images are discussed in detail in [[Images]].</p><br /> <br /> <ul><br /> <li>To declare lists without having to use an <code>IN filename CLEAR LIST listname</code> clause. See [[Lists#Creating and clearing a list|Creating and clearing a list]].</li><br /> <br /> <li>To declare %variables, see [[Using variables and values in computation]]. </li><br /> </ul><br /> <br /> ====Syntax====<br /> <p><br /> The format of the DECLARE statement is as follows:</p><br /> <p class="syntax">DECLARE <span class="term">declaration</span><br /> </p><br /> <p><br /> where <span class="term">declaration</span> is one of the following:</p><br /> <p class="syntax">LABEL <span class="term">label</span> COMMON<br /> <br /> [LIST] <span class="term">listname</span> [IN [FILE [PERM | TEMP] GROUP] <span class="term">name</span>]<br /> [COMMON]<br /> <br /> IMAGE <span class="term">imagename</span> COMMON<br /> <br /> MENU <span class="term">menuname</span> COMMON<br /> <br /> SCREEN <span class="term">screenname</span> COMMON<br /> <br /> <span class="term">%variable</span> [IS] {FIXED [DP <span class="term">n</span>] | FLOAT}<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [COMMON]<br /> <br /> <span class="term">%variable</span> [IS] STRING [LEN <span class="term">n</span>] [DP {<span class="term">dn1</span> | *}]<br /> [ARRAY(<span class="term">d1</span> [,<span class="term">d2</span> [,<span class="term">d3</span>]])] [NO FIELD SAVE] [COMMON]<br /> <br /> SUBROUTINE <span class="term">subname</span>[(<span class="term">type</span> [<span class="term">inout-option</span>] [,...]) ]<br /> </p><br /> <br /> ====Example====<br /> <p><br /> For example, the DECLARE statement declares the list RECNAMES in the following request:</p><br /> <p class="code">BEGIN<br /> DECLARE LIST RECNAMES<br /> DECLARE SUBROUTINE REGION(LIST OUTPUT, STRING)<br /> .<br /> .<br /> .<br /> CALL REGION(LIST RECNAMES, 'NORTHEAST')<br /> .<br /> .<br /> .<br /> SUBROUTINE REGION(LIST RGNLST OUTPUT, -<br /> %REGION IS STRING)<br /> <br /> R1: IN EMPLOYEE FIND ALL RECORDS FOR WHICH<br /> REGION = %REGION<br /> R2: PLACE RECORDS IN R1 ON LIST RGNLIST<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ===Defining common variables===<br /> <p><br /> You can define common variables at the beginning of all programs without later redefinitions. The syntax lets you use the %VAR IS COMMON clause without duplicating the previous attributes.</p><br /> <p><br /> However, if attributes, such as STRING or LEN, are included in the redefinition, which differ from those previously defined, a compilation error occurs. In addition, if the variable is not previously defined, it is allocated based on the current default variable definition. </p><br /> <p><br /> For example, </p><br /> <p class="code">BEGIN<br /> VARIABLES ARE STRING LEN 20 <br /> %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON <br /> SUBROUTINE A<br /> * full definition on next line no longer required<br /> ** %X IS STRING LEN 3 INITIAL ('AAA') STATIC COMMON<br /> * new syntax on next line replaces previous line<br /> %X IS COMMON /? defaults to previous %X definition ?/<br /> CALL B<br /> END SUBROUTINE<br /> <br /> SUBROUTINE B<br /> * But next line will fail compile since %X already exists<br /> %X IS STRING LEN 4 COMMON /? compiler error ?/<br /> * And the next line will result in a default definition<br /> * since %Y is not previously defined.<br /> %Y IS COMMON<br /> END SUBROUTINE<br /> PRINT %X<br /> CALL A<br /> END<br /> </p><br /> <br /> ===Shared common element examples===<br /> <p><br /> The following examples illustrate the differences between data that is locally scoped and data that is shared using the COMMON keyword. </p><br /> <br /> ====Example 1====<br /> <p><br /> In this example, the variable %I assumes different values depending upon which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> %I IS FIXED<br /> DECLARE SUBROUTINE SUBR1(STRING)<br /> .<br /> .<br /> .<br /> FOR %I FROM 1 TO 10<br /> CALL SUBR1(%ARR(%I))<br /> END FOR<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%A IS STRING)<br /> %I IS FIXED<br /> FOR %I FROM 1 TO 10<br /> PRINT %I and %A<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <br /> ====Example 2====<br /> <p><br /> In this example, the screen EXAMPLE and the %A and %B variables retain the same values no matter which part of the request is being executed:</p><br /> <p class="code">BEGIN<br /> SCREEN EXAMDEF COMMON<br /> TITLE 'THIS IS A COMMON SCREEN DEFINITION'<br /> PROMPT 'ENTER VALUE'<br /> INPUT FLD1 AT 10 LEN 20 PAD '_'<br /> END SCREEN<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> DECLARE SUBROUTINE SUBR1(STRING LEN 10)<br /> .<br /> .<br /> .<br /> SUBROUTINE SUBR1(%Z IS STRING LEN 10)<br /> DECLARE SCREEN EXAMDEF COMMON<br /> %A IS STRING LEN 10 COMMON<br /> %B IS FLOAT COMMON<br /> .<br /> .<br /> .<br /> END<br /> </p><br /> <br /> ====Example 3====<br /> <p><br /> In this example, the main request and the subroutine share the common data of an array and a found set:</p><br /> <p class="code">BEGIN<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> DECLARE SUBROUTINE EXAMPLE<br /> .<br /> .<br /> .<br /> ALL.RECS: FIND ALL RECORDS<br /> END FIND<br /> %I = 0<br /> %J = 1<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD<br /> END FOR<br /> CALL EXAMPLE<br /> STOP<br /> <br /> SUBROUTINE EXAMPLE<br /> %COM.ARRAY IS STRING LEN 10 ARRAY(10,10) COMMON<br /> DECLARE LABEL ALL.RECS COMMON<br /> %I IS FIXED<br /> %I = 0<br /> %J = 2<br /> FOR 10 RECORDS IN ALL.RECS<br /> %I = %I + 1<br /> %COM.ARRAY(%I,%J) = FLD2<br /> END FOR<br /> END SUBROUTINE<br /> END<br /> </p><br /> <p><br /> In the preceding example, the main request updates column 1 of the array %COMM.ARRAY with the contents of FLD. The subroutine, EXAMPLE, updates column 2 of the same array with the contents of FLD2. Both the array %COM.ARRAY and the found set ALL.RECS are shared by using the COMMON keyword. %I and %J are both local variables. %I is local because it was declared without the COMMON keyword; %J is local because it was not declared at all. </p><br /> <br /> <div id="On statement"></div> <br /> ==On units== <br /> <p><br /> An <var>On</var> unit lets you specify a course of action following a triggering event, such as the terminal operator pressing one of the <var>Attention</var> identifier (AID) keys. The <var>On</var> unit provides an application with a way to override the normal system response. </p><br /> <br /> ====Syntax====<br /> <p><br /> To define an <var>On</var> unit, use an <var>On</var> block in the following format:</p><br /> <p class="syntax">[<span class="term">label</span>] On <span class="term">unittype</span><br /> <span class="term">statement</span><br /> <span class="literal">...</span><br /> End On<br /> </p><br /> <p><br /> where <var class="term">unittype</var> is one of the following:</p><br /> <table><br /> <tr class="head"><br /> <th>unittype</th><br /> <th>You can specify the course of action to take if...</th><br /> </tr><br /> <br /> <tr><br /> <td>ATTENTION</td><br /> <td>The end user invokes the attention feature (for example, presses the <var>BREAK, ATTN,</var> or <var>PA1</var> key, or enters <var>*CANCEL</var>). </td><br /> </tr><br /> <br /> <tr><br /> <td>ERROR</td><br /> <td><var class="product">Model&nbsp;204</var> cancels a request. Before a request is canceled or, for transaction backout files, after the current transaction is backed out, the ON ERROR unit is processed instead of returning control to the terminal command level. For more information on transaction backout files, see [[Data recovery]]. </td><br /> </tr><br /> <br /> <tr><br /> <td nowrap>FIELD CONSTRAINT<br /> CONFLICT (FCC)</td><br /> <td>There are field level constraint conflicts. Violating the UNIQUE and AT-MOST-ONE attributes causes field-level conflicts.*</td><br /> </tr><br /> <br /> <tr><br /> <td>FIND CONFLICT</td><br /> <td>A conflict arises evaluating a FIND statement or a FOR EACH RECORD statement used for retrieval.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING FILE</td><br /> <td>A remote file is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>MISSING MEMBER</td><br /> <td>A remote optional member is no longer available.</td><br /> </tr><br /> <br /> <tr><br /> <td>RECORD LOCKING CONFLICT</td><br /> <td>A conflict arises during a record locking attempt.</td><br /> </tr><br /> </table><br /> <p><br /> *If you have procedures written for <var class="product">Model&nbsp;204</var> V2R1.0 that use ON FCC for UNIQUE fields, and you are planning to use ON FCC for AT-MOST-ONE fields, you might need to rewrite the ON FCC unit to take the new value of $UPDSTAT (2 for AT-MOST-ONE) into account. </p><br /> <p><br /> Several $functions provide information about conflicts. They are:</p><br /> <table><br /> <tr><br /> <td>[[$UpdFile]]</td><br /> <td>[[$UpdFld]]</td><br /> <td>[[$UpdOval]]</td><br /> <td>[[$UpdRec]]</td><br /> </tr><br /> <tr><br /> <td>[[$UpdStat]]</td><br /> <td>[[$UpdStmt]]</td><br /> <td>[[$UpdVal]]</td><br /> <td>[[$UnqRec]]</td><br /> </tr><br /> </table><br /> <br /> ===Body of an ON unit===<br /> <p><br /> The body of the ON unit consists of statements immediately following the ON statement. Any User Language statement can appear within an ON unit except the SUBROUTINE statement.</p><br /> <br /> ===Ending an ON unit===<br /> <p><br /> You must conclude an ON unit with either an END ON statement or an END BLOCK statement. The format of the END ON statement is as follows:</p><br /> <p class="syntax">END ON [<span class="term">label</span>]<br /> </p><br /> <p><br /> where <var class="term">label</var> is the label of the statement that began the ON statement. </p><br /> <br /> ===Processing an ON unit===<br /> <p><br /> When an ON statement is evaluated, <var class="product">Model&nbsp;204</var> remembers the location of the ON unit body (the statement after the ON statement and within the unit), but does not immediately evaluate the body. Instead, it passes control to the statement immediately following the ON unit. The ON unit body is evaluated only when the triggering event takes place.</p><br /> <br /> ===Usage guidelines for ON units===<br /> <p><br /> Note the following considerations when using ON units:</p><br /> <ul><br /> <li>You must define the ON unit before it is invoked (that is, you should typically place the ON unit near the beginning of your procedure). </li><br /> <br /> <li>A subsequent definition of an ON unit of the same kind replaces the previous one. For example, if you define two ON ATTN units, the second one becomes the current one.</li><br /> <br /> <li>You can jump to destinations within the same ON unit. </li><br /> <br /> <li>You can jump out of an ON unit only to unnested, labeled statements.</li><br /> <br /> <li>You cannot jump into an ON unit.</li><br /> <br /> <li>You can jump outside of an ON unit only if the ON unit is part of a main routine or part of a complex subroutine. </li><br /> <br /> <li>You cannot jump out of an ON unit contained in a simple subroutine, regardless of whether the destination is within the subroutine or back in the mainline program, because ON units are part of the mainline program; hence, there is no scoping of ON units. This restriction ensures that the ON unit is executed and the control returned to the main routine.</li><br /> <br /> <li>An ON unit definition is not preserved when a request is continued with an END MORE statement and a MORE command. Each new request continuation must define its own ON units. (See [[Large request considerations#Rules for request continuation|Rules for request continuation]].)</li><br /> <br /> <li>For complex subroutines, an active ON unit is temporarily disabled when a subroutine is called that contains an ON UNIT of the same type; it is restored when the subroutine returns. Any ON unit enabled during the execution of a subroutine is replaced by the active ON unit at the time of the last CALL statement as soon as the RETURN statement is evaluated.</li><br /> <br /> <li>ON units coded inside complex subroutines can contain JUMP statements that specify a destination outside the ON unit. The destination must be to an unnested labeled statement within the complex subroutine. Also, if the ON unit is to be jumped out of, the condition that causes the ON unit to be invoked must be raised in the subroutine that contains the ON unit.<br /> <p><br /> This prevents a lower level subroutine from returning inadvertently by raising a condition for which there is an ON unit coded in a higher level subroutine. If the inadvertent return is attempted, the request is canceled. </p><br /> </li><br /> <br /> <li>ON units do not have their own local data and labels. They inherit the scope of the part of the program in which they are compiled. An ON unit that is compiled within a complex subroutine is considered part of only that subroutine. <br /> </li><br /> </ul><br /> <br /> ====Example====<br /> <p><br /> In the following example, if the user presses the<var> ATTN</var> key instead of entering a response to the prompt in the GET.REC.TYPE statement, the ON ATTENTION unit sets %FLAG to 1. The FLAG.SET statement tests %FLAG. If %FLAG is set, the request branches to END.REQUEST and the FIND statement is not executed. </p><br /> <p class="code">%FLAG=0<br /> ON ATTENTION<br /> %FLAG=1<br /> BYPASS<br /> END ON<br /> GET.REC.TYPE: %TYPE=$READ('ENTER RECORD TYPE')<br /> FLAG.SET: IF %FLAG=1 THEN<br /> JUMP TO END.REQUEST<br /> END IF<br /> FIND.RECS: FIND ALL RECORDS FOR WHICH<br /> TYPE = %TYPE<br /> END FIND<br /> .<br /> .<br /> .<br /> END.REQUEST:<br /> END<br /> </p><br /> <br /> ===Only one ON unit at a time===<br /> <p><br /> Only one ON unit of each kind is active at a time. For example, the processing of a second ON ERROR statement resets the current ON ERROR unit, but does not affect the current ON ATTENTION unit. Thus, you can redefine what to do in a variety of cases by having several ON statements and units within a request. An ON unit can be redefined within another ON unit.</p><br /> <br /> ===Passing control to and from ON units===<br /> <p><br /> <var class="product">Model&nbsp;204</var> passes control to an ON unit when the triggering event occurs. For example, an ON ATTENTION unit receives control when a user presses one of the ATTENTION identifier (AID) keys at the terminal during the execution of a request. Use one of the following statements to return control to the body of the request. </p><br /> <br /> ====BYPASS statement====<br /> <p><br /> The BYPASS statement handles the various unittypes of an ON statement as follows:</p><br /> <table><br /> <tr class="head"><br /> <th>For unittype...</th><br /> <th>The BYPASS statement...</th><br /> </tr><br /> <tr><br /> <td>ON MISSING FILE<br><br /> ON MISSING MEMBER</td><br /> <td>Returns control to the statement immediately after the END FOR statement that closes the current FOR loop. </td><br /> </tr><br /> <tr><br /> <td>ON ERROR</td><br /> <td>Ends the request.</td><br /> </tr><br /> <tr><br /> <td nowrap>ON ATTENTION<br><br /> ON FIND CONFLICT<br><br /> ON RECORD LOCKING CONFLICT</td><br /> <td>Returns control to the statement immediately after the statement that invoked the ON unit.</td><br /> </tr><br /> </table><br /> <p><br /> The format of the BYPASS statement is as follows:</p><br /> <p class="syntax">BYPASS [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the PENDING STATEMENT keyword is optional. If the ON unit is not ended with a BYPASS statement, <var class="product">Model&nbsp;204</var> automatically generates a STOP statement at the end of the unit. </p><br /> <br /> ====CONTINUE statement====<br /> <p><br /> The CONTINUE statement is supported only with the Parallel Query Option. If you lose access to a group member that is an optional file during FOR processing, the CONTINUE statement continues FOR processing with the next available file, and skips any other unavailable files.</p><br /> <br /> ====JUMP TO statement====<br /> <p><br /> The JUMP statement, when used to jump to a labeled statement outside the ON unit, causes the request to continue at that point. There are restrictions pertaining to jumps; see [[Flow of control in User Language#Branching statements|Branching statements]] and [[#Simple subroutines|Simple subroutines]]. </p><br /> <br /> ====RETRY statement====<br /> <p><br /> The RETRY statement passes control to the statement that invoked the ON unit, thereby retrying that statement. The RETRY statement is not valid in an ON ERROR unit.</p><br /> <p><br /> The format of the RETRY statement is as follows:</p><br /> <p class="syntax">RETRY [PENDING STATEMENT]<br /> </p><br /> <p><br /> where the <var>PENDING STATEMENT</var> keyword is optional.</p><br /> <br /> ====STOP statement====<br /> <p><br /> The STOP statement is used to end the request. </p><br /> <br /> ===Clearing ON units===<br /> <p><br /> You can issue the following statement to clear the definition of an ON unit: </p><br /> <p class="syntax">CLEAR ON <span class="term">unittype</span><br /> </p><br /> <p><br /> This statement clears any defined ON unit of the type specified. Clearing an ON unit produces the following results:</p><br /> <br /> <ul><br /> <li>After a CLEAR ON ATTENTION, pressing one of the ATTENTION identifier (AID) keys at the terminal does not invoke the ON ATTENTION unit.</li><br /> <br /> <li>After a CLEAR ON ERROR, a request cancellation error does not invoke the ON ERROR unit. </li><br /> </ul><br /> <p><br /> An ON unit can be defined, cleared, and then redefined. </p><br /> <br /> ===Pausing during the request===<br /> <p><br /> The PAUSE statement can be used with ON units to cause the request to wait a specified time and then to retry the statement that caused the evaluation of the ON unit. PAUSE is typically used with the other ON unit types (RECORD LOCKING CONFLICT and ON FIND CONFLICT) and is discussed in [[Record level locking and concurrency control]]. </p><br /> <br /> </div> <br /> <br /> [[Category:SOUL]]</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78428 Release notes for SirPro V7.5 2015-07-23T02:43:37Z

<p>Heikki: /* New PL subsystem */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (ProcSearch/PS)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> <br /> ====Search strings====<br /> The maximum length has been increased to ??.<br /> <br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> <br /> ===Other features===<br /> ====Enhanced Procedure Name search====<br /> If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So take caution when combining AND and OR selections.<br /> ====Field error tagging====<br /> (in progress) If field is in error, e.g. the Context field is<br /> invalid, the field is tagged red.<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (ProcList/PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS&nbsp;|&nbsp;A&nbsp;[xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>U (Undo)</th><br /> <td><br /> May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> </td></tr><br /> <br /> <tr><th>Y</th><br /> <td><br /> This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> </td></tr><br /> </table><br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> A new command PL allows direct entry to the Procedure List screen in SirPro. The format is:<br /> <p class="code">PL [<procedurePattern>] [FILE <fileName>|GROUP <groupName>]<br /> </p><br /> If FILE or GROUP is not supplied then the current open context will be used. The context is obtained using $view('APDFCNTX') (see [[APDFCNTX_parameter]]).<br /> <br /> Note - If a procedure search is required for the words 'FILE' or 'GROUP', then it must be entered as:<br /> <p class="code">PL file FILE <filename></p><br /> where the first 'file' is for procedures containing the word 'file'. The second 'FILE' is required as the context is not automatically added if searching for the words 'FILE' or 'GROUP'.<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirLib_V7.5&diff=78378 Release notes for SirLib V7.5 2015-07-21T11:13:48Z

<p>Heikki: Created page with "(placeholder page - Adrian to provide content)"</p> <hr /> <div>(placeholder page - Adrian to provide content)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_RKTools_V7.5&diff=78374 Release notes for RKTools V7.5 2015-07-21T10:45:49Z

<p>Heikki: </p> <hr /> <div>The following are the release notes for the components of ULSPF that have been updated for version S7.5. Please note that the version numbering has changed and is now linked to the Model 204 release version number. Hence ULSPF S7.5 can only run on Model 204 release 7.5 or higher. The ULSPF version prior to S7.5 was 801. <br /> <ul><br /> <li>[[Release notes for SirPro version S7.6 -- DRAFT]]</li><br /> <li>[[Release notes for SirLib version S7.5 -- DRAFT]]</li><br /> <li>[[Release notes for SirScan version S7.5 -- DRAFT]]</li><br /> <li>New TN3270 editor [[SoulEdit]]</li><br /> </ul><br /> ==Common ULSPF enhancements==<br /> <br /> ===Enhanced fast-path===<br /> Fast-pathing between ULSPF components is supported by typing the component name in the command line. For instance, typing SIRMON from anywhere inside SIRPRO or SIRSCAN will take you to the SirMon System Overview screen. Typing SIRPRO 8 from inside SirMon will take you to the SirPro Group Definition page.<br /> <br /> ===Enhanced help===<br /> (in progress)<br /> The help will be extended to include field help. When PF1 is pressed and the cursor is located on a field the help will be positioned to the help text for that field. Otherwise it will be positioned at the start. The user can then choose to scroll up or down to see the rest of the help text.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78371 Release notes for SirPro V7.5 2015-07-21T08:21:05Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (ProcSearch/PS)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> <br /> ====Search strings====<br /> The maximum length has been increased to ??.<br /> <br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> <br /> ===Other features===<br /> ====Enhanced Procedure Name search====<br /> If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So take caution when combining AND and OR selections.<br /> ====Field error tagging====<br /> (in progress) If field is in error, e.g. the Context field is<br /> invalid, the field is tagged red.<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (ProcList/PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS&nbsp;|&nbsp;A&nbsp;[xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>U (Undo)</th><br /> <td><br /> May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> </td></tr><br /> <br /> <tr><th>Y</th><br /> <td><br /> This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> </td></tr><br /> </table><br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78370 Release notes for SirPro V7.5 2015-07-21T08:12:35Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> <br /> ====Search strings====<br /> The maximum length has been increased to ??.<br /> <br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> <br /> ===Other features===<br /> ====Enhanced Procedure Name search====<br /> If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So take caution when combining AND and OR selections.<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS&nbsp;|&nbsp;A&nbsp;[xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>U (Undo)</th><br /> <td><br /> May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> </td></tr><br /> <br /> <tr><th>Y</th><br /> <td><br /> This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> </td></tr><br /> </table><br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78369 Release notes for SirPro V7.5 2015-07-21T08:08:37Z

<p>Heikki: /* Search strings */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Enhanced Procedure name search====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections.<br /> <br /> ====Search strings====<br /> The maximum length has been increased to ??.<br /> <br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS&nbsp;|&nbsp;A&nbsp;[xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>U (Undo)</th><br /> <td><br /> May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> </td></tr><br /> <br /> <tr><th>Y</th><br /> <td><br /> This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> </td></tr><br /> </table><br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78368 Release notes for SirPro V7.5 2015-07-21T08:06:29Z

<p>Heikki: /* Procedure name */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Enhanced Procedure name search====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections.<br /> <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS&nbsp;|&nbsp;A&nbsp;[xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>U (Undo)</th><br /> <td><br /> May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> </td></tr><br /> <br /> <tr><th>Y</th><br /> <td><br /> This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> </td></tr><br /> </table><br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78367 Release notes for SirPro V7.5 2015-07-21T08:05:34Z

<p>Heikki: /* Selection field */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS&nbsp;|&nbsp;A&nbsp;[xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>U (Undo)</th><br /> <td><br /> May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> </td></tr><br /> <br /> <tr><th>Y</th><br /> <td><br /> This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> </td></tr><br /> </table><br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78366 Release notes for SirPro V7.5 2015-07-21T07:59:59Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS&nbsp;|&nbsp;A&nbsp;[xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78365 Release notes for SirPro V7.5 2015-07-21T07:57:14Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> If a command is in error it will now leave the command on the screen so it can be amended.<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS | A [xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78364 Release notes for SirPro V7.5 2015-07-21T07:55:31Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>PROCS | A [xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxxx]</th><br /> <td><br /> Creates a new procedure named 'xxxx' in the current file/group <br /> context. If there is no 'xxxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78363 Release notes for SirPro V7.5 2015-07-21T07:50:46Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>PROCS | A [xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD | PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxx]</th><br /> <td><br /> Creates a new procedure named 'xxx' in the current file/group <br /> context. If there is no 'xxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78362 Release notes for SirPro V7.5 2015-07-21T07:50:13Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY&nbsp;|&nbsp; CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>PROCS | A [xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr><th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD/PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxx]</th><br /> <td><br /> Creates a new procedure named 'xxx' in the current file/group <br /> context. If there is no 'xxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78361 Release notes for SirPro V7.5 2015-07-21T07:47:27Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY | CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>PROCS | A [xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </th><br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr<th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD/PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxx]</th><br /> <td><br /> Creates a new procedure named 'xxx' in the current file/group <br /> context. If there is no 'xxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> </table><br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78360 Release notes for SirPro V7.5 2015-07-21T07:44:22Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY | CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>PROCS | A [xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>FILE | FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP xxx </tr>0<br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP | GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr<th>GPP xxx</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD/PWD</th><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>OCC [nnn]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'nnn' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'nnn' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Ignore Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>CREATEPROC | CREATE | CP [xxx]</th><br /> <td><br /> Creates a new procedure named 'xxx' in the current file/group <br /> context. If there is no 'xxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> </table><br /> <br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78359 Release notes for SirPro V7.5 2015-07-21T07:40:28Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY | CODE | SHOW | CL [n]</th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'n' are 0 through 9. If there <br /> is no 'n' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS | HA | H [xxx]</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> If the string 'xxx' is omitted the search string is cleared.<br /> </td></tr><br /> <br /> <tr><th>PROCS | A [xxxx]</th><br /> <td><br /> Changes the procedure name filter to 'xxxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> If the filter name 'xxxx' is omitted then all procedures<br /> are displayed.<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> Hence this filters the current display listing to show<br /> only those that also meet the new criteria.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter by combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. Hence this <br /> adds additional procedures to the display listing. <br /> </td></tr><br /> <br /> <tr><th>FILE/FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP </tr>0<br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP/GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr<th>GPP</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD/PWD</td><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>OCC [xxx]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'xxx' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'xxx' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Igonre Comment lines'.<br /> </td></tr><br /> <br /> <tr><th>CREATEPROC|CREATE|CP [xxx]</th><br /> <td><br /> Creates a new procedure named 'xxx' in the current file/group <br /> context. If there is no 'xxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> </table><br /> <br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78358 Release notes for SirPro V7.5 2015-07-21T07:31:35Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY [x]<br/>CODE [x]<br/>SHOW [x]<br/>CL [x]<br/></th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'x' are 0 through 9. If there <br /> is no 'x' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS/HA/H xxx</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> </td></tr><br /> <br /> <tr><th>PROCS xxx A xxxx</th><br /> <td><br /> Changes the procedure name filter to 'xxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td></tr><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. <br /> </td></tr><br /> <br /> <tr><th>FILE/FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP </tr>0<br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP/GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr<th>GPP</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD/PWD</td><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>OCC [xxx]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'xxx' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'xxx' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> <tr><th>HS [x]</th><br /> <td><br /> Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> </td></tr><br /> <br /> <tr><th>IC [x]</th><br /> <td><br /> Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Igonre Comment lines'.<br /> </td></th><br /> <br /> <tr><th>CREATEPROC|CREATE|CP [xxx]</th><br /> <td><br /> Creates a new procedure named 'xxx' in the current file/group <br /> context. If there is no 'xxx' specified, an unnamed <br /> procedure will be created. <br /> </td></tr><br /> <br /> <tr><th>LASTID | LID [xxx]</th><br /> <td><br /> Changes the value of 'Last Updater ID'. <br /> The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> </td></tr><br /> </table><br /> <br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78357 Release notes for SirPro V7.5 2015-07-21T07:24:16Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY [x]<br/>CODE [x]<br/>SHOW [x]<br/>CL [x]<br/></th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'x' are 0 through 9. If there <br /> is no 'x' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS/HA/H xxx</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> </td></tr><br /> <br /> <tr><th>PROCS xxx A xxxx</th><br /> <td><br /> Changes the procedure name filter to 'xxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. <br /> </td></tr><br /> <br /> <tr><th>FILE/FL xxx</th><br /> <td><br /> Changes the file context using the existing privileges to <br /> the file.<br /> </td></tr><br /> <br /> <tr><th>FLP </tr>0<br /> <td><br /> Changes the file context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>GROUP/GP xxx</th><br /> <td><br /> Changes the group context using the existing privileges to <br /> the group. <br /> </td></tr><br /> <br /> <tr<th>GPP</th><br /> <td><br /> Changes the group context with prompt for password.<br /> </td></tr><br /> <br /> <tr><th>PASSWORD/PWD</td><br /> <td><br /> Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> </td></tr><br /> <br /> <tr><th>OCC [xxx]</th><br /> <td><br /> Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'xxx' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'xxx' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> </td></tr><br /> <br /> HS [x] Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> <br /> IC [x] Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Igonre Comment lines'.<br /> <br /> CREATEPROC/ Creates a new procedure named 'xxx' in the current file/group <br /> CREATE/ context. If there is no 'xxx' specified, an unnamed <br /> CP [xxx] procedure will be created. <br /> <br /> LASTID/ Changes the value of 'Last Updater ID'. <br /> LID [xxx] The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> <br /> EXIT/QUIT/ Return to previous screen without processing any prefix<br /> END commands.<br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78356 Release notes for SirPro V7.5 2015-07-21T07:18:27Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command</th><th>Description</th></tr><br /> <br /> <tr><th>DISPLAY [x]<br/>CODE [x]<br/>SHOW [x]<br/>CL [x]<br/></th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'x' are 0 through 9. If there <br /> is no 'x' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> <br /> <tr><th>HAS/HA/H xxx</th><br /> <td><br /> Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> </td></tr><br /> <br /> <tr><th>PROCS xxx A xxxx</th><br /> <td><br /> Changes the procedure name filter to 'xxx'. Wildcarding<br /> is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> </td></tr><br /> <br /> <tr><th>AND xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> </td></tr><br /> <br /> <tr><th>+AND xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> </td><br /> <br /> <tr><th>OR xxx</th><br /> <td><br /> Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. <br /> </td></tr><br /> <br /> FILE/FL xxx Changes the file context using the existing privileges to <br /> the file.<br /> <br /> FLP Changes the file context with prompt for password.<br /> <br /> GROUP/GP xxx Changes the group context using the existing privileges to <br /> the group. <br /> <br /> GPP Changes the group context with prompt for password.<br /> <br /> PASSWORD/PWD Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> <br /> OCC [xxx] Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'xxx' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'xxx' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> <br /> HS [x] Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> <br /> IC [x] Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Igonre Comment lines'.<br /> <br /> CREATEPROC/ Creates a new procedure named 'xxx' in the current file/group <br /> CREATE/ context. If there is no 'xxx' specified, an unnamed <br /> CP [xxx] procedure will be created. <br /> <br /> LASTID/ Changes the value of 'Last Updater ID'. <br /> LID [xxx] The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> <br /> EXIT/QUIT/ Return to previous screen without processing any prefix<br /> END commands.<br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78355 Release notes for SirPro V7.5 2015-07-21T07:10:27Z

<p>Heikki: /* Command Line */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> <table class="thJustBold"><br /> <tr class="head"><th>Command </th><th>Description</th></tr><br /> <tr><th><br /> DISPLAY [x]<br/><br /> CODE [x]<br/><br /> SHOW [x]<br/><br /> CL [x]<br/><br /> </th><br /> <td><br /> With these commands you can alter the number of lines of<br /> code to be displayed beginning with the first of any found<br /> search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'x' are 0 through 9. If there <br /> is no 'x' specified,it will give a default value of 0 to <br /> the '# of context lines'<br /> </td></tr><br /> </table><br /> <br /> HAS/HA/H xxx Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> <br /> PROCS xxx Changes the procedure name filter to 'xxx'. Wildcarding<br /> A xxxx is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> <br /> AND xxx Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> <br /> +AND xxx Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> <br /> OR xxx Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. <br /> <br /> FILE/FL xxx Changes the file context using the existing privileges to <br /> the file.<br /> <br /> FLP Changes the file context with prompt for password.<br /> <br /> GROUP/GP xxx Changes the group context using the existing privileges to <br /> the group. <br /> <br /> GPP Changes the group context with prompt for password.<br /> <br /> PASSWORD/PWD Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> <br /> OCC [xxx] Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'xxx' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'xxx' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> <br /> HS [x] Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> <br /> IC [x] Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Igonre Comment lines'.<br /> <br /> CREATEPROC/ Creates a new procedure named 'xxx' in the current file/group <br /> CREATE/ context. If there is no 'xxx' specified, an unnamed <br /> CP [xxx] procedure will be created. <br /> <br /> LASTID/ Changes the value of 'Last Updater ID'. <br /> LID [xxx] The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> <br /> EXIT/QUIT/ Return to previous screen without processing any prefix<br /> END commands.<br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78354 Release notes for SirScan V7.5 2015-07-21T06:04:29Z

<p>Heikki: /* Set Colors screen (SetColors/SC) */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (ScanSel/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6 - SetColors]]. This navigates to the [[#Set Colors screen (SetColors/SC)|Set Colors screen]]. (did this exist before?)<br /> <br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the ScanSel screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF4 - Reset Time====<br /> Reset the date and time to the selected journal's initialization <br /> date and time. <br /> ====PF5 - Daemon only help====<br /> Help for free sdaemon-only SirScan that is provided with Janus Web. <br /> ====PF6 - SetColors====<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> <br /> ==Set Colors screen (SetColors/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks like:<br /> ..............<br /> <br /> ==Scan List Screen (ScanList/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the ScanSel screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78353 Release notes for SirScan V7.5 2015-07-21T06:03:52Z

<p>Heikki: /* New scan line color option */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (ScanSel/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6 - SetColors]]. This navigates to the [[#Set Colors screen (SetColors/SC)|Set Colors screen]]. (did this exist before?)<br /> <br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the ScanSel screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF4 - Reset Time====<br /> Reset the date and time to the selected journal's initialization <br /> date and time. <br /> ====PF5 - Daemon only help====<br /> Help for free sdaemon-only SirScan that is provided with Janus Web. <br /> ====PF6 - SetColors====<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> <br /> ==Set Colors screen (SetColors/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks line:<br /> ..............<br /> <br /> ==Scan List Screen (ScanList/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the ScanSel screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78351 Release notes for SirScan V7.5 2015-07-21T05:57:02Z

<p>Heikki: /* PF5/PF6 - Previous/Next Bookmark (or refresh) */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (ScanSel/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6 - SetColors]]. This navaites to the [[#Set Colors screen (SetColors/SC)|Set Colors screen]]. (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the ScanSel screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF4 - Reset Time====<br /> Reset the date and time to the selected journal's initialization <br /> date and time. <br /> ====PF5 - Daemon only help====<br /> Help for free sdaemon-only SirScan that is provided with Janus Web. <br /> ====PF6 - SetColors====<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> <br /> ==Set Colors screen (SetColors/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks line:<br /> ..............<br /> <br /> ==Scan List Screen (ScanList/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the ScanSel screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78350 Release notes for SirScan V7.5 2015-07-21T05:56:07Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (ScanSel/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6 - SetColors]]. This navaites to the [[#Set Colors screen (SetColors/SC)|Set Colors screen]]. (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the ScanSel screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF4 - Reset Time====<br /> Reset the date and time to the selected journal's initialization <br /> date and time. <br /> ====PF5 - Daemon only help====<br /> Help for free sdaemon-only SirScan that is provided with Janus Web. <br /> ====PF6 - SetColors====<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> <br /> ==Set Colors screen (SetColors/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks line:<br /> ..............<br /> <br /> ==Scan List Screen (ScanList/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78348 Release notes for SirScan V7.5 2015-07-21T05:51:26Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (ScanSel/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6 - SetColors]]. This navaites to the [[#Set Colors screen (SetColors/SC)|Set Colors screen]]. (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the ScanSel screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF6 - SetColors====<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> <br /> ==Set Colors screen (SetColors/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks line:<br /> ..............<br /> <br /> ==Scan List Screen (ScanList/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78347 Release notes for SirScan V7.5 2015-07-21T05:49:12Z

<p>Heikki: /* Scan Select Screen (SCANSEL/SS) */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (ScanSel/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6]]. This navaites to the [[#Set Colors screen (SETCOLORS/SC)|Set Colors screen]]. (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF6 - SetColors====<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> <br /> ==Set Colors screen (SETCOLORS/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks line:<br /> ..............<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78346 Release notes for SirScan V7.5 2015-07-21T05:48:43Z

<p>Heikki: /* =PF6 - SetColors */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6]]. This navaites to the [[#Set Colors screen (SETCOLORS/SC)|Set Colors screen]]. (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF6 - SetColors====<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> <br /> ==Set Colors screen (SETCOLORS/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks line:<br /> ..............<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78345 Release notes for SirScan V7.5 2015-07-21T05:48:11Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by using [[#PF6 - SetColors|PF6]]. This navaites to the [[#Set Colors screen (SETCOLORS/SC)|Set Colors screen]]. (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> ===Function key changes===<br /> ====PF6 - SetColors===<br /> This function key navigates to the SetColors page which can be used to change the colors for Entry Types.<br /> ==Set Colors screen (SETCOLORS/SC)==<br /> This is a new screen to set the colors for the various Entry Types. The screen looks line:<br /> ..............<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78344 Release notes for SirScan V7.5 2015-07-21T05:40:22Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New Bookmarks option====<br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the ScanList page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=PF5|PF6=> latest bookmark <=PF5|PF6=> refresh page (i.e. new bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78343 Release notes for SirScan V7.5 2015-07-21T05:34:39Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> The command without the BookmarkId (i.e. just ".") will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78342 Release notes for SirScan V7.5 2015-07-21T05:31:51Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark Lines|Bookmark Lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark option on the ScanSel screen is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78341 Release notes for SirScan V7.5 2015-07-21T05:30:08Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark lines|Bookmark lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark setting is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78340 Release notes for SirScan V7.5 2015-07-21T05:27:39Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[#Bookmark lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> ====Bookmark Lines====<br /> If the Bookmark setting is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78339 Release notes for SirScan V7.5 2015-07-21T05:24:39Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> <br /> See [[Bookmark lines]] below for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> <br /> <br /> ====Bookmark Lines====<br /> <br /> If the Bookmark setting is set to "Y", an additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> The bookmark line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78337 Release notes for SirScan V7.5 2015-07-21T05:20:52Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> The line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> <br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> See xxx for more details.<br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> Also the size of Max records has increased to 7 digits.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> <br /> <br /> ====Bookmark Lines====<br /> <br /> As notes in xxx if the Bookmark setting is turn on "Y", and additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78336 Release notes for SirScan V7.5 2015-07-21T05:17:30Z

<p>Heikki: /* New QT scan option */</p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====Increase size of Max records====<br /> This has been increased to 7 digits.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan line option====<br /> (project M204CMDS - Alan)<br /> <br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> <br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> The line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> <br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> See xxx for more details.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> <br /> <br /> ====Bookmark Lines====<br /> <br /> As notes in xxx if the Bookmark setting is turn on "Y", and additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78335 Release notes for SirScan V7.5 2015-07-21T05:16:06Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> The screen layout has changed with the Users field first. The field prompts label now consistently use ':' rather than the more verbose '==>'.<br /> ====Increase size of Max records====<br /> This has been increased to 7 digits.<br /> ====New scan line color option====<br /> By setting Use Color to 'Y' the scan lines are colored based on the entry types. The colors can be changed by ??? (did this exist before?)<br /> ====New QT scan option====<br /> (project M204CMDS - Alan)<br /> <br /> ====Start Time changes====<br /> The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> ====Max I/O and Max Record changes====<br /> The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> <br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> The line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> <br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> See xxx for more details.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> <br /> <br /> ====Bookmark Lines====<br /> <br /> As notes in xxx if the Bookmark setting is turn on "Y", and additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_RKTools_V7.5&diff=78334 Release notes for RKTools V7.5 2015-07-21T05:08:45Z

<p>Heikki: </p> <hr /> <div>The following are the release notes for the components of ULSPF that have been updated for version S7.5. Please note that the version numbering has changed and is now linked to the Model 204 release version number. Hence ULSPF S7.5 can only run on Model 204 release 7.5 or higher. The ULSPF version prior to S7.5 was 801. <br /> <ul><br /> <li>[[Release notes for SirPro version S7.6 -- DRAFT]]</li><br /> <li>[[Release notes for SirLib version S7.5 -- DRAFT]]</li><br /> <li>[[Release notes for SirScan version S7.5 -- DRAFT]]</li><br /> <li>New TN3270 editor [[SoulEdit]]</li><br /> </ul><br /> ==Common ULSPF enhancenments==<br /> <br /> ===Enhanced fast-path===<br /> Fast-pathing between ULSPF components is supported by typing the component name in the command line. For instance, typing SIRMON from anywhere inside SIRPRO or SIRSCAN will take you to the SirMon System Overview screen. Typing SIRPRO 8 from inside SirMon will take you to the SirPro Group Definition page.<br /> <br /> ===Enhanced help===<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78333 Release notes for SirScan V7.5 2015-07-21T04:53:41Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> Prompts '==>' replaced by ':' <br /> ====Increase size of Max records===<br /> This has been increased to 7 digits.<br /> ====New QT scan option====<br /> (project M204CMDS - Alan)<br /> ====Functionality changes====<br /> <br /> * The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> <br /> * The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> <br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> The line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> <br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> See xxx for more details.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> <br /> <br /> ====Bookmark Lines====<br /> <br /> As notes in xxx if the Bookmark setting is turn on "Y", and additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78332 Release notes for SirScan V7.5 2015-07-21T04:39:22Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> Prompts '==>' replaced by ':' <br /> ====New QT scan option====<br /> (project M204CMDS - Alan)<br /> ====Functionality changes====<br /> <br /> * The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> <br /> * The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> <br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> The line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> <br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> See xxx for more details.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New .[BookmarkId] command====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> <br /> ===Screen display changes===<br /> <br /> <br /> ====Bookmark Lines====<br /> <br /> As notes in xxx if the Bookmark setting is turn on "Y", and additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - cursor sensitive scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_RKTools_V7.5&diff=78331 Release notes for RKTools V7.5 2015-07-21T04:36:07Z

<p>Heikki: /* Enhanced fast-path */</p> <hr /> <div>The following are the release notes for the components of ULSPF that have been updated for version S7.5. Please note that the version numbering has changed and is now linked to the Model 204 release version number. Hence ULSPF S7.5 can only run on Model 204 release 7.5 or higher.<br /> <ul><br /> <li>[[Release notes for SirPro version S7.6 -- DRAFT]]</li><br /> <li>[[Release notes for SirLib version S7.5 -- DRAFT]]</li><br /> <li>[[Release notes for SirScan version S7.5 -- DRAFT]]</li><br /> <li>New TN3270 editor [[SoulEdit]]</li><br /> </ul><br /> ==Common ULSPF enhancenments==<br /> <br /> ===Enhanced fast-path===<br /> Fast-pathing between ULSPF components is supported by typing the component name in the command line. For instance, typing SIRMON from anywhere inside SIRPRO or SIRSCAN will take you to the SirMon System Overview screen. Typing SIRPRO 8 from inside SirMon will take you to the SirPro Group Definition page.<br /> <br /> ===Enhanced help===<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirScan_V7.5&diff=78330 Release notes for SirScan V7.5 2015-07-21T03:21:12Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirScan</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Scan Select Screen (SCANSEL/SS)==<br /> <br /> ===Field changes===<br /> <br /> ====Layout changes====<br /> Prompts '==>' replaced by ':' <br /> <br /> ====Functionality changes====<br /> <br /> * The <b>Start time (HH:MM:SS)</b> field will now accept periods(.) as seperators (which means that the valid formats for this field are HH:MM:SS, HH.MM.SS or HHMMSS)<br /> <br /> * The <b>Max I/O's.:</b> and <b>Max records:</b> fields have been changed to recognize, reset and report the situation where the values entered are greater than the maximum allowable. The maximum allowable values, for the <b>Max I/O's.:</b> and <b>Max records:</b> fields, can be viewed and/or set using the SirAdmin apsy (within the <b>SirScan SCLASS settings</b> option). If the <b>Max I/O's.:</b> and/or <b>Max records:</b> values, entered on the SCANSEL screen, exceed those recorded in SirAdmin, then the values will be automatically reset to the maximum allowable and an informational message will be displayed on the 'message line' (2nd bottom line of the screen).<br /> <br /> ====New field Bookmarks====<br /> <br /> Bookmarks are a new feature. When turned on (value "Y"), a bookmark line will<br /> be created in the display on the SCANLIST page for each successive scan request. <br /> Note that bookmarks are only active if the Interval (Minutes) field is left blank.<br /> The line looks like:<br /> <br /> <p class="code">______________________________________________________ BookMark 4: 19:59:37.23 - 19:59:58.90<br /> </p><br /> <br /> It shows the bookmark number and the time range for that scan. The bookmarks <br /> are sequentially numbered and the message line at the bottom of the screen shows<br /> the lasted bookmark id, for example:<br /> <br /> <p class="code">--------------------------------------------------------------------- -- Latest Bookmark: 4<br /> </p><br /> <br /> Bookmarks are saved for the session. Hence if SirScan is exited and re-entered<br /> during the same session, the previous bookmarks are retained and can be<br /> re-displayed. The new bookmark id's will follow on from the last one previously<br /> created. This provides an alternative to noting down the time of a scan in<br /> cases where the information needs to be re-displayed. Also it is possible to<br /> change the Display and Format Entry Types on this screen and re-display the<br /> journal lines for a previous bookmark period.<br /> <br /> See xxx for more details.<br /> <br /> ==Scan List Screen (SCANLIST/SL)==<br /> <br /> ===Field changes===<br /> ====New command .[BookmarkId]====<br /> A command in format .[BookmarkId] will navigate direct to that bookmark, e.g. <br /> <br /> <p class="code">.22</p><br /> <br /> A command with the BookmarkID will navigate to the latest bookmark.<br /> ====Fix Left/Right command====<br /> (project LFTRTLFT - Alan)<br /> ====Fix ALL command====<br /> (project ALLON - Alan) <br /> ===Screen display changes===<br /> <br /> <br /> ====Bookmark Lines====<br /> <br /> As notes in xxx if the Bookmark setting is turn on "Y", and additional line<br /> is displayed separating each bookmark scan period. The current (active) bookmark<br /> is shown in green whilst old bookmarks are shown in red.<br /> <br /> ===Function Keys===<br /> <br /> ====PF5/PF6 - Previous/Next Bookmark (or refresh)==== <br /> If the Interval (Minutes) field in the SCANSEL screen is left blank, then PF5 will<br /> navigate to the previous bookmark and PF6 to the next bookmark, or create a new one <br /> if already on the last bookmark. Hence the sequence is:<br /> <br /> old bookmarks <=> latest bookmark <=> refresh page (i.e. the next bookmark). <br /> <br /> The scan listing for the old bookmarks is “frozen”, e.g. pressing enter or “bottom”<br /> will not add to the listing and only the scan lines for that bookmark are shown.<br /> <br /> However the latest bookmark listing can be added to with fresh scans. Bookmarks on this page listing are shown in green. If you return to the latest bookmark, only the lines for that bookmark are shown – any others previously on the listing become old bookmarks that you can use PF5 to display. Note that pressing PF5 from the latest bookmark page will take you to the bookmark one less than the latest bookmark, even if the display has a number of earlier bookmarks that have accumulated on the page.<br /> <br /> Note that PF6 can be used to refresh the listing page so it is ready for new journal lines (if already on the latest bookmark). This is equivalent to pressing PF3, keying Start Time -0 and then Enter.<br /> <br /> ====PF7/PF8 - line scrolling====<br /> The scrolling has been enhanced to scroll based on the position of the<br /> cursor when the cursor is in the listing area. If PF8 is pressed then the page scrolls<br /> so the line under the cursor becomes the top line. If PF7 is pressed the the line under<br /> the cursor becomes the bottom line. The cursor is reset to the Command field so <br /> subsequent scrolling will be for full pages.</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_RKTools_V7.5&diff=78329 Release notes for RKTools V7.5 2015-07-21T03:13:33Z

<p>Heikki: </p> <hr /> <div>The following are the release notes for the components of ULSPF that have been updated for version S7.5. Please note that the version numbering has changed and is now linked to the Model 204 release version number. Hence ULSPF S7.5 can only run on Model 204 release 7.5 or higher.<br /> <ul><br /> <li>[[Release notes for SirPro version S7.6 -- DRAFT]]</li><br /> <li>[[Release notes for SirLib version S7.5 -- DRAFT]]</li><br /> <li>[[Release notes for SirScan version S7.5 -- DRAFT]]</li><br /> <li>New TN3270 editor [[SoulEdit]]</li><br /> </ul><br /> ==Common ULSPF enhancenments==<br /> <br /> ===Enhanced fast-path===<br /> Fast-pathing between ULSPF components is supported by typing the component name in the command line. For instance, typing SIRMON ! from anywhere inside SIRPRO or SIRSCAN will take you to the SirMon System Overview screen. Typing SIRPRO 8 from inside SirMon will take you to the SirPro Group Definition page.<br /> ===Enhanced help===<br /> (in progress)</div>

Heikki https://m204wiki.rocketsoftware.com/index.php?title=Release_notes_for_SirPro_V7.5&diff=78294 Release notes for SirPro V7.5 2015-07-20T12:07:02Z

<p>Heikki: </p> <hr /> <div>This document lists the changes that have been made for <var class="product">SirPro</var> version S7.5. It requires <var class="product">Model 204</var> release 7.5 or higher.<br /> <br /> ==Procedure Search screen (SEARCH)==<br /> <br /> ===Field changes===<br /> The searching capabilities have been enhanced to provide better impact analysis. The following fields has been changed or added.<br /> ====Procedure name====<br /> Enter a procedure name or search mask. If a procedure <br /> name is entered and any matching procedures are found, <br /> a procedure list is presented. <br /> <br /> Wildcard strings are valid in this field, using "*" as <br /> a substitution character for any number of characters in<br /> the procedure name. For example: *XYZ will find all <br /> procedure names ending in the string XYZ, and XYZ* will <br /> find all procedure names beginning with XYZ. <br /> <br /> A space indicates "AND", so entering "PU END" would <br /> return only those procedures whose names contain both <br /> the character sets "PU" and "ND", so, PUNP-END or <br /> PUMPKIN.SPENDER. <br /> <br /> The "or" bar indicates "OR", so "PU|ND" would find any <br /> procedures containing the strings "PU" or "ND". This <br /> might include "PUMP", "COLORPURPLE" and "NINTENDO". <br /> <br /> Wildcards can be used in conjuntion with the AND/OR <br /> selections, so "PUPR*|SCPR*|MOPR*" would find all <br /> procedures starting with any of the above strings. <br /> <br /> The routine currently has a bias in favor of "OR" <br /> selections, so a selection like "PUPR*|SCPR AND" <br /> won't work. It will return all procedures beginning <br /> with PUPR, then will attempt to add to the list <br /> any procedure with the characters "SCPR AND", which <br /> will find nothing, because of the embedded space. <br /> So do not combine AND and OR selections. <br /> ====Search strings====<br /> The maximum length has bene increased to nn.<br /> ====# of context lines====<br /> Numeric indicator (0 through 9) of number of lines of code <br /> to display before and after the line containing the <br /> search string. <br /> ====# occurrences to find====<br /> The number (from 1 to 999) that specifies the number of occurrences within a procedure that will <br /> be displayed.<br /> ====Hide SEQa/BASEs====<br /> SirLib users will see a prompt and entry area that allows <br /> the display or hiding of SEQ. and BASE. procedures, which <br /> are used in code management functions but are not intended <br /> to be edited directly. Enter "Y" to prevent this procedures <br /> from being displayed, and "N" to display them. <br /> ====Ignore Comment Lines====<br /> If set to Y it will ignore any Soul formatted comment lines. If set to N all found lines will be included.<br /> <br /> ===New Function Keys===<br /> ====PF5 - Toggle between case sensitive/insensitive====<br /> In Case Sensitive mode, a search for "html" would only find the <br /> lower-case version of that string. In Case-Insensitive mode <br /> the same search would find procedures containing either <br /> "html" or "HTML". <br /> ====PF6 - Create Proc====<br /> ===Other features===<br /> ====Longer proc names====<br /> ====Better subsystem transfer====<br /> ====Save profile for each change====<br /> <br /> ==Procedure List screen (PL)==<br /> ===Field changes===<br /> ====Command Line====<br /> Most of the functions able to be performed on the Search screen may now be done as commands in the Command Line field. In addition commands can be strung together using the semicolon as a delimiter. For example to switch to a new field and display those procedures that have HELP in their name can be done as:<br /> FL SIRIUS;A HELP<br /> <br /> Most commands have a full name and an abbreviation.<br /> <br /> DISPLAY [x] Changes the value of '# of context lines'.<br /> CODE [x] With these commands you can alter the number of lines of<br /> SHOW [x] code to be displayed beginning with the first of any found<br /> CL [x] search string. Obviously, if no search string was<br /> specified on the previous screen, this command has no<br /> effect. Valid values for 'x' are 0 through 9. If there <br /> is no 'x' specified,it will give a default value of 0 to <br /> the '# of context lines'. <br /> <br /> HAS/HA/H xxx Changes the selection to procedures containing the specified<br /> string 'xxx'. 'HAS $GETG' restricts procedures to those<br /> containing $GETG. HAS does not support wildcards, so a<br /> search for 'locate*' will look for the string 'locate*'.<br /> <br /> PROCS xxx Changes the procedure name filter to 'xxx'. Wildcarding<br /> A xxxx is assumed and fully supported, so for instance, the<br /> command 'PROCS CADDIE' will find all procedures with<br /> the string 'CADDIE' in its name. If specific wildcard<br /> characters are used, the search is done for the<br /> specified pattern, so 'PROCS I.*' restricts the display<br /> to procedures beginning with 'I.'<br /> <br /> AND xxx Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, applying 'distributive <br /> law' if necessary. For instance, if the current value of the <br /> procedure name filter is 'A|B', an 'AND C' command will <br /> change it to 'A C|B C' by applying 'distributive law': <br /> (A|B) C -> A C|B C.<br /> <br /> +AND xxx Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with AND logic, but WITHOUT applying <br /> 'distributive law'. It just simply appends 'xxx' to the <br /> existing procedure name filter. For instance, if the current<br /> value of the procedure name filter is 'A|B', an 'AND C' <br /> command will change it to 'A|B C'. <br /> <br /> OR xxx Changes the procedure name filter bying combining 'xxx' with <br /> the existing value with OR logic. For instance, if the <br /> current value of the procedure name filter is 'A|B', an <br /> 'OR C' command will change it to 'A|B|C'. <br /> <br /> FILE/FL xxx Changes the file context using the existing privileges to <br /> the file.<br /> <br /> FLP Changes the file context with prompt for password.<br /> <br /> GROUP/GP xxx Changes the group context using the existing privileges to <br /> the group. <br /> <br /> GPP Changes the group context with prompt for password.<br /> <br /> PASSWORD/PWD Reopens the current file or group with prompt for password. <br /> It implies a switch of privileges associated with the <br /> password to the current file or group.<br /> <br /> OCC [xxx] Changes the value of '# of occurrences to find'. The valid <br /> value for the optional 'xxx' is either a number between 1 <br /> and 999 or 'ALL'. If there is no 'xxx' specified, it will <br /> give a default value of 1 to the '# of occurrences to find'.<br /> <br /> HS [x] Changes the value of 'Hide SEQs/BASEs'. The valid value for <br /> the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Hide SEQs/BASEs'. <br /> <br /> IC [x] Changes the value of 'Ignore Comment lines'. The valid value <br /> for the optional 'x' is 'Y' or 'N'. If there is no 'x' <br /> specified, it will give a default value of 'Y' to the <br /> 'Igonre Comment lines'.<br /> <br /> CREATEPROC/ Creates a new procedure named 'xxx' in the current file/group <br /> CREATE/ context. If there is no 'xxx' specified, an unnamed <br /> CP [xxx] procedure will be created. <br /> <br /> LASTID/ Changes the value of 'Last Updater ID'. <br /> LID [xxx] The valid value for 'xxx' is a string not longer than 10, or <br /> blank. <br /> <br /> EXIT/QUIT/ Return to previous screen without processing any prefix<br /> END commands.<br /> <br /> ====Selection field====<br /> The following procedure selection option has been added:<br /> <br /> E (Edit): Invokes the [[soulEdit|SoulEditor]]. <br /> <br /> The following new selection options a part of the<br /> Sirius Configuration and Change Control System (SirLib). If SirLib is<br /> not installed then these commands are not valid. Further information<br /> on managed updates and the Configuration Management system is in the<br /> SirLib User's Guide.<br /> <br /> U (Undo): May only be executed against a change deck. This command<br /> performes the same operation as a Q, resulting in a "working"<br /> procedure and a sequenced copy of that procedure being created<br /> in the user's selected development procfile. However, the U<br /> command specifically includes the change deck against which it is<br /> executed in the code for the working procedure, but NOT in the<br /> code from the sequenced copy. In other words, it recreates<br /> the state of the development procedures that created the change<br /> deck against which the U command is executed.<br /> <br /> Typically, the U command is used to recreate the state of development<br /> when the programmer has accidentally deleted the procedures she<br /> was working on, either manually, or via the "Clean-up" switch on<br /> the Xcompare screen.<br /> <br /> The U command is a special-use feature, and there are a number<br /> of ways in which it will fail to work -- most notably, if the<br /> selected change deck is somewhere in the middle of a series of<br /> changes and, by excluding it from procedure creation, some code<br /> dependency is missing. However, for its primary function --<br /> recovering from a mistake that was made very recently, typically<br /> as the most recent change to a procedure, it should always work.<br /> <br /> Y This change-control prefix command provides a special check-out<br /> ability in which the user can "refresh" their local working copy<br /> of a procedure with changes that have been checked in by other<br /> programmers since the working copy was originally taken from<br /> the source procedure file. "Y" is applied against the working<br /> procedure, a screen is presented, and the result is a new<br /> working procedure with all updates applied AND the user's current<br /> changes still in place, and a sequenced copy that has all updates<br /> applied, but the user's current changes not in place.<br /> <br /> In other words, the "Y" command is very much like a "Q" command,<br /> but it is done while changes are in progress, and it slips<br /> into place other changes that have occurred since the original<br /> procedure check-out.<br /> <br /> == New PL subsystem==<br /> (Adrian to complete)<br /> <br /> ==Enhanced Help==<br /> (in progress)</div>

Heikki