The Chains Module Information template retrieves the details of the chains module in your current workspace and writes it to a spreadsheet. It's commonly used when documenting and validating workspace or environment variables across the entirety of your workspace.
Requirements
- The Create Sheet and Spreadsheet chain must also be published in your workspace.
- The following connectors must be configured in your workspace:
Note: Some variable values may contain sensitive information such as usernames and passwords. We recommend using the "Encrypt" option for information-sensitive variables and setting the appropriate permissions for your spreadsheet.
Build your chain
The Chains Module Information 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 screen.
- Select Workiva Chains from the menu at the top.
- Search for Chains Module Information at the top right and open the template.
After locating your template, configure it to for your workspace using the variables and runtime inputs listed below.
Note: For detailed instructions on creating a chain from a template, see the Create and manage chains article.
Variables
| Type | Name | Purpose |
| Dynamic Chain Variable | dv-counter |
Counts the number of environments in the workspace and controls how many sheets are required in the created spreadsheet. |
Runtime inputs
| Input Type | Name | Purpose |
| Open Text Field | SpreadsheetName | Inputs the name of the spreadsheet that will be created (if one does not already exist). |
| Group Field | Do-You-Want-To-Create-InfoSheets-For | Group field with the inputs below. |
| Check box within Group Field | Workspace-Info | Creates the Workspace Info sheet that contains the variables created at the workspace level and corresponding values. |
| Check box within Group Field | Environment-Info |
Creates the Environment Info sheet that contains the names of the workspace environments and their variable values. Note: The environment variables can not be created; they can only be overridden at the environment level. |
| Check box within Group Field | Chains-Info | Creates the Chains Info sheet and corresponding sub sheets for each environment. Each sub sheet contains the list of chains and related information for each environment. |
Outputs
The Chains Module Information output is divided into three categories:
-
Workspace: This includes all workspace variables and their values.
-
Environment: This includes all workspace variables and their value at each environment level -- regardless of whether it's a default or override value.
-
Chains: This includes a list of chains in each environment and each chain's ID, description, and URL.