|
Classic file types are no longer available for use as of January 2021. You can transition your classic files or download a PDF. Learn More

Workiva Support Center

Manage connectors for chains

Manage connectors for chains

  • Last updated on

The first step in building a chain is for an Org Security Admin to enable the necessary connectors. This makes all of the commands associated with that connector available in your workspace. These commands, in turn, form the building blocks of chains and govern the interaction between your data sources.

Note: Connector settings are applied at the org level, meaning an enabled connector will be available to every workspace in your organization.

Requirements

  • You must be a Workspace Owner to access the Connectors screen.
  • You must be an Org Security Admin to enable or disable a connector.

View available connectors

We offer connectors for data sources within the Workiva platform as well as those contained in a third-party solution. Your subscription includes all core connectors and a number of premium connectors; any additional connectors enabled will appear on your invoice when your billing cycle ends. There's no limit on how many connectors you can activate.

To view the connectors enabled for use by your organization:

  1. In Wdata, select Configuration from the lefthand menu.
  2. At the top of the screen, click Connectors.
    manage-connectors_03.png

After an org security admin enables a connector, you can set up its connection in Chain Builder.

Note: Workspace owners can view which connectors are available, but they can't enable additional connectors.

Add a connector

To use a connector within a chain, it must be enabled for use by your organization and set up with the properties required to connect to its data source.

Step 1. Enable the connector

To make a connector available for use in your organization's chains, an org security administrator must enable it:

  1. From Configuration, hover over the connector under Connectors, and click Enable. manage-connectors_01.png

    Note: Disabled connectors appear alphabetically after your enabled connectors.

Step 2. Set up the connection

After a connector is enabled, an org security admin or workspace owner must set up its connection from Chain Builder. This allows you to define its use and enter the properties required to integrate with its system of record, including:

  • The CloudRunner or GroundRunner that interact with your data source.
  • Authentication credentials required to securely log in to the data source.
  • Any additional properties or resources required by the data source.

Connections are enabled separately for each environment and workspace, ensuring users are not using production credentials for non-production environments.

To set up a connection:

  1. From Chain Builder, click Connections  compare_arrows, and then Create at the top right.
  2. Under Connector Connection, choose the type of connection to create and the runner to use, based on the data source to connect to:
    • To connect to a cloud or Software-as-a-Service (SaaS) data source, select CloudRunner.
    • To connect to an on-premises data source within your firewall, select its GroundRunner.

  3. To help collaborators identify the connection, under Basic Info, enter a unique name and description.

    Note: Connection names are pooled across your entire organization. For example, the name "Workiva connector" can only be used one time across your entire organization.
  4. Some connections require resources, such as the certificate for an Anaplan® connector. If required, click Add under "Resources" and upload the files referenced by the connection.
  5. If necessary, enter the connection's credentials and properties, based on the solution.
  6. Under Environments, select which environments will use the connection; to select every environment within a workspace, click the checkbox to the right of that workspace. environments.png
  7. Click Save.

 

Edit a connection's password, credentials, or other properties

To update a connection's details or properties, such as its password or credentials, a workspace owner can edit it from Chain Builder:

  1. From Chain Builder, click Connections  compare_arrows, select Edit for the connection.
    2023-11-21_11-26-35.png
  2. Update the connection's information and properties as necessary.
  3. Click Save.

 

View a connection's usage

To view how many or which chains use a connection, such as before you edit or delete it:

  1. From Chain Builder, click Connections  compare_arrows, select Edit for the connection.
  2. Next to Update Connection, view how many chains use the connection. To view which chains use the connection, click its Uses count.
    connection-uses.png

 

Disable a connector

If your organization no longer needs a connector, an org security admin can disable it from Configuration.

Note: When you disable a connector, you disable it for all of your organization's workspaces, and any chain with its commands no longer runs.
  1. From Configuration , select the connector under Connectors, and click Disable.
    manage-connectors_02.png
  2. Click Disable.

 

Delete a connection

If no chain actively uses a connection, an org security admin or workspace owner can delete it from Chain Builder.

Note: You can't delete a connection if a chain uses its commands. To view where a connection is used, click its Uses count.
  1. From Chain Builder, click Connections  compare_arrows, select Edit for the connection.
  2. Click Delete.
The first step in building a chain is for an Org Security Admin to enable the necessary connectors. This makes all of...