Suppress output

Specifies fields to exclude from the extraction output. For example, if you use the field id _raw_data as a source for a nicely_formatted computed field, then specify the raw field's id in this method to show only the computed field in the output.

Parameters

The following parameters are in the computed field's global Method parameter:

keyvaluedescription
id (required)suppressOutput
source_ids (required)array of field ids in the current configThe id of the fields to exclude from the extraction output.
In advanced use cases, configure field execution order to prevent unintential null output from other computed field methods. For an example, see Zip sections example.

The following example shows suppressing a raw "driver's name" field and outputting the split last name.

Config

{
  "fields": [
    {
      "id": "_driver_name_first_last_raw",
      "anchor": "name of driver",
      "method": {
        "id": "label",
        "position": "below"
      }
    }
  ],
  "computed_fields": [
    {
      "id": "driver_name_last",
      "method": {
        "id": "split",
        "source_id": "_driver_name_first_last_raw",
        "separator": " ",
        "index": 1
      }
    },
    {
      "id": "hide_fields",
      "method": {
        "id": "suppressOutput",
        "source_ids": [
          "_driver_name_first_last_raw"
        ]
      }
    }
  ]
}

Example document

The following image shows the example PDF used with this example config:

Click to enlargeClick to enlarge

Example PDFDownload link

Output

{
  "driver_name_last": {
    "value": "Petrov",
    "type": "string"
  }
}

Did this page help you?