Model parameters

Overview

Parameters can be added to a model or an individual data source. Once defined, they can then be used in SQL expressions when creating calculated columns in pipelines.

Parameters act as constants in your calculated columns, allowing you to insert specific values in the columns, as defined within the parameters themselves. A parameter's value can then be easily changed using the Parameters list, with the change being automatically propagated to all calculated columns that use the parameter.

Parameters are designed to compliment data source-specific parameters, such as those currently available via a CRM data source (viewable on the PARAMETERS tab when a CRM data source tab is open).

Note

Parameters added to individual data sources can only be used in pipelines that originate from that data source.

TimeZone parameter

The TimeZone parameter is a standard SQL value for time zones. It is used, along with the current UTC time and Time zone model property, to create a calculation to determine the correct local time when new data relationships are added (via the Add date relationship right-click option that is accessed from DateTime-type columns).

View and edit parameters

Parameters are viewed in one of the following two areas:

  • In the Parameters list on the model screen.

ref para 1 mod_parameter_view_paralist.png

  • On the Parameters tab for an individual data source (a CRM data source is shown in the example below).

ref para 2 mod_parameter_view_datasource.png

You can edit values for custom parameters directly in either parameter table.

Note

The TimeZone parameter, which appears by default in the model screen Parameters list, cannot be edited. However, you can change the current selection using the Time zone setting on the model's Properties panel.

Add parameters

You can add parameters to two different locations within a model, depending on the desired scope of the parameter:

  • Data source. Parameters added to individual data sources can only be used in pipelines that originate from that data source.

  • Model Parameters list. Parameters added to this list are model-wide and can be used in any pipeline in the model.

Use parameters in a pipeline

Once defined, you can add parameters to a calculated column in a pipeline.

  1. Open or create a calculated column in a pipeline.

  2. On the CALCULATION tab on the Properties pane, insert the parameter, using the following syntax: #parameter_name#

    Important

    Parameter names are case-sensitive.

    The parameter value will then appear in the Profile area of the Properties pane, as well as in each row of the calculated column (as displayed in the Preview pane). Parameters may also be added to the Value column of a condition in a pipeline Filter list.

Deleting parameters

You can delete a parameter by right-clicking it in the Parameters list (on the model tab), and selecting Delete.

Important

You cannot delete the TimeZone parameter.

In this section: