Adapters > Using the Adapter for CA-IDMS/DB > Managing IDMS/DB Metadata

Managing IDMS/DB Metadata

Topics:

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.

Creating Synonyms

How to:

Reference:

x

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

  1. From the Web Console sidebar, click Applications or Connect to Data.

    The Applications page opens.

  2. If you started from the Applications page, right-click an application folder, point to New, and click Synonym on the context menu.

    The Connect to Data page opens.

  3. On the Configured list, click the down arrow next to a connection for the configured adapter, or right-click a connection.

    Depending on the type of adapter you chose, one of the following options appears on the context menu.

    • Show DBMS objects. This opens the page for selecting synonym objects and properties.
    • Create metadata objects. This opens the page for selecting synonym objects and properties.
    • Show files. This opens a file picker. After you choose a file of the correct type, the page for selecting synonym objects and properties opens.
    • Show local files. This opens a file picker. After you choose a file of the correct type, the page for selecting synonym objects and properties opens.
  4. Enter values for the parameters required by the adapter as described in the chapter for your adapter.
  5. After entering the parameter values, click the highlighted button on the ribbon.

    The button may be labeled Next, Create Synonym, Create Base Synonyms, Create Cluster Synonym, or Update Base Synonyms.

    The synonym creation process for most adapters has been consolidated so that you can enter all necessary parameters on one page. However, for some adapters such as LDAP, you must click Next buttons until you get to a page that has a Create Synonym button.

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

Note: When creating a synonym, if you choose the Validate check box (where available), the server adjusts special characters and checks for reserved words. For more information, see Validation for Special Characters and Reserved Words.

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, right-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, right-click the record name and choose Save from the pop-up menu.
Application

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 available options.

For a list of options, see Synonym Management Options.

WebFOCUS

Feedback