Maintaining and Finding Symbol Tables

#### Search Results

Search

# Maintaining and Finding Symbol Tables

Symbol tables are defined in a Symbol Master or Symbol Active window. Maintenance functions for symbol tables are provided from the context menu of a symbol table selected from a Symbol Table Master or Symbol Table Active node.

The fields and functions provided in a Symbol Master or Symbol Active window are explained in Fields: Symbol. The functions provided for symbol and symbol table maintenance are explained in Available Functions: Symbol.

This document covers the following topics:

- Available Functions: Symbol Table

- Listing Symbol Table Masters Defined for an Owner

- Listing Active Symbol Tables

- Listing Usable Symbol Tables

- Listing Jobs and Networks that Use a Symbol Table

- Determination and Activation of Necessary Symbol Tables

- Displaying and Modifying a Symbol Table

- Adding a Symbol Table Master

- Versioning of Symbol Tables

- Maintaining the Usage of Symbol Table Versions

- Saving Symbol Tables as Files

- Deleting a Symbol Table Master

## Available Functions: Symbol Table

To list all functions available for a symbol table node

- For a symbol table master: In the object workspace, select the Symbol Table Master node from an Owner instance and open the context menu.

  Or:
  For an active symbol table: In the object workspace, select a Symbol Table Active node from an Active Run and open the context menu.

  The following functions are available for a list of symbol tables:

  Function | Shortcut | Description
  --- | --- | ---
  List | F8 | Lists symbol tables: see Listing Symbol Table Masters Defined for an Owner and Listing Active Symbol Tables.
  New | CTRL+N | Adds a symbol table master. This function is not available for active symbol tables.
  Refresh | F5 | See Refreshing Object Lists.
  Filter | F3 | See Filtering Objects.
  Paste data | CTRL+V | See Pasting Objects. This function is not available for active symbol tables.
  Export | --- | See Exporting Objects in the Import/Export Functions documentation. This function is not available for active symbol tables.
  Set Drag And Drop Function | --- | See Drag & Drop.

To list all functions available for a symbol table

- For a symbol table master: In the object workspace, select an instance from a Symbol Table Master node and open the context menu.

  Or:
  For an active symbol table: In the object workspace, select an instance of a Symbol Table Active node and open the context menu.

  The following functions are available:

  Function | Shortcut | Description
  --- | --- | ---
  Open | CTRL+O | Modifies the symbol table.
  Display | CTRL+D | Displays the symbol table.
  Where used | --- | Lists jobs and networks that use the symbol table. This function is not available for active symbol tables.
  Active Usage |  | Lists active jobs using an active symbol table. This function is not available for symbol table masters.
  Delete | DELETE | Deletes a symbol table master. This function is not available for active symbol tables.
  Copy data | CTRL+C | See Copying Objects. This function is not available for active symbol tables.
  Version Usage | --- | Maintains the usage of symbol table versions. This function is not available for active symbol tables.
  Export | --- | See Exporting Objects in the Import/Export Functions documentation. This function is not available for active symbol tables.
  Add to Workplan | --- | See Add to Workplan.
  Save as File | --- | See Saving Symbol Tables as Files.
  Set Drag And Drop Function | --- | See Drag & Drop.

## Listing Symbol Table Masters Defined for an Owner

This function applies to symbol table masters only.

To list all symbol table masters of an owner

- In the object workspace, select the Symbol Table Master node of an owner and choose List from the context menu, or press F8.

  A Symbol Table Master List window like the example below opens:

  This window lists symbol table masters already defined to Entire Operations. You see only the symbol tables that belong to your owner (here: `EXAMPLE`). If no symbol table masters exist, an appropriate message is returned.

  The functions available for a symbol master list are explained in Available Functions: Symbol Table.

This section covers the following:

## Listing Active Symbol Tables

To list symbol tables active during a job run

- In the object workspace, select the Symbol Table Active node of an Active Run and choose List from the context menu, or press F8.

  A Symbol Table Active List window like the example below opens:

  This window lists all active symbol tables for the selected job run (here: `2`) of a network (here: `E60-FLOW`). If active symbol tables are not available, an appropriate message is returned.

  The functions available for a list of active symbol tables are explained in Available Functions: Symbol Table.

## Listing Usable Symbol Tables

You can list all symbol tables that can be used by a job and/or network and network version. For an active network, usable symbol tables are active symbol tables required and actually used for symbol replacement during the current network run. You can list and access all symbols contained in listed symbol tables.

To list symbol tables available for a job or network

1. In the object workspace, select an instance of a job or network (master or active).

2. Open the context menu and choose Usable Symbol Tables.

   A Usable Symbol Tables window like the example of an active job below opens:

   This window lists all symbol tables which can be used by the current object (network, job master, active job). The example above lists the symbol tables that can be used by the active job `JOB-01`.

   The columns in the window are explained in Columns: Usable Symbol Tables.

The symbol tables are listed in descending hierarchical order, that is, the topmost symbol table is used first during symbol replacement.

This section covers the following topics:

- Columns: Usable Symbol Tables

### Columns: Usable Symbol Tables

The columns contained in the Usable Symbol Tables window are described in the following table:

Column | Description
--- | ---
Type | Type of the symbol table: see Symbol Table Types and Symbol Search Order.
Owner | Owner of the symbol table.
Symbol Table | Name of the symbol table.
Version | Version of the symbol table.
Network | For active job networks only. Active network which uses the symbol table.
Version | For active job networks only Version of the active network which uses the symbol table.
Run | For active job networks only. Run number of the active job network.

## Listing Jobs and Networks that Use a Symbol Table

You can list all jobs and networks that use a symbol table master or an active symbol table. This is required, for example, if you cannot delete a symbol table because it still uses one or more jobs. You then need to find these jobs and change their symbol table settings or delete the jobs.

Note
This function only shows the references of a network or job to a symbol table master if it has been explicitly defined. You can use the cross-reference function Symbol Table Usage (see Generating Cross-Reference Reports Online) to get a list of all references to a symbol table master including the references contained in input conditions and End-of-Job actions.

To list jobs and networks that use a symbol table master

- In the object workspace, select a Symbol Table Master instance and choose Where used from the context menu.

  A Where used Symbol Table Master window like the example below opens:

  The window lists all networks and jobs that use the selected symbol table master (here: `EXAM-TABLE`) of the specified owner (here: `SAGTEST`).

  All symbol table versions defined for the selected symbol table are listed.

  The columns in the window are explained in Fields and Columns: Symbol Table Usage.

To list all active jobs using an active symbol table

1. In the object workspace, select a Symbol Table Active instance.

2. Open the context menu and choose Active Usage.

   An Active Usage Symbol Table Active window like the example below opens:

   The window lists all active jobs used by the active symbol table. The columns contained in the window correspond to the columns in the Where used Symbol Table Master. They are explained in Columns: Symbol Table Usage.

This section covers the following topics:

- Columns: Symbol Table Usage

### Columns: Symbol Table Usage

The columns contained in the Where used Symbol Table Master or Active Usage Symbol Table Active window are explained in the following table:

Column | Description
--- | ---
Network | Name and version of the job network.
Job | Name of the job that uses the symbol table. A dash (`-`) or a blank indicates that the symbol table is specified in the network definition.
Type | Indicates whether a job master or job active, or a network master/version or network active uses the symbol table. For possible column entries, see the Symbol Table Type table column described in Symbol Table Types and Symbol Search Order.
Run | Displays the job's run number if the symbol table is used by an active job.
SymTab Version | Named version (if defined) or reserved name of the symbol table. For possible column entries, see Reserved Version Names for Symbol Tables.

## Determination and Activation of Necessary Symbol Tables

During network activation or single job activation, the list of the required (active) symbol tables is determined by Entire Operations. The result of the determination is written to the Entire Operations log. It may look like this:

    List of active Symbol Tables created
    Determined Symbol Table Versions for 17.01.14
    ... Ob  Job         St  SymTab      defined         determined
    ... NV              00  N1649T00    (current)   ->  v002
    ... JM  J001        00  N1649T00    (unnamed)   ->  (unnamed)
    ... JM  J003        ED  N1649T00    (current)   ->  v002
    ... JM  J004        ED  N1649T00    (nv)        ->  (unnamed)
    ... JM  J005        ED  N1649T00    (svn)       ->  v002

The St column shows the status of the symbol table to be activated:

`ED` | Evaluation duplicate. This status is set if a previous determination (evaluation) resulted in the same symbol table with the same version. In this case, the symbol table (version) is activated only once.
`EJ` | Indicates End-of-Job checking or End-of-Job actions.
`00` | Undefined status.
`10` | Indicates that prompting is not required.
`20` | Indicates that prompting is required.
`30` | Indicates that prompting is performed.

The Ob column shows the symbol table type, for example, `JM` for a symbol table referenced by a job master. See also Symbol Table Types and Symbol Search Order.

The determined symbol table versions (see Versioning of Symbol Tables in the section Symbol Table and Symbol Maintenance) are used for the subsequent symbol table activation.

In case of any determination error, the network activation or job activation is aborted.

## Displaying and Modifying a Symbol Table

Displaying and modifying a symbol table master or an active symbol table consists of viewing, adding, modifying or deleting symbols contained in the symbol table. You cannot change the name or version of a symbol table.

To display or modify symbols contained in a symbol table

1. For a symbol table master: In the object workspace, select a Symbol Table Master instance.

   Or:
   For an active symbol table: In the object workspace, select a Symbol Table Active instance.

2. To display symbols: Choose Display from the context menu, or press `CTRL+D`.

   Or:
   To modify symbols: Open the context menu and choose Open, or press CTRL+O.

   For a symbol table master, a Display Symbol Table Master or Maintenance Symbol Table Master window like the example below opens:

   For an active symbol table, a Display Symbol Table Active or Maintenance Symbol Table Active like the example below opens:

   You can modify a selected symbol (here: `CLASS`) by choosing Modify, add a new symbol by choosing Add, or delete a selected symbol by choosing Delete.

   The fields and columns contained in the window are explained in Fields and Columns: Symbol Table.

3. If you choose Delete, a window prompts you to delete the selected symbol.

4. If you choose Modify or Add, a Maintenance Symbol Master window like the example below opens:

5. Make the required definitions in the fields of the tabbed pages Main, Multiple Symbol Values and Value Check. They are explained in Fields: Symbol.

6. Choose OK when you are finished.

   The symbol table master is changed and now ready to use in the network.

This section covers the following topics:

- Fields and Columns: Symbol Table

### Fields and Columns: Symbol Table

The fields and columns in a Symbol Table Master or Symbol Table Active window are explained in the following table:

Field/Column | Description
--- | ---
Symbol | Name of the symbol used as a variable.
Format | Format of the variable. Possible values:
`A`
Alphanumeric (including special characters).
`D` | Date.
`L` | Alphanumeric; conversion to lowercase letters.
`N` | Numeric.
`U` | Alphanumeric; conversion to uppercase letters.
Prompt | Prompting. The user is prompted for this symbol during manual activation of the job network. Possible values:
`A` | Prompted for symbol during each activation.
`E` | Prompted only if no value is specified in the symbol table.
`N` | Never prompted for symbol.
Value | Current value of the variable, i.e., the string or number substituted in dynamically generated JCL. Possible entries:
empty column | The value of the symbol is an empty string.
`*** n multiple values ***` | One or more values (`n`) are defined for the variable. Select the Multiple Symbol Values tab to view or change the values.
Modified by | User who last modified the symbol.
Time | Date and time when a user last modified the symbol.

## Adding a Symbol Table Master

This function applies to symbol table masters only.

You can add a symbol table master by either copying an existing table (see the Copy data/Paste data functions for a symbol table instance of a master node) or creating a new symbol table with the New function. This requires that you define at least one symbol master along with the table.

This section provides instructions for using the New function.

To add a symbol table master

1. In the object workspace, select the Symbol Table Master node.

2. From the context menu choose New, or press CTRL+N.

   A Create new Symbol Table Master window opens.

   The fields and columns contained in the window correspond to the field and columns in the Maintenance Symbol Table Master window. They are explained in Fields and Columns: Symbol Table.

3. Enter a name for the symbol table and symbol table version and choose Add.

   A Create new Symbol Master window opens.

   The fields and tabbed pages contained in the window correspond to the fields and tabbed pages in the Maintenance Symbol Master window. They are explained in Fields: Symbol.

4. If required, enter a different symbol table name and version and make your definitions on the tabbed pages Main, Multiple Symbol Values and Value Check.

5. Choose OK when you are finished.

   The symbol table master is created and now ready to use in the active network.

This section covers the following topics:

## Versioning of Symbol Tables

This function applies to symbol table masters only.

This section describes how to maintain and use different versions of symbol tables.

- Version Names

- Version Names Exit

- Reserved Version Names for Symbol Tables

- Creating Symbol Table Versions by Copying Symbol Tables

- Copying Single Symbols

- Deleting Symbol Table Versions

- Deleting Symbol Table Versions or Single Symbols via API

- Using Symbol Table Versions for Schedule Activation

- Definition of Symbol Table Versions

- Versioning for Active Symbol Tables

- Symbol Prompting

- Search Order for Symbols

- Symbol Tables at System and Owner Level

- Logging

- Cross-References (XRef)

- Reporting

- Import/Export

- Exit Functionality (Symbol Table)

- Maximum Number of Versions per Symbol Table

### Version Names

The following applies when creating version names:

- The name can contain up to 10 alphanumeric characters and uppercase or lowercase letters.

- Space characters and the following special characters are not allowed:

  ?<>*‚()_

- To avoid problems when porting an Entire Operations environment to another platform, do not use special characters and umlauts.

- Do not use a reserved version name (see the relevant section).

### Version Names Exit

You can force a user-specific version name syntax by using a global version name exit. For detailed information, see Global Exit for Version Names in the Administration documentation.

### Reserved Version Names for Symbol Tables

You can specify a reserved version name to determine the symbol table to be used for an active network or job run.

A reserved version name is evaluated during network or job activation and is replaced by a defined version name if available for the symbol table at that time.

You can use the following reserved version names:

> Blank value or `(unnamed)`

>   A blank value or `(unnamed)` is replaced by the unnamed version of a symbol table.

>   An unnamed symbol table network version is the only symbol table version that exists after migration from an earlier Entire Operations version that does not support symbol table versioning.

>   In parameter listings (for example, for reporting functions such as Compare Symbol Tables) you can also use a hyphen (`-`).

> `(current)`

>   `(current)` is replaced by the symbol table version that is in effect during version evaluation. `(current)` can also be used in input fields that reference symbol table versions.

> `(nv)`

>   `(nv)` is replaced by the network version of the active network.

> `(svn)`

>   `(svn)` is replaced by the symbol table version used by the active network. `(svn)` can also be used in symbol tables referenced in a subnetwork.

> `(svj)`

>   `(svj)` is replaced by the symbol table version used by the active job. `(svj)` can also be used in input and output conditions defined for the job. For example:

>   - Requested prerequisite dependent on the symbol value,

>   - Requested prerequisite dependent on multiple-value symbols,

>   - End-of-Job action: set symbol.

### Creating Symbol Table Versions by Copying Symbol Tables

You can copy symbol tables to add a new version for an existing symbol table. This is a common way to build new symbol table versions.

### Copying Single Symbols

You can copy a single symbol from any version of the originating symbol table.

### Deleting Symbol Table Versions

- If multiple versions of a symbol table exist, you must select the version to be deleted.

- A symbol table version cannot be deleted if listed in an activated time schedule as a standard version. A defined date in the past is not relevant.

### Deleting Symbol Table Versions or Single Symbols via API

You can delete single symbol table versions by using the API NOPUSY7N.

### Using Symbol Table Versions for Schedule Activation

You can maintain version usage in symbol table administration by using the functions described in Maintaining the Usage of Symbol Table Versions.

### Definition of Symbol Table Versions

Symbol table versions can be defined in the following:

- Network version definition,

- Job definition.

### Versioning for Active Symbol Tables

- The activation of symbol tables is a component of network and job activations.

- A symbol table can only be activated in a clearly identified version. The identification of the requested symbol table version is part of the activation process.

- Active symbol tables loose their version nomenclature `(current)` or `(nv)`. They are detached during activation.

- Active symbol tables can only have the version nomenclature `(none)` or a defined version name.

- If a requested symbol table version is missing or if the version cannot be defined, then the activation process will be aborted with an error message.

### Symbol Prompting

Before symbol prompting (during manual activation and before executing the symbol prompting exit in the Monitor), the symbol table versions to be used will be clearly determined. See also Symbol Prompting during Network or Job Activation.

If at least one symbol table version cannot be identified, the activation process will be aborted with an error message.

### Search Order for Symbols

The order in which symbols are searched for in the symbol tables defined in your environment depends on the hierarchy levels at which the symbol tables defined in you environment can be accessed: see Symbol Table Types and Symbol Search Order.

### Symbol Tables at System and Owner Level

Global symbol tables are not version-controlled.

The symbol tables are:

    SYSDBA / A
    owner / A

### Logging

Logging of symbol actions include the version of the table where the symbol was loaded from.

The generated comments in the Entire Operations JCL header contain the symbol table version of all used symbols.

### Cross-References (XRef)

Symbol table versions will be considered.

### Reporting

Symbol table versions will be considered.

### Import/Export

Symbol table versions will be considered.

### Exit Functionality (Symbol Table)

Entire Operations provides user exits and APIs that are related to symbols and support network versioning, for example, API `NOPUSY7N`.

### Maximum Number of Versions per Symbol Table

The maximum number of symbol table versions can be limited system wide as described in Defaults for Network Options in the Administration documentation.

## Maintaining the Usage of Symbol Table Versions

This function applies to symbol table masters only.

You can use the Version Usage function to determine a period (from/to date range) during which a defined symbol table version is used as the current symbol table for all scheduled job activations.

Note
You cannot use the Version Usage function to add a symbol table version. You can define a symbol table version when you create or copy a symbol table master.

This section covers the following topics:

- Listing, Defining and Deleting Version Usage

- Fields and Columns: Version Usage Definition

### Listing, Defining and Deleting Version Usage

This section provides instructions for listing, defining and deleting version usage definitions for symbol table versions.

To list version usage definitions

1. In the object workspace, select a symbol table master.

2. Open the context menu and choose Version Usage.

   A Version Usage Symbol Table Master window like the example below opens:

   The window lists the version usage defined for the selected symbol table master version (the table is empty if no definition exists).

   If you enter an asterisk (`*`) in the Version field, all version usages defined for all versions of the symbol table master are listed in the window as shown in the example above. The fields and columns are explained in Fields and Columns: Version Usage Definition.

   The following functions are available:

   Function | Description
   --- | ---
   Add | Adds a version usage definition: see To add or modify a version usage definition.
   Modify | Modifies the usage definition selected in the table row. See To add or modify a version usage definition.
   Delete | Deletes the usage definition selected in the table row. A window prompts you to confirm the deletion with Yes or cancel the action with No.
   Auto Refresh/Refresh | See Refreshing Object Lists.

To add or modify a version usage definition

1. In the Version Usage Symbol Table Master window, choose Add to create a new definition.

   Or:
   In the Version Usage Symbol Table Master window, select the table row that contains the definition you want to modify, and choose Modify.

   The input fields that appear in the window are shown in the following example:

2. Enter the required values or select a value from the drop-down list boxes. Activate or deactivate a From or To field by selecting the check box next to it. Deactivated fields are ignored and not processed. For additional information, see Fields and Columns: Version Usage Definition.

3. Choose OK when you are finished.

### Fields and Columns: Version Usage Definition

Field/Column | Description
--- | ---
From (column or input field) | Start date of a default usage period of a network version. `>>>>>>>>` denotes that no start date has been defined. Possible value for an input field: A start date or no value (check box of field not selected) for no start date. You can open the drop-down list box to select a date from a calendar. Default: A start date is not defined. Note Date ranges must not overlap.
To (column or input field) | End date of a default usage period of a network version. `>>>>>>>>` denotes that no end date has been defined; the usage is unlimited (infinite). Possible value for an input field: An end date or no date (check box of field not selected) for an unlimited time. You can open the drop-down list box to select a date from a calendar. Note Date ranges must not overlap. Default: An end date is not defined.
Version (column) | Symbol table version for which the usage is defined.
Description (column) | Description of the version usage.
Symbol Table Version | Input field for the symbol table version to be used as the current version during the period specified in the From/To fields. Enter the required version or select a version from the drop-down list box.
Version Usage Description | Input field for a description of the version usage. Maximum input: 70 characters.

## Saving Symbol Tables as Files

To save a symbol table master as a file

1. In the object workspace, select a Symbol Table Master instance and choose Save as File from the context menu.

2. Specify the file format and type as described in Report Output Options and choose OK.

   An output file like the example below is created:

   This output displays the selected symbol table master and all related information.

To save an active symbol table as a file

1. In a Symbol Prompting window, select Save symbol table active as file and choose Continue.

2. Specify the file format and type as described in Report Output Options and choose OK.

   An output file like the example below is created:

   This output displays the symbol table active and all related information.

## Deleting a Symbol Table Master

This function applies to symbol table masters only.

> Restrictions:

>   - You cannot delete a symbol table master that is still used by one or more jobs. In this case, the error message `EOR1859 - Symbol Table ... used in Definitions` occurs. You can only delete the symbol table if you either specify another symbol table for these jobs or delete them. Proceed as described in Listing Jobs and Networks that Use a Symbol Table Master to find the jobs that use the symbol table.

>   - You cannot delete a symbol table master with a symbol table version that is still defined in the version usage of the symbol table. In this case, the error message `EOR2691 - Version ... - current usage found` occurs. You then need to delete the usage defined for the version as described in Maintaining the Usage of Symbol Table Versions.

To delete a symbol table master

1. In the object workspace, select a Symbol Table Master instance.

2. Choose Delete from the context menu, or press DELETE.

   A confirmation window opens.

3. Choose Yes to confirm the deletion or No to cancel the action.

### On this page

- Available Functions: Symbol Table
- Listing Symbol Table Masters Defined for an Owner
- Listing Active Symbol Tables
- Listing Usable Symbol Tables
- Listing Jobs and Networks that Use a Symbol Table
- Determination and Activation of Necessary Symbol Tables
- Displaying and Modifying a Symbol Table
- Adding a Symbol Table Master
- Versioning of Symbol Tables
- Maintaining the Usage of Symbol Table Versions
- Saving Symbol Tables as Files
- Deleting a Symbol Table Master