The Descriptions Generated by AUTOIDMS

In this section:

AUTOIDMS creates complete Master Files and Access Files for the subschema and records selected by the user. The following describes the attributes and values assigned to them by AUTOIDMS.


Top of page

x
File and Segment Attributes Generated by AUTOIDMS

The file and segment attributes are:

FILE=

Master File name specified on the Main Menu.

SEGNAME=

For records described in the Master File, the segment name is composed of the letter S, the four digit record id number, an underscore, and a two digit sequence number to ensure uniqueness (for example, S0415_01). For repeating groups within a record, the segment name is composed of the letters OCC, the two-digit sequence number of the parent segment, an underscore, and its own two-digit sequence number (for example, OCC04_01).

SEGTYPE=

For member segments, the value is S; for owner segments, the value is U. The value for repeating groups is S.

PARENT=

For dependent segments, this is the value of the SEGNAME attribute of the parent record.

OCCURS=

For repeating groups only, this will contain either the fixed number of occurrences of the repeating group (if you selected to generate OCCURS segments on the Main Menu) or the name of the field that contains the number of variable occurrences of the group.

POSITION=

For repeating groups only, this entry identifies the position of the repeating values in the parent record. If the repeating values are described as a GROUP, this value will be the ALIAS of the group field. If the repeating group consists of only one field, this value will be the letter S, the two digit sequence number of the parent, the string _OCC, and the two digit sequence number of the occurs segment (for example, S04_OCC01). This artificial name is used as the placeholder in the parent record so that the field name can be used in the occurs segment.



x
Field Attributes Generated by AUTOIDMS

The field attributes are:

FIELD=

This attribute identifies simple IDMS elements as fields.

GROUP=

This attribute identifies IDMS group elements that are composed of other contiguous fields. The GROUP attribute is only used for groups at the highest level in the record description.

$GROUP=

This attribute identifies IDMS group elements that are themselves components of another group. Since these are embedded groups, they cannot be referenced. However, you can reference this field by uncommenting the entry (by removing the leading dollar sign) and commenting the parent group (by adding a leading dollar sign).

$  RDF=

This attribute identifies redefined IDMS elements. You can reference either the original fields or the redefined fields. You can reference the redefined field by changing $ RDF= to FIELD= and commenting the original field (by adding a leading dollar sign).

$  88 =

This attribute identifies conditional IDMS elements (COBOL level 88 fields). These entries are provided in the Master File for documentation purposes only. The value of the conditional field is contained in the USAGE attribute. If the conditional field is a range, the low end of the range is in the USAGE attribute. The high end of the range is in the ACTUAL attribute.

$  BIT=

This attribute identifies BIT fields. The first BIT field in a set is described with a FIELD attribute and an alphanumeric format. The length is the number of bytes occupied by all BIT fields in the set. Subsequent BIT fields in the set are described as comments with the $ BIT= attribute. To access the individual BIT fields, you can create virtual fields (within the Master File or a FOCEXEC) using the BITSON subroutine, using the first field in the set as input.

$DESC=

This attribute lists the full IDMS element name. If the field name is truncated as a result of user selections, this will also include the string *TRUNC*.

$DUPLICATE

This attribute, found at the end of the Master File, identifies duplicate fields described in the Master File. It lists the full IDMS element name, the number of duplicate occurrences, and the segments in which the duplicate fields are located.

Field names

Field names are derived from the IDMS dictionary and may be truncated based on user selections on the Main Menu. Hyphens in the IDMS name are converted to underscores. Certain field names are generated by AUTOIDMS. A field that is generated to ensure full-word boundaries at the end of a record in an LRF will be blank. A calculated position field will have the format Smm_OCCnn (see the description of the POSITION attribute in Adapter for CA-IDMS Master Files). A field that describes the internal IDMS database key (whose alias is DBKEY) will consist of the SEGNAME and the string _KEY. A field indicating the sequence number for a repeating group (whose alias is ORDER) will be the same as its SEGNAME.

Aliases

Alias names are calculated by AUTOIDMS. For most fields, this value will be the letter F, the four digit record ID, an underscore, and a unique sequence number (for example, F0415_1). If a record is described more than once in a Master File, the alias will be suffixed with an alphabetic character. The alias will therefore be unique within a Master File and will be consistent from Master File to Master File for the same subschema. If truncation of field names causes duplicates, the unique alias can be used to reference the field instead. The alias for the last field of each record in an LRF will consist of the letter F, the two-character segment sequence number, and the string .END. The alias for a calculated position field will be blank. The alias DBKEY is used to identify the internal IDMS database key value and appears at the end of each IDMS record described. The alias ORDER is used to identify the sequence number of a repeating group and appears at the end of each segment for repeating groups.



x
Changes to the Descriptions Generated by AUTOIDMS

In general, you will not need to change the descriptions generated by AUTOIDMS. You may need to edit the generated Master File and/or its corresponding Access File if:


Top of page

x
Creating a Record of Master Files Generated by AUTOIDMS

How to:

AUTOIDMS maintains a temporary list of the Master Files generated during any one session. This list is refreshed at the beginning of each session and is normally erased at the end of the session.



x
Syntax: How to Create a Record of Master Files Generated

You can retain a list of Master Files generated by executing AUTOIDMS with the following syntax:

EX AUTOIDMS MFDLIST=Y

The list will reside in a temporary data set allocated to ddname AUTOIDML, with a disposition of MOD and record length of 114.

Length

Columns

Description

8

1 – 8

Master File name

8

9 –16

Number of duplicate field names

10

17 – 26

Blank

44

27 – 70

Master Target PDS name

44

77 – 114

Access Target PDS name



x
Search Order for the AUTOIDMS Parameter Log File

The AUTOIDMS parameter log file will be located in one of three ways, in the following order:

  1. DDNAME IDMS$PRM
    • If this ddname is allocated to a PDS prior to execution of AUTOIDMS, it will be used. The member IDMS$PRM will be used or created for the user.
    • If this ddname is allocated to a sequential data set, it will be freed, a message generated, and parameter logging will be disabled.
    • AUTOIDMS does not free this ddname upon exiting, assuming that it may be used again, even if it was allocated by AUTOIDMS with one of the following two methods.
  2. Data set name userid.FOCIDMS.DATA
    • This is the default name provided in the code as &DSNP0. If that default has been changed during the adapter installation, that data set name will be used.
    • This data set must be a PDS. If not, a message is displayed and parameter logging is disabled.
  3. DDNAME FOCIDMS
    • The first data set allocated to ddname FOCIDMS will be used as the parameter file if the first two methods fail.
    • If ddname FOCIDMS is not allocated, a message is displayed and AUTOIDMS exits. AUTOIDMS cannot be executed if there is no FOCIDMS ddname for the IDMSIDD files.

Method number two assumes standard Information Builders naming conventions. Method number three assumes that a user's data set is allocated first in the concatenation of data sets allocated to DDNAME FOCIDMS. The first method allows the user to identify the profile data set prior to execution of AUTOIDMS. This option is recommended for sites that have non-standard data set naming conventions.


Information Builders