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.
For a specific data source, the LinkageMapSink property defines the details of where extraction results are stored. For the general receive-all, a LinkageMapSink property can be defined at the same level as the DataSources property. Either way, the configuration settings are the same for both, but are located in different areas within the appsettings.json or appsettings.datasources.json files.
The properties of a data sink are described below:
| Property | Description |
|---|---|
Type | The LinXmart Data Client supports one connection type for data sinks:
|
Properties | These are properties specific to the data source type:
|
ColumnMapping | A mapping of linkage map properties to column names in the destination. The following mappings are mandatory:
appsettings.json configuration, they will be ignored:
LinkageFields sub-property (see below) |
PostgreSQL and ODBC are not currently supported as data sinks.
If you want to create a compatible table yourself, an example creation script for SQL Server for all standard fields are shown below.
CREATE TABLE [dbo].[LXM_Extraction_Results] (
[ProjectCode] [nvarchar](50) NULL,
[EventTypeCode] [nvarchar](50) NULL,
[SourceUniqueId] [nvarchar](100) NULL,
[SourcePersonId] [nvarchar](100) NULL,
[PersonKey] [nvarchar](100) NULL,
[ExtractionProjectId] [nvarchar](100) NULL,
[LinkedProjectPersonKey] [nvarchar](100) NULL
);
Additional linkage fields
Linkage fields can be included in the linkage map extraction if required. For example, you may have another identifier that needs to be paired with the original record identifier and person key.
The ColumnMapping.LinkageFields property is an array of name-value pairs, identifying the linkage field name and the destination column name.
The following example shows a ColumnMapping entry that includes the linkage field, TextField1.
"ColumnMapping": {
"ProjectCode": "Project Code",
"EventTypeCode": "Event Type Code",
"SourceUniqueId": "Source Unique Id",
"SourcePersonId": "Source Person Id",
"PersonKey": "Person Key",
"ExtractionProjectId": "Extraction Project Id",
"LinkedProjectPersonKey": "Linked Project Person Key",
"LinkageFields": [
{
"Name": "TextField1",
"DestinationColumn": "Grouping"
}
]
}