The Synonym Editor occupies the DMC workspace and displays the Field View, Segment View, Modeling View, Text View, and Access File Text View tabs.
The 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 Field View tab.
Object |
Function |
Description |
---|---|---|
|
Synonym |
General icon used to indicate synonyms, visible on top of the 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. |
|
Unique Segment (FOCUS/FDS and XFOCUS only) |
Indicates a unique segment in a FOCUS/FDS or XFOCUS synonym. |
Virtual Segment (Cross-Referenced) |
Indicates a virtual or cross-referenced segment. Note: This type of segment is applicable for FOCUS data sources. |
|
|
Key Column |
Indicates a key column. |
|
Column |
Indicates a general column. |
|
Virtual Column (DEFINE) |
Indicates a virtual or defined column. |
|
Index Column |
For FOCUS files, indicates the field index for quick retrieval of values for this field. |
|
Filter |
Indicates a filter in the synonym. |
|
Compute |
Indicates a computed field. |
|
Internal field |
Indicates a column that does not appear in sample data or in the list of available columns. |
|
Needs Value field |
Indicates a column that requires a value to access the data. |
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 List 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 shortcut menu shown in the following image appears in both the Field View and Segment View tabs. This image shows a SQL data source with the root segment selected.
The following options are available:
Opens a pane showing the properties of the selected segment.
Enables you to insert one of the following:
The reference is a pointer to the source synonym using the synonym as a child. If you subsequently make changes to the source synonym, reopening the current synonym will reflect those changes.
The reference is a pointer to the source synonym using the synonym as a root. If you subsequently make changes to the source synonym, reopening the current synonym will reflect those changes.
Enables you to create and add a new synonym to the current synonym using 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 Sort Objects folder and a sort object. This option is available only if the Support extended options option is selected and is not used with DataMigrator.
Adds a Variables folder and a variable to the segment.
Adds a Styles folder and a style object. This option is available only if the Support extended options option is selected and is not used with DataMigrator.
Adds a subquery to the fields list.
Adds an Index folder and an index.
Provides the characteristics of the data for a segment. The following options are available:
Shows statistic values for the selected segment only.
Shows a count of the number of rows in the selected source table. For a multi-segment synonym, it shows the count for each segment.
This option is available only when viewing a lower segment of a hierarchy (cluster join).
Allows you to select the columns that you would like to analyze as potential keys to the source table.
Shows unique values and their percentages.
Shows identical values and their percentages.
Displays sample data in the workspace for the selected segment or synonym.
Displays sample data for the selected segment joined to the parent segment. This option is only available when a child segment is selected in a multi-segment synonym.
Deletes the segment.
Allows you to rename the segment.
Allows you to edit adapter specific properties, such as the delimiter value in a delimited flat file.
Allows you to assign columns to a SCD type by using drag-and-drop.
Opens the Join Editor so that you can specify how the selected segment is joined to the parent segment. This option is only available when a child segment is selected in a multi-segment synonym.
When you right-click a column in the Synonym Editor, a shortcut menu appears in both the Field View and List View tabs. The following image shows a SQL data source with a column selected.
Note: If you multi-select columns and right-click them, an abridged version of the shortcut menu opens.
The following options are available:
Opens a pane showing the properties of the selected column.
Displays a shortcut menu with a list of available function that can be added to the synonym. Selecting one of the functions opens the Function Assist dialog box, which allows you to specify parameters for that function.
Adds a general column to the synonym.
Inserts a Date/Time function.
Adds a filter to the segment.
Opens the Group values for dialog box, where you can configure group values.
Provides a choice of preconfigured aggregation functions that open in the Function Assist dialog box. The selected functions will be saved in the Constant Defines/Computes folder for the synonym.
Provides a choice of preconfigured analytic functions that open in the Function Assist dialog box. The selected functions will be saved in the Constant Defines/Computes folder for the synonym.
Adds a Sort Objects folder and a sort object.
Adds a Variables folder, if needed, and a variable.
Adds a Styles folder and a style object.
Adds a subquery to the fields list.
The following option is available:
Allows you to turn (or pivot) columns into rows or a single column into multiple columns, for retrieval.
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.
Shows statistic values for the selected segment only.
Allows you to select the columns that you would like to analyze as potential keys to the source table.
Shows hexadecimal value of the selected field.
Shows a values report for the selected column.
Displays a graph for both alpha and numeric field types.
Displays a pie graph.
Shows identical values and their percentages.
Shows outlier report for the selected column.
Displays sample data in the workspace.
Deletes the column.
Allows you to rename the column.
The Modeling View tab shows a graphical representation of the synonym, as shown in the following image. 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 syntax by selecting Print from the Application 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 syntax by selecting Print from the Application menu.
The image below is an example of an SQL data source in the Access File Text View tab.
Note: While you can edit the text views, it is highly recommended that you do so with care. Editing the synonym incorrectly can invalidate the synonym.
The Metadata tab in the ribbon contains groups and commands that provide quick access to commonly performed functions while working in the Synonym Editor. The behavior of the command is determined by the selected object. Therefore, certain tab commands may be inactive.
The Metadata tab contains the following additional groups:
Switches to the Field View in the workspace.
Switches to the Segment View in the workspace.
Switches to the List View in the workspace.
Switches to the Modeling View in the workspace.
Switches to the Text View in the workspace.
Switches to the Access File Text View in the workspace.
Opens the Aerial View window. This view is only available when in the Modeling View tab.
The Insert command allows you to insert one of the following:
Enables you to view and refresh sample data for the object.
Provides the data characteristics for synonym columns. The following options are available:
Runs the impact analysis report for the selected column.
Displays the Properties panel for the selected object.
This option is only available when the synonym name (root) is selected. For more information, see Creating a Quick Copy.
Adds field/value security DBA.
Enables you to create a Business View and a custom Master File that can use selected fields from the original synonym. In addition, you can customize field names, titles, and descriptions.
WebFOCUS | |
Feedback |