The Extract - Keys Tab

The Extract - Keys tab is used to add, edit, remove, include, exclude, and define the layout for key files, and to map the key columns.

To add key files

Adding input and output key files enables mapping of the key columns in the driving table to a record in the key file.

  1. On the Extract - Keys tab, click Add Key. The Select Key File dialog box appears.
  2. From the Object list, select the object to which to add the key file.
  3. From the Key Type choices, select either Input or Output based on the type of key to be added.
  4. From the Resource Type choices, select either File or Dataset.
    • If File was selected, in the Select File field, enter the path to the file or click Browse to navigate to the file location. Then click OK.
    • If Dataset was selected, do one of the following:
    • From the Host list, select the host to connect to. In the Name field, enter the dataset name and click List. The datasets that match the entered filter appear. Select the dataset to use as the key file. In the Executive Host, Executive Port, User ID, and Password fields, enter the corresponding information for the File-AID/EX executive host. Click OK.
    • In the Name field, enter the dataset name. In the Executive Host, Executive Port, User ID, and Password fields, enter the corresponding information for the File-AID/EX executive host. Click OK.

Important

While multiple output key files can be added, only one input key file can be added, which should be on the driving table.

Important

Optionally, to view the data in a selected dataset, click View.

The object name and the key file value appear on the Extract - Keys tab with a Key Type of Input or Output.

To remove a key file

Remove a key file from a specification.

Important

Alternatively, a key file can be excluded so that, when the specification is run, the key file is not included.


On the Extract - Keys tab, select the key file and right-click and select Remove or click Remove. The key file is removed from the specification.

To exclude a key file

Excluding a key file allows the user to keep a key in the specification but exclude it from running when the specification is executed.

On the Extract - Keys tab, clear the check box for the key file to be excluded. When the specification is run, the key file is not included.

To define the layout of a key file and map columns to key file records

The key columns are normally the columns in the object that hold unique data, which identifies that column from all other columns. The key file is a flat file in text format and must have separators for each field, and each record must be terminated with CR/LF (combination of a carriage return and a line feed characters). No special characters, such as monetary symbols, are allowed in numeric fields.

When specifying the key columns for output keys, a list of key values is generated (written) for the object and this list is saved to a file.

When specifying the key columns for input keys, a list of key values is generated (read in) for the driving object, and this list is saved to a file. These key values can come from the list that is created when specifying the output keys (recommended), or the list can be created as a text file.

For input keys, if the Column Type is Date, the format must be yyyy-MM-dd HH:mm:ss.SSS. The output key file uses the same date format.

This file is then loaded during the execution of the extract specification and used as chase keys. The key file values are matched appropriately with key columns in the driving object.

This procedure is used to map the key columns in an object to a record in the key file. The key columns are normally the columns in the object that hold unique data, which identifies that column from all other columns. The key file is a flat file in text format and must have separators for each field.

  1. On the Extract - Keys tab's Key File table, select the key file.

  2. Do one of the following:

    • Click Define Layout.
    • Right-click and select Define Layout.
      The Define Layout dialog box appears.

       3. Do any of the following:


    • To remove a field, select the field and click Remove.
    • Use the Move Up and Move Down buttons (or drag and drop) to reorder the fields. The fields can be mapped in the order that the fields appear in this table.
    • Rename a field by selecting it and entering a new name.

       4. From the Field Delimiter list, select the character or enter the characters to be used as a field separator.

       5. Click OK. The layout appears on the Extract - Keys tab's Key Columns Mapping table.

       6. To map the layout to the table columns on which the key file was added, use the Key Columns Mapping column to select the fields.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*