SirPro procedure-list operations: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (change PF keys)
m (→‎Prefix commands: add some words)
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
<!--Page automatically generated by CMSTOWIK EXEC and will be
** automatically replaced ** -- any manual edits will be lost.
You've been warned.  ..  (Page built by JAL at the SIRIUS VM; file: FUNPGNEW SYSUT2) -->
<!-- Page name: SirPro procedure-list operations-->
==Overview==
==Overview==
The procedure list shows the procedures that fit the criteria
you specified on the [[SirPro procedure-list selection|selection screen]].


<p class="caption" style="width:500px">The Procedure List screen</p>
<p class="caption" style="width:550px">Procedure List screen</p>
<p class="figure">[[File:ProcListS.png|550px]]</p>


The procedure list shows the procedures that fit the criteria
<p class="note"><b>Note:</b> You can also access this screen from any screen in [[RKTools]] by using the <var>[[RKTools#PL_command|PL]]</var> command-line command. You access a similar screen in [[RKWeb]] by selecting <code>Build > Edit</code> and clicking the <b>Open Procedure List</b> button.</p>
specified on the selection panel.
A prefix area to the left of each
procedure name allows entry of a variety of single-character procedure commands.


Supply a value in the select field (<b>SEL</b>), as described below:
===Prefix commands===
To act on individual procedures in a TN3270 list, you specify single-character procedure commands in the select field (<b>Sel</b>) in the prefix area to the left of a procedure name. These commands are described in the following table, and the screens and processing they invoke are documented later in this page.
<p class="note"><b>Note:</b>
Prefix commands and most of their functionality are not available in the [[RKWeb]] interface which uses a different editor; they can only be used in the SirPro TN3270 interface. </p>
<p>
You may enter any number and combination of prefix commands, none of
which execute until the Enter key is pressed.
<b>D</b>eletes and <b>P</b>rints are done for all procedures at once.
Processing for other commands is performed one
procedure at a time, but with all same-type commands processed
sequentially (that is, all Edits are performed, then all Browses, then
all Prints, etc.) in the order in which commands are encountered from
the top of the procedure list.</p>


<table class="thJustBold">
<table class="thJustBold">
<tr class="head"><th>Command</th>
<th>Action</th></tr>
<tr><th>B</th>
<tr><th>B</th>
<td>Browse</td></tr>
<td>Browse.
<p>
For more information, see [[#smartbr|SmartBrowse: Browse, Variable and (#) Expand]], below.</p></td></tr>


<tr><th>C</th>
<tr><th>C</th>
<td>Copy</td></tr>
<td>Copy.
<p>
For more information, see [[#Move/Copy|Move/Copy]], below.</p></td></tr>


<tr><th>D</th>
<tr><th>D</th>
<td>Delete</td></tr>
<td>Delete.</td></tr>


<tr><th>E or S</th>
<tr><th>E</th>
<td>Edit</td></tr>
<td>Edit.
<p>
Invokes [[SoulEdit]], the SOUL editor, as of RKTools version 7.5. Under an earlier version of SirPro, it invokes the Model&nbsp;204 editor.</p></td></tr>


<tr><th>I</th>
<tr><th>I</th>
<td>Include</td></tr>
<td>Include.
<p>
Invokes a <var class="product">Model&nbsp;204</var> <var>[[INCLUDE command|INCLUDE]]</var> command. </p></td></tr>


<tr><th>M</th>
<tr><th>M</th>
<td>Move</td></tr>
<td>Move.
<p>
For more information, see [[#Move/Copy|Move/Copy]], below.</p></td></tr>


<tr><th>P</th>
<tr><th>P</th>
<td>Print</td></tr>
<td>Print.
<p>
For more information, see [[#Printing procedures|Printing procedures]], below.</p></td></tr>


<tr><th>R</th>
<tr><th>R</th>
<td>Rename</td></tr>
<td>Rename.
<p>
For more information, see [[#Renaming procedures|Renaming procedures]], below.</p></td></tr>
 
<tr><th>S</th>
<td>Edit.
<p>
Invokes the Model&nbsp;204 editor.</p></td></tr>


<tr><th>V</th>
<tr><th>V</th>
<td>Variable analysis</td></tr>
<td>Variable analysis.
<p>
For more information, see [[#smartbr|SmartBrowse: Browse, Variable and (#) Expand]], below.</p></td></tr>


<tr><th>#</th>
<tr><th>#</th>
<td>Expanded Browse</td></tr>
<td>Expanded browse.
<p>
For more information, see [[#smartbr|SmartBrowse: Browse, Variable and (#) Expand]], below.</p></td></tr>
</table>
</table>
In addition, the following <i>managed update commands</i> are
 
provided for users of the <var class="product">SirLib</var> change management system.
In addition, the following are prefix commands that are
provided for users of the <var class="product">[[SirLib]]</var> change management system. They are described in [[SirPro change management tools and functions]].
 
<table class="thJustBold">
<table class="thJustBold">
<caption>Managed-update commands</caption>
<tr class="head"><th>Command</th>
<th>Action</th></tr>
<tr><th>X</th>
<tr><th>X</th>
<td>Xcompare</td></tr>
<td>Xcompare</td></tr>
Line 62: Line 101:


<tr><th>Z</th>
<tr><th>Z</th>
<td>resequence (or ReSequence or resequenZ)</td></tr>
<td>Resequence (or ReSequence or resequenZ)</td></tr>
 
<tr><th>U</th>
<td>Undo</td></tr>
 
<tr><th>Y</th>
<td>Refresh</td></tr>
</table>
</table>


The managed update commands are described in [[SirPro change management tools and functions]].
===Display fields and function keys===
<p>
Users may enter any number and combination of prefix commands, none of
which will execute until the Enter key is pressed.
<b>D</b>eletes and <b>P</b>rints are done for all procedures at once.
Processing for other commands is performed one
procedure at a time, but with all same-type commands processed
sequentially (that is, all Edits are performed, then all Browses, then
all Prints, etc.) in the order in which commands are encountered from
the top of the procedure list.</p>
<p>
<p>
The display area of the screen, described below, can be toggled between
The display area of the screen, described below, can be toggled between
Line 82: Line 118:


<table class="thJustBold">
<table class="thJustBold">
<tr><th nowrap>PROCEDURE NAME</th>
<tr><th nowrap>Procedure Name</th>
<td>The name of a procedure available for editing. Procedure names longer than 25 characters are truncated. An asterisk is added as the last character of the truncated procedure name to indicate that the full name is not displayed, and the procedure name is highlighted. These procedures can still be selected from the list, and the full procedure name is used in all functions.</td></tr>
<td>The name of a procedure available for editing. Procedure names longer than 25 characters are truncated. An asterisk is added as the last character of the truncated procedure name to indicate that the full name is not displayed, and the procedure name is highlighted. These procedures can still be selected from the list, and the full procedure name is used in all functions.</td></tr>


<tr><th>ACCOUNT</th>
<tr><th>Account</th>
<td>The account (user id) of the last user to update the procedure.</td></tr>
<td>The account (user id) of the last user to update the procedure.</td></tr>


<tr><th>BYTES</th>
<tr><th>Bytes</th>
<td>Number of bytes stored in Table D for the procedure.</td></tr>
<td>Number of bytes stored in Table D for the procedure.</td></tr>


<tr><th>DATE/TIME</th>
<tr><th>Date/Time</th>
<td>The date and time the procedure was last updated.</td></tr>
<td>The date and time the procedure was last updated.</td></tr>
</table>
</table>


<p><b>Function keys</b></p>
<p>
<p>
The following function keys invoke actions as described:</p>
The following function keys invoke actions as described:</p>
Line 131: Line 166:


<tr><th>F11</th>
<tr><th>F11</th>
<td>Toggles between upper and mixed case <b><i>E</i></b>dit when the editor is invoked. The key label indicates the case to which you will switch when the key is pressed.</td></tr>
<td>Toggles between upper and mixed case <b>E</b>dit when the editor is invoked. The key label indicates the case to which you will switch when the key is pressed.</td></tr>


<tr><th>F12</th>
<tr><th>F12</th>
<td>Toggle the display between a "D LIST" format and a "FULLNAME" format. In DLIST format, the display shows the traditional <var class="product">Model 204</var> procedure list information with long procedure names truncated at 25 characters (for display only). In FULLNAME format, long procedure names overlay their corresponding procedure information.</td></tr>
<td>Toggle the display between a "D LIST" format and a "FULLNAME" format. In DLIST format, the display shows the traditional <var class="product">Model 204</var> procedure list information with long procedure names truncated at 25 characters (for display only). In FULLNAME format, long procedure names overlay their corresponding procedure information.</td></tr>
</table>
</table>
===Command-line commands===
<p>
The commands in the following table are valid on the command-line of this screen. These commands are not available in the RKWeb interface. </p>
<p>
<p>
The following commands are valid on the command-line of this screen:</p>
As of version 7.5, you can string command-line commands together using a semicolon (<tt>;</tt>) as a delimiter. For example, to switch to a new file, <code>SIRIUS</code>, and display those procedures that have "HELP" in their name, specify: </p>
<p class="code">FL SIRIUS;A HELP</p>
 
An erroneous command remains on the screen so it can be amended.


<table class="thJustBold">
<table class="thJustBold">
<tr><td nowrap>Screen navigation <br>commands:</td>
<td><table class="thJustBold">
<tr class="head"><th>Command</th><th>Description</th></tr>
<tr><th>L <i>n</i></th>
<tr><th>L <i>n</i></th>
<td>Locate line number <i>n</i>.</td></tr>
<td>Locate line number <i>n</i>.</td></tr>
Line 166: Line 212:
<tr><th>END or QUIT</th>
<tr><th>END or QUIT</th>
<td>Same as F3, returns to previous screen.</td></tr>
<td>Same as F3, returns to previous screen.</td></tr>
</table>
</table></td></tr>
 
<tr><td colspan="2"></td></tr>
 
<tr><td nowrap>Procedure list <br>commands:</td>
<td>As of version 7.5, most of the functions you can perform on the [[SirPro procedure-list selection|procedure file selection]] screen, you can issue as commands in the command line field. Most of these commands have a full name and an abbreviation.
 
<table class="thJustBold">
<tr class="head"><th>Command</th><th>Description</th></tr>
 
<tr><th>{PROCS&nbsp;|&nbsp;A}&nbsp;[<i>xxxx</i>]</th>
<td>Changes the procedure name filter to '<i>xxxx</i>'. Wildcarding (as described in [[SirPro procedure-list selection#procname|Procedure name]]) is assumed and fully supported, so for instance, the command <code>PROCS CADDIE</code> finds all procedures with the string "CADDIE" in its name.
<p>
If you use specific wildcard characters, the search is done for the
specified pattern, so <code>PROCS I*</code> restricts the display
to procedures beginning with "I". </p>
<p>
If the filter <var class="term">xxxx</var> is omitted, all procedures are displayed. </p>
</td></tr>
 
<tr><th>AND <i>xxxx</i></th>
<td>Changes the procedure name filter by combining <var class="term">xxxx</var> with the existing value with And logic, applying the "distributive law" if necessary. For instance, if the current value of the procedure name filter is <code>A|B</code>, an <code>AND C</code> command changes it to <code>A C|B C</code> by applying the distributive law:
<p class="code">(A|B) C -> A C|B C </p>
Hence this filters the current display listing to show only those that also meet the new criteria.
</td></tr>
 
<tr><th>+AND <i>xxxx</i></th>
<td>Changes the procedure name filter by combining <var class="term">xxxx</var> with the existing value with And logic, but <b>without</b> applying the "distributive law." It just simply appends <var class="term">xxxx</var> to the existing procedure name filter. For instance, if the current value of the procedure name filter is <code>A|B</code>, an <code>AND C</code> command changes it to <code>A|B C</code>. 
</td></tr>
   
<tr><th>OR <i>xxxx</i></th>
<td>Changes the procedure name filter by combining <var class="term">xxxx</var> with the existing value with Or logic. For instance, if the current value of the procedure name filter is <code>A|B</code>, an <code>OR C</code> command changes it to <code>A|B|C</code>. Hence this adds additional procedures to the display listing.
</td></tr>
 
<tr><th nowrap>{CREATEPROC | CREATE | CP} [<i>xxxx</i>]</th>
<td>Creates a new procedure named <code><i>xxxx</i></code> in the current file/group context. If there is no <var class="term">xxxx</var> specified, an unnamed procedure is created. 
</td></tr>
 
<tr><th>{FILE | FL} <i>xxx</i></th>
<td>Changes the file context to <var class="term">xxx</var> using the existing privileges to the file.
</td></tr>
 
<tr><th>FLP <i>xxx</i> </th>
<td>Changes the file context to <var class="term">xxx</var> with a prompt for password.
</td></tr>
 
<tr><th>{GROUP | GP} <i>xxx</i></th>
<td>Changes the group context to <var class="term">xxx</var> using the existing privileges to the group. 
</td></tr>
         
<tr><th>GPP <i>xxx</i></th>
<td>Changes the group context to <var class="term">xxx</var> with a prompt for password.
</td></tr>
 
<tr><th>PASSWORD | PWD</th>
<td>Reopens the current file or group with a prompt for password. It implies a switch of privileges associated with the password to the current file or group.
</td></tr>
 
<tr><th>{LASTID | LID} [<i>xxx</i>]</th>
<td>Changes the value of the <b>Last Updater ID</b> field. The valid value for <var class="term">xxx</var> is a string not longer than 10, or is a blank.             
</td></tr>
 
<tr><th>{HAS | HA | H} [<i>xxx</i>]</th>
<td>Changes the selection to procedures containing the specified string <var class="term">xxx</var>. <code>HAS $GETG</code> restricts procedures to those containing <code>$GETG</code>.
<p>
<p>
In addition, any of the prefix commands may be typed on the command
<var>HAS</var> does <i>not</i> support wildcards, so a search for <code>locate*</code> looks for the string "locate*". </p>
line, followed by either a procedure name, or the number of that
procedure in the displayed list. If the procedures selected in this
manner is the first procedure selected, processing is initiated
immediately. If other prefix commands have already been entered, the
procedure is added to the selected list.</p>
<p>
<p>
<b>I</b>nclude and <b>E</b>dit (<b>E</b> or <b>S</b>)
If the string <var class="term">xxx</var> is omitted, the search string is cleared. </p></td></tr>
are not documented further, as they merely invoke a <var class="product">Model 204</var> edit or include. The other prefix commands invoke special screens and
 
processing, which are documented in the sections that follow.</p>
<tr><th>{DISPLAY&nbsp;|&nbsp;CODE | SHOW | CL} [<i>n</i>]</th>
<td>With these commands you can alter the number of lines of code to be displayed, beginning with the first of any found search string. If no search string was specified on the previous screen, this command has no effect.
<p>
Valid values for <var class="term">n</var> are 0 through 9. If there is no <var class="term">n</var> specified, it gives a default value of 0 to the <b># of context lines</b> field. </p>
</td></tr>
 
<tr><th>OCC [<i>nnn</i>]</th>
<td>Changes the value of the <b># of occurrences to find</b> field. The valid value for the optional <var class="term">nnn</var> is a number between 1 and 999 or it is <var>ALL</var>. If there is no <var class="term">nnn</var> specified, it gives a default value of 1 to the <b># of occurrences to find</b> field.
</td></tr>
 
<tr><th>IC [<i>x</i>]</th>
<td>Changes the value of the <b>Ignore Comment lines</b> field. The valid values for the optional <var class="term">x</var> are <code>Y</code> and <code>N</code>. If there is no <var class="term">x</var> specified, it gives a default value of <code>Y</code> to <b>Ignore Comment lines</b>.
</td></tr>
     
<tr><th>HS [<i>x</i>]</th>
<td>Changes the value of the <b>Hide SEQs/BASEs</b> field. The valid value for the optional <var class="term">x</var> is <code>Y</code> or <code>N</code>. If there is no <var class="term">x</var> specified, it gives a default value of <code>Y</code> to <b>Hide SEQs/BASEs</b>.
</td></tr>
</table></td></tr>
 
<tr><td colspan="2"></td></tr>
 
<tr><td>Prefix commands:</td>
<td>Any of the [[#Prefix commands|prefix commands]] may be typed on the command line, followed by a procedure name or the number of that procedure in the displayed list. If the procedures selected in this manner is the first procedure selected, processing is initiated immediately. If other prefix commands have already been entered, the procedure is added to the selected list.</td></tr>
</table>


==Move/Copy==
==Move/Copy==
Line 185: Line 312:
The source information is protected.
The source information is protected.


<p class="caption" style="width:500px">Move/Copy procedure screen</p>
<p class="caption" style="width:450px">Move/Copy procedure screen</p>
<p class="figure">[[File:SProCopyMv.png|450px]]</p>


The copy screen requires input in the following fields:
The copy screen requires input in the following fields:
<table class="thJustBold">
<table class="thJustBold">
<tr><th>FROM FILE</th>
<tr><th>Copy <br>Procedure <br>From: <td>
<td>The name of the file from which you are moving/copying. This field is protected.</td></tr>


<tr><th>FROM PROC</th>
<table>
<tr><th>Context</th>
<td><code>FILE</code> or <code>GROUP</code> is displayed.</td></tr>
 
<tr><th>Proc File</th>
<td>The name of the file from which you are moving/copying. This field is protected. Provide the file password, if needed.</td></tr>
 
<tr><th>Procedure</th>
<td>The name of the procedure from which you are moving/copying. This field is protected.</td></tr>
<td>The name of the procedure from which you are moving/copying. This field is protected.</td></tr>
</table></td></tr>


<tr><th>DESTINATION FILE</th>
<tr><th>Copy <br>Procedure <br>To: <td>
<td>The name of the file to which you want to move/copy the file.</td></tr>


<tr><th>DESTINATION FILE PASSWORD</th>
<table>
<td>The file password, if needed.</td></tr>
<tr><th>Context</th>
<td><code>FILE</code> or <code>GROUP</code> are the only valid input values.</td></tr>


<tr><th nowrap>DESTINATION PROCEDURE NAME</th>
<tr><th>Proc File</th>
<td>The name of the file to which you want to move/copy the file.  Provide the file password, if needed.</td></tr>
 
<tr><th>Procedure</th>
<td>The procedure can be renamed during Copy/Move operation. If the file is being copied or moved to the same file, it must be renamed.</td></tr>
<td>The procedure can be renamed during Copy/Move operation. If the file is being copied or moved to the same file, it must be renamed.</td></tr>


<tr><th>REPLACE Y/N</th>
<tr><th nowrap>Replace Existing Procedure?</th>
<td>Type Y to replace if the procedure already exists. The default is N.</td></tr>
<td>Type <code>Y</code> to replace if the procedure already exists. The default is <code>N</code>.</td></tr>


<tr><th>EDIT Y/N</th>
<tr><th>Keep Old Date?</th>
<td>Type <code>Y</code> to edit the new procedure before <var class="product">UL/SPF</var> performs the move/copy. The default is <code>N</code>.
<td><code>Y</code> transfers the existing date (last update) of the source procedure to the destination procedure. The default is <code>Y</code>. </td></tr>
<p>
</table></td></tr>
If you type <code>Y</code>, editing takes place before <var class="product">UL/SPF</var> stores the procedures in the "TO" procedure and leaves the source procedure unchanged. The procedure status line (the top line of the editor display screen) shows that you are editing a temporary procedure into the destination procedure name.</p>
<p>
When you finish editing the procedure, type <code>END</code> in the command window. <var class="product">UL/SPF</var> stores the new procedure in the destination procedure name.
To terminate the edit process and abandon edit changes and the Copy, type <code>QUIT</code>.</p></td></tr>
</table>
</table>


Line 232: Line 366:
or F12 to confirm the deletions.
or F12 to confirm the deletions.


<p class="caption" style="width:500px">Confirming procedure deletion</p>
<p class="caption" style="width:550px">Confirming procedure deletion</p>
<p class="figure">[[File:SProProcDeleteS.png|550px]]</p>


Function keys are the same as on the procedure selection list, except that F10
Function keys are the same as on the procedure selection list, except that F10
Line 244: Line 379:
A variety of options are provided for printing procedures.
A variety of options are provided for printing procedures.
Procedures may be routed to an output file, or to a printer via a <code>USE
Procedures may be routed to an output file, or to a printer via a <code>USE
<i>printer.id</i></code> command or a <code>USE $PRINT</code> command.
<i>printer.id</i></code> command or a <var>[[USE $PRINT / $PUNCH / $JOB command|USE $PRINT]]</var> command.


No confirmation is performed for print operations.
No confirmation is performed for print operations.
Line 252: Line 387:
and various characteristics of the print job:
and various characteristics of the print job:


<p class="caption" style="width:500px">Print destination screen</p>
<p class="caption" style="width:450px">Print destination screen</p>
<p class="figure">[[File:SProPrintS.png|450px]]</p>


Enter the following information:
Enter the following information:


<table class="thJustBold">
<table class="thJustBold">
<tr><th>DESTINATION</th>
<tr><th>Destination</th>
<td>The destination of the procedure. Select 1 to print to a the printer named in the PRINTER field, 2 to output the procedures to the file named in the FILE field,
<td>The destination of the procedure. Select 1 to print the procedure(s) to the file named in the <b>Dataset DDNAME</b> field, 2 to output to the printer named in the <b>Printer ID</b> field,
and 3 to invoke a USE $PRINT, to the specified CLASS and PRINTER.</td></tr>
and 3 to invoke a <code>USE $PRINT</code> to the specified <b>$PRINT Class</b> and default printer.</td></tr>


<tr><th>PRINTER</th>
<tr><th>Dataset DDNAME</th>
<td>A valid predefined printer name. If this field is blank or invalid when a 1 is specified in the OUTPUT DESTINATION field, the print comes to the user's terminal.</td></tr>
<td>DDname of a sequential data set to contain the print output. This name must begin with <code>OUT</code>.</td></tr>


<tr><th>OUTFILE</th>
<tr><th>Printer ID</th>
<td>A valid preallocated sequential file.</td></tr>
<td>A valid predefined printer name. If this field is blank or invalid when a 2 is specified in the <b>Destination</b> field, the print goes to the user's terminal.</td></tr>


<tr><th>CLASS</th>
<tr><th>$PRINT Class</th>
<td>The job class to use for USE $PRINT requests. This job class should be a valid class at your site. USE $PRINT is an obsolete method of printing, and its use is discouraged.
<td>The job class to use for <code>USE $PRINT</code> requests. This must be a valid class at your site.  
If the PRINTER is blank or invalid when a USE $PRINT is invoked, the print is routed to PRINTER=LOCAL by <var class="product">Model 204</var></td></tr>
</td></tr>


<tr><th>WITH criteria</th>
<tr><th>with</th>
<td>Enter in these two fields any print routing criteria normally placed in the "WITH" clause of a USE statement (such as COPIES=xx, TAG or ID statements).</td></tr>
<td>Enter in these two fields any print routing criteria normally placed in the <var>WITH</var> clause of a <var>USE</var> statement (such as <var>COPIES=<i>xx</i></var>, <var>TAG</var> or <var>ID</var> statements).</td></tr>


<tr><th>UDDLPP</th>
<tr><th>Lines Per Page (UDDLPP)</th>
<td>The number of lines to be printed or displayed per page. The default is 60 lines per page.</td></tr>
<td>The number of lines to be printed or displayed per page. The default is 60 lines per page.</td></tr>


<tr><th>UDDCCC</th>
<tr><th>Characters Per Line (UDDCCC)</th>
<td>The number of characters to be printed or displayed per line. The default is 133 characters per line.</td></tr>
<td>The number of characters to be printed or displayed per line. The default is 133 characters per line.</td></tr>


<tr><th>HDRCTL</th>
<tr><th>Record Format (UDDRFM)</th>
<td>Header control settings allow the user to suppress various levels of automatic print headers.</td></tr>
 
<tr><th>UDDRFM</th>
<td>The number of characters to be printed or displayed per line. The default is 133 characters per line.</td></tr>
<td>The number of characters to be printed or displayed per line. The default is 133 characters per line.</td></tr>


<tr><th nowrap>Use SirPro Formatting?</th>
<tr><th>Header Control (HDRCTL)</th>
<td>Specifying <code>N</code> to this prompt prints procedures as they are in the procedure file. Specifying <code>Y</code> forces a page break at the beginning of each procedure,
<td>Header control settings let you suppress various levels of automatic print headers.</td></tr>
numbers the lines of the procedure and produces a header at the top of each page, indicating the procedure file, procedure name, date, and time of the print.</td></tr>


<tr><th>Format for file reorg?</th>
<tr><th nowrap>Output for procedure reload (Y/N)</th>
<td>Specifying <code>Y</code> to this prompt prints procedures beginning in column 1 and placing <code>PROCEDURE <i>procname</i></code> and <code>END PROCEDURE <i>procname</i></code> statements around each output procedure.
<td>Specifying <code>Y</code> to this prompt prints procedures beginning in column 1 and placing <code>PROCEDURE <i>procname</i></code> and <code>END PROCEDURE <i>procname</i></code> statements around each output procedure.
Procedures output to a file using this formatting feature can be input directly to a procedure file reorganization job.  
This allows later uploading of the output stream directly back into a Model&nbsp;204 procedure file.  
<p>
<p>
Specifying <code>Y</code> to this prompt overrides a <code>Y</code> to the previous prompt (<b>Use SirPro Formatting?</b>), because file reorganization format precludes the type of headers and line numbers used in SirPro formatting.</p></td></tr>
Specifying <code>Y</code> to this prompt fails if a <code>Y</code> is also specified for the following prompt (<b>Use SIRPRO Formatting</b>).</p></td></tr>
 
<tr><th nowrap>Use SIRPRO Formatting (Y/N)</th>
<td>Specifying <code>N</code> to this prompt prints procedures as they are in the procedure file. Specifying <code>Y</code> forces a page break at the beginning of each procedure,
numbers the lines of the procedure, and produces a header at the top of each page, indicating the procedure file, procedure name, date, and time of the print.</td></tr>
</table>
</table>


Line 311: Line 447:
except the destination.
except the destination.


==Rename procedures==
==Renaming procedures==
Procedures selected for <b>R</b>enaming are presented one at a time.
Procedures selected for <b>R</b>enaming are presented one at a time.


<p class="caption" style="width:500px">Renaming procedures screen</p>
<p class="caption" style="width:400px">Rename Procedure screen</p>
<p class="figure">[[File:SProRenameProcS.png|400px]]</p>


On returning to the original list, procedure information lines are
On returning to the original list, procedure information lines are
overwritten with a success message for renamed procedures, and they are
overwritten with a success message for renamed procedures, and they are
protected from update until the user's procedure list is refreshed.
protected from update until the user's procedure list is refreshed.
On a renaming failure, SirPro reports the reason: insufficient privileges, the procedure name already exists, or the procedure name exists as an alias, or the procedure is locked. 


<p><b>Function keys</b></p>
<p><b>Function keys</b></p>
Line 330: Line 469:
</table>
</table>


<div id="smartbr"></div>
==<b id="smartbr"></b>SmartBrowse: Browse, Variable and (#) Expand==
==SmartBrowse: Browse, Variable and (#) Expand==
<!--Caution: <div> above-->
 
<b>B</b>rowse, <b>V</b>ariable and <b>#</b> (Expand) prefix
<b>B</b>rowse, <b>V</b>ariable and <b>#</b> (Expand) prefix
commands all invoke SmartBrowse sessions.
commands all invoke SmartBrowse sessions.
Line 348: Line 484:


<p class="caption" style="width:500px">SmartBrowse: Browsing a procedure</p>
<p class="caption" style="width:500px">SmartBrowse: Browsing a procedure</p>
<p class="figure">[[File:SProBrowse2S.png|500px]]</p>


<p class="caption" style="width:500px">SmartBrowse: Displaying undeclared variables</p>
The following command-line commands are also valid, depending on the SmartBrowse session context:


All three of these commands invoke the same procedure, so the user may
switch their browse session from one view to another with the following commands:
<table class="thJustBold">
<table class="thJustBold">
<tr><th>BOTTOM</th>
<td>Moves the display to the bottom of the procedure list.</td></tr>
<tr><th>BROWSE</th>
<tr><th>BROWSE</th>
<td>Convert the display to a simple browse session.</td></tr>
<td>Convert the display to a simple browse session.</td></tr>
<tr><th>UNDECL</th>
<td>Display undeclared variable names only.</td></tr>
<tr><th>VARIABLE</th>
<td>Display undeclared variable names only (same as UNDECL).</td></tr>


<tr><th>EXPAND</th>
<tr><th>EXPAND</th>
<td>Expand all include statements.</td></tr>
<td>Expand all include statements.</td></tr>
</table>


The following command-line commands are also valid:
<tr><th>F <i>string</i> or /<i>string</i></th>
<td>Find a specific "string," starting the search from the top line of the display. This string can be any part of the procedure name. That is, it is not a prefix search.</td></tr>
 
<tr><th>-F <i>string</i> or -/<i>string</i></th>
<td>Find a specific string, searching backward from the top line of the display.</td></tr>


<table class="thJustBold">
<tr><th>L <i>n</i></th>
<tr><th>L <i>n</i></th>
<td>Locate line number <i>n</i>.</td></tr>
<td>Locate line number <i>n</i>.</td></tr>
Line 376: Line 510:
<td>Scroll <i>n</i> or -<i>n</i> lines from the top line of the display.</td></tr>
<td>Scroll <i>n</i> or -<i>n</i> lines from the top line of the display.</td></tr>


<tr><th>F <i>string</i> or /<i>string</i></th>
<tr><th>M</th>
<td>Find a specific "string," starting the search from the top line of the display. This string can be any part of the procedure name. That is, it is not a prefix search.</td></tr>
<td>When using F7 or F8, scroll up or down to the top or bottom of the list of procedures.</td></tr>
 
<tr><th>-F <i>string</i> or -/<i>string</i></th>
<td>Find a specific string, searching backward from the top line of the display.</td></tr>


<tr><th>TOP</th>
<tr><th>TOP</th>
<td>Moves the display to the top of the procedure list.</td></tr>
<td>Moves the display to the top of the procedure list.</td></tr>


<tr><th>BOTTOM</th>
<tr><th>UNDECL or VARIABLE</th>
<td>Moves the display to the bottom of the procedure list.</td></tr>
<td>Display undeclared variable names only.</td></tr>
 
<tr><th>M</th>
<td>When using F7 or F8, scroll up or down to the top or bottom of the list of procedures.</td></tr>
</table>
</table>


Latest revision as of 16:56, 23 June 2017

Overview

The procedure list shows the procedures that fit the criteria you specified on the selection screen.

Procedure List screen

Note: You can also access this screen from any screen in RKTools by using the PL command-line command. You access a similar screen in RKWeb by selecting Build > Edit and clicking the Open Procedure List button.

Prefix commands

To act on individual procedures in a TN3270 list, you specify single-character procedure commands in the select field (Sel) in the prefix area to the left of a procedure name. These commands are described in the following table, and the screens and processing they invoke are documented later in this page.

Note: Prefix commands and most of their functionality are not available in the RKWeb interface which uses a different editor; they can only be used in the SirPro TN3270 interface.

You may enter any number and combination of prefix commands, none of which execute until the Enter key is pressed. Deletes and Prints are done for all procedures at once. Processing for other commands is performed one procedure at a time, but with all same-type commands processed sequentially (that is, all Edits are performed, then all Browses, then all Prints, etc.) in the order in which commands are encountered from the top of the procedure list.

Command Action
B Browse.

For more information, see SmartBrowse: Browse, Variable and (#) Expand, below.

C Copy.

For more information, see Move/Copy, below.

D Delete.
E Edit.

Invokes SoulEdit, the SOUL editor, as of RKTools version 7.5. Under an earlier version of SirPro, it invokes the Model 204 editor.

I Include.

Invokes a Model 204 INCLUDE command.

M Move.

For more information, see Move/Copy, below.

P Print.

For more information, see Printing procedures, below.

R Rename.

For more information, see Renaming procedures, below.

S Edit.

Invokes the Model 204 editor.

V Variable analysis.

For more information, see SmartBrowse: Browse, Variable and (#) Expand, below.

# Expanded browse.

For more information, see SmartBrowse: Browse, Variable and (#) Expand, below.

In addition, the following are prefix commands that are provided for users of the SirLib change management system. They are described in SirPro change management tools and functions.

Managed-update commands
Command Action
X Xcompare
Q seQuence
N New
K Klobber
Z Resequence (or ReSequence or resequenZ)
U Undo
Y Refresh

Display fields and function keys

The display area of the screen, described below, can be toggled between a set of views. The DLIST view, similar to the view of procedures most commonly seen by User Language developers at the command level, contains the following information:

Procedure Name The name of a procedure available for editing. Procedure names longer than 25 characters are truncated. An asterisk is added as the last character of the truncated procedure name to indicate that the full name is not displayed, and the procedure name is highlighted. These procedures can still be selected from the list, and the full procedure name is used in all functions.
Account The account (user id) of the last user to update the procedure.
Bytes Number of bytes stored in Table D for the procedure.
Date/Time The date and time the procedure was last updated.

The following function keys invoke actions as described:

F1 Full screen help.
F2 Sort the displayed list by procedure name.
F3 Quit (return to previous screen).
F4 Sort the displayed list by last updating user.
F5 Sort the displayed list by last date updated.
F6 Sort the displayed list by size of procedure.
F7 Scroll backward (up).
F8 Scroll forward (down).
F9 Repeat last command-line command.
F10 Refresh the list. Use this key to clear any prefix selections and to recheck the file for procedure information that may have changed (for instance, if another user is deleting procedures in the same file, your list may be out-of-date).
F11 Toggles between upper and mixed case Edit when the editor is invoked. The key label indicates the case to which you will switch when the key is pressed.
F12 Toggle the display between a "D LIST" format and a "FULLNAME" format. In DLIST format, the display shows the traditional Model 204 procedure list information with long procedure names truncated at 25 characters (for display only). In FULLNAME format, long procedure names overlay their corresponding procedure information.

Command-line commands

The commands in the following table are valid on the command-line of this screen. These commands are not available in the RKWeb interface.

As of version 7.5, you can string command-line commands together using a semicolon (;) as a delimiter. For example, to switch to a new file, SIRIUS, and display those procedures that have "HELP" in their name, specify:

FL SIRIUS;A HELP

An erroneous command remains on the screen so it can be amended.

Screen navigation
commands:
CommandDescription
L n Locate line number n.
n or -n Scroll n or -n lines from the top line of the display.
F string or /string Find a specific "string," starting the search from the top line of the display. This string can be any part of the procedure name. That is, it is not a prefix search.
-F string or -/string Find a specific string, searching backward from the top line of the display.
TOP Moves the display to the top of the procedure list.
BOTTOM Moves the display to the bottom of the procedure list.
M When using F7 or F8, scroll up or down to the top or bottom of the list of procedures.
CLOSE xxxx Closes the specified file or group. SirPro subsystem files, and the file(s) from which the current procedure list was taken, cannot be closed.
END or QUIT Same as F3, returns to previous screen.
Procedure list
commands:		 As of version 7.5, most of the functions you can perform on the procedure file selection screen, you can issue as commands in the command line field. Most of these commands have a full name and an abbreviation.
CommandDescription
{PROCS | A} [xxxx] Changes the procedure name filter to 'xxxx'. Wildcarding (as described in Procedure name) is assumed and fully supported, so for instance, the command PROCS CADDIE finds all procedures with the string "CADDIE" in its name.

If you use specific wildcard characters, the search is done for the specified pattern, so PROCS I* restricts the display to procedures beginning with "I".

If the filter xxxx is omitted, all procedures are displayed.

AND xxxx Changes the procedure name filter by combining xxxx with the existing value with And logic, applying the "distributive law" if necessary. For instance, if the current value of the procedure name filter is A|B, an AND C command changes it to A C|B C by applying the distributive law:

(A|B) C -> A C|B C

Hence this filters the current display listing to show only those that also meet the new criteria.

+AND xxxx Changes the procedure name filter by combining xxxx with the existing value with And logic, but without applying the "distributive law." It just simply appends xxxx to the existing procedure name filter. For instance, if the current value of the procedure name filter is A|B, an AND C command changes it to A|B C.
OR xxxx Changes the procedure name filter by combining xxxx with the existing value with Or logic. For instance, if the current value of the procedure name filter is A|B, an OR C command changes it to A|B|C. Hence this adds additional procedures to the display listing.
{CREATEPROC | CREATE | CP} [xxxx] Creates a new procedure named xxxx in the current file/group context. If there is no xxxx specified, an unnamed procedure is created.
{FILE | FL} xxx Changes the file context to xxx using the existing privileges to the file.
FLP xxx Changes the file context to xxx with a prompt for password.
{GROUP | GP} xxx Changes the group context to xxx using the existing privileges to the group.
GPP xxx Changes the group context to xxx with a prompt for password.
PASSWORD | PWD Reopens the current file or group with a prompt for password. It implies a switch of privileges associated with the password to the current file or group.
{LASTID | LID} [xxx] Changes the value of the Last Updater ID field. The valid value for xxx is a string not longer than 10, or is a blank.
{HAS | HA | H} [xxx] Changes the selection to procedures containing the specified string xxx. HAS $GETG restricts procedures to those containing $GETG.

HAS does not support wildcards, so a search for locate* looks for the string "locate*".

If the string xxx is omitted, the search string is cleared.

{DISPLAY | CODE | SHOW | CL} [n] With these commands you can alter the number of lines of code to be displayed, beginning with the first of any found search string. If no search string was specified on the previous screen, this command has no effect.

Valid values for n are 0 through 9. If there is no n specified, it gives a default value of 0 to the # of context lines field.

OCC [nnn] Changes the value of the # of occurrences to find field. The valid value for the optional nnn is a number between 1 and 999 or it is ALL. If there is no nnn specified, it gives a default value of 1 to the # of occurrences to find field.
IC [x] Changes the value of the Ignore Comment lines field. The valid values for the optional x are Y and N. If there is no x specified, it gives a default value of Y to Ignore Comment lines.
HS [x] Changes the value of the Hide SEQs/BASEs field. The valid value for the optional x is Y or N. If there is no x specified, it gives a default value of Y to Hide SEQs/BASEs.
Prefix commands: Any of the prefix commands may be typed on the command line, followed by a procedure name or the number of that procedure in the displayed list. If the procedures selected in this manner is the first procedure selected, processing is initiated immediately. If other prefix commands have already been entered, the procedure is added to the selected list.

Move/Copy

The destination screen is displayed once for each procedure selected for Copy or Move. The screen requires entry of destination file and procedure name, and allows the procedure to be edited on the way to the new location. The source information is protected.

Move/Copy procedure screen

The copy screen requires input in the following fields:

Copy
Procedure
From:
Context FILE or GROUP is displayed.
Proc File The name of the file from which you are moving/copying. This field is protected. Provide the file password, if needed.
Procedure The name of the procedure from which you are moving/copying. This field is protected.
Copy
Procedure
To:
Context FILE or GROUP are the only valid input values.
Proc File The name of the file to which you want to move/copy the file. Provide the file password, if needed.
Procedure The procedure can be renamed during Copy/Move operation. If the file is being copied or moved to the same file, it must be renamed.
Replace Existing Procedure? Type Y to replace if the procedure already exists. The default is N.
Keep Old Date? Y transfers the existing date (last update) of the source procedure to the destination procedure. The default is Y.

Function keys

The following keys invoke actions as described:

F1 Full screen help.
F3 Cancel the request to copy or move this procedure. If this is one of a list of selected procedures, the next procedure is presented; if this is the only procedure, or if it is the last procedure in a list, you are returned to the procedure list display.

Deleting procedures

Procedures selected for deletion are presented in a single scrollable list, from which you press the F3 key to cancel (and return to the list where the selections can be changed), or F12 to confirm the deletions.

Confirming procedure deletion

Function keys are the same as on the procedure selection list, except that F10 is not active (the user must return to the previous screen to refresh the procedure list), and F12 is used as a confirmation key for the delete.

On returning to the original list, procedure information lines are overwritten with a success or failure message for the delete operation.

Printing procedures

A variety of options are provided for printing procedures. Procedures may be routed to an output file, or to a printer via a USE printer.id command or a USE $PRINT command.

No confirmation is performed for print operations. The user is routed directly to the Print Destination screen for routing.

The Print destination screen controls output routing of the procedures, and various characteristics of the print job:

Print destination screen

Enter the following information:

Destination The destination of the procedure. Select 1 to print the procedure(s) to the file named in the Dataset DDNAME field, 2 to output to the printer named in the Printer ID field, and 3 to invoke a USE $PRINT to the specified $PRINT Class and default printer.
Dataset DDNAME DDname of a sequential data set to contain the print output. This name must begin with OUT.
Printer ID A valid predefined printer name. If this field is blank or invalid when a 2 is specified in the Destination field, the print goes to the user's terminal.
$PRINT Class The job class to use for USE $PRINT requests. This must be a valid class at your site.
with Enter in these two fields any print routing criteria normally placed in the WITH clause of a USE statement (such as COPIES=xx, TAG or ID statements).
Lines Per Page (UDDLPP) The number of lines to be printed or displayed per page. The default is 60 lines per page.
Characters Per Line (UDDCCC) The number of characters to be printed or displayed per line. The default is 133 characters per line.
Record Format (UDDRFM) The number of characters to be printed or displayed per line. The default is 133 characters per line.
Header Control (HDRCTL) Header control settings let you suppress various levels of automatic print headers.
Output for procedure reload (Y/N) Specifying Y to this prompt prints procedures beginning in column 1 and placing PROCEDURE procname and END PROCEDURE procname statements around each output procedure.

This allows later uploading of the output stream directly back into a Model 204 procedure file.

Specifying Y to this prompt fails if a Y is also specified for the following prompt (Use SIRPRO Formatting).

Use SIRPRO Formatting (Y/N) Specifying N to this prompt prints procedures as they are in the procedure file. Specifying Y forces a page break at the beginning of each procedure, numbers the lines of the procedure, and produces a header at the top of each page, indicating the procedure file, procedure name, date, and time of the print.

Function keys are the same as on the procedure selection list, except that F10 is not active (the user must return to the previous screen to refresh their selected list), and F12 is used as a confirmation key for the print.

If either Option 1 or Option 2 is selected, SirPro executes a simple USE command. If Option 3 is selected, a command of the following format is executed:

USE $PRINT PRINTER=printer.id CLASS=print.class

If the specified printer is invalid, PRINTER=LOCAL is substituted.

All user entries on the print screen are saved in the user profile except the destination.

Renaming procedures

Procedures selected for Renaming are presented one at a time.

Rename Procedure screen

On returning to the original list, procedure information lines are overwritten with a success message for renamed procedures, and they are protected from update until the user's procedure list is refreshed.

On a renaming failure, SirPro reports the reason: insufficient privileges, the procedure name already exists, or the procedure name exists as an alias, or the procedure is locked.

Function keys

The following keys invoke actions as described:

F1 Full screen help for this screen.
F3 Cancel the request to rename this procedure.

SmartBrowse: Browse, Variable and (#) Expand

Browse, Variable and # (Expand) prefix commands all invoke SmartBrowse sessions.

  • Browse displays the procedure in a scrollable list (which does not invoke an edit session).
  • Expand (#) brings inline all INCLUDEd code, and presents the fully expanded procedure in a scrollable list (INCLUDEs of temporary procedures are ignored).
  • Variable scans the fully expanded procedure and presents a list of undeclared %variables.

SmartBrowse: Browsing a procedure

The following command-line commands are also valid, depending on the SmartBrowse session context:

BOTTOM Moves the display to the bottom of the procedure list.
BROWSE Convert the display to a simple browse session.
EXPAND Expand all include statements.
F string or /string Find a specific "string," starting the search from the top line of the display. This string can be any part of the procedure name. That is, it is not a prefix search.
-F string or -/string Find a specific string, searching backward from the top line of the display.
L n Locate line number n.
n or -n Scroll n or -n lines from the top line of the display.
M When using F7 or F8, scroll up or down to the top or bottom of the list of procedures.
TOP Moves the display to the top of the procedure list.
UNDECL or VARIABLE Display undeclared variable names only.

Function keys

The following keys invoke actions as described:

F1 Full screen help for this screen.
F3 Exit from SmartBrowse of this procedure.
F7 Scroll up.
F8 Scroll down.
F9Repeat last command-line command.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=SirPro_procedure-list_operations&oldid=103555"