Template Update Utility panel
The Template Update Utility panel allows you to update an existing template either to the input data set or to an optional output data set.
- Use the copybook filters to select only templates referencing specified copybooks or copybook patterns.
- Change the copybook library data sets used to build the templates.
- Change the DBD data set used to build the template.
- Run the utility in batch or foreground.
Panel and field definitions
- Template
- Data set name
- (Required) A fully-qualified or generic data set name used to
identify the data set which must be partitioned.
In a generic data set name, use the percent sign (%) to represent a single character, and an asterisk (*) to represent any number of characters within a qualifier. Two asterisks (**) represent any number of characters within any number of qualifiers.
The TSO prefix (as defined for your user ID) is used as the high-level qualifier for any name that is not enclosed in quotation marks.
For performance reasons, you should qualify the data set name as much as you can.
You can combine the member name with the dataset name in the form Data set name(Member).
- Member
- Name of a member of a partitioned data set. If you leave the member name
blank, or specify a member name pattern, FM/IMS displays a member name list.
You can then select the required member by entering S in the Select field for
the appropriate member.
A member name pattern can consist of any characters that are valid in a member name and two special pattern characters, the asterisk (*) and the percent sign (%):
- *
- Represents any number of characters. As many asterisks as required can
appear anywhere in a member name. For example, if you enter
*d*
, a list all members in the data set whose name contains "d" is displayed. - %
- A place holding character that means a single character. As many percent
symbols as necessary may appear anywhere in a member name. For example, if you enter:
%%%%
, a list of all members in the data set whose name is 4 characters in length is displayed.
- Copybook filter
- Up to four member names or patterns to be used as a filter so that only templates referencing those copybooks, or copybooks that match the member patterns are selected for processing.
- Output Template
- Data set name
- (Optional) A fully-qualified or generic data set name used to
identify the output data set which must be partitioned. If this field is not
specified, then the update takes place on the input data set.
You can specify a generic data set name using the percent (%) sign and asterisk (*) as described for the template data set name above.
The TSO prefix (as defined for your user ID) is used as the high-level qualifier for any name that is not enclosed in quotation marks. For performance reasons, you should qualify the data set name as much as you can.
You can combine the member name with the dataset name in the form Data set name(Member).
- Member mask
- Specify a pattern to rename members in the output partitioned data set based
upon the member names in the input partitioned data set. A member name pattern
can consist of any characters that are valid in a member name and two special
pattern characters: the asterisk (*) and the percent sign (%).
- *
- A place-holding character that means multiple characters with
no change. Only one asterisk should appear in the mask.
Any subsequent asterisk characters are treated as percent signs.
For example, if you enter:
the renamed members will all begin with ABC followed by the remainder of the old member name.ABC*
- %
- A place-holding character that means a single character with no change.
As many percent symbols as necessary may appear anywhere in a member name.
For example, if you enter:
the first 3 characters of the renamed members remain unchanged, the fourth character is replaced with the letter "A", and the remainder of the old member name is unchanged.%%%A*
- Processing Options:
- Batch execution
- Presents the JCL to run the function in batch. The JCL can be edited and submitted. You can use the Set Batch Job Card Information panel to tailor the default JOB card that FM/IMS uses to generate JCL.
- Advanced member selection
- Allows you to specify which members are to be processed based on member name, created date, last changed date, and the user ID by which the member was last updated. For each of these criteria, a mask or range of values can be entered.
- Skip member list
- Run without showing the member selection list. This option bypasses the member list panel and process all the qualifying members. If an error (like a duplicate output name) results from the specified parameters, then the member list panel is displayed with the errors highlighted.
- Skip database segment list update
- Skips updating the database segment lists in the templates. Select this option when there are no changes to the list of segment names specified in the DBDs that the templates are built from. When this option is selected, the DBDs that the templates are built from are not loaded or processed, resulting in improved performance.
- New database segments
- Select this option if one or more of the templates being processed are built from DBDs that have new segments. If you select this option and the Skip database segment list update option is not selected, the New Database Segments panel is displayed where you can specify the layout members for each of the new segments.
- Preserve copybook library
- Ensures that, if a copybook still
exists in the library that it was previously found in and that library is
in the list that the update is using, then that version of
the copybook is used.
If you do not select this option, or the copybook no longer exists in the library it was previously found in, or that library is not in the list the update is using, then the utility searches the libraries in the order they are listed and uses the first version of the copybook that it finds.
- Replace member
- Replaces like-named members in an output partitioned data set.
- Specify copylib list
- Select this option if you want to specify the copybook libraries that the utility uses to build
the templates.
If this option is selected, the Copybook Library List panel is displayed where you can specify the required copybook libraries. The copybook library list is stored in the updated template.
If this option is not selected, the utility uses the copybook library list stored in the template.
- Specify DBDLIB list
- Select this option if you want to specify the DBD libraries that the utility gets the DBDs from.
If this option is selected and the Skip database segment list update option is not selected, the DBD Library List panel is displayed. Use this panel to specify the required DBD libraries. The DBD library list is stored in the updated template.
If the Specify IMS catalog option is also selected, the utility only gets the DBDs from the specified DBD libraries when the DBDs that were used when the template's database segment list was last updated came from DBD libraries. When they came from an IMS™ catalog, the utility gets the DBDs from the specified IMS™ catalog.
When none of these options is selected and the DBDs that were used when the template's database segment list was last updated came from DBD libraries, the utility gets the DBDs from the DBD library list in the template.
- Specify IMS catalog
- Select this option if you want to specify the IMS™ catalog that the utility gets the DBDs from.
If this option is selected and the Skip database segment list update option is not selected, the IMS Catalog Specification panel is displayed. Use this panel to select the required IMS™ catalog. The SSID for the selected IMS™ catalog is stored in the updated template.
If the Specify DBDLIB list option is also selected, the utility only gets the DBDs from the specified IMS catalog when the DBDs that were used when the template's database segment list was last updated came from an IMS™ catalog. When they came from DBD libraries, the utility gets the DBDs from the specified DBD libraries.
When none of these options is selected and the DBDs that were used when the template's database segment list was last updated came from an IMS™ catalog, the utility gets the DBDs from the IMS™ catalog whose SSID is stored in the template.
Note: Only subsystems that use IMS-managed ACBs may be specified on the IMS Catalog Specification panel. - Check mode - no update
- Runs the function without saving the resulting members. Normally used to check for errors.
- Forced update
- Performs the update even if no changes have been detected.
Note: When the Skip database segment list update, the Specify IMS catalog and the Specify DBDLIB list options are all not selected, the utility uses the DBDs in either the DBD library list stored in the template or the IMS catalog stored in the template.