CLP - Refresh Connection using ID – Support Center

In order to give end users the ability to see the most up to date data available within the Workiva Platform, refreshing Connections is essential. In this Connected Learning Path, we will learn how to create a Chain that refreshes a Connection between the Workiva Platform and Wdata using the Connection ID. In subsequent paths, we will learn how to automatically pull the Connection ID and refresh the Connection using Chains.

Primary Business Use Case	Data Connectivity between Workiva and Wdata
Primary Learning Objective	Learn how to refresh a Connection using Chains
Prerequisites	Configure Workiva Connector Complete the CLP \| Uploading Data to a Table Path Complete the CLP \| Create a Query with a Calculated Field Provide permissions to the Spreadsheet for the associated Workiva OAuth Grant User
Supporting Template	CLP \| Refresh Connection using ID

Note: The CLP Employee Detail Query is required for this connection. Follow the CLP | Create a Query with a Calculated Field for instructions to build the Query. If all Query Management paths have been completed, navigate to the CLP Employee Details Query Parameters and follow these steps to delete the Country Parameter.

Step 1: Create an Incoming Connection

In order to learn how to refresh a Connection using a Chain, we first need to establish a connection between a Wdata Query and a Spreadsheet.

Navigate to the Workiva Platform to create a new Spreadsheet
Click Create and select Spreadsheet
Name the Spreadsheet: CLP Employee Overview
- Name the first Sheet: CLP Employee Details
Add an Incoming Connection to the CLP Employee Details sheet:
- Open the Connections panel on the right by clicking the Connections icon
- On the Incoming Connections tab, select Add Connection
  - Select Wdata Query
  - Select the CLP Employee Detail Query
  - Click Connect

Step 2: Create a Chain

Navigate to Chain Builder
Add a new Chain
- Name the Chain: CLP | Refresh Connection using ID
Save the Chain

Step 3: Runtime Inputs

We use the Runtime Inputs Chain Event to kick off the Chain. This allows us to specify which Connection we want to refresh at Chain run time.

Add a Runtime Inputs Chain Event from Chain Trigger Events the Start Node
Edit the Runtime Inputs Chain Event by double clicking on the Command
- Type: TextField
- Display Name: Connection ID
- Required: Unchecked
Save the Command

Step 4: Refresh Connection

We will use the Refresh Connection Command to refresh our Connection using the Connection ID

Add a Refresh Connection Command from the Workiva Connector to the Chain canvas
Connect the Runtime Inputs Command to the Refresh Connection Command
Double click the Command to configure it
- Name the Command: Refresh Connection
- Use the Connection ID variable from Runtime Inputs - this allows us to push the value specified at Chain run time through to the Refresh Connections command
  - Click on the Connection ID field
  - In the left panel, expand the Trigger dropdown
  - Expand the Runtime Inputs dropdown
  - Select the Connection ID variable
- Leave the Parameter options as is, we will cover the Parameter fields in a future path

Step 5: Test the Exercise

Now that the Chain is complete, test the result

Publish the Chain
Click Execute and then select Run With Inputs
Find the Connection ID
- Navigate to the CLP Employee Overview Spreadsheet
- In the Connections panel, find the CLP Employee Detail Query Connection and click the up arrow. Once the dropdown appears, select View Properties

Copy the Connection ID - make sure you don’t miss any characters or add any spaces

Navigate back to Chain Builder and paste the Connection ID into the Connection ID Runtime Input
Click Start
Once the Chain has completed, navigate back to the Table or Spreadsheet and see that the Connection has been refreshed successfully!

Successful Chain run:

Successful Connection refresh:

Learn more about refreshing Connections using Chains by completing the next path: Refresh Connections with a Parameter!

Workiva Support Center