|
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

Workiva Carbon connector

Workiva Carbon connector

  • Last updated on

With the Workiva Carbon connector, you can use commands in a chain to efficiently transfer carbon accounting data within Workiva.

Requirements

To enable the connection, the connector uses Java database connectivity (JDBC) secured with basic username and password authentication. To set up the connector, you'll need:

  • A designated integration user with API access enabled
  • The integration user's username and password
  • The connection's URL

Set up the Workiva Carbon connector

Note: To make the connector available for use in your organization's chains, an org security administrator first enables it from Configuration.
  1. From Chain Builder, click Connections  compare_arrows, and then Create at the top right.
  2. Under Connector Connection, select Workiva Carbon and the runner to use with the connection.2024-06-18_08-36-21.png
  3. Under Basic Info, enter a unique name and description to help identify the connection.
  4. If you are going to use a key pair for authentication, under Resources, upload the private key file.
  5. Under Properties, enter the connector's details:
    Image_0.png
    Property Details
    Username Enter the username of the connector's integration user. 
    Password Enter the password for the Username property. 
    Connection URL Enter the URL for the connection:
    • For US Production: 
      jdbc:snowflake://yqlyisz-workiva_carbon_prod_us.snowflakecomputing.com/
    • For EU Production: 
      jdbc:snowflake://yqlyisz-workiva_carbon_prod_eu.snowflakecomputing.com/
    • For legacy Sustain.Life (US Azure): 
      jdbc:snowflake://pu59769.east-us-2.azure.snowflakecomputing.com/
    To include optional properties for the connection, append them as a query string.
    Private Key File The file to be used for authentication in combination with the server's public key. A Username and Password must still be provided. The Private Key file filename must match a file uploaded as a connection resource.
    Note: All sensitive credentials are automatically encrypted and stored at Advanced Encryption Standard (AES)-256 encryption. For security purposes, avoid including user credentials as optional properties within the Connection URL property.
  6. Select the environments to use with the connection, and click Save.

Troubleshooting

If the connection fails:

  • Verify the integration user's authentication credentials.
  • Check the URL for the connection.
  • If connecting to an on-premise database, check the GroundRunner selected for the connector.

If the connection fails to perform a command, verify its inputs—such as its SQL syntax—are valid.

With the Workiva Carbon connector, you can use commands in a chain to efficiently transfer carbon accounting data wit...