Skip to main content
Version: Next

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.

The appsettings.json file can be found in the root of the data client service installation folder. An example of this file is available in the Sample Configuration File.

In this configuration file, data sources are configured in the LinXmartDataClient.DataSources array property.

The properties of a data source are described below:

PropertyDescription
NameA name, unique to this data client, that is used by LinXmart to refer to it.
TypeThe LinXmart Data Client supports three connection types for data sources:
  • SQL Server (Microsoft SQL Server)
  • PostgreSQL (PostgreSQL)
  • ODBC (ODBC)
PropertiesThese are properties specific to the data source type:
  • ConnectionString - the full connection string to the data source in the format required by the Type
  • CredentialsName - (optional) if a username/password combination is required for the connection string, you can instead specify the name of the credentials stored in the service account user's credential store (Generic Credentials) - it will add these to the connection string at runtime
  • Table - the name of the table to read data. Do not include schema - table or view name only.
ColumnsAn array of objects, each describing the columns available for LinXmart to use in the source data:
  • Name - the name of the column
  • Ordinal - the ordinal value of the column
  • Type - the .NET CLR data type of the column (Int16, Int32, String, etc)
ModifiedDateColumn(optional) The name of the column that indicates the timestamp at which the record was created/modified. It can be used to determine whether records need to be loaded into LinXmart.
LinkageMapSink(optional) A set of configurations that describe how the extraction results (the linkage map) are stored. See Data Sink Configuration.

SQL Server data sources connect directly with SQL Server tables (and views), and support connection and command retry mechanisms for resilience.

PostgreSQL data sources behave similarly for PostgreSQL tables and views. However, retry mechanisms are not available.

ODBC data sources are provided for other types of data and can be configured through the ODBC Data Sources configuration in Windows.

info

ODBC DSNs must be configured through the 64-bit version of the ODBC Data Source Administrator (either a system DSN or a user DSN specific to the service account).