Modeling interface elements

Names and descriptions

Model tab

The model tab displays model elements.

  • The left side of the tab lists individual model sections (e.g. data sources and pipelines).

  • The right side of the tab (Properties panel) allows access to the model's properties.

ref_interface_1.png

Rename a model

Rename a model by clicking the model name at the top of the model tab and typing a new name in the text box.

ref_interface_2.png

Define a model description

Specify a description for a model using the text box, below the model name on the model's tab.

This description appears adjacent to the model's name when viewed in the model's folder.

Model organization

Data model nodes, displayed in Resource Explorer, contain all the sub-resources of a data model, such as pipelines and data sources. In this regard, they behave similarly to folders in the Data Hub interface.

When a data model like a folder is opened, its tab is opened in the design canvas (unlike a folder, which, when clicked, displays its contents and provides access to ribbon commands such as cut, copy, paste and rename). Instead, a right-click menu, accessed from Resource Explorer, provides easy access to these commands for data models.

Most menu items are equivalents of features on the Folder tab, except the Get Link command, which is the equivalent to the Share feature on the Home screen.

Right-click menu with options

Right-click options provide the ability to create sub-folders and move sub-resources within data models. Data model nodes hold all the sub-resources of a data model (e.g. pipelines and data sources). They behave similarly to folders in this regard. For large data models, it is useful to create a more complex structure by adding sub-folders for different sub-resource types, or for different divisions of the organization, then move the data model's sub-resources to the sub-folders.

Note

Although designed for use with data model nodes, right-click options are available with other folders and resources in Resource Explorer (e.g. charts).

Delete

Click Delete wherever displayed in the Data Hub interface, to remove items within a model.

Note

Select Folders > Rename to delete an entire model.

Delete verification

When removing subresources (pipelines and data sources) from a model, a verification dialog box appears, allowing you to verify the deleting action.

Delete subresources

When removing subresources (e.g. pipelines and data sources) from a model, if the resource has dependent resources (pipelines) or settings (relationships), the deletion verification dialog box allows you to determine exactly what will be deleted. You can choose to remove only the selected subresource or the selected subresource and all the dependent resources. This option only appears when the application detects that dependent resources or settings will be impacted by the removal of the selected subresource.

You can choose to delete the data source (Delete Selected) or the data source along with all of its pipelines and related settings (Delete & Fix option).

Each of the dependent pipelines or settings for the data source is shown in the Used By list, allowing you to easily see what items in your model will be removed.

Important

The Delete & Fix option only deletes the items listed in the verification dialog box. It does not impact any other items in your model.

This feature applies only to sub-resources of a model (data sources and pipelines).

The following resources or settings may be dependent on a pipeline or data source:

  • Warehouse pipelines

  • Source Table pipelines, if the deleted resource is a data source

  • Relationships

  • Lookups

  • Union steps

Note

If the deleted resource is a pipeline, dependent SQL-based resources, (e.g. SQL steps and warehouse SQL pipelines) are not deleted.

If you chose to not delete the dependent resources when prompted, they remain in your model, but they will display errors. You may not want to remove dependent resources if you are switching pipelines from a test data source to a production data source.

Model summary

Use the summary feature to view a condensed report (on a separate tab) containing specific data model information.

The following information is typically included in a data model summary:

  • Name and location of the model resource

  • Database name and related settings

  • List (and details) for major model components (e.g. data sources, pipelines, database scripts, parameters)

Copy a model

You can copy a model by selecting Folder > Copy when the model is selected in its folder.

When a model is copied, any existing schedules are automatically disabled. (Schedule check box is cleared in the schedule's Properties panel.) Once the model is processed manually, the schedule can be reactivated (by selecting the Schedule check box) and it will function normally.

Notes

Add notes to a column

Add custom notes to columns using the Notes property in the Properties panel.

These notes are available to allow data model designers to describe how a particular column is used in a data model, especially if that usage is not obviously clear.

ref interface 2.png

Working with list grids

Model tab lists

The left side of the model tab displays various lists, each of which shows different parts of your model (e.g. data sources, pipelines, and relationships).

The number of items in each list is displayed to the right of each list's heading (as highlighted below). This feature allows you to see if any entries are present, and how many entries, without having to expand each list.

Note

The number of items in the Relationships list is only displayed after the list has been expanded for the first time. After this initial expansion, the number remains visible even if the list is collapsed again.

Use checkboxes to the left of individual list entries to select single items. (Not all lists use checkboxes.)

In addition to selecting single items via the checkboxes, you can also click to the right of the item's name (in the Name column) to select it. The item name is not underlined when it is clicked. If it is underlined when clicked, the item itself is opened in a separate tab.

Note

The names of single items in the Name column become underlined (hyperlinks) if you hover on or near them. Clicking the name when it is underlined opens the item in a separate tab. It does not select the item.

  • Select multiple items in the list by clicking the check box for each item.

  • Select each of the listed items using the Select All option.

  • Remove the selections by clicking the Clear option (which appears after the Select All option is clicked).

Working with SQL fields

IntelliSense-style code completion

When typing an entry into an expression builder window for calculated columns and SQL steps, code completion is available. As you type, a list of possible entries appears, allowing you to select any entry that contains your typed text.

The following types of entries are included in the list:

  • Previously used entries in the current expression

  • Names of pipelines in the current model

  • Names of columns in the current pipeline

  • Parameters in the current model

  • SQL keywords

  • Placeholders that refer to the previous step's results, (@IN and @INALIAS)

These lists appear in the following two locations within the data model interface:

  • Calculated column. In the expression builder section on the Properties panel.

  • SQL step. In the SQL Statement expression builder panel.

Simple character matches are displayed (as in the example below, where the letter i has been typed).

REF INTERFACE 111.png

In addition, based on the syntax used for various entries, you can type specific characters to see a list of specific items.

  • A list of available model pipelines is displayed when a $ (dollar sign) is typed.

REF INTERFACE 12.png
  • A list of available parameters, as defined in the model tab's Parameters list, is displayed when a # (pound sign) is typed.

REF INTERFACE 13.png
  • A list of placeholders referring to the result of the previous step appears when a @ (ampersand) is typed.

  • A list of columns in the current pipeline appears when a [ (left square bracket) is typed.

  • The feature may also be operated using the keyboard:

    • If nothing has been typed into the expression builder, or space has been typed after a previous entry, pressing CTRL-SPACE will display the entry list with all possible entries available.

    • If you have moved the cursor using the arrow keys, pressing CTRL-SPACE will redisplay the entry list using the characters in the current entry to the left of the cursor as a filter.

    • If an entry list is displayed, pressing TAB twice will insert the first entry in the list.

    • If an entry list is displayed, pressing the DOWN ARROW key lets you select an item in the list. Pressing TAB or ENTER inserts the highlighted entry.