Extract Entry panel

Panel and field definitions

  Process   Options   Help
 ──────────────────────────────────────────────────────────────────────────────
 FM/IMS                       Extract Entry Panel

 IMS:
    Subsystem name  . . IF52          PSB name  . . . LA19D     (If static PSB)
    Database name . . . DJ1E          AGN name  . . .           (If BMP)
 Criteria:
    Data set name . . . 'FMN.REGTEST.IMS.CRITERIA'                 
    Member  . . . . . .         

 Processing Options:
    PSB type            Region type         Fetch DB dsnames from (if DLI)
    1  1. Dynamic       1  1. DLI           1  1. User profile
       2. Static           2. BMP              2. DFSMDA members

    Criteria usage      Enter "/" to select option
    2  1. New              Use key values   /  Create extract template
       2. Existing         Edit criteria       Skip DB data set panel (if DLI)
       3. None             Scramble            SDEP in timestamp order

 Command ===>                                                                  
  F1=Help      F2=Split     F3=Exit      F4=CRetriev  F7=Backward  F8=Forward
  F9=Swap     F10=Actions  F12=Cancel

IMS

Subsystem name

The ID of the IMS subsystem that the databases you want to extract data from are defined in. FM/IMS searches the FM/IMS installation options module for the subsystem with the specified name. If you enter either no subsystem name or a subsystem name pattern, the Subsystem Selection panel is displayed. You can select a subsystem from the list of subsystems displayed on that panel.

PSB name

If you select "Static" for PSB type, specify the name of the PSB that you want the Extract to use.

The PSB that you specify must have a PCB for the primary database of the Extract.

If you want your Extract to chase logical relationships, the PSB must also have a PCB for each database that is logically related to the primary database.

FM/IMS searches either an IMS catalog or PSB libraries for a PSB with the specified name. Which of these two sources is searched depends on whether or not the selected subsystem uses IMS-managed ACBs.

If the selected subsystem uses IMS-managed ACBs, then FM/IMS searches the IMS catalog that the subsystem uses.

Otherwise, FM/IMS searches user- or administrator-specified PSB libraries. The libraries that are searched depend on which subsystem you select, so they are called the PSB libraries for the selected subsystem.

The PSB libraries for the selected subsystem are displayed on the PSB and DBD Data Sets panel and may or may not be fixed by the FM/IMS administrator.

If the PSB libraries for the subsystem are fixed, the PSB Data set name fields on the PSB and DBD Data Sets panel are protected and you must use the PSB libraries that the administrator has specified. Otherwise, these fields are not protected and you are free to modify the list of PSB libraries that FM/IMS searches.

FM/IMS searches the PSB libraries in the order in which they are specified and uses the first PSB it finds with the specified name.

If you do not enter a PSB name or if you enter a PSB name pattern, the PSB Selection panel is displayed. You can select a PSB from the list of PSBs displayed on that panel.

Note: If you select "Dynamic" for PSB type, this field is ignored.

Database name

The name of the primary database of the Extract.

FM/IMS searches either an IMS catalog or DBD libraries for a DBD with the specified name. Which of these two sources is searched depends on whether or not the selected subsystem uses IMS-managed ACBs.

If the selected subsystem uses IMS-managed ACBs, then FM/IMS searches the IMS catalog that the subsystem uses.

Otherwise, FM/IMS searches user- or administrator-specified DBD libraries. The libraries that are searched depend on which subsystem you select, so they are called the DBD libraries for the selected subsystem.

The DBD libraries for the selected subsystem are displayed on the PSB and DBD Data Sets panel and may or may not be fixed by the FM/IMS administrator.

If the DBD libraries for the subsystem are fixed, the DBD Data set name fields on the PSB and DBD Data Sets panel are protected and you must use the DBD libraries that the administrator has specified. Otherwise, these fields are not protected and you are free to modify the list of DBD libraries that FM/IMS searches.

FM/IMS searches the DBD libraries in the order in which they are specified and uses the first DBD it finds with the specified name.

The following applies to when you select “Dynamic? for PSB type:

• If you enter either no database name or a database name pattern, the Database Selection panel is displayed. You can select a database from the list of databases displayed on that panel.
• If the selected subsystem does not use IMS-managed ACBs, then IMS requires these DBDs to be in at least one of the specified DBD libraries:
  • The DBD for the primary database of the Extract .
  • The DBD for each database that is logically related to the primary database of the Extract.

The following applies to when you select “Static? for PSB type:

• The PCB Selection panel is displayed when any one of these is true:
  • You enter no database name and there is more than one database PCB in the specified PSB.
  • You enter a database name and there is more than one PCB for the database in the PSB.
  • You enter a database name pattern and the PSB has PCBs for databases with names that match the pattern.

  You can select a PCB from the list of database PCBs that is displayed on the PCB Selection panel.

• If the subsystem does not use IMS-managed ACBs, then IMS requires these DBDs to be in at least one of the specified DBD libraries:
  • The DBD for each database that is specified in the PSB.
  • The DBD for each database that is logically related to a database specified in the PSB.

AGN name

The Application Group Name (AGN) identifies a group of IMS resources. The name you specify is passed to the IMS region controller when you select BMP for the Region type.

If you select a subsystem that does not use AGNs, no AGN name should be entered.

If you select a subsystem that uses AGNs, specify an AGN that provides you with the access the Edit requires and that you have authority to use. (The BMP region that FM/IMS starts is only authorized to use the IMS resources that are associated with the specified AGN.)

The AGN Selection panel is displayed when all these conditions are true:

• A BMP region type is selected.
• The selected subsystem uses AGNs.
• AGNs for the selected subsystem are listed in the FM/IMS installation options module.
• Either no AGN name is entered or an AGN name pattern is entered and there are AGNs for the selected subsystem in the FM/IMS installation options module that match the pattern.

You can select an AGN from the list of AGNs that is displayed on the AGN Selection panel. If AGNs for the selected subsystem are not listed in the FM/IMS installation options module, you must specify the full name of the AGN.

Note: This field is ignored when you select DLI for the Region type.

Criteria

Data set name

If you select "Existing" for the Criteria usage, this is the name of the data set that contains the criteria that you want the Extract to use.

Note: If you select "New" or "None" for Criteria usage, this field is ignored.

Member

If you select "Existing" for Criteria usage, then:

• If the criteria that you want the Extract to use are in a PDS(E), specify the criteria member name in this field.
• If the criteria that you want the Edit to use are in a sequential data set, blank out this field.

Note: If you select "New" or "None" for Criteria usage, this field is ignored.

PSB type

The type of PSB that the Extract uses to access the databases:

1. Dynamic

The Extract uses a temporary PSB that it generates at the start of the batch job.

2. Static

The Extract uses an existing PSB you specify in the PSB name field.

Region type

The type of region that you want the Extract to run in:

1. DLI

For a DL/I batch processing region. You can use a DL/I batch processing region when the database is offline or there is data sharing support.

2. BMP

For a BMP region. You can use a BMP region when the database is online.

Fetch DB dsnames from (if DLI)

If you select "DLI" for Region type, a database that is not a HALDB, and an IMS subsystem that is not a dynamic allocation only subsystem:

1. User profile

Extract uses the database data sets whose names are saved in your user profile.

2. DFSMDA members

Extract uses the database data sets specified in the DFSMDA dynamic allocation members.

Note: This field is ignored when you specify any one of these:

• "BMP" for Region type.
• A database that is a HALDB.
• An IMS subsystem that is defined as dynamic allocation only in the FM/IMS installation option module.

Criteria usage

Determines whether the Extract uses a new criteria, existing criteria, or no criteria:

1. New

Select this option when you want Extract to use new criteria.

The Extract creates a temporary criteria set from a template for the specified database.

FM/IMS searches user or administrator-specified template libraries for the template. The template libraries that FM/IMS searches depends on which subsystem you select:

• If the template libraries for the specified subsystem are not fixed, FM/IMS searches the template libraries specified on the Template Data Sets panel.
• If the template libraries for the subsystem are fixed, FM/IMS searches the default template libraries for the subsystem (specified in the FM/IMS installation options module).

FM/IMS searches the template libraries in the order in which they are specified and uses the first template it finds with the specified database name.

FM/IMS starts the Criteria dialog where you can edit and save the temporary criteria set.

2. Existing

Select this option when you want Extract to use existing criteria. Extract uses the criteria set specified in the Criteria Data set name and Member fields.

3. None

Select this option when you do not want Extract to use criteria.

Use key values

Select this option if you want to specify the key values of the root segments of the records that are to be extracted.

If you select this option, the Extract Options panel is displayed. You specify the name of the data set that contains the key values that you want the Extract to use on that panel.

Edit criteria

Select this option if you have selected "Existing" for Criteria usage and you want to edit the criteria before you use them.

If you select this option, FM/IMS starts the Criteria dialog where you can edit and save the criteria specified in the Criteria Data set name and Member fields.

Note: This field is ignored when you select "New" or "None" for Criteria usage.

Create extract template

Select this option if you want either the Extract dialog or your Extract job to create a template for the Extract file. You can use this template to edit or view the records in the Extract file.

If you select this option, the Extract Options panel is displayed. You specify the name of the output Extract template data set and Extract template processing options on that panel.

Skip DB data set panel (if DLI)

Select this option if you do not want FM/IMS to display the Database Data Set Specification panel or the Database Data Set Display panel.

If this option is not selected and you select "DLI" for Region type, the Database Data Set Specification panel or the Database Data Set Display panel is displayed.

Note: This field is ignored when you select BMP for the Region type.

Scramble

Select this option to apply scrambling options that are defined in the associated template to the extracted data.

SDEP in timestamp order

Select this option if you are extracting data from a DEDB with Sequentially Dependent (SDEP) segments, the extracted SDEP segments are to be loaded into a database, and there is a requirement for the loaded SDEP segments to be in timestamp order.

If this option is not selected, all of the sequential dependents of a root segment are physically loaded together in the reverse sequence they were extracted.

When using DL/I calls to read SDEP segments, the sequence of the SDEP segments in the loaded database appear to be the same as their sequence in the database you extracted them from. However, when the DEDB is processed using the Sequential Dependent Scan Utility, you will find the SDEP segments are in a different sequence.

Note:

1. If you select this option, elapsed time and I/O for the Extract will be greater.
2. This field is ignored when the specified database does not have SDEP segments.