IMS Extract

Use the IMS Extract utility function to extract data from all or selected IMS segments of a database and save the data to a sequential data set (the unload data set).

Optionally, create a File Manager for z/OS Formatted Editor template from a template which is specified in the IMS subsystem's Template Libraries configuration setting. This template can be used to view or edit the sequential data set in formatted mode.

If the extract completes successfully, the associated dialog will have a button to view or edit the data set.

This page details the mapping of fields to batch parameters and miscellaneous notes. Refer to the IBM File Manager® Users Guide and Reference for IMS for more information.

Limitations

Basic Settings

Subsystem - you can specify the IMS subsystem using the lookup button on the right. From here, you can also edit the subsystem's configuration by clicking on the edit button to the right of the field.

Region Type - Specifies the region type that you want the function to run in. The database must be online to use BMP, and you can use DLI when the database is offline or if there is data sharing support. Either of these options may be disabled by your system administrator in the File Manager installation options. Batch parameter: REGNTYPE

Mode - Specifies whether to use an existing PCB in a PSB to specify the segments to extract (static), or whether File Manager for z/OS should dynamically create a PCB for the entered database (dynamic). Either of these options may be disabled by your system administrator in the File Manager installation options. Batch parameter: PSBTYPE

Unload data set - Specify the name of the sequential data set to extract to. This must be a PS, PDS, or Library data set with a Variable Blocked record format, and a maximum record length which is at least as large as the concatenated length of all the segments which will be extracted; if it is a PDS or Library data set, a member must also be specified. If this data set does not exist, you will be prompted to allocate it with some sensible default allocation parameters. Batch DD name: UNLOAD

Create template - If you would like to create a template to use for the Base File Manager Formatted Editor, specify the name of the sequential data set to create a template in. This must be an already-existing PS, PDS, or Library data set; if it is a PDS or Library data set, a member must also be specified. Batch parameters: TDSNIN and TDSNOUT

Back to top

Processing options

Use criteria - If you would like to use File Manager for z/OS Selection Criteria, specify the data set and/or member which contains the Selection Criteria. Batch parameters: CRITERIA, CRITDSN

Keys range - If you would like to restrict the extract to segments with a certain range of key values, specify the key value range here. You must specify a start and end key, separated by a comma. You may use hex escaping (e.g. X'4040') or case escaping (e.g. C'Aa') individually for each key, and you must use one of these for any key values which contain a comma. Batch parameter: KEYRANGE

Keys list - If you would like to restrict the extract to segments with a certain set of key values, specify the set of keys here. If you specify more than one key value, separate each key value from the next by using a comma. You may use hex escaping (e.g. X'4040') or case escaping (e.g. C'Aa') individually for each key, and you must use one of these for any key values which contain a comma. Batch parameter: KEYLIST

Keys file - If you would like to restrict the extract to segments with a certain set of key values, and you have a data set or member which contains the key values of the root segments of the records that you want extracted, specify the name of that data set (and optionally member) here. Batch parameter: KEYEXT, batch DD: KEYSFILE

Maximum root segments - If you would like to limit your extract to a certain maximum number of segments, enter that maximum here. Batch parameter: MAXROOTS

Edit Database Data Sets - If Mode is set to Dynamic, you may tick this box to edit the database data sets for the entered database name prior to running the extract. If ticked, a separate dialog will be shown to allow you to edit these; changes you make will be persisted for the database and subsystem which you make them for. This option will have no effect if the system administrator has configured the selected IMS subsystem's installation options to use dynamic allocation of data sets, or if the entered database is a HALDB. Batch parameters: DBDDSN1, DBDDSN2, ..., DBDDSN6

Write SDEP timestamp to Unload data set (if applicable) - Specifies whether or not FM/IMS is to write the SDEP timestamp to the unload file. This option is only applicable for DEDBs with Sequential Dependent (SDEP) segments. Batch parameter: SDEPTSO

Interaction between processing options: - The final set of segments to extract is the set of all segments which key range, key list, and keys file would cover (union, i.e. added together with duplicates removed), intersected with the set of segments which the selection criteria would cover.

Back to top