Table Of Contents

Checking Compliance of Data Entering File Service

Last Modified: April 1, 2021

Define data integrity rules to ensure that all data entering the SystemLink file service complies with the metadata requirements for your data analyses. The checks apply to the workspaces that the DataFinder instance indexes.

Define data integrity rules in a JSON file that you upload to a DataFinder dedicated to indexing the file service.
  1. In a text editor, create a JSON file that defines the required metadata at the root, group, and channel level for all TDM data entering the file service.
    spd-note-tip
    Tip  

    Update the RequiredMetadataVersion property when updating a definition file. This enables you to search for data that complies with a specific version of the definition file.

    Refer to the code example for a metadata definition file at the bottom of this page.
  2. Upload the JSON file to the DataFinder that indexes the file service.
    1. In SystemLink Web Application, under Data Administration, click Data Indexing and then DataFinder Instances.
    2. Select the instance to which you want to upload the file and click »Manage.
    3. On the Index tab, click Data Integrity Rules.
    4. Upload the definition file from your disk and click OK. The DataFinder instance checks all new files entering the file service for compliance with the metadata definition and adds two properties to the index:
      Added Properties Values
      NI_FS~RequiredMetadata~Compliant (searchable in Data Navigation) Not compliant: Value = 0

      Compliant:       Value > 0
      Compliant value is "RequiredMetadataVersion" from the metadata definition file

      NI_FS~RequiredMetadata~ErrorText (not searchable in Data Navigation) Missing keys: metadata1, metadata2, ...
    5. To remove the file, click Remove definition file.
  3. On the Search Areas tab, select the Workspaces you want to index. If you want to index the entire file service, switch the toggle to Index all workspaces on the system.
  4. Optional: Reset the entire index to execute a compliance check on already indexed files in the file service.
    1. Select the Index tab.
    2. Click the arrow next to Reset Index and choose Entire Index. The DataFinder instance reindexes all files in the file service, checks them for compliance, and adds the same properties as above to the index. This process may take a while.

Example for a definition file:

{
    "FileVersion": 1,
    "Description": "Required metadata keys for SystemLink (this line is ignored)",
    "RequiredMetadataVersion": 1.0,
    "RequiredMetadataKeys": {
        "root": ["product_identifier", "product_type", "product_design_step"],
        "group": ["package", "dut_id"],
        "channel": ["ResultStatArithMean", "ResultStatMax", "ResultStatMin"]
    }
}
Search for the files that do not comply with the data integrity rules in the advanced search in Data Navigation and add the missing metadata.

Recently Viewed Topics