The Get Chain GUID template allows you to automatically retrieve the ID for a specific chain based on its name in that chain environment. The ID can then be used to execute subsequent processes, such as running a chain through the Workiva API or retrieving the chain's run history.
Note: A chain GUID can also be manually retrieved from the Chains screen in Chain Builder.
Requirements
- The Get Chain GUID template must be executed in the same environment as the target chain.
- The following connectors must be configured in your workspace:
Build your template
The Get Chain GUID 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 Get Chain GUID 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.
Runtime inputs
| Runtime input | Purpose | Required |
| Chain name | The name of the chain from which you're retrieving the GUID. | Yes |
Verify your results
After running this chain, you can verify its successful execution from the Monitor screen. When hovering over your result, you should see the GUID of the chain.
Additionally, you can locate the chain result by going to the RTT - ChainID node of your chain and viewing the Outputs tab.
Troubleshooting
If your chain triggered an error or failed to update the correct data, check that the following is true:
- The provided chain name is exactly matches the chain name in that environment. We recommend copying and pasting the name of the chain.
- The "Workiva Chains" connector is set up correctly.
- There are no duplicate names of the intended chain.