Maps output from source fields using a case-sensitive lookup table. A common use case for this method is to standardize output across configs. For example, if different documents inconsistently format data ("6 month policy period" versus "6 mo. policy duration"), you can map those data to a common format using the Mapper method. Consistently formatted output simplifies your application logic by allowing you to ignore distinctions between document sources.

Parameters

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

key	value	description
id (required)	`mapper`
source_id (required)	a field id in the current configuration	The id of the field to map
mappings (required)	object	An object with mappings from strings or numbers to output strings represented as key/value pairs, for example, `{ "03/04": "March 4th" }`. Key value pairs are case sensitive.

Examples

The following example shows using a mapper to standardize a time duration.

Config

{
  "fields": [
    {
      "id": "_premium_period_raw",
      "anchor": "duration",
      "method": {
        "id": "row"
      }
    }
  ],
  "computed_fields": [
    {
      "id": "premium_period_months",
      "type": "number",
      "method": {
        "id": "mapper",
        "source_id": "_premium_period_raw",
        "mappings": {
          "ANNUAL": "12",
          "BIANNUAL": "6",
          "MONTHLY": "1",
          "Six months": "6",
          "six months": "6",
          "Twelve months": "12",
          "twelve months": "12"
        }
      }
    }
  ]
}

Example document

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

Click to enlarge

Example PDF	Download link

Output

{
  "_premium_period_raw": {
    "type": "string",
    "value": "Six months"
  },
  "premium_period_months": {
    "source": "6",
    "value": 6,
    "type": "number"
  }
}