View source for SirPro change management tools and functions

==Overview==
Managed-update commands allow the manipulation and promotion of just the updates you make to a procedure, "deltas," instead of preserving and working with a sequence of updated copies of the entire procedure or entire procedure file. Managed-update commands are available in SirPro if the change management system, <var class="product">[[SirLib]]</var>, is active in the Online.

The output from a managed-update command that produces update
procedures contains a single-line comment describing the creator,
date, time, and source file for the change.
<p>
The managed-update commands are entered as prefix commands on the Procedure List screen
(see [[SirPro procedure-list operations]]).
These prefix commands are:</p>

<table class="thJustBold">
<tr><th>X</th>
<td><b>Xcompare</b>. 
<p>Compares two versions of a procedure and creates a third procedure containing the differences between the two. This output is an "update procedure," the physical unit managed by the change management system.</p></td></tr>

<tr><th>Q</th>
<td><b>Sequence</b>. 
<p>Creates both a working and sequenced version of a procedure that are the later input to Xcompare.</p></td></tr>

<tr><th>N</th>
<td><b>New</b>. 
<p>
Creates a "differences" update procedure similar to Xcompare, but which is the source for a new procedure.</p></td></tr>

<tr><th>K</th>
<td><b>Erase</b>. 
<p>Creates an update procedure similar to Xcompare output, but telling <var class="product">SirLib</var> to perform a logical delete on the procedure.</p></td></tr>

<tr><th>Z</th>
<td><b>ReSequence</b>. 
<p>Creates a special update procedure to reorder the internal sequence numbers of a procedure.</p></td></tr>
</table>

The Procedure List screen is the main working environment for the
programmer in the <var class="product">SirPro</var>/<var class="product">SirLib</var>-controlled environment. This screen, and others like it,
provide access to all procedure activity in <var class="product">Model&nbsp;204</var>.
For details on the use of <var class="product">SirLib</var>, including the special commands for managed updates, see the <var class="book">[[Media:LibrNew.pdf|SirLib User's Guide]]</var>.
Only the special Procedure List screen
prefix commands (<code>Q</code>, <code>X</code>, <code>K</code>, <code>N</code>, and <code>Z</code>) for creating and manipulating managed updates are explained here.

The <code>Q</code>, <code>X</code>, <code>N</code>, <code>K</code>, and <code>Z</code> prefix commands are used to generate "working" base and sequenced copies of procedures and to generate updates from those copies.
Type one of these managed update commands to the left of the selected procedure and press
the Enter key.
<var class="product">SirPro</var> then presents one of the managed update screens to get
further details on the managed update.
Those screens are shown in the following detailed sections.

<div id="sequenc"></div>
==Sequencing: Creating working copies of procedures==
<!--Caution: <div> above-->

"Sequencing" is the managed update method by which programmers
make copies of procedures to work on.  In other systems, programmers
make backup copies of procedures and then work on the original.
In <var class="product">SirPro</var>, programmers never alter the original program code, but execute <code>Q</code> commands to get working and sequenced copies from which
update procedures can be generated.

<p class="caption" style="width:450px">Sequencing a procedure with the "Q" command</p>
<p class="figure">[[File:SProSequence.png|450px]]</p>

Placing a <code>Q</code> to the left of a procedure name on the Procedure List screen tells SirLib to generate both a copy of the
selected procedure (the copy that the programmer will work on) and a
"sequenced" copy of the procedure (a copy containing sequence or
line numbers), which will later be used as comparison input for the
<code>XCOMPARE</code> command.
Building these copies is always the first step in generating a managed update.
The <code>Q</code> prefix command presents the <b>Sequence procedure</b> screen, which has the following input fields:

<table class="thJustBold">
<tr><th>Output procedures</th>
<td>Enter a procedure file where <var class="product">SirLib</var> should create a working and <code>SEQ.</code> version of the selected procedure.</td></tr>

<tr><th>Password</th>
<td>An update password for this output procedure file is required unless the file is already open with update privileges.</td></tr>

<tr><th nowrap>UnSequenced procedure</th>
<td>Procedure name for the copy of the selected procedure that the programmer will be making updates to.  This defaults to the input procedure name.</td></tr>

<tr><th>Sequenced procedure</th>
<td>Procedure name for a copy of the procedure with each line prefixed by a sequence number, indicating line sequence and amount of update activity that has been applied in generating the working version.
<p>
The default procedure name for sequenced procedures is: </p>
<p class="code">SEQ.<i>procname</i>
</p> 
<p>
This default prefix may be overridden if it conflicts with local APSY naming standards.</p></td></tr>

<tr><th>FixFile</th>
<td>Name of the file containing  Control and Update procedures for this file. Default file is <code>SIRLIBP</code>.</td></tr>

<tr><th>Password</th>
<td>A password for this FixFile is required unless the file is public or is already open with read privileges. The privileges for this password must allow the contents of procedures in the control file to be read.
<blockquote class="note">
<b>Note:</b> The control procedure name is displayed in the block of text above the FixFile input field for informational purposes only. This procedure, formatted as follows:
<p class="code">CONTROL.<i>filename</i>
</p> 
<p>
Where <i>filename</i> is the name of the file from which the selected procedure is being copied. The control file must exist in the specified FixFile. This CONTROL procedure contains the project names active for this file. The update procedures that are pointed to by the project identifiers in the control procedure must be in the same file.</p></blockquote></td></tr>

<tr><th nowrap>Replace existing procedures</th>
<td>This field defaults to <code>N</code>, indicating that if a same-named procedure already exists in the destination procedure file, the attempt to copy over it will be aborted. To overwrite existing procedures, set this indicator to <code>Y</code>.</td></tr>
</table>

When the <code>Q</code> prefix command is executed from the Procedure
List screen, <var class="product">SirLib</var> looks in the
source file for a procedure named <code>BASE.<i>procname</i></code>, where
<i>procname</i> is the name of the selected procedure.
If no such procedure is found, <var class="product">SirLib</var> copies the selected
procedure into the specified target procedure in the specified Output file.
In addition, <var class="product">SirLib</var> generates a sequenced copy of the procedure, named whatever the programmer specified in the <b>Sequenced procedure</b> field on this screen. The sequenced copy of the procedure is identical to the unsequenced (or working) copy, except that each line is prefixed with a sequence number.

If <var class="product">SirLib</var> does find a <code>BASE.<i>procname</i></code> procedure, it looks for the <code>CONTROL.<i>filename</i></code> procedure in the specified FixFile.
A control procedure of the specified name must exist or the <code>Q</code> prefix
command fails. Noting the active projects in the control procedure,
<var class="product">SirLib</var> finds all update procedure names that match this pattern:
<p class="code"><i>file.project.procname</i></p>

Where:
<ul>
<li><var class="term">file</var> is the name of the input file for this
operation. </li>

<li><var class="term">procname</var> is the name of the selected input
procedure. </li>

<li><var class="term">project</var> is one of the identifiers in
columns 1 to 8 of the specified control procedure. </li>
</ul>

All update procedure names that conform to this pattern are sorted by their project and then by the sequence line numbers they effect.
This aggregate update is then applied to <code>BASE.<i>procname</i></code> to
produce the sequenced and unsequenced output procedures.
In other words, the programmer doesn't just get a copy of the procedure they
request, they get a generated procedure that is the BASE of what they
want, with all active updates applied.

If a project name is commented out in the control procedure, it is not
included in the resulting sequenced and unsequenced output procedures.
A project name is commented out by placing an asterisk (<tt>*</tt>) in
front of it in the control procedure. (This is how working versions of
production procedures can be generated in development regions if the
development region has active projects that do not exist yet in
production).

The sequenced version of a procedure should never be changed, as it is
the "before" image for the <code>XCOMPARE</code> that will eventually generate
the update procedure.
Sequence numbers generally should not concern programmers, though there are a few times when it is worth knowing something about how they work.

The <code>Q</code> prefix command automatically begins sequencing at 10000 and
increments each line in the <code>BASE.<i>procname</i></code> procedure by 10000.
As changes are generated, the <code>XCOMPARE</code> function generates new line numbers
for lines of code being inserted and replaced.
The <code>XCOMPARE</code> algorithm
attempts to number the first new line of code beginning with a sequence
number 1 greater than its starting point in the existing sequence (this
applies to Inserts and Replaces: it is irrelevant for Deletes).
Subsequent new lines which are part of the same update are incremented
by a power of 10 less than the last sequence of numbers for the section of code.
Later changes that apply to the same section again begin
numbering at their starting sequence number plus 1, and continue to
increment at the next lowest available power of 10.

Fortunately, you do not have to understand any of this in order for it to work.
The lower-order digit(s) of the sequence numbers
in a <code>SEQ</code> procedure however will indicate the number of times a section
of code has been changed. The sequence numbers themselves will
indicate whether the <code>XCOMPARE</code> will be able to "fit" changes into
the same section of code again.
For example, a section of code with sequence numbers that look like this indicates that changes will still "fit" in the hundreds and tens columns:
<p class="code">003451001
003452001
003453001
</p>

If an update procedure attempts to insert three lines of code
after line 003452001, the resulting code will be numbered like this:
<p class="code">003451001
003452001
003452102
003452202
003452302
003453001
003454001
</p>
Replace (a <code>./R</code> command in an update procedure) operates
slightly differently than Insert, but the outcome looks very similar.
When changes will no longer "fit," <code>XCOMPARE</code> can still
successfully generate an update procedure that effects this section of
code, but the update procedure will become unnecessarily long and
<var class="product">SirLib</var> might lose its ability to detect update collisions.
In this case, a Resequence is required. Resequencing is described later in this page.

Once an initial update has been coded and the update procedure placed
in the FixFile, all subsequent <code>Q</code> prefix commands against the same
procedure generate copies containing the update, and sequence
numbers in output sequenced versions of the procedure reflect the
insertion of the update code.

<div id="xcomp"></div>
==XCOMPARE: Creating an update procedure==
<!--Caution: <div> above-->

The <code>XCOMPARE</code> operation is executed by placing an <code>X</code> next to the
changed procedure on the Procedure List screen.
This invokes a compare operation of that procedure
against its sequenced version.
The output from this operation is an update procedure.

<p class="caption" style="width:450px">XCOMPARE screen for creating a "differences" deck</p>
<p class="figure">[[File:SProXcompare.png|450px]]</p>

Placing an <code>X</code> to the left of a procedure name in the Procedure List screen
tells SirLib to compare the specified procedure against a matching
"sequenced" procedure, and to generate another procedure
containing the differences between the two.
The <code>X</code> prefix command presents the <b>Build Update Deck</b> screen, which has the following input fields:

<table class="thJustBold">
<tr><th nowrap>UnSequenced input procedure</th>
<td>Protected fields displaying the source file and procedure.</td></tr>

<tr><th>Sequenced input procedure</th>
<td>Source file of sequenced procedure. This defaults to the same file as for the input unsequenced procedure.</td></tr>

<tr><th>Password</th>
<td>Read access is required for the above file. No password need be input if the file is already open or has high enough default privileges to read procedures.</td></tr>

<tr><th>Procedure</th>
<td>Procedure name of sequenced procedure. <code>SEQ.</code> is the prefix generated by the <code>Q</code> command, so <code>XCOMPARE</code> defaults to this.</td></tr>

<tr><th>FixFile</th>
<td>Name of destination file for update procedure output from this <code>XCOMPARE</code>.</td></tr>

<tr><th>Password</th>
<td>Write access to this FixFile is required. If the file is already open, or if default privileges for the file are high enough to allow the creation of a new procedure, no password is required.</td></tr>

<tr><th>Project Name</th>
<td>This is the 8-character project name to which this update should be linked.
<p>
The <var class="product">SirLib</var> file administrator may have required that updates for this file only be linked to existing projects, in which case the entered project name is checked to make sure it exists in the control procedure. If this setting is not on, updates may be created, and the project entered in the control procedure later.</p></td></tr>

<tr><th>Target File</th>
<td>The production file containing the base procedure against which this update will apply.</td></tr>

<tr><th>Replace existing update?</th>
<td>Entering <code>Y</code> in this field lets you overwrite a same-named update procedure in the destination file with the current update procedure. Programmers are always permitted to overwrite update procedures created under their userid when this switch is set to <code>Y</code>.
<p>
The <var class="product">SirLib</var> file administrator may have specified in the Administration options that programmers may not overwrite each other's update procedures, either in this file or within the entire system. If this option is set, and an update procedure exists of the same name as the one being created in the target file, and the userid who created the update procedure (or last updated it) is not the same as the current user's ID, the generation of the update is not permitted.</p></td></tr>

<tr><th>Enter editor for update?</th>
<td>Entering <code>Y</code> at this prompt places the generating user into an edit session on the new update procedure. The update procedure will have already been stored before the edit session is invoked, so <b>QUIT</b> (F3) may be used to exit the edit session without losing the update procedure.</td></tr>

<tr><th>Synchronization count</th>
<td>This field lets you set the number of lines that will be compared before the sequenced and unsequenced versions of the procedures are considered to be back in sync, and further lines are no longer to be generated to the output update procedure (at least until the next mismatch).
<p>
The default sync count value is 2, and this will work well for the vast majority of cases. Increasing the sync count may reduce the number of difference lines found,
resulting in smaller update procedures, or it may have no effect at all beyond a minor performance penalty in the <code>XCOMPARE</code> operation. In a very few cases it may produce larger output procedures. </p>
<p>
An entered value of asterisk (<code>*</code>) tells <code>XCOMPARE</code> to repeat the compare operation, increasing the sync count from 1 until it hits a value that no longer produces a smaller output procedure. As might be imagined, this is the worst-performing option for running <code>XCOMPARE</code>, but it will almost always generate the smallest possible output procedure. Unless changes are massive and many, the size of the output procedure is fairly irrelevant, and playing with the sync count has little utility.</p></td></tr>

<tr><th>Unlock this procedure?</th>
<td>Entering <code>Y</code> in this field makes the procedure available to other programmers in systems or files where procedures are locked to one updating user at a time.
<p>
Any value but <code>Y</code> lets you generate an update procedure, but it will retain the exclusive lock on the procedure (such as when a test integration is being run,
and you don't want to relinquish control of the procedures being updated). </p>
<p>
If procedure locking is not turned on, the lock/unlock information is still maintained for historical reporting, but this switch has no actual effect in locking procedures. See Administration options for Procedure Locking options.</p></td></tr>
</table>

<div id="newp"></div>
==New: Create a new procedure via update deck==
<!--Caution: <div> above-->

Placing an <code>N</code> to the left of a procedure name in the Procedure List screen tells SirLib to generate an update procedure, similar to that produced by <code>X</code>,
but containing all lines of the specified procedure (because it is a new procedure to the system).

<p class="caption" style="width:450px">Generating a "New" procedure</p>
<p class="figure">[[File:SProNewproc.png|450px]]</p>

Prefixing a procedure by <code>N</code> in the Procedure List screen
presents the <b>Create New proc</b> screen, which has the following input fields:

<table class="thJustBold">
<tr><th>New procedure name</th>
<td>Protected fields displaying the source procedure file and source procedure for this update procedure creation.</td></tr>

<tr><th>Output update procedure</th>
<td>
<table class="thJustBold">
<tr><th>FixFile</th> 
<td>The destination for the output update procedure.</td></tr>

<tr><th>Password</th>
<td>Write access to this FixFile file is required. If the file is already open, or if default privileges for the file are high enough to allow the creation of a new procedure, no password is needed.</td></tr>

<tr><th nowrap>Project name</th>
<td>A valid project identifier (up to 8-characters).
<p>The <var class="product">SirLib</var> file administrator may have required that updates for this file only be linked to projects previously defined in the control procedure. In this case the project entered is verified to see that it exists before the update is generated. If this setting is not on, updates may be generated first, and the project names entered in the control procedure later.</p></td></tr>

<tr><th>Target file</th>
<td>The name of the production file containing the base procedure to which this update will apply.</td></tr>
</table></td></tr>

<tr><th nowrap>Replace existing update?</th>
<td>Entering <code>Y</code> in this field lets you overwrite a same-named update procedure in the destination file with the current update procedure. Programmers are permitted to overwrite update procedures created under their userid when this switch is set to <code>Y</code>.
<p>
The <var class="product">SirLib</var> file administrator may have specified in the Administration options that programmers may not overwrite each other's update procedures either in this file or within the entire system. If this option is set, and an update procedure exists of the same name as the one being created in the target file, and the userid of the creator of the update procedure (or that last updated it) is not the same as the current user's ID, then the generation of the update procedure is not permitted.</p></td></tr>

<tr><th>Enter Editor for update?</th>
<td>Entering <code>Y</code> at this prompt places the generating user into an edit session on the new update procedure. The update procedure will have already been stored before the edit session is invoked, so <b>QUIT</b> may be used to exit the edit session without the update procedure being lost.</td></tr>
</table>

<div id="klobber"></div>
==K (Klobber): Managed-update procedure deletion==
<!--Caution: <div> above-->

Placing a <code>K</code> to the left of a procedure name in the Procedure List screen generates an update procedure that contains only a special command that tells <var class="product">SirLib</var> that the "change" to the K-prefixed procedure is a delete.
Managed update deletes are always logical deletes, allowing deleted procedures to be recovered at any time when the file is reconfigured.
For this reason, an empty (zero-line) version of the erased procedure is left in the file and should not be physically deleted.

The <code>K</code> prefix command presents the
<b>Klobber procedure</b> screen, which has the same input fields as the <b>Create New proc</b> screen described in [[#newp|New: Create a new procedure via update deck]].

<p class="caption" style="width:450px">"K" (klobber) Generating a logical procedure deletion</p>
<p class="figure">[[File:SProKlobber.png|450px]]</p>

<div id="reseqnc"></div>

==ReSequence: Refreshing internal sequence numbers==
<!--Caution: <div> above-->

The sequence numbers generated by <var class="product">SirLib</var> are generally of no concern to the programmers working on procedures.
However, if a large number of update procedures are generated that affect the same section
of code in a procedure, further changes to the same section may result
in unnecessarily large update procedures.
In addition, <var class="product">SirLib</var> will
lose its ability to detect when updates are overwriting each other.

In case this rare event occurs, a manager can generate a resequence procedure.
By placing a <code>Z</code> to the left of the procedure name on the Procedure List screen,
the <b>ReSequence procedure</b> screen is produced:

<p class="caption" style="width:450px">Z: Resequencing a managed procedure</p>
<p class="figure">[[File:SProResequence.png|450px]]</p>

The <b>ReSequence procedure</b> screen has the following input fields:
<table class="thJustBold">
<tr><th>Resequence procedure</th>
<td>
<table class="thJustBold">
<tr><th>Proc file
<br/>Procedure</th>
<td>Protected fields displaying the source file and procedure name for this update procedure creation.</td></tr>
</table></td></tr>

<tr><th>Output update procedure</th>
<td>
<table class="thJustBold">
<tr><th>FixFile</th>
<td>Destination for output update procedure.</td></tr>

<tr><th>Password</th>
<td>Write access to this FixFile file is required. If the file is already open, or if default privileges for the file are high enough to allow the creation of a new procedure, no password is needed.</td></tr>

<tr><th nowrap>Project name</th>
<td>A valid project identifier (as many as 8 characters).
<p>
The <var class="product">SirLib</var> file administrator may have required that updates for this file be linked only to projects previously defined in the control procedure.
In this case, the project entered is verified to see that it exists before the update is generated. If this setting is not on, updates may be generated first, and the project names entered in the control procedure later.</p></td></tr>

<tr><th>Target file</th>
<td>The name of the production file containing the base procedure to which this update will apply.</td></tr>
</table></td></tr>

<tr><th nowrap>Replace existing update?</th>
<td>Entering <code>Y</code> in this field lets you overwrite a same-named update procedure in the destination file with the current update procedure.
Programmers are permitted to overwrite update procedures created under their userid when this switch is set to <code>Y</code>.
<p>
The <var class="product">SirLib</var> file administrator may have specified in the Administration options that programmers may not overwrite each other's update procedures either in this file or within the entire system. If this option is set, and an update procedure exists of the same name as the one being created in the target file, and the userid that created the update procedure (or last updated it) is not the same as the current user's, the generation of the update procedure is not permitted.</p></td></tr>

<tr><th>Enter editor for update?</th>
<td>Entering <code>Y</code> at this prompt places the generating user into an edit session on the new update procedure. The update procedure is already stored before the edit session is invoked, so <b>QUIT</b> may be used to exit the edit session without the update procedure being lost.</td></tr>
</table>

==SirPro change management overview==
<!-- Page name: SirPro change management overview-->

Notice that no sequenced copy of a procedure is needed for New, Erase,
or Resequence operations. <code>Q</code> (seQuence) is the managed update equivalent of a Copy, just as <code>N</code> (New) is the equivalent of Create, and <code>K</code>
(Klobber, or Erase) is the equivalent of Delete.
<code>XCOMPARE</code> has no direct equivalent in the "unmanaged" command structure, though coupled with later reconfiguration using the output update procedure, it
is analogous to moving finished changes to a staging area.
Resequencing is of course a special purpose function with no "unmanaged" corollary.

<p class="caption" style="width:444px">How a change progresses through SirLib</p>
<p class="figure">[[File:SirLibChange.png|444px]]</p>

In the example above, procedure <code>TEMP</code> exists in file <code>PFILE1</code> (upper left). The programmer uses the <code>Q</code> command to copy <code>TEMP</code> into <code>WORKFILE</code>, getting both a working and a <code>SEQ</code> version of the procedure. 

A single line of new code is inserted in <code>TEMP</code> (the line
<code>PRINT STATE AND ZIP AT 40</code>).
Using <code>XCOMPARE</code>, the update is generated to file <code>CHANGES</code>, and named <code>PFILE1.CHG1.TEMP</code>.
A project leader defines the project name <code>CHG1</code> in <code>CONTROL.PFILE1</code>.

Finally, <var class="product">SirLib</var>'s ReConfiguration function is used to create a "BASE" version of the procedure, so the update can be backed out if necessary, and the original procedure <code>TEMP</code> is deleted.
The update procedure <code>PFILE1.CHG1.TEMP</code> is applied to <code>BASE.TEMP</code>
to create the new executable procedure <code>TEMP</code>.
<p>
The final state of <code>PFILE1</code> is shown lower right.</p>

==See also==
{{Template:SirPro topic list}}

[[Category: SirPro]]