The Maintain Wdata Parameters template lets you maintain a Wdata parameter pick list by updating its values through a chain.
Tip: Parameter values are specified at run time and are used to dynamically filter query results. Pick lists enforce these values, but must be defined before running the query -- which creates challenges when those values change regularly. This template allows you to maintain those values programmatically.
Requirements
- To use this template, you must have a Workiva spreadsheet or query that contains the list of values you need to add to your parameter pick list.
- You must generate an OAuth token and store the client ID and client secret as workspace variables. Make sure the client secret workspace variable is encrypted.
- The following connectors must be configured in your workspace:
Build your template
The Maintain Wdata Parameters template is located in the Workiva Chains section of the Templates screen.
Here's how to find it:
- In Chain Builder, go to the Templates tab.
- Select Workiva Chains from the menu at the top.
- Search for Maintain Wdata Parameters at the top right and open the template.
After locating your template, configure it to for your workspace using the runtime inputs listed below.
Note: For detailed instructions on creating a chain from a template, see the Create and manage chains article.
Variables
| Variable Type | Variable Name | Variable Purpose |
| Chain | cv-Wdata Parameter Item List Limit | Stores the Wdata limits for the number of pick list items. This is created as a variable to allow for any future limit changes. |
| Workspace variable | wsv_API Base URL - IAM | Root path to the IAM API. You can find this value in our API developer documentation. |
| Workspace variable | wsv_API Base URL - Wdata | Root path to the Wdata API. You can find this value in our API developer documentation. |
| Workspace variable | wsv_Client ID | The client ID of your OAuth grant. |
| Workspace variable | wsv_Client Secret | The client secret of your OAuth grant. Make sure this variable is encrypted after entering it. |
Configure your chain
The following sections will help you identify the configurable elements of this chain and their function.
Runtime Inputs
| Runtime Input | Type | Purpose |
| Parameter Name | Text | Specifies the Wdata parameter whose values will be updated by this chain. |
| Update Type | Dropdown | Option to either add new values to the existing list or to replace all values with the values that will be added. |
| Values to Add | File | A single column file containing the values to add as rows. A header row is required in this file. This file can be created from a Workiva spreadsheet, a Wdata query, or any other source that generates a file in the required format. |
| Parameter Type | Dropdown | Options to specify if the parameter is defined globally within the workspace or locally within a query. |
| Query ID | Text | Required if the parameter type is local. This is used to look up the select list ID associated with the parameter assigned to the query. |
Sub-chains
- Maintain Wdata Parameters | Add Values: This chain is automatically deployed when you deploy the primary chain.
Note: Make sure you publish this child chain before executing the primary chain.
Configurable nodes
You can modify the fields used for messaging purposes as needed to support your business requirements:
- Primary Chain: Render Text Template - Invalid Query ID
- Primary Chain: Set Chain Result - Warn (Query not Found)
- Primary Chain: Render Text Template - Invalid Parameter
- Primary Chain: Set Chain Result - Warn (Invalid Parameter)
- Child Chain (Add Values): Render Text Template - No Parameter ID supplied
- Child Chain (Add Values): Set Chain Result - Warn (Param ID)
- Child Chain (Add Values): Render Text Template - Parameter Mode Type
- Child Chain (Add Values): Set Chain Result - Warn (Param Type)
- Child Chain (Add Values): Render Text Template - Informational: No New Items
- Child Chain (Add Values): Render Text Template - Warning: Too Many Items
- Child Chain (Add Values): Set Chain Result - Warn (Replace)
- Child Chain (Add Values): Set Chain Result - Warn (Add)
- Child Chain (Add Values): Render Text Template - Status Report