Managing DATACOM 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 DATACOM data types.

For the Adapter for DATACOM to access DATACOM files, you must describe each file you use in a Master and Access File. The logical description of an DATACOM file is stored in a Master File, which describes the field layout. The physical attributes of the DATACOM file, such as the database number and security are stored in the Access File.

Creating Synonyms

How to:

Reference:

x

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

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, which represent the server's metadata.

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.
    • Show topics. This opens the page for selecting synonym objects and properties for topics within the Kafka environment.
  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 DATACOM

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.

Filter Data Base Name

The first Create Synonym pane displays the connection name, user table, and data dictionary ID that were supplied during configuration. To see all related databases, simply click Next.

If you wish to filter the list of available databases, click the Filter Data Base check box. A Name input box is added to the pane.

Type a string for filtering the list of databases, inserting the wildcard character (%) as needed at the beginning and/or end of the string, then click Next.

For example, enter: ABC% to select all databases whose names begin with the letters ABC; %ABC to select databases whose names end with the letters ABC; %ABC% to select databases whose names contain the letters ABC at the beginning, middle, or end.

Data Base Name

On the second Create Synonym pane, select a database from the drop-down list and click Next.

Filter Table Name

If you wish to filter the list of available tables, click the Filter Table Name check box. A Name input box is added to the pane.

Type a string for filtering the list of tables, inserting the wildcard character (%) as needed at the beginning and/or end of the string, then click Next.

Table Name

On the third Create Synonym pane, select a table in the selected database from the drop-down list and click Next.

URT or Connection

On the final Create Synonym pane, indicate whether you want to generate the synonym with a user requirements table (URT) or a connection name. The generated Access Files attributes depend on the method you choose here. (For an illustration of the differences, see Access Files Generated by URT and Connection.)

If you choose URT, enter the name of a user requirements table. This table defines the database and files that a user can access.

Note that this entry is not required for creating a synonym, however, data cannot be accessed without it. For more information about the user requirements table, see Controlling Data Access With a User Requirements Table.

If you choose Connection, enter the name of the connection that defines the URT and Database ID for accessing Datacom data.

Synonym name

Displays the name that will be assigned to the synonyms. To assign a different name, replace the displayed value.

Application

Select an application directory. The default value is baseapp.

Prefix/Suffix

If you have tables with identical table names, assign a prefix or a suffix to distinguish them. For example, if you have identically named human resources and payroll tables, assign the prefix HR to distinguish the synonyms for the human resources tables. Note that the resulting synonym name cannot exceed 64 characters.

If all tables and views have unique names, leave the prefix and suffix fields blank.

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.

Select elements

An element is the smallest unit of data. An element contains fields that can belong to more than one element.

  • To select all elements in the list, select the check box to the left of the Element Name column heading.
  • To select specific elements, select the corresponding check boxes.

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