Reference: |
The Synonym Editor occupies the DMC workspace and displays Segment and Field View (both together and separate), Modeling View, Text View, and Access File Text View tabs.
The Segment and Field View tab shows a hierarchy of segments and columns on the left, with the attributes and values of the selected item on the right.
Note: The attributes available depend on the type of synonym.
The image below is an example of an SQL data source with a key column selected.
Note: Information about the attribute that has focus is displayed at the bottom of the attribute list. In this case, an explanation of the FIELDNAME attribute appears.
The following objects may appear on the Segment and Field View tab.
Object |
Function |
---|---|
|
Synonym General icon used to indicate synonyms, visible on top of the Segment and Field View tab. It provides information about the file name used and the application it resides in. |
|
Segment Indicates a segment in a synonym. The root or parent segment appears first in the tree. |
|
Key Column Indicates a key column. |
|
Column Indicates a general column. |
|
Virtual Column (DEFINE) Indicates a virtual or defined column. |
|
Index Column Indicates the native DBMS has an index for quick retrieval of values for this field. |
|
Filter Indicates a filter in the synonym. |
|
Compute field Indicates a computed field. |
The Segment View tab shows a hierarchy of segments on the left, with the attributes and values of the selected item on the right, as seen in the following image.
The Field View tab shows a list of objects on the left, with the attributes and values of the selected item on the right, as shown in the following image.
When you right-click a segment in the Synonym Editor, the following context menu appears in both the Segment and Field View and Segment View tabs.
The image below is an example of an SQL data source with the root segment selected.
The following options are available:
Enables you to insert one of the following:
The reference is a pointer to the source synonym. If you subsequently make changes to the source synonym, reopening the current synonym will reflect those changes.
Adds a static copy of an existing synonym to the current synonym. If you subsequently make changes to the source synonym, the current synonym will not reflect those changes.
Enables you to create and add a new synonym to the current synonym through the Create Synonym tool.
Adds a synonym that must be coded manually.
Adds a general column to the segment.
Adds a virtual or defined column to the segment.
Adds a filter to the segment.
Adds a calculated value to the file.
Adds a group column to the segment.
Variable name for access file parameter.
Provides the characteristics of the data for a segment. The following options are available:
Shows statistic values for the selected segment only.
This option is available only when viewing a lower segment(s) of a hierarchy (cluster join).
Allows you to select the columns that you would like to analyze as potential keys to the source table.
Displays sample data in the workspace for the selected segment or synonym.
Displays sample data for the selected segment joined to the parent segment.
Deletes the segment.
Enables you to rename the segment.
Opens the Join Editor so that you can specify how the selected segment is joined to the parent segment.
When you right-click a column in the Synonym Editor, the following context menu appears in both the Segment and Field View and Field View tabs.
The image below is an example of an SQL data source with a column selected.
The following options are available:
Enables you to insert one of the following:
Adds a general column to the synonym.
Adds a virtual or defined column to the synonym.
Adds a filter to the segment.
Adds a calculated value to the file.
Adds a group column to the synonym.
Variable name for access file parameter.
Displays an Impact Analysis report for the particular column in the workspace. An Impact Analysis report identifies the procedures that access a Master File or field within a Master File.
Provides the ability to see how the column was derived.
Provides the characteristics of the data for a column.
Shows statistic values for the selected segment only.
Displays sample data in the workspace.
Decomposes date fields into virtual columns representing Year, Month, Day, and Quarter fields.
Note: Decompose Date is visible for date fields.
Maps XML found in a text field (described as USAGE=TX) using a description found in an external file.
This option is used when a database column contains XML documents that are similarly formed. The Synonym Editor will take you through steps similar to those used when creating a synonym for an XML document on disk. You can create a synonym using an xsd, dtd, or XML itself.
This option creates a new segment in the synonym for the XML structure so that it can be retrieved as though the elements of the XML were additional columns in the table.
Deletes the column.
Allows you to rename the column.
The Modeling View tab shows a graphical representation of the synonym. Use the Modeling View to define dimensions for OLAP analysis, view join properties, create cluster joins, and add or edit segments.
The Text View tab shows the description of the underlying table.
You can print the synonym code by selecting Print from the File menu.
The image below is an example of an MS SQL Server data source in the Text View tab.
The Access File Text View tab shows the description of the Access File for a synonym, which is used to access the database.
Note: You can print the synonym code by selecting Print from the File menu.
The image below is an example of an SQL data source in the Access File Text View tab.
Note: The text views are read-only. You cannot edit the underlying description from these tabs. However, you can right-click a synonym from the navigation pane and select Edit as Text or Edit Access File as Text (for relational synonyms).
The Synonym Editor toolbar contains buttons that provide quick access to commonly performed functions. The behavior of the button is determined by the selected object. Therefore, certain toolbar buttons may be inactive.
Button |
Definition |
---|---|
|
Save Saves the edits made to the synonym. |
|
Save As Saves the edits made to the synonym under a different name. |
|
|
|
Insert Reference to Segment from Existing Synonym Enables you to reference a segment from an existing synonym by using the Select Synonym dialog box. |
|
Insert Copy of Segment from Existing Synonym Enables you to add segments from an existing synonym by using the Select Synonym dialog box. |
|
Insert Segment via Metadata Import Enables you to add segments through metadata import by using the Create Synonym tool. This tool creates a synonym and includes it as a segment in the synonym from which the tool was launched. |
|
Add Segment Manually Enables you to add segments manually, assigning values to segment attribute fields in the Synonym Editor. Note: You would only use this approach if you are coding a new synonym, as you would for a FOCUS data source. |
|
Add field Adds a column field. |
|
Add Define Adds a virtual column (DEFINE) field. |
|
Add Filter Adds a filter in the synonym. |
|
Add Compute Adds a COMPUTE field. |
|
Add group Adds a group. This option is available for both FOCUS and Flat Files. |
|
Add Variable Adds a variable to the synonym. |
|
Delete Selected Deletes the selected item. |
|
Sample Data Enables you to view and refresh sample data for the object. |
|
Create Business View Enables you to create a Business View and create a custom synonym that can use selected fields from the original synonym. In addition, you may customize field names, titles, and descriptions. |
iWay Software |