Mappings

Mapping is the process of defining how a transaction, and the properties it contains, are read, sorted, filtered and rendered.

Mappings are used to define:

• the label for a property
• a property index
• which properties should be treated as text, date or number
• the format of values
• custom rules to control filtering and sorting

Properties

All properties are optional unless otherwise indicated.

Mappings

Property	Description
$mapping	Map<Mapping> (Default: null) Required. See Mapping.

Mapping

Property	Description
label	String (Default: null) Required. Text to be displayed as the property label.
dataIndex	String (Default: null) Required. Path for the property to be used by this mapping. Dynamic variables like ${ applicant.key } can be used to support Primary and Secodary applicants.
type	String (Default: null) Required. Type of the property mapped. We currently support the following types: text, date or number.
encoding	String (Default: null) Support encodings: base64.
sorter	Boolean (Default: false) Whether this mapping is sortable. Defaults to false.
filter	Map<Filter> (Default: null) Map that describes the filter strategy for this mapping.
link	Map<Link> (Default: null) Map to the linked property.

Filter

Property	Description
type	String (Default: null) Required. Type of filter to use. Supported filter types: picker, input, select, multiselect.
options	Map<Option, String/List/Map> (Default: null) Options can be a Map, List or String to be passed to the filter component.

Link

Property	Description
type	String (Default: null) Required. Type of property mapped. Supported types: json, xml, html, url, text.
dataIndex	String (Default: null) Required. Path of the property to be used by this link. Dynamic variables like ${ applicant.key } can be used to support Primary and Secondary applicants.

Examples

Mapping with a simple Input filter

{
  "$trackingCode": {
    "label": "Tracking code",
    "dataIndex": "trackingCode",
    "type": "text",
    "filter": {
      "type": "input"
    }
  }
}

Sortable mapping with a multiselect filter

{
  "$status": {
    "label": "Status",
    "dataIndex": "formStatus",
    "type": "text",
    "sorter": true,
    "filter": {
      "type": "multiselect",
      "options": ["Assigned", "Opened"]
    }
  }
}

Sortable mapping with a date picker filter

{
  "$stepAge": {
    "label": "Step age",
    "dataIndex": "timeRequest",
    "type": "date",
    "format": "relative",
    "sorter": true,
    "filter": {
      "type": "picker",
      "options": {
        "minDate": "{{ date('1 month ago') }}",
        "maxDate": "{{ date('today') }}"
      }
    }
  }
}

Dynamic mapping with an HTML link to be used in the Integrations card

{
  "$qualfile": {
    "label": "Qualfile",
    "dataIndex": "properties['FisQualiFile.${ applicant.key }.accountAcceptanceTxt']",
    "type": "text",
    "link": {
      "dataIndex": "properties['FisQualiFile.${ applicant.key }.htmlReport']",
      "type": "html"
    }
  }
}