In this section: |
When the server accesses a data source, it needs to know 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 Millennium data types.
How to: Reference: |
Synonyms define unique names (or aliases) for each Millennium file 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 that represents the server's metadata.
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.
The Applications page opens.
The Select adapter to configure or Select connection to create synonym pane opens.
The first of a series of synonym creation panes opens.
The Status pane indicates that the synonym was created successfully.
The synonym is created and added under the specified application directory.
Note:
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.
COBOL FD Selection Options
Select one of the following from the drop-down list:
Depending on your selection for File System, enter the fully qualified PDS name or absolute directory path that contains the COBOL FD.
Depending on your selection for File System, enter the member name or file that contains the COBOL FD.
You can enter a string for filtering these names, inserting the wildcard character (%) as needed at the beginning and/or end of the string. For example, enter ABC% to select names which begin with the letters ABC; %ABC to select names which end with the letters ABC; %ABC% to select names which contain the letters ABC at the beginning, middle, or end.
If you selected Absolute HFS directory pathname as the file system, enter the extension of the file that contains the COBOL FD.
For each file that you want to map using a COBOL FD, check the box next to the appropriate file name. Select the check box in the table heading to select all files. You can edit the default synonym names. Enter a cluster name to associate it with a particular metadata description. The cluster name is embedded in the Master File. If you do not enter the cluster name during the synonym creation process, you will have to add it dynamically at run time.
Additional Options
Select the Validate check box if you wish to convert all special characters to underscores and perform a name check to prevent the use of reserved names. (This is accomplished by adding numbers to the names.) This parameter ensures that names adhere to specifications. See Validation for Special Characters and Reserved Words for more information.
When the Validate option is unchecked, only the following characters are converted to underscores: '-'; ' '; ' \'; '/'; ','; '$'. No checking is performed for names.
Select the Make unique check box if you wish to set the scope for field and group names to the entire synonym. This ensures that no duplicate names are used, even in different segments of the synonym. When this option is unchecked, the scope is the segment.
Optionally, select Customize COBOL FD conversion options to customize how the COBOL FD is translated. If you do not select the check box, default translation settings are applied.
For more information, see Customization Options for COBOL File Descriptions.
Select an application directory. The default value is baseapp.
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.
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.
This column displays the name that will be assigned to each synonym. To assign a different name, replace the displayed value.
Use the following steps to create a synonym for the DBVSAM01data source:
user1.dbvsam01.cluster
You should get a message indicating that the synonym was created successfully.
FILENAME=DBVSAM01, SUFFIX=CPMILL , $ DATASET=user1.dbvsam01.cluster, $ SEGMENT=SEG1, SEGTYPE=S0, $ $ GROUP=COUNTRY, ALIAS=E1, USAGE=A24, ACTUAL=A24, $ FIELDNAME=COUNTRY_CODE, ALIAS=E2, USAGE=A8, ACTUAL=A8, $ FIELDNAME=COUNTRY_NAME, ALIAS=E3, USAGE=A16, ACTUAL=A16, $
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.
Option |
Description |
---|---|
Open |
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. |
Copy |
Copies the synonym to the clipboard. |
Delete |
Deletes the synonym. You are asked to confirm this selection before the synonym is deleted. |
Cut |
Deletes the synonym and places it on the clipboard. |
Privileges |
Shows the security subjects on the server and the privileges they have to this synonym. |
Properties |
Displays the properties of the synonym, including physical location, last modified date, description, and privileges. |
You can customize how a COBOL FD is translated by selecting Customize options in the Synonym creation pane. The following options are added to the right pane:
Parameter |
Definition |
---|---|
Choose:
| |
Choose:
| |
You may treat COBOL REDEFINE fields in one of three ways. Choose:
| |
Choose Segments to describe OCCURS structures as segments. Otherwise, choose Field. Segments is the default value. | |
Choose:
| |
FD Translator removes characters from the left, up to and including the Nth hyphen (depending on the value of N chosen in the menu).
| |
Choose:
| |
Choose:
| |
Sets how zoned numeric values will be stored. | |
Numeric Field Edit Options | |
Choose:
| |
Choose:
| |
Choose:
| |
Choose:
|
For additional information about customization options, see Translating COBOL File Descriptions.
01 COUNTRY-REC. 02 G1. 03 COUNTRY_COD1 PIC X(5). 03 FILLER PIC X(3). 02 COUNTRY_NAM1 PIC X(15). 02 FILLER PIC X(1).
WebFOCUS |