Workiva Support Center

With the Microsoft® SQL Server® connector, you can use commands in a chain to perform structured query language (SQL) operations in Microsoft SQL Server databases, including solutions such as Microsoft Dynamics® Great Plains® (GP) or Yardi® Private Cloud. For example, with this connector, you can:

• Execute SQL commands, including a CREATE or UPDATE statement or SELECT query
• Retrieve details about a table in SQL Server
• Insert records into a SQL Server database

Note: This connector is built by Workiva and connects to a third-party system. While our Support team can help configure this connector within your workspace, we are unable to troubleshoot or otherwise assist with any issues that originate outside of the Workiva platform.

Requirements

To enable the connection to the SQL Server database, 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 created in SQL Server for the connector
• The integration user's username and password
• The JDBC connection's URL, such as jdbc:sqlserver://localhost:1433;[options]
• To connect to an on-premises SQL Server database, a GroundRunner for the connection

Supported versions

The Microsoft® SQL Server® connector is compatible with the following database versions:

• Azure SQL Database
• Azure Synapse Analytics
• Azure SQL Managed Instance
• SQL Server 2022
• SQL Server 2019
• SQL Server 2017
• SQL Server 2016
• SQL Server 2014

Set up the Microsoft SQL Server 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 Microsoft SQL Server and the runner to use with the connection.
   
3. Under Basic Info, enter a unique name and description to help identify the connection.
4. Under Properties, enter the connector's details:
   
   

   Property	Details
   Username	Enter the username of the connector's SQL Server integration user.
   Password	Enter the password for the Username property.
   Connection URL	Enter the URL for the JDBC connection, such as jdbc:sqlserver://<server>:<port>. To include optional properties for the connection, append them after a semicolon, such as jdbc:sqlserver://localhost:1433;<options>. For example, to connect to a database using Active Directory® integrated security: ;databasename=<database>;integratedSecurity=True;authenticationScheme=NTLM Note: By default, the port is 1433; however, this may be different for your environment.

   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.

5. Select the environments to use with the connection, and click Save.
6. To test the connection, create and run a chain with the connector's Get Table Definition command, and verify it returns a valid output.

Troubleshooting

If the connection to SQL Server fails:

• Verify the integration user's authentication credentials.
• Check the URL for the JDBC connection, including its server and port.
• If connecting to an on-premises database, check the GroundRunner selected for the connector.

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