Skip to main content
Version: Next

Envelopes

At its simplest, a LinXmart Envelope is a dataset paired with a descriptor that tells LinXmart what to do with it. These Envelopes exist as standard zip files containing one or more data files, other metdata files and a manifest file that describes what each file is for. This could be to load data for linkage, extract linkage keys for specified source records, or even modify the groupings of records.

There are several types of Envelopes:

  • Linkage Request - to load data for linkage
  • Deletion Request - to delete existing records
  • Extraction Request - to request linkage keys for specific records
  • Probability Estimation - estimation of probabilities
  • Batch Quality Review - forced change of groupings of records

These Envelope files can be created manually. However, the preferred method is through the Envelope Builder App or the Envelope Builder Libraries.

info

The full Envelope format is described in detail here.