Table of Contents


Overview

Microsoft SQL Server is the dominant relational database on Windows estates and the back end of most of the management tooling that runs on them. Configuration Manager holds its hardware and software inventory in a SQL Server site database, and so do the majority of Windows-based ITSM, CMDB, asset management, HR and finance applications. For many organisations it is the single richest source of device and application data that ReadyWorks can reach without an API.

The ReadyWorks connector connects directly to a SQL Server instance over the network using the mssql.php driver and a SQL login. A job carries a T-SQL statement in its Data Selection field, ReadyWorks runs it, and the result set is written to the destination staging table with one column per selected column. Where a product exposes reporting views over its schema, those views are usually the right thing to query.

This is how ReadyWorks reads inventory that the vendor’s API either does not expose or exposes too slowly to be useful. A Configuration Manager site database answers questions about installed software, hardware specification and last hardware scan that no agent-level API answers as cheaply. Staged against Active Directory computer objects and the CMDB, it becomes the backbone of a device refresh or an operating system migration programme.

The connector is inbound only. It reads query results and writes staging tables, and it issues no writes to the source database.

NOTE: Give ReadyWorks a dedicated login with read access only to the tables or views it needs. Query reporting views rather than base tables where the product provides them, since base table schemas change between product releases.

Connector Properties

PropertyValue
IdentifierMS SQL
NameMicrosoft SQL
DescriptionConnector for accessing Microsoft SQL database tables.
Job TypesInbound Only
Order220
EnabledYes
LockedYes
Block UpdateNo
Single AuthenticationNo
Windows OnlyNo
Connector Version2025-03-12
HooksNone
Additional Job FieldsNone
Image

Authentication Methods

One method ships: a direct network connection with a SQL Server login and password.

MethodIdentifierBase MethodScriptOrderEnabledConfig Fields
Username / PasswordMS SQL_userMS SQL_usermssql.php10Yes5

NOTE: This method requires a SQL Server authentication login. The form has no option for Windows Integrated authentication, so an instance configured for Windows authentication only cannot be read through this connector. Either enable mixed mode and create a SQL login, or use the Powershell: Microsoft SQL connector, which runs on a Windows host.

NOTE: The form has no field for TLS, certificate trust or instance encryption settings. Place the ReadyWorks server and the SQL Server on a network path you trust.

Method 1: Username / Password (MS SQL_user)

Connect to a MS SQL Server

Username / Password connects to the SQL Server instance named in Source Server on the port given in Source Server Port (the default is 1433), authenticates with the supplied credentials, and selects the database named in Source DB Name. All five fields are required. The password is stored encrypted.

Connection Configuration Fields (5)

OrderLabelTypeRequiredDefaultMax LenTooltip
10Source ServertextYes255Enter name of the source server
20Source Server PorttextYes14335Enter port number of the source server
30Source DB NametextYes255Enter name of the source database
40UsernametextYes1024Enter username of the database account
50PasswordpasswordYes64000Enter password of the database account

No authentication recipe is stored. The driver script authenticates natively using the fields above.

Inbound Job Fields Enabled (13)

These are the job-level settings exposed for a Microsoft SQL extract. Data Selection holds the T-SQL statement.

OrderLabelTypeRequiredDefaultTooltip
10Job DescriptiontextYesEnter description of the Job
20Job SchedulelookupYesDailySelect frequency Job should run
30EnabledradioYesYesChoose if Job is enabled
60Allow Empty TableradioYesYesChoose if an empty table is allowed
70Destination TabletextYesEnter name of the destination table
80Data IdentitytextNoEnter identity of the Job
90Data SelectiontextareaNoEnter connector specific data selection command of the Job
120Append New Data to Existing TablesradioNoNoChoose if new data will append to the existing destination table, or will create a new destination table
130Fields to IndextextNoEnter fields to index
150Request Unique Key FieldtextNoEnter request unique field key of the Job
160Request Sort By FieldtextNoEnter field to sort by
290Request LimittextNoEnter request limit of the Job
560OrdertextYesEnter order of the Job

Inbound Job Templates (1)

One inbound template ships as a worked example. It arrives disabled and carries a placeholder query, so it is a pattern to copy rather than a job to enable.

#Job DescriptionDestination TableAPI End PointEnabledWhat It Pulls
1MS SQL Table Datamssql_dataNot setNoA skeleton job carrying the statement SELECT * FROM {tablename} and writing to the mssql_data staging table. Replace the statement, the destination table and the data identity with your own.

Job Template Configuration

Settings

SettingValue
Order10
EnabledNo
Job ScheduleDaily (15 1 * * *)
Destination Tablemssql_data
Data Identitymssql_data
Allow Empty TableYes
Append Files to Same Destination TableNo
Append New Data to Existing TablesNo
Use Unparsed DataNo
Convert UUID-Keyed Objects to RowsNo
Ignore XML AttributesNo
Log Raw API CallsNo
Method TypeGET
Body Data Sending MethodJSON Encoded Data

Job Parameters and Enumeration

MS SQL Table Data

Data Selection: SELECT * FROM {tablename}

Outbound Job Templates (0)

This connector ships no outbound templates and does not support outbound jobs.

Last updated on 11/4/2026

Attachments