Adding Virtual Columns (DEFINE) in a Synonym

How to:

You can create transformations in a synonym by adding a virtual column, also known as a DEFINE. This creates a transformation that appears with the data source list of columns.

A virtual column in the synonym is useful in the following situations:

A virtual column in the synonym can also be used in the following situations, as an alternative to using a source transformation:

It is often useful to prototype the transformations with a limited number of rows, and then place them in the source definition after analyzing your performance.

Note: If you have a data flow that uses the synonym in which you are creating a virtual column, you should right-click the synonym's application directory and select Refresh to use the new column.

A virtual column can contain an expression, a constant, or a column name.

After creating a virtual column, you can test it by right-clicking the synonym and selecting Sample Data. Sample data appears in a separate dialog box.


Top of page

x
Procedure: How to Create a Virtual Column in a Synonym
To create a virtual column in a synonym:
  1. From an application directory in the navigation pane, double-click a synonym, or right-click it and click Open.

    The Synonym Editor opens.

  2. Right-click a segment (or column), select Insert, and then click Define.

    The Define Calculator opens, as shown in the following image.

    Define Calculator

  3. From the Define Calculator, type a name for the column in the Name input field, or use the default define name.
  4. You may enter a descriptive title for the virtual column (DEFINE) in the Title input field.

    Tip: From the Synonym Editor, click the browse (...) button at the right of the TITLE and DESCRIPTION value fields to specify multiple language titles.

  5. Use the Expression tab and the calculator buttons to build the expression for the virtual column (DEFINE).

    or

    Use the Relational Expression tab to build the expression.

    1. From the Relational Expression tab, use the drop-down lists to select the filter Column, Relation, and Type.

      Note: Parameters are not supported.

    2. Click the browse (...) button at the right of the Value input field.

      The Value Selection dialog box opens.

    3. Select from the available values and use the arrows to add or remove values.
    4. Click OK to close the Value Selection dialog box and return to the Relational Expression tab.

      The expression is added to the value field.

    5. To add another filter, double-click a column or variable from the Columns/Variables tab on the right side of the Virtual Column Calculator. The filter is added to the Relational Expression tab, where you can add the expression value.
    6. To delete an expression, click in the row number column of the expression that you are deleting, right-click, and select Delete selected row(s). The expression is removed from the Relational Expression tab.
  6. You may select the Check Expression and Sample Data buttons, located on the top right of the Virtual Column Calculator, to verify that the expression is valid and to view sample data for the filter.
  7. Click OK to close the Define Calculator and return to the Synonym Editor.

    Note: To edit the Define, Title, or Expression, you may do so directly from the Synonym Editor, or you may click the browse (...) button at the right of the EXPRESSION value field to relaunch the Define Calculator.

  8. If no columns from the synonym are used in the expression or have been defined, you can use the WITH option to identify the logical home of the defined calculation. You can also use the WITH option to move the logical home for the virtual column to a lower segment than it would otherwise be assigned (for example, to count instances in a lower segment).

    Tip: You can click and drag the DEFINE field and move it to a different segment in the Tree View tab, which also changes the segment association.

  9. Specify the Missing Data options for columns that allow null data. You can allow all missing data.
  10. Click Save from the Quick Access Toolbar to save the synonym.
  11. To close the Synonym Editor, click the control button in the upper-right corner.

iWay Software