Variable Definitions and Metadata

The Variable Definitions interface shows all of the defined variables and properties for Dataflow. Properties are not listed separately, they have the Category type 'Property'.

You can modify existing variable and property definitions here, but not create new variables (this can be done in the Variables management screen in the Dataflow Configuration workspace; see Variables management).

You can also add extra 'metadata' columns to store information about variables.

To access the Variable Definitions interface, click the CONFIGURATION  button at the top left and select Variable Definitions.

Note: Access to the Variable Definitions screen is available in read-only mode to all users that have access to the Manage Data workspace. The role 'Dataflow/Document Templates and Variables' is required to add or modify metadata columns, and to modify any content for the variable definitions and metadata (see Roles).

Variables display

The default columns shown are 'ID', 'Name', 'Data Type', 'Category', and 'Prompt'. The displayed columns can be modified using the Options button (see below). Any added metadata columns appear to the right of the default columns, and non-default columns will appear to the right of the metadata columns (but you can change the column ordering by dragging column headers).

Each column in the table has two buttons in the column header which can be used to filter the variables and information that are displayed.

  • Filter button filter button: Use this to filter by search string, or by cell contents
  • Options button overflow menu button (this button is only visible when the mouse is hovering over the column header): Use Choose Columns to hide/show table columns

You can drag a column header to change the column ordering in the display.

Edit variable definitions

You can edit variable data directly in the table grid. Double-click in a cell to edit the cell's value. The changed value appears in italic font to indicate an un-saved edit.

You can also perform spreadsheet-style editing on the data: copy-and-paste of single and multiple cells, fill down, cell drag down, and the use of keyboard shortcuts for selection and editing. You can copy and paste both to and from external applications (such as spreadsheet apps). Note for copying cells to paste to an external application: use the Copy Headers to Clipboard check box (at top left) to include column headers in the copied data.

Click the Save button to save the changes that you have made. Click the Refresh button Refresh Grid button to discard any unsaved changes.

Add a metadata column

Click the 'Cog' button at the top-right. A blade appears at the right to show currently-defined metadata columns (with 'Name' and 'Data Type').

Click + Add Text Column or + Add Date Column to add a new column.

Rename a metadata column

Click the 'Cog' button to open the column edit blade and click the 'Pen' icon for the column to be renamed. Type a new name in the Rename Column dialog.

Delete a metadata column

Click the 'Cog' button to open the column edit blade and click the 'Bin' icon for the column to be deleted.