SQL Server Connector Setup

Version 22.0.8209

SQL Server Connector Setup

The SQL Server connector allows you to integrate SQL Server into your data flow by pushing or pulling data from SQL Server. Follow the steps below to connect ArcESB to SQL Server.

Establish a Connection

To allow ArcESB to use data from SQL Server, you must first establish a connection using login credentials. You can create the connection from either the connector configuration pane or the Connections tab of the Settings page.


  • The login process is only required the first time the connection is created.
  • Connections to SQL Server can be re-used across multiple SQL Server connectors.

From the Connector Configuration Pane

  1. Drag the SQL Server connector into an ArcESB flow and give it a name.

  2. In the Connector Configuration pane, click + Create next to the Connection drop-down list.

  3. The Add Connection modal appears. Provide the requested information:

    • Name — The static name of the connection. Set this as desired.
    • Type — This is always set to SQL Server.
    • Server — The address of the SQL Server you want to connect to.
    • Port — The port to use when connecting to the server
    • Database — The name of the database you want to target.
    • User — The username to use for logging in.
    • Password — The password for the user entered above.
    • Other — Other authentication information if needed.
  4. If needed, click Advanced to open the drop-down menu of advanced connection settings. These should not be needed in most cases.

  5. Click Test Connection to ensure that ArcESB can connect to SQL Server with the provided information. If an error occurs, check all fields and try again.

  6. Click Add Connection to finalize the connection.

  7. In the Connection drop-down list of the connector configuration pane, select the newly-created connection.

  8. Click Save Changes.

From the Settings Page

  1. Open the Settings page, and then click the Connections tab.

  2. Click Add to open the Connection Type modal.

  3. Click SQL Server, then click Next.

  4. Continue from step 3 above for Connection Configuration Pane.

Select an Action

After establishing a connection to SQL Server, you must choose the action that the SQL Server connector will perform. The table below outlines each action and where it belongs in an ArcESB flow.

Action Description Position in Flow
Upsert Inserts or updates SQL Server data. By default, if a record already exists in SQL Server, an update is performed on the existing data in SQL Server using the values provided from the input. End
Lookup Retrieves a value from SQL Server and inserts that value into an already-existing Arc message in the flow.
The Lookup Query determines what value the connector will retrieve from SQL Server. It should be formatted as a SQL query against the SQL Server tables.
Select Retrieves data from SQL Server and brings it into ArcESB.
You can use the Filter panel to add filters to the Select. These filters function similarly to WHERE clauses in SQL.
Execute Stored Procedures Treats data coming into the connector as input for a stored procedure, and then passes the result down the flow.
You can click the Show Sample Data button to provide sample inputs to the selected Stored Procedure and preview the results.