Data Client deployment

Overview

The LinXmart Data Client is a lightweight Windows service that is deployed remotely, alongside data that cannot be accessed directly by the LinXmart server. It acts as a proxy, connecting to local data sources (such as SQL Server, PostgreSQL or ODBC) and exposing them to LinXmart over a secure, mutually authenticated connection.

This section describes how to deploy a Data Client, from registering it with the LinXmart server through to verifying a successful deployment, and provides a reference for the Data Client's configuration file.

Topics

This section covers the following topics for deploying a LinXmart Data Client:

• Service Accounts - creating the required service account
• Machine Configuration - preparing the server to meet the minimum software and hardware requirements
• Deployment Procedure - registering, configuring and installing the data client
• Deployment Verification - verifying the deployment by checking the service and logs
• Data Source Configuration - configuring the data sources exposed by the data client
• Data Sink Configuration - configuring where extraction results are written by the data client
• Sample Configuration File - a full example of the data client's appsettings.json file

📄️ Service Accounts

A service account is required to run the LinXmart Data Client service. The following account needs to be created if it does not already exist, but it may be an Active Directory domain account or a local user account:

📄️ Machine Configuration

Data Client Server

📄️ Deployment Procedure

Deployment Order

📄️ Verification

The installation of the data client should create and start the data client as a Windows service.

📄️ Data Source Configuration

The primary function of the data client is to provide LinXmart access to remote data sets. Providing this access is done through the data client's configuration file: appsettings.json.

📄️ Data Sink Configuration

Data clients can be configured to receive extraction results (linkage map data) for specific data sources, or for all data from the server. For the latter, LinXmart must be configured to allow the data client to receive all of this data.

📄️ Sample Configuration File

The following is a complete example of a data client's appsettings.json file, showing a single data source with a source-specific linkage map sink, and a general receive-all linkage map sink.