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.
Subsystem: The IMS subsystem can be specified using the Lookup button on the right. From here, the subsystem's configuration may be edited by clicking on the edit button to the right of the field.
Region Type: Specifies the Region type the function will run in. The database must be online to use BMP, and the user can use DLI when the database is offline or if there is data sharing support. Either of these options may be disabled by the 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 the system administrator in the File Manager installation options. Batch parameter: PSBTYPE
Database name: The name of the database (also known as DBD) must be specified to extract from here. Batch parameter: DBDNAME
PSB name: The name of the PSB name must be specified which contains the PCB to be used to extract. Batch parameter: PSBMEM
Database name: The name of a database can optionally be specified which is used to filter a list of PCBs in the selected PSB. If there are more than one PCB, then a PCB must be selected.
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, the user will be prompted to allocate the data set with some sensible default allocation parameters. Batch DD name: UNLOAD
Create template - If the user 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 topCriteria dataset: Use this parameter to specify the data set and/or member which contains the Selection Criteria. Batch parameters: CRITERIA, CRITDSN
Keys range: Use this parameter to restrict the extract to segments with a certain range of key values. Start and end key must be specified, separated by a comma. Hex escaping (e.g. X'4040') may be used or case escaping (e.g. C'Aa') individually for each key, and one of these must be used for any key values which contain a comma. Batch parameter: KEYRANGE
Keys list: Use this parameter to restrict the extract to segments with a certain set of key values. If more than one key value are specified, separate each key value from the next by using a comma. Hex escaping (e.g. X'4040') may be used or case escaping (e.g. C'Aa') individually for each key. One of these must be used for any key values which contain a comma. Batch parameter: KEYLIST
Keys file: Use this parameter to restrict the extract to segments with a certain set of key values. If there is a data set or member that contains the key values of the root segments of the records to extract, specify the name of that data set (and optionally member) here. Batch parameter: KEYEXT, batch DD: KEYSFILE
Maximum root segments - Use this parameter to limit the extract to a certain maximum number of segments. Batch parameter: MAXROOTS
Display Database Data Sets - If Mode is set to Dynamic, this box can be ticked 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 thedata sets to be edited. The changes made will be persisted for the database and subsystem which has been specified. 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