Synonym Editor Layout

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.


Top of page

x
Reference: Synonym Editor - Segment and Field View Tab

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.

SQL data source with a key column selected example

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 button

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 button

Segment

Indicates a segment in a synonym. The root or parent segment appears first in the tree.

Key Column button

Key Column

Indicates a key column.

Column button

Column

Indicates a general column.

Virtual column

Virtual Column (DEFINE)

Indicates a virtual or defined column.

Index Column

Index Column

Indicates the native DBMS has an index for quick retrieval of values for this field.

Filter

Filter

Indicates a filter in the synonym.

Compute field

Compute field

Indicates a computed field.



x
Reference: Synonym Editor - Segment Field View Tab

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.

Segment Field View Tab


Top of page

x
Reference: Synonym Editor - Field View Tab

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.

Field View Tab


Top of page

x
Reference: Synonym Editor - Segment Context Menu

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.

Segment Context Menu

The following options are available:

Insert

Enables you to insert one of the following:

Reference to Segment From Existing Synonym

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.

Copy of Segment From Existing Synonym

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.

Segment Via Metadata Import

Enables you to create and add a new synonym to the current synonym through the Create Synonym tool.

Segment Manually

Adds a synonym that must be coded manually.

Field

Adds a general column to the segment.

Define

Adds a virtual or defined column to the segment.

Filter

Adds a filter to the segment.

Compute

Adds a calculated value to the file.

Group

Adds a group column to the segment.

Variable

Variable name for access file parameter.

Data Profiling

Provides the characteristics of the data for a segment. The following options are available:

Statistics

Shows statistic values for the selected segment only.

Statistics with parent segment

This option is available only when viewing a lower segment(s) of a hierarchy (cluster join).

Key Analysis

Allows you to select the columns that you would like to analyze as potential keys to the source table.

Values

Duplicate Values

Sample Data

Displays sample data in the workspace for the selected segment or synonym.

Sample Data with parent key

Displays sample data for the selected segment joined to the parent segment.

Delete

Deletes the segment.

Rename

Enables you to rename the segment.

Join Properties

Opens the Join Editor so that you can specify how the selected segment is joined to the parent segment.


Top of page

x
Reference: Synonym Editor - Column/Field Context Menu

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.

SQL data source with a column selected example

The following options are available:

Insert

Enables you to insert one of the following:

Field

Adds a general column to the synonym.

Define

Adds a virtual or defined column to the synonym.

Filter

Adds a filter to the segment.

Compute

Adds a calculated value to the file.

Group

Adds a group column to the synonym.

Variable

Variable name for access file parameter.

Impact Analysis

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.

Data Lineage

Provides the ability to see how the column was derived.

Data Profiling

Provides the characteristics of the data for a column.

Statistics

Shows statistic values for the selected segment only.

Patterns

Values

Outliers

Sample Data

Displays sample data in the workspace.

Decompose Date

Decomposes date fields into virtual columns representing Year, Month, Day, and Quarter fields.

Note: Decompose Date is visible for date fields.

Map External XML

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.

Delete

Deletes the column.

Rename

Allows you to rename the column.


Top of page

x
Reference: Synonym Editor - Modeling View Tab

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 Modeling View Tab


Top of page

x
Reference: Synonym Editor - Text View Tab

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.

MS SQL Server data source


Top of page

x
Reference: Synonym Editor - Access File 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.

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).


Top of page

x
Reference: Synonym Editor Toolbar

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 button

Save

Saves the edits made to the synonym.

Save as button

Save As

Saves the edits made to the synonym under a different name.

Print button

Print

Insert Reference to Segment from Existing Synonym button

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 button

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 button

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 button

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 button

Add field

Adds a column field.

Add Define button

Add Define

Adds a virtual column (DEFINE) field.

Add Filter button

Add Filter

Adds a filter in the synonym.

Add Compute button

Add Compute

Adds a COMPUTE field.

Add Group button

Add group

Adds a group. This option is available for both FOCUS and Flat Files.

Add Variable button

Add Variable

Adds a variable to the synonym.

Delete Selected button

Delete Selected

Deletes the selected item.

Sample Data button

Sample Data

Enables you to view and refresh sample data for the object.

Creates Business View button

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