Managing Model 204 Metadata

Creating Synonyms

How to:

Create a Synonym

Reference:

Synonym Creation Parameters for Model 204
Managing Synonyms

Synonyms define unique names (or aliases) for each Model 204 table or view that is accessible from the server. Synonyms are useful because they hide the underlying data source 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 metadata.

Procedure: How to Create a Synonym

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

The Applications page opens.
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.
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.
Enter values for the parameters required by the adapter as described in the chapter for your adapter.
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 Model 204

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.

File name

Is the Model 204 file name.

File password

Is the associated password for the file. This entry is optional.

Rectype name

Is a valid Model 204 field with the name RECTYPE. This entry is optional.

Rectype value

Is a valid value of the Model 204 field with the name RECTYPE. This entry is optional.

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.

Example: Creating a Synonym

To generate a synonym for the VEHICLES data source, enter the following information on the Create Synonym panes of the Web Console or the Data Management Console:

On the first Create Synonym pane, enter VEHICLES in the File Name field and WHEELS in the File Password field.
Enter m204veh as the Synonym name.
Select m204 from the Application list.
Click Create Synonym. The synonym is created and added under the specified application directory (baseapp is the default).
The Create Synonym Status pane indicates that the synonym was created successfully. Click Applications on the menu bar.
Open the baseapp application folder in the navigation pane and click the synonym m204.
Choose Edit as Text from the menu to view (and edit) the generated Master File and Access File.

Generated Master File:

FILENAME=M204VEH, SUFFIX=M204INX , $
  SEGMENT=VEHICLES, SEGTYPE=S0, $
    FIELDNAME=BODY, ALIAS=BODY, USAGE=A4, ACTUAL=A4, $
    FIELDNAME=COLLISION_PREMIUM, ALIAS='COLLISION PREMIUM', USAGE=I9, ACTUAL=A9, $
    FIELDNAME=COLOR, ALIAS=COLOR, USAGE=A255, ACTUAL=A255, $
    FIELDNAME=DEDUCTIBLE, ALIAS=DEDUCTIBLE, USAGE=I9, ACTUAL=A3, $
    FIELDNAME=GARAGING_LOCATION, ALIAS='GARAGING LOCATION', USAGE=A4, ACTUAL=A4, $
    FIELDNAME=LIABILITY_LIMIT, ALIAS='LIABILITY LIMIT', USAGE=I9, ACTUAL=A3, $
    FIELDNAME=LIABILITY_PREMIUM, ALIAS='LIABILITY PREMIUM', USAGE=I9, ACTUAL=A9, $
    FIELDNAME=MAKE, ALIAS=MAKE, USAGE=A255, ACTUAL=A255, $
    FIELDNAME=MODEL, ALIAS=MODEL, USAGE=A255, ACTUAL=A255, $
    FIELDNAME=OTHER_DRIVER, ALIAS='OTHER DRIVER', USAGE=A255, ACTUAL=A255, $
    FIELDNAME=OWNER_POLICY, ALIAS='OWNER POLICY', USAGE=A6, ACTUAL=A6, $
    FIELDNAME=PRINCIPAL_DRIVER, ALIAS='PRINCIPAL DRIVER', USAGE=I9, ACTUAL=A9, $
    FIELDNAME=SURCHARGE%, ALIAS=SURCHARGE%, USAGE=A255, ACTUAL=A255, $
    FIELDNAME=TRANS, ALIAS=TRANS, USAGE=A2, ACTUAL=A2, $
    FIELDNAME=USAGE, ALIAS=USAGE, USAGE=A255, ACTUAL=A255, $
    FIELDNAME=VEHICLE_PREMIUM, ALIAS='VEHICLE PREMIUM', USAGE=I9, ACTUAL=A9, $
    FIELDNAME=VEHICLE_RATING, ALIAS='VEHICLE RATING', USAGE=A1, ACTUAL=A1, $
    FIELDNAME=VEHICLE_USE_CLASS, ALIAS='VEHICLE USE CLASS', USAGE=A2, ACTUAL=A2, $
    FIELDNAME=VIN, ALIAS=VIN, USAGE=A10, ACTUAL=A10, $
    FIELDNAME=YEAR, ALIAS=YEAR, USAGE=A255, ACTUAL=A255, $

Generated Access File:

 SEGNAM=VEHICLES, CONNECTION=M204, FILE=VEHICLES, PASS=WHEELS, $
  FIELD=BODY, TYPE=ORA, $
  FIELD=COLLISION_PREMIUM, TYPE=ORN, $
  FIELD=COLOR, TYPE=ORA, $
  FIELD=DEDUCTIBLE, TYPE=ORN, $
  FIELD=GARAGING_LOCATION, TYPE=ORA, $
  FIELD=LIABILITY_LIMIT, TYPE=ORN, $
  FIELD=LIABILITY_PREMIUM, TYPE=ORN, $
  FIELD=MAKE, TYPE=ORA, $
  FIELD=MODEL, TYPE=ORA, $
  FIELD=OTHER_DRIVER, TYPE=KEY, $
  FIELD=OWNER_POLICY, TYPE=ORA, $
  FIELD=PRINCIPAL_DRIVER, TYPE=ORN, $
  FIELD=TRANS, TYPE=ORA, $
  FIELD=USAGE, TYPE=ORA, $
  FIELD=VEHICLE_PREMIUM, TYPE=ORN, $
  FIELD=VEHICLE_RATING, TYPE=ORA, $
  FIELD=VEHICLE_USE_CLASS, TYPE=ORA, $
  FIELD=VIN, TYPE=ORA, $

M204 fields may have KEY and ORDERED attributes at the same time. In such cases, the field in the Access File has TYPE=KEY(IVK for invisible field) and a comment with information about another possible TYPE:

 SEGNAM=RNG, CONNECTION=M204, FILE=RNG, $
  FIELD=FKEY, TYPE=KEY, ATTRIBUTE=FRV, $
  FIELD=FORC, TYPE=KEY, $
$  Field has KEY and ORC attributes. KEY is chosen.      $
  FIELD=FORN, TYPE=KEY, $
$  Field has KEY and ORN attributes. KEY is chosen.      $
  FIELD=FRNG, TYPE=RNG, $

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