SIRFIELD command: Difference between revisions
mNo edit summary |
m (link repair) |
||
| Line 1: | Line 1: | ||
<p class="note"><b>Note:</b> This is a <var class="product">[[Sirius Mods]]</var>-only command prior to Version 7.5 of <var class="product">[[Model 204]]</var>.</p> | <p class="note"><b>Note:</b> This is a <var class="product">[[Sirius Mods]]</var>-only command prior to Version 7.5 of <var class="product">[[Model 204]]</var>.</p> | ||
The SIRFIELD command allows you to control access to and update | The <var>SIRFIELD</var> 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 (BATCH204, | This control is provided in any [[Model 204]] load module (BATCH204, | ||
ONLINE, IFAM4, IFAM1, etc.) with the [ | ONLINE, IFAM4, IFAM1, etc.) with the [[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]. | ||
The SIRFIELD command is used to assign special attributes to a field name; | The <var>SIRFIELD</var> 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 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 field, and to ease a migration period for applications using the field. | ||
===SIRFIELD command syntax=== | ===SIRFIELD command syntax=== | ||
The general form of the <var>SIRFIELD</var> command is: | |||
<p class="syntax">[IN <span class="term">file</span>] SIRFIELD <span class="term">name subcommand operands</span> </p> | <p class="syntax">[IN <span class="term">file</span>] SIRFIELD <span class="term">name subcommand operands</span> </p> | ||
Where: | Where: | ||
| Line 48: | Line 48: | ||
The <var>SIRFIELD</var> subcommands are summarized below and described in detail | The <var>SIRFIELD</var> subcommands are summarized below and described in detail | ||
in the <var class="book">[ | in the <var class="book">[[Media:SirfieldNew.pdf|Rocket M204 Sir2000 Field Migration Facility]]</var>. | ||
You invoke a subcommand with the | You invoke a subcommand with the | ||
<code> | <code>SIRFIELD</code> prefix (for example, <code>SIRFIELD ALIAS</code>, <code>SIRFIELD SET</code>). | ||
<dl> | <dl> | ||
<dt>ALIAS | <dt>ALIAS | ||
Latest revision as of 01:23, 2 March 2016
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.
SIRFIELD command syntax
The general form of the SIRFIELD command is:
[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 Rocket M204 Sir2000 Field Migration Facility.
You invoke a subcommand with the
SIRFIELD prefix (for example, SIRFIELD ALIAS, SIRFIELD SET).
- 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.