Data Value Extractor

The Data Value Extractor serves to extract data from a document that is linked in annotation's metadata. The main use case is to process data from REST API Export as a part of the Export Pipeline.

Installation

1. Login to your Rossum account.

2. Navigate to Extensions → My extensions.

3. Click on Create extension.

4. Fill the following fields:

   1. Name: Data value extractor

   2. Trigger events: Export

   3. Extension type: Webhook

   4. URL (see below)

5. In "Advanced settings" select Token owner (should have Admin access)

6. Click Create the webhook.

Available configuration options

Simple extraction example.

{
  "extract": [
    {
      "format": "json",
      "source_reference_key": "ifs_export_reply_payload",
      "extract_rules": [
        {
          "value_path": "MessageId[0].value",
          "target_schema_id": "ifs_reply_message_id"
        }
      ]
    }
  ]
}

More complex configuration example using extraction from two different source_reference_key and two extract_rules in the second one. There is also the condition used, which is reference to a document ID in the annotation which triggers the execution of the extraction.

{
  "extract": [
    {
      "format": "json",
      "extract_rules": [
        {
          "value_path": "doc_id",
          "target_schema_id": "erp_doc_id"
        }
      ],
      "source_reference_key": "api_xml_export_reply_payload"
    },
    {
      "format": "json",
      "condition": "@{api_gate}",
      "extract_rules": [
        {
          "value_path": "status_code",
          "target_schema_id": "erp_api_status_code"
        },
        {
          "value_path": "headers.etag",
          "target_schema_id": "erp_api_etag"
        }
      ],
      "source_reference_key": "api_xml_export_reply_headers"
    }
  ]
}

Parameters

Extract Object

The extract object consists of the following parameters:

The extract_rules object defines how values are extracted and stored: