Skip to main content
Version: Next

Client commands

Remote data clients will communicate with LinXmart by connecting through the client API and asking LinXmart if there are any commands for it to perform. This polling will occur regularly and is configurable via the LinXmart system configuration.

Two common commands that might be invoked as part of the standard linkage process are:

Other commands might be issued for more administrative purposes.

All client commands can be monitored via the Client Comms Activity page.

Upload data command​

When data is loaded into a Linkage Project from a Data Client Data Source, an upload data command is created for the specific data client. The next time that client polls the server for commands, it is given this upload directive. The client will then, in the background, prepare and upload the required data to LinXmart via the client API.

At the same time the upload data command is created, the system will continue on with the standard load and linkage process. When the Load Linkage Request job starts, it will look to see if the data is available to process. If the client has yet to upload the data, the job will wait indefinitely until the data does become available. If the Load Linkage Request appears to be stuck on "Waiting for Datasource", check the status of the Data Client to ensure it is connected. You can also verify that the client command has been issued and processed via the Client Comms activity page.

info

If a command has been issued to a Data Client, it is possible to cancel the command if it is in the queued stated, or request a cancellation if it has already started. Cancelling a client command will also cancel any job that is associated with it.

Download extraction results command​

An update linkage map command is created for a data client if extraction results are requested for an Event Type and the following criteria are met:

  • the Event Type has a Data Source connected to one of the Data Client's Datasets
  • the Event Type is attached to the Linkage Project
  • the Dataset has the capability to receive extraction results

Upon receipt of this command, the data client will download the extraction results via the client API and store these in a location configured by the remote data client itself.