SIRFIELD command: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 3: | Line 3: | ||
The SIRFIELD command allows you to control access to and update | The SIRFIELD command allows you to control access to and update | ||
of fields in a file. | of fields in a file. | ||
This control is provided in any [[Model 204]] load module ( | This control is provided in any [[Model 204]] load module (BATCH204, | ||
ONLINE, IFAM4, IFAM1, etc.) with the [http://m204wiki.rocketsoftware.com/images/4/4b/SirfieldNew.pdf Sir2000 Field Migration Facility]. | |||
The SIRFIELD command is used to assign special attributes to a field name; | The SIRFIELD command is used to assign special attributes to a field name; | ||
Line 12: | Line 12: | ||
===SIRFIELD command syntax=== | ===SIRFIELD command syntax=== | ||
<p class="syntax">[IN file] SIRFIELD name subcommand operands </p> | <p class="syntax">[IN <span class="term">file</span>] SIRFIELD <span class="term">name subcommand operands</span> </p> | ||
Where: | |||
<dl> | <dl> | ||
<dt>IN file | <dt>IN <var class="term">file</var> | ||
<dd> | <dd>The file to which the <var>SIRFIELD</var> command applies. | ||
This is | This is only necessary if <var class="term">file</var> is not the default file. | ||
only necessary if | <var>IN <i>file</i></var> can be specified with any <var>SIRFIELD</var> subcommand, but | ||
for readability, it is not presented in subsequent syntax diagrams. | |||
file | |||
for readability, is not presented in subsequent syntax diagrams. | <dt><var class="term">name</var> | ||
<dt>name | <dd>Alias name or field name in the current file (it must already be | ||
<dd> | |||
defined). | defined). | ||
If it contains blanks or special characters, the entire name must be | If it contains blanks or special characters, the entire name must be | ||
enclosed in apostrophes, for example, SIRFIELD 'DATE OF BIRTH' ... | enclosed in apostrophes, for example, <code>SIRFIELD 'DATE OF BIRTH' ...</code>. | ||
Note that certain SIRFIELD subcommands accept either a | Note that certain <var>SIRFIELD</var> subcommands accept either a field name | ||
or an alias, while other subcommands accept only a | or an alias, while other subcommands accept only a field name or only | ||
an alias. | an alias. | ||
<dt>subcommand | |||
<dd> | <dt><var class="term">subcommand</var> | ||
It is one of the | <dd>The operation being performed. | ||
words | It is one of the words <var>ALIAS</var>, <var>DELETE</var>, <var>FORMAT</var>, | ||
<var>DISPLAY</var>, <var>RELATE</var>, or <var>SET</var>. | |||
Meanings of these are described below. | Meanings of these are described below. | ||
The subcommands are described briefly below and in detail in | The subcommands are described briefly below and in detail in | ||
the | the <var class="book">Sir2000 Field Migration Facility Reference Manual</var>. | ||
<dt>operands | |||
<dt><var class="term">operands</var> | |||
<dd>The operands specific to the operation. | <dd>The operands specific to the operation. | ||
These are | These are | ||
described in the | described in the <var class="book">Sir2000 Field Migration Facility Reference Manual</var>. | ||
</dl> | </dl> | ||
The SIRFIELD command may not be issued against a file that has | The <var>SIRFIELD</var> command may not be issued against a file that has "CCA" | ||
as the first three characters of the file name. | as the first three characters of the file name. | ||
The SIRFIELD subcommands are summarized below and described in detail | The <var>SIRFIELD</var> subcommands are summarized below and described in detail | ||
in the [ | in the <var class="book">[http://m204wiki.rocketsoftware.com/images/f/fb/FactrNew.pdf SirFact Reference Manual]</var>. | ||
You invoke a subcommand with the | You invoke a subcommand with the | ||
<code>SIRFACT</code> prefix (for example, <code>SIRFACT CANCEL</code>, <code>SIRFACT MAXDUMP</code>). | |||
<dl> | <dl> | ||
<dt>ALIAS | <dt>ALIAS | ||
<dd>Provide an additional name that programs can use to refer to a field. | <dd>Provide an additional name that programs can use to refer to a field. | ||
<dt>DELETE | <dt>DELETE | ||
<dd>Removes an alias name. | <dd>Removes an alias name. | ||
<dt>DISPLAY | <dt>DISPLAY | ||
<dd>Shows the attributes that SIRFIELD has associated with a field. | <dd>Shows the attributes that <var>SIRFIELD</var> has associated with a field. | ||
<dt>FORMAT | <dt>FORMAT | ||
<dd>Ensures that only values of the specified format(s) | <dd>Ensures that only values of the specified format(s) | ||
are stored in the field, and associates the format, CENTSPAN, and SPANSIZE | are stored in the field, and associates the format, <var>CENTSPAN</var>, and <var>SPANSIZE</var> | ||
with the field for use in applications or in the SIRFIELD RELATE subcommand. | with the field for use in applications or in the <var>SIRFIELD RELATE</var> subcommand. | ||
<dt>RELATE | <dt>RELATE | ||
<dd>Causes any update of a field to be reflected by the | <dd>Causes any update of a field to be reflected by the | ||
equivalent update to another field. | equivalent update to another field. | ||
<dt>SET | <dt>SET | ||
<dd>Specifies special processing options for a field or alias name. | <dd>Specifies special processing options for a field or alias name. | ||
Line 70: | Line 75: | ||
This command will perform no useful processing unless a site is authorized | This command will perform no useful processing unless a site is authorized | ||
for the | for the <var class="product">Sir2000 Field Migration Facility</var>. | ||
[[Category:System administrator commands]] | [[Category:System administrator commands]] | ||
[[Category:Commands]] | [[Category:Commands]] |
Revision as of 22:53, 21 April 2014
Note: This is a Sirius Mods-only command prior to Version 7.5 of Model 204.
The SIRFIELD command allows you to control access to and update of fields in a file. This control is provided in any Model 204 load module (BATCH204, ONLINE, IFAM4, IFAM1, etc.) with the Sir2000 Field Migration Facility.
The SIRFIELD command is used to assign special attributes to a field name; the purpose of these attributes is to provide additional checking of uses of the field, and to ease a migration period for applications using the field. The general form of the SIRFIELD command is:
SIRFIELD command syntax
[IN file] SIRFIELD name subcommand operands
Where:
- IN file
- The file to which the SIRFIELD command applies. This is only necessary if file is not the default file. IN file can be specified with any SIRFIELD subcommand, but for readability, it is not presented in subsequent syntax diagrams.
- name
- Alias name or field name in the current file (it must already be
defined).
If it contains blanks or special characters, the entire name must be
enclosed in apostrophes, for example,
SIRFIELD 'DATE OF BIRTH' ...
. Note that certain SIRFIELD subcommands accept either a field name or an alias, while other subcommands accept only a field name or only an alias. - subcommand
- The operation being performed. It is one of the words ALIAS, DELETE, FORMAT, DISPLAY, RELATE, or SET. Meanings of these are described below. The subcommands are described briefly below and in detail in the Sir2000 Field Migration Facility Reference Manual.
- operands
- The operands specific to the operation. These are described in the Sir2000 Field Migration Facility Reference Manual.
The SIRFIELD command may not be issued against a file that has "CCA" as the first three characters of the file name.
The SIRFIELD subcommands are summarized below and described in detail
in the SirFact Reference Manual.
You invoke a subcommand with the
SIRFACT
prefix (for example, SIRFACT CANCEL
, SIRFACT MAXDUMP
).
- ALIAS
- Provide an additional name that programs can use to refer to a field.
- DELETE
- Removes an alias name.
- DISPLAY
- Shows the attributes that SIRFIELD has associated with a field.
- FORMAT
- Ensures that only values of the specified format(s) are stored in the field, and associates the format, CENTSPAN, and SPANSIZE with the field for use in applications or in the SIRFIELD RELATE subcommand.
- RELATE
- Causes any update of a field to be reflected by the equivalent update to another field.
- SET
- Specifies special processing options for a field or alias name.
This command will perform no useful processing unless a site is authorized for the Sir2000 Field Migration Facility.