Microsoft SQL Server Connection
Overview
The Microsoft SQL Server connection allows IB-X Agents to connect to Microsoft SQL Server databases and perform database operations from workflows.
The connection can be used by database activities to perform operations such as:
- Selecting records
- Inserting records
- Updating records
- Deleting records
- Executing stored procedures
The connection supports both SQL Authentication and Windows Integrated Authentication (SSPI).
Prerequisites
Before creating a Microsoft SQL Server connection:
- Ensure that the SQL Server instance is accessible from the IB-X environment.
- Obtain the database server and database information required for the connection.
- Determine whether the connection should use SQL Authentication or Windows Integrated Authentication (SSPI).
- When using SQL Authentication, obtain the required database user credentials.
- Ensure that the configured database account has the permissions required by the intended workflow operations.
Connection Properties
Configure the following properties when creating a Microsoft SQL Server connection.
| Property | Description |
|---|---|
| Name | Unique name used to identify the Microsoft SQL Server connection in IB-X. |
| Description | Optional description of the connection and its intended usage. |
| Database Server Name | Name or address of the Microsoft SQL Server instance. |
| Database Name | Name of the database to connect to. |
| SSPI (Integrated Security) | Specifies whether Windows Integrated Authentication (SSPI) should be used instead of SQL Authentication. |
| User Name | User name used to authenticate with SQL Server. Required when SSPI (Integrated Security) is not enabled. |
| Password | Password associated with the SQL Server user. Required when SSPI (Integrated Security) is not enabled. |
Database Server Name
Specify the name or address of the Microsoft SQL Server instance that IB-X should connect to.
The value must identify a SQL Server instance that is reachable from the IB-X environment.
Database Name
Specify the name of the SQL Server database that IB-X should access.
The configured database account must have the permissions required to access this database and perform the operations used by the Agent.
Authentication
Microsoft SQL Server connections support SQL Authentication and Windows Integrated Authentication (SSPI).
The authentication method is determined by the SSPI (Integrated Security) option.
SQL Authentication
Leave SSPI (Integrated Security) disabled to authenticate using a SQL Server user account.
Provide:
- User Name
- Password
The configured SQL Server user must have access to the specified database and the permissions required by the workflow activities that use the connection.
The Password is a sensitive credential.
Protect the password from unauthorized access and manage it according to your organization's credential-management and security policies.
Windows Integrated Authentication (SSPI)
Enable SSPI (Integrated Security) to connect to SQL Server using Windows Integrated Authentication.
When this option is enabled, the connection uses the Windows identity available to the IB-X environment instead of SQL Server user name and password credentials.
The Windows identity used by the IB-X environment must have access to the configured SQL Server instance and database.
Ensure that your IB-X deployment and SQL Server environment are configured appropriately for Windows Integrated Authentication.
Testing the Connection
After providing the required connection properties, click Test Connection to verify that IB-X can connect to the configured Microsoft SQL Server database.
Connection or authentication issues can result from:
- An incorrect Database Server Name
- An incorrect Database Name
- An invalid User Name or Password
- Incorrect SSPI (Integrated Security) configuration
- Windows Integrated Authentication configuration problems
- Network connectivity problems
- Database access restrictions
A successful connection test confirms that IB-X can establish the database connection using the supplied configuration. The database account must still have the appropriate permissions for the operations performed by individual workflow activities.
Used By
The Microsoft SQL Server connection can be used by IB-X database activities to interact with SQL Server databases.
Depending on the activity, the connection can be used to:
- Query database records
- Insert records
- Update existing records
- Delete records
- Execute stored procedures
The operations that can be performed depend on the selected database activity and the permissions granted to the configured database account.
Security Considerations
When configuring a Microsoft SQL Server connection:
- Grant only the database permissions required by the Agent.
- Protect SQL Authentication credentials from unauthorized access.
- Use SSPI (Integrated Security) only when the IB-X environment is appropriately configured for Windows Integrated Authentication.
- Restrict access to connection management based on organizational requirements.
- Rotate database credentials according to your organization's security policies.
- Ensure that the SQL Server instance is accessible only from authorized environments.
For example, if an Agent only reads database records, the configured database account should not be granted write permissions unless they are required.
The AI Command Center must have network access to the configured SQL Server instance.
For self-hosted environments, ensure that the required database server is reachable from the AI Command Center deployment.
For information about creating, editing, testing, cloning, deleting, and auditing connections, see Connections.