Loading in an Envelope
An Envelope can contain a data file that is marked for linkage. The Envelope's manifest will specify a target Linkage Project for the data, as well as the Event Type the data should be classified. Other Envelope types will have other metadata describing how the data should be used by the system.
It is recommended that the Envelope Builder app be used to create Envelopes. However, they can be created manually if they follow the correct Envelope file format.
As the Envelope explicitly defines everything about the data in it, it just needs to be passed to LinXmart for processing. There are several ways to do this:
Inbox
Most deployments of LinXmart will have an Inbox folder defined. This is a special folder, available to both the system and the users, designated for loading Envelopes into the system. The system will monitor this folder, and when a new file is detected, the system will attempt to identify the file as an Envelope. If it passes validation, the Envelope is moved out of the Inbox and processing jobs are then triggered for execution.
While there are other methods for loading Envelopes, a dedicated folder is not impacted by file size restrictions (like web based methods) and can form part of an automated process.
Web upload
Uploading an Envelope directly via the web interface is done from the 'All Envelopes' page. Click on the JOBS tab and you should be presented with the Upload Envelope panel at the top of the page.
Click the Chose File button to select a local Envelope zip file to load, then click the Upload button.
While the file is uploading, an 'uploading' modal message is shown on the page. Large files can take a while to upload via HTTP, and the system will also examine the Envelope after upload to determine if it is valid.
On successful completion of the upload, the system will trigger a new series of Jobs to begin the linkage process.
API upload
Envelopes can also be uploaded directly to the system via the Web API. This assumes that the API has been configured for the system and the user has permissions to use the API.
In version 3.1 of the API, the call is a POST request with a multipart/form-data content containing the Envelope.
POST /api/v3.1/envelopes