Workiva Support Center

In this Connected Learning Path, we will create a Chain that illustrates how to leverage the Handlebars Connector to parse data from an HTTP response and templatize variables that can be used throughout a Chain.

Step 1: Create a Chain

1. Add a new Chain.
2. Name the Chain CLP | Handlebars Configuration.
3. Create a Chain variable. Enter the following values for the variable name and value:
   • Variable Name: cv-AllStations
   • Variable Value: https://cs-sftp-training-bucket.s3.amazonaws.com/cs-training/transformation-qs/station_information.json
4. Save the Chain.
   

Step 2: Retrieve JSON Data

This step uses the HTTP Connector to retrieve Citibike-related data in JSON format from a web location.

1. Add a GET Command from the HTTP Connector to the Start node.

2. Configure the Command using the following values:

   Name	GET - All Stations
   User Name	<leave blank>
   Password	<leave blank>
   CA Certificate	<leave blank>
   Certificate	<leave blank>
   Certificate Private Key	<leave blank>
   Show Response	Checked
   URL	cv-AllStations Chain Variable
   Query string	<leave blank>
   Content type	application/json
   Response	<leave blank>

3. Save the Command.
   

Step 3: Iterate through the JSON data

Use the Handlebars - Render Text template Command to iterate through the CitiBike station data to provide a format that provides each individual stations data combined.

1. Add the Handlebars - Render Text Template Command to the Chain canvas.
2. Connect the GET - All Stations Command to the Handlebars - Render Text Template Command.
3. Double-click the Command to edit it.
   1. Name the Command: RTT - Parsing JSON Response.
   2. Add a JSON Variable and name it citibikeData.
   3. For the Value field use the Response variable from the Get - All Stations Command.

   4. Fill out the template field with the following value:

      {{#each citibikeData.data.stations}} 
      {{@index}} | {{name}} | {{capacity}}
      {{/each}}

      This will allow the Command to iterate through the JSON response, using a root path of data.stations to provide text values from each key: (“name”, “capacity”). In addition, it will add an index value for each row processed.

4. Save the Command.
   

Step 4: Templatizing Runtime Variables

Use the Handlebars - Render Text Template Command to templatize variables. This will allow the Chain to render a text template that provides context on different components of the Chain based on its runtime.

1. Add the Handlebars - Render Text Template Command to the Chain canvas.
2. Connect the GET - All Stations Command to the Handlebars - Render Text Template Command.
3. Double-click the Command to edit it, using the following values:
   1. Name the Command: RTT - Templatizing Variables.
   2. Add and populate the following information for the variables section:
      The Value fields will be populated from the Runtime dropdown of the left variables pane.
      • Variable 1
        • Variable Name: Chain-Env
        • Value: <Chain.Enviroment> (Runtime Variable)
      • Variable 2
        • Variable Name: Chain-Exec-Time
        • Value: <Chain.ExecutionDateTime> (Runtime Variable)
      • Variable 3
        • Variable Name: System-RunTime-Month
        • Value: <System.DateTime> (Runtime Variable)
          1. Click on the <System.DateTime> runtime variable to transform the variable.
          2. On Select Transformation, choose Parse Date/Time, and click the “+”.
          3. In the first value field, choose “ISO Extended (Platform Standard)".
          4. In the Output date format field, enter “%m”.
          5. In the Input date timezone field, choose “UTC (Etc/UTC)”.
          6. In the Output date timezone field, choose “UTC (Etc/UTC)”.
          7. Click Accept.
      • Variable 4
        • Variable Name: System-RunTime-Year
        • Value: <System.DateTime> (Runtime Variable)
          1. Click on the <System.DateTime> runtime variable to transform the variable
          2. In Select Transformation, choose Parse Date/Time, and click the “+”.
          3. In the first value field, choose “ISO Extended (Platform Standard)".
          4. In the Output date format field, enter “%Y”.
          5. In the Input date timezone field, choose “UTC (Etc/UTC)”.
          6. In the Output date timezone field, choose “UTC (Etc/UTC)”.
          7. Click Accept.
   3. Fill out the template field with the following values:
      • Chain Environment: {{Chain-Env}}
      • Chain Execution Date: {{Chain-Exec-Time}}
      • System Runtime Month-year: {{System-RunTime-Month}}-{{System-RunTime-Year}}
4. Save the Command.
   

Step 5: Templatizing Workspace Variables - Get Workspaces

Use Handlebars - Render Text Template to templatize components of a Workspace. This will allow the Chain to render a text template that provides context from different components of the Workspace that the Chain is located in.

1. Add the Get Workspaces Command from the Workiva Chains connector to the Chain canvas.
2. Connect the GET - All Stations Command to the Get Workspaces Command.
3. Double-click the Command to edit it, and confirm that the connection is correct.
4. Save the Command.
   

Step 6: Templatizing Workspace Variables - RTT - WorkspaceID

1. Add the Handlebars - Render Text Template Command to the Chain canvas.
2. Connect the Get Workspaces Command to the Handlebars - Render Text Template Command.
3. Double-click the Command to edit it.
   • Name the Command RTT - WorkspaceID.

   • Enter the following value into the Template field:

     {{#each workspaces}}
     {{#if (equal name "<(chain.workspace)>") }}
     {{id}}{{/if}}{{/each}}

4. Select the <Chain.Workspace> variable from the runtime variables section in the left panel
5. In the JSON Variables field, enter the following information:
   • Variable Name: workspaces
   • Variable Value:: <Workspaces>
6. Expand the Get Workspaces variable from the variables panel on the left and select Workspaces.
7. Save the Command.
   

Step 7: Templatizing Workspace Variables - Get Environments

1. Add the Get Environments Command from the Workiva Chains Connector to the Chain canvas.
2. Connect the RTT - WorkspaceID Command to the Get Environments Command.
3. Double-click the Command to edit it, and enter the Rendered Text variable from the RTT-WorkspaceID Command within the Workspace ID field.
4. Save the Command.
   

Step 8: Templatizing Workspace Variables - RTT - EnvironmentID

1. Add the Handlebars - Render Text Template Command to the Chain canvas.
2. Connect the Get Environments Command to the Handlebars - Render Text Template Command.

3. Double-click this Command to edit it, using the following values:

   1. Name the Commmand: RTT - EnvironmentID.

   2. Enter the following value into the Template field:

      {{#each environments}}
      {{#if (equal name "<(chain.environment)>") }}
      {{id}}{{/if}}{{/each}}

      The <Chain.Environment> is a Runtime variable, and can be found on the left panel.

   3. In the JSON variables field, enter the following information:
      • Variable Name: environments
      • Variable Value: <Environments>
        This value is found on the left variable panel under the Get Environments Command.
   4. Save the Command.
      

   Step 9: Test the Exercise

   1. Publish the Chain.
   2. Click Execute, and then select Run Chain.
   3. Once the Chain has completed its run:
      Confirm that all nodes were successfully executed by click on the executed RTT - Parsing JSON Response Command and verifying that the first few lines of the output is as follows:
      

   4. Click on the executed RTT - Templatizing Variables Command, and verify that the rendered text is accurate within the “Logs” tab.
      

      Note: These values will change based both on the Environment that the Chain is run in and when it is run.

   5. Click the RTT - Environment ID node and select the Outputs tab.
   6. Confirm that a value has populated for the rendered text variable (again, this result will vary depending on your Environment).
      

   Learning more

   To learn more about data transformation using Chains, check out Connected Learning Paths - Transformation Introduction