Managing IDMS/DB Metadata

In this section:

When the server accesses a data source, it needs information on how to interpret the data stored there. For each data source the server will access, you create a synonym that describes the structure of the data source and the server mapping of the IDMS/DB data types.

Top of page

Creating Synonyms

How to:



Synonyms define unique names (or aliases) for each IDMS/DB file that is accessible from a server. Synonyms are useful because they hide location information and the identity of the underlying data source from client applications. They also provide support for extended metadata features of the server, such as virtual fields and additional security mechanisms.

For the Adapter for IDMS/DB to access IDMS/DB files, you must describe each IDMS/DB file you use in a Master File and Access File. The logical description of an IDMS/DB file is stored in a Master File, which describes the field layout.

Using synonyms allows an object to be moved or renamed while allowing client applications to continue functioning without modification. The only modification required is a redefinition of the synonym on the server. The result of creating a synonym is a Master File and Access File.

Procedure: How to Create a Synonym

To create a synonym, you must have previously configured the adapter. You can create a synonym from the Applications or Adapters pages of the Web Console.

  1. From the Web Console menu bar, click Applications.

    The Applications page opens.

  2. Click the New button and select Synonym from the drop-down menu.

    The Select adapter to configure or Select connection to create synonym pane opens.

  3. Click a connection for the configured adapter.

    The first of a series of synonym creation panes opens.

  4. Enter values for the parameters required by the adapter as described in the synonym creation parameters reference.
  5. After entering the parameter values, click Create Synonym.

    The Status pane indicates that the synonym was created successfully.

The synonym is created and added under the specified application directory.


Reference: Synonym Creation Parameters for IDMS/DB

The following list describes the parameters for which you will need to supply values, and related tasks you will need to complete in order to create a synonym for the adapter. These options may appear on multiple panes. To advance from pane to pane, click the buttons provided, ending with the Create Synonym button, which generates the synonym based on your entries.

Dictionary Name

Type a data dictionary name.

Database Name

Type a database name.

Subschema Name

From the drop-down list of subschemas, select a subschema.

Select Root Record Name and Child Records
  1. Choose the first record of the selected subschema to be described and click Add. This record will be the root segment in the generated Master File.

    Note: If a field name contains dashes (-) as part of the name, they are converted to underscores (_) in the generated Master File.

    It is recommended that the root record-type have a set relationship with a CALC or index field.

  2. If you want to add additional levels of records to this structure, click the record name and then choose Add Child from the pop-up menu. Records that have no available children display a red diamond next to the record name. Those with available children display a stack of green squares.

    A list of available child segments is displayed. Check each record that you want to be a child of the previous record. To select all of the listed records, check the Record Name check box.

  3. When you have selected the child records you want to add to the structure, click Add. You can repeat this process of selecting children and creating additional levels in the structure until no children are available.
  4. When you are finished selecting children, click the disk icon at the top of the window.

Select an application directory. The default value is baseapp.

Overwrite Existing Synonyms

To specify that this synonym should overwrite any earlier synonym with the same fully qualified name, select the Overwrite existing synonyms check box.

Note: The connected user must have operating system write privileges in order to recreate a synonym.

Synonym Name

If necessary, edit the default name for the synonym that will be created.

Reference: Managing Synonyms

Once you have created a synonym, you can right-click the synonym name in the Adapter navigation pane of either the Web Console or the Data Management Console to access the following options.




Opens the Master File for viewing and editing using a graphical interface. If an Access file is used it will be also available.

Edit as Text

Enables you to view and manually edit the Master File synonym.

Note: To update the synonym, it is strongly recommended that you use the graphical interface provided by the Open option, rather than manually editing the Master File.

Edit Access File as Text

Enables you to view and manually edit the Access File synonym.

Note: This option is available only when an Access File is created as part of the synonym.

Sample Data

Retrieves up to 20 rows from the associated data source.

Data Profiling

Data Profiling provides the data characteristics for synonym columns.

Alphanumeric columns provide the count of distinct values, total count, maximum, minimum, average length, and number of nulls.

Numeric columns provide the count of distinct values, total count, maximum, minimum, average value, and number of nulls.

Refresh Synonym (if applicable)

Regenerates the synonym. Use this option if the underlying object has been altered.

Data Management

Followed by these options, if applicable:

Recreate DBMS Table. Recreates the data source table. You are asked to confirm this selection before the table is regenerated. (Note that the table will be dropped and recreated. During the process, data may be lost.)

Delete All Data. Deletes all existing data. You are asked to confirm this selection before the data is deleted.

Drop Table. Drops the table so that it is removed from the DBMS.

Insert Sample Data. Inserts specified number of sample records, populating all fields with counter values.

Show/Modify Data. Opens a window that shows the data in the data source with buttons you can click to insert values, filter values, reload the data source, and customize the view.

Reorganize. Recreates the data source table preserving original data.

Note: This option is not available in the Web Console.

Impact Analysis

Generates a report showing where this synonym is stored and used, with links to the synonym instances. Impact Analysis reports enable you to evaluate changes before they are made by showing which components will be affected. See the Server Administration manual for details about Impact Analysis reports.

Dependencies Analysis

Generates a report showing information about the synonym and other synonyms and objects that are referenced within it.


Copies the synonym to the clipboard.


Deletes the synonym. You are asked to confirm this selection before the synonym is deleted.


Deletes the synonym and places it on the clipboard.


Shows the security subjects on the server and the privileges they have to this synonym.


Displays the properties of the synonym, including physical location, last modified date, description, and privileges.