Workiva Support Center

With parameters, you can set the values for a query's filters or calculations each time it runs. To enable consistency across queries, workspace owners can set up parameters for common values from Configuration. For example, you can share parameters for Current Fiscal Year, Entity, or Region with multiple queries.

With these shared parameters:

• Collaborators can use common parameters with set values in addition to adding custom parameters specific to their query.
• Admins can lock a parameter to a specific value for all instances—such as to set Current Fiscal Year—to ensure consistent analysis.

Configure a parameter

To enable consistency across queries, configure a parameter for a common value.

Step 1. Create the parameter

1. From Configuration , select the Parameters tab, and click Create .
   

2. Enter the parameter's name, and click Create.

   Note: The parameter's name can include alphanumeric characters and underscores, but no spaces or other special characters.

Step 2. Set up the parameter's details

1. From the Details panel, select the data type of the parameter's values, such as Text or Integer.

2. To provide a set list of options to choose from when a query runs, enable Pick List, and enter each option on its own line.

   Note: For a date or timestamp filter, enter each option in the YYYY-MM-dd format.

3. Enter or select the parameter's default value.
4. To prevent collaborators from using a value other than the default, select Locked.
5. Click Apply.

Edit a parameter's details

To edit a parameter's details, such as to adjust its pick list or lock its value: 

1. From Configuration , select the parameter on the Parameters tab.
2. From the Details panel, edit the parameter's name, data type, or values as necessary. 
3. To prevent collaborators from using a value other than the default, select Locked. 
4. Click Apply. 

When editing the parameter's details, any changes are applied when its queries next run or refresh.

                                                                              Warning

Any major update to an active parameter—such as changing the SQL name, selecting a new data type, or switching a field type to the "multi-select" option—will break existing queries and result in a failed connection.

For this reason, we recommend removing the global parameter from any dependent queries prior to making a change. You will otherwise need to individually edit each query in SQL mode to account for the altered parameter.

Delete a parameter

To remove a parameter from Configuration , select it on the Parameters tab, and click Delete .