Skip to main content

Celonis Product Documentation

Parameters

Parameters help you to reuse certain elements in multiple places and they also function as a central repository for items which can be modified in Data Jobs. They are two types of parameters:

  • Data Pool parameters: they are stored on a Data Pool level and they can be used in all tasks of the pool. They are accessible through the main menu item "Data Pool Parameters".

  • Task parameters: every task (so extraction or transformation) can have one or multiple parameters of different types. They can either have a literal value or they can reference a Data Pool parameter of the same data type.

Creating and Modifying Parameters

The following screenshots show task parameters only. Data Pool parameters almost work the same way. It is indicated if that is not the case.

12321423.png
  1. Task parameters are accessible by clicking on the parameter tab in either extractions or transformations.

  2. The table shows you the key information for each parameter.

  3. You can create a new parameter by clicking on the "new parameter" button. This opens a configuration modal.

  4. By clicking either on the row or the "open" entry in the context menu of a parameter you can open its configuration. (see below)

  5. After a confirmation dialog a parameter can be deleted. There is a difference between Data Pool and task parameters here:

    1. Data Pool parameters can only be deleted if they are not used by any task parameter. If they are still in use, you will see a list of these instances when you try to delete the parameter.

    2. If task parameters are deleted, you need to make sure yourself that all instances where they are used are replaced with either another parameter or a value. If you leave the placeholders of a deleted parameter in the task configuration, the Data Job will fail.

12321424.png
  1. The placeholder is the technical name of the parameter. Whenever you would like to use the parameter, you need to use the syntax <%= placeholder %>. The placeholder has to be unique among the parameters of the task and it cannot contain any spaces or special characters.

  2. The name of the parameter is the "pretty" name of the parameter which can contain spaces and special characters.

  3. Use the description to specify how the parameter is and should be used.

  4. The type of the parameter defines who can see it and whether it is static or dynamic:

    1. private (static): Only admins of the data pool can see and edit this parameter (default)

    2. public (static): Admins of the data pool can see and edit this parameter and meanwhile installing a process connector from the Marketplace the parameter can be edited.

    3. dynamic: Only visible to admins of the data pool and it is dynamically generated from the existing data. Three additional fields: table, column and operation type define how the parameter value is calculated. For pool parameters also the data connection, on which the table is stored, has to be selected. The following three operation types are possible:

      1. FIND_MAX: The parameter will be set to the maximum value of the specified column of the specified table.

      2. FIND_MIN: The parameter will be set to the minimum value of the specified column of the specified table.

      3. LIST: The parameter will be set to a list of the distinct values of the specified column of the specified table.

  5. The data type of a parameter can be one of the following. The list types always consist of at least one element. In the usage section below you find a description on how they are replaced when used.

    1. date

    2. double (a real floating-point type)

    3. integer

    4. text

    5. double list

    6. integer list

    7. text list

  6. The value of the parameter can either be entered in this window or if it is a task parameter you can reference a Data Pool parameter. Please note that the drop down will only show Data Pool parameters of the same data type. This means that if you select double as data type you will only see double Data Pool parameters in the drop down. So if it is empty this does not mean that no Data Pool parameter exists.

Using parameters

Data Pool parameters can only be used by referencing them in a task parameter. Task parameters can then be used directly in extractions and transformations. You can use a parameter by employing the following syntax:

<%= placeholder %>

The spaces before and after the placeholder term are optional.

This placeholder will then be replaced by the parameter value. For a non-list data type, the value is pasted in as is. For lists the placeholder is replaced by brackets and commas. For a text lists single quotes are used around the entries.

Note regarding text parameters

Please note that parameters with the data type "text" will be replaced with the text value without added quotes. Text lists however are replaced with single quotes, commas and brackets (see example section below).

Examples

param1 of data type "integer list" with the values 1,2 and 3.

(1, 2, 3) -- replacement value of <%= param1 %>
Table1.IntegerColumn IN <%= param1 %> -- usage of the parameter with an INT column and the operator IN

param2 of data type "text list" with the values val1, val2 and val3.

('val1', 'val2', 'val3') -- replacement value of <%= param2 %>
Table1.StringColumn IN <%= param2 %> -- usage of the parameter with a (N)VARCHAR column and the operator IN