K3 Documents

SQL Server Source Adaptor


SQL Server is an enterprise relational database product that forms part of the larger Microsoft enterprise application infrastructure.

Below you will find details on how to configure the K3 SQL Server Adaptor to connect a SQL Server instance. 

SQL Server Source Adaptor

The K3 SQL Server Source Adaptor supports pulling data from a SQL Server database. The following instructions will walk you through how to set up the SQL Server adaptor.

1. Enter the connection information and click the Test button

Assuming the connection information is correct a success message will be shown. If you have successfully tested the connection click the OK button.  

Configuration Parameter Description
DB User Enter a user that has permission to read from the SQL Server database to which you will be connecting.
DB Password Enter a password for the user provided in the DB User field.
DB Subname
Enter the Database Server and database useing the following format:

//<DB_ServerName>:<Port>;databaseName=<DB Name>

2. Click the Build Query Button

Clicking Build Query starts the process of building the SQL query to pull data from the SQl Server database previously configured.


3. Select the table to query

The build query screen allows you to select a table to query without writing any SQL. Select the table to query from the tables in the drop down list.

4. Select the column K3 should use to track whether there are new records in the table.

Selecting the column K3 will use the selected column to determine if there are new records in the table. This is done by keeping track of the latest value, for the selected column, which K3 has processed, and then using that value to determine if there is a newer value. Most often unique ids or time stamps are the best columns to use.

5. Review the query and adjust the poll schedule

Once you complete the query process and click save the query will display along with the column used to poll. Finally, the poll schedule needs to be determined. K3 currently supports Cron scheduling, which is the default, and periodic schedule.  


Configuration Field Value
Schedule Cron (only available if you select Cron Scheduling) Enter the Cron schedule script to determine when the poll will run.
Poll Delay  (only available if you select Periodic Scheduling) Enter the Poll Delay in milliseconds to determine when the poll will run.
Previous Article XML Upload Adaptor
Next Article SQL Server Target Adaptor