Skip to main content

Data value extractor

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.
Work in progress

We're still working on this part and would love to hear your thoughts! Feel free to share your feedback or submit a pull request. Thank you! 🙏

EnvironmentWebhook URL
EU1 Irelandhttps://elis.data-value-extractor.rossum-ext.app/
EU2 Frankfurthttps://shared-eu2.data-value-extractor.rossum-ext.app/
US east coasthttps://us.data-value-extractor.rossum-ext.app/
Japan Tokyohttps://shared-jp.data-value-extractor.rossum-ext.app/

Basic usage

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 (reference rest-api-export) as a part of (reference export-pipeline).

Available configuration options

{
"extract": [
{
"format": "json",
"extract_rules": [
{
"value_path": "status_code",
"target_schema_id": "api1_status_code"
}
],
"source_reference_key": "export_reply_headers"
},
{
"format": "json",
"extract_rules": [
{
"value_path": "id",
"target_schema_id": "coupa_invoice_id"
}
],
"source_reference_key": "export_reply_payload"
}
]
}

Currently only json format is supported.

  • value_path is the jmespath to the desired place of the response (be it headers or body). Headers are stored in json format.
  • target_schema_id is the schema_id of the annotation you are exporting, where the data will be stored and thus available for further extensions in the export pipeline (reference).
  • source_reference_key is the reference key for the stored data in annotation's metadata