Use Parameters to make Data Actions reusable by prompting Members to select values when they run the Data Action. This article explains how to create, configure, and use Parameters.
Access rights and permissions
Members must have the Import Data permission to create, edit, or use Parameters. For more information on access rights and permissions, see About Roles, Permissions, and Access Rights.
Before you begin
Parameters currently support the following capabilities:
Dimension Parameters
Single-value selection
Selective mapping in Metric-to-Metric imports
Fixed default values
Manual execution or execution from a Board using an Action widget
Support for additional Parameter types, multi-value selection, Data Flows, List-to-List filtering, Variable-based defaults, scheduling, and APIs is planned for future updates.
Create a Parameter
Parameters are managed at the Application level under Data Actions & Flows.
⚠️ Important
Parameters are configured once in an Application and can be reused across multiple Data Actions in that Application.
The Parameters overview displays all Parameters in the Application, including their names, associated Dimensions, and default values.
To access Parameters:
In your Application, select the three-dot menu from the sidebar.
Go to Data Actions & Flows, then select the Parameters tab
From the Parameters tab in your Application:
Select Create a parameter. If Parameters already exist in your Application, select + Create a parameter in the top-right corner of the Parameters tab.
In the Details section, enter a name and an optional description to indicate when Members should use the Parameter.
In the Configuration section, select the data type from the drop-down menu. Currently, only the Dimension data type is supported.
Select the Dimension from the drop-down menu, then choose the selection mode. Currently, only single-value selection is available.
(Optional) Select a default value for the Parameter from the drop-down menu. Members can change the selected value before running the Data Action.
Select Save.
The Parameter and associated configuration details appear in the Parameters tab.
⚠️ Important
Any edits to a Parameter’s details or configuration impact all Data Actions that use it.
Use Parameters with Selective mapping
Use Parameters in the Selective mapping step of a Metric-to-Metric import to replace fixed source or target Items with values selected by Members when running the Data Action. For more information, see Selective mapping.
For example, an import configuration might always import the Draft 1 Version from the source Metric into the Budget Version of the target Metric. To later import from Draft 2 instead, you would need to edit the configuration. With a Parameter, Members can select the source value, target value, or both each time each time they run the Data Action.
Add a Parameter to Selective mapping
To use a Parameter in Selective mapping:
In your Application, open the target Metric.
Select the three-dot menu, then Import data.
Select Pigment Metric, then select the source Metric from the drop-down menu.
Select Set up import.
Select + Add mapping, then select the Dimension to remap from the drop-down menu.
In the source Item or target Item field, select the Parameter symbol next to the drop-down menu to replace a fixed Item with a Parameter. Then select an existing Parameter or Create a new parameter.
Enter a name and description for the import configuration, then select Save.
After the import configuration is saved, it can be triggered manually or from a Board using an Action widget. Members are prompted to select Parameter values each time they run the Data Action.
Run Imports with Parameters from a Board
Run saved import configurations with Parameters from a Board using an Action widget. Members can run the same Data Action with different values by selecting the Action button on the Board.
To run an import from the Board using Parameters:
On the Board, select the Action button linked to the saved configuration. For example,
Update Budget.In the dialog that opens, review or update each Parameter value from the drop-down menu. If configured, the default value is pre-selected.
Select Apply.
After the Data Action runs, the Import summary displays the Parameter values used for that run.