Mappings

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

You can use mappings 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

Example

Mappings config

{
  "mappings": {
    "$primaryApplicantSection": {
      "label": "Primary",
      "dataSource": "properties['Applicants']",
      "properties": [
        {
          "label": "Name",
          "dataIndex": "[0].extracts['PrimaryName']",
          "type": "text",
          "filter": {
            "type": "input"
          }
        },
        {
          "label": "Email",
          "dataIndex": "[0].extracts['PrimaryEmail']",
          "type": "text"
        },
        {
          "label": "SSN #",
          "dataIndex": "[0].extracts['PrimarySSN']",
          "type": "text"
        }
      ]
    },
    "$fisChexsystems": {
      "label": "FIS Chexsystems",
      "properties": [
        {
          "label": "Primary",
          "properties": [
            {
              "label": "IDA",
              "dataIndex": "properties['FisIda.PrimaryApplicant.verifyStatus']",
              "type": "text"
            },
            {
              "label": "IDV",
              "dataIndex": "properties['FisIdv.PrimaryApplicant.idvVerifyStatus']",
              "type": "text",
              "link": {
                "dataIndex": "properties['FisIdv.PrimaryApplicant.htmlReport']",
                "type": "html"
              }
            },
            {
              "label": "OFAC",
              "dataIndex": "properties['FisIdv.PrimaryApplicant.ofacStatus']",
              "type": "text"
            },
            {
              "label": "Qualfile",
              "dataIndex": "properties['FisQualiFile.PrimaryApplicant.accountAcceptanceTxt']",
              "type": "text",
              "link": {
                "dataIndex": "properties['FisQualiFile.PrimaryApplicant.htmlReport']",
                "type": "html"
              }
            }
          ]
        },
        {
          "label": "Secondary",
          "properties": [
            {
              "label": "IDA",
              "dataIndex": "properties['FisIda.SecondaryApplicant.verifyStatus']",
              "type": "text"
            },
            {
              "label": "IDV",
              "dataIndex": "properties['FisIdv.SecondaryApplicant.idvVerifyStatus']",
              "type": "text",
              "link": {
                "dataIndex": "properties['FisIdv.SecondaryApplicant.htmlReport']",
                "type": "html"
              }
            },
            {
              "label": "OFAC",
              "dataIndex": "properties['FisIdv.SecondaryApplicant.ofacStatus']",
              "type": "text"
            },
            {
              "label": "Qualfile",
              "dataIndex": "properties['FisQualiFile.SecondaryApplicant.accountAcceptanceTxt']",
              "type": "text",
              "link": {
                "dataIndex": "properties['FisQualiFile.SecondaryApplicant.htmlReport']",
                "type": "html"
              }
            }
          ]
        }
      ]
    },
    "$tinCheck": {
      "label": "TIN check",
      "properties": [
        {
          "label": "Primary",
          "dataSource": "properties['Integrations']",
          "properties": [
            {
              "label": "TIN verification",
              "dataIndex": "[0]['Data']['ApplicationResult']",
              "type": "text",
              "link": {
                "dataIndex": "[0]['Data']['ApplicantResultResponse']",
                "type": "json",
                "encoding": "base64"
              }
            }
          ]
        },
        {
          "label": "Secondary",
          "dataSource": "properties['Integrations']",
          "properties": [
            {
              "label": "TIN verification",
              "dataIndex": "[1]['Data']['ApplicationResult']",
              "type": "text"
            }
          ]
        }
      ]
    },
    "$genericContent": {
      "label": "Applicant validations",
      "dataSource": "properties['GenericContent']",
      "type": "json",
      "foreach": true,
      "properties": [
        {
          "label": "Type",
          "dataIndex": "type",
          "type": "text"
        },
        {
          "label": "View report",
          "type": "text",
          "link": {
            "dataIndex": "htmlContent",
            "type": "html",
            "encoding": "base64"
          }
        },
        {
          "label": "View JSON",
          "type": "text",
          "link": {
            "dataIndex": "jsonContent",
            "type": "json",
            "encoding": "base64"
          }
        },
        {
          "label": "View XML",
          "type": "text",
          "link": {
            "dataIndex": "xmlContent",
            "type": "xml",
            "encoding": "base64"
          }
        },
        {
          "label": "View PDF",
          "link": {
            "dataIndex": "pdfContent",
            "type": "pdf"
          }
        }
      ]
    },
    "$taskId": {
      "label": "Task ID",
      "icon": "TaskID",
      "dataIndex": "job.jobRefNumber",
      "type": "text",
      "filter": {
        "type": "input"
      }
    },
    "$product": {
      "label": "Product",
      "dataIndex": ["job.name", "formName"],
      "type": "text",
      "filter": {
        "type": "select",
        "options": [
          "DAO - Manual Review",
          "Review of deposit account opening",
          "Review of loan application"
        ]
      }
    },
    "$primaryApplicant": {
      "label": "Name",
      "dataIndex": ["properties['PrimaryName']", "formDataMap['PrimaryName']"],
      "type": "text",
      "filter": {
        "type": "input"
      }
    },
    "$primaryEmail": {
      "label": "Email",
      "dataIndex": "properties['PrimaryEmail']",
      "type": "text"
    },
    "$primarySSN": {
      "label": "SSN #",
      "dataIndex": "properties['PrimarySSN']",
      "type": "text"
    },
    "$secondaryApplicant": {
      "label": "Name",
      "dataIndex": "properties['SecondaryName']",
      "type": "text"
    },
    "$secondaryEmail": {
      "label": "Email",
      "dataIndex": "properties['SecondaryEmail']",
      "type": "text"
    },
    "$secondarySSN": {
      "label": "SSN #",
      "dataIndex": "properties['SecondarySSN']",
      "type": "text"
    },
    "$fundingType": {
      "label": "Funding type",
      "dataIndex": "properties['FundingType']",
      "type": "text"
    },
    "$fundingAmount": {
      "label": "Funding amount",
      "dataIndex": "properties['FundingAmount']",
      "type": "text"
    },
    "$score": {
      "label": "Score",
      "dataIndex": "properties['ThreatMetrixScore.PrimaryApplicant']",
      "type": "number"
    },
    "$riskRating": {
      "label": "Risk rating",
      "dataIndex": "properties['ThreatMetrixRiskRating.PrimaryApplicant']",
      "type": "text"
    },
    "$decision": {
      "label": "Decision",
      "dataIndex": "properties['ThreatMetrixDecision.PrimaryApplicant']",
      "type": "text",
      "link": {
        "dataIndex": "properties['ThreatMetrixQueryResponse.PrimaryApplicant']",
        "type": "json"
      }
    },
    "$secondaryScore": {
      "label": "Score",
      "dataIndex": "properties['ThreatMetrixScore.SecondaryApplicant']",
      "type": "number"
    },
    "$secondaryRiskRating": {
      "label": "Risk rating",
      "dataIndex": "properties['ThreatMetrixRiskRating.SecondaryApplicant']",
      "type": "text"
    },
    "$secondaryDecision": {
      "label": "Decision",
      "dataIndex": "properties['ThreatMetrixDecision.SecondaryApplicant']",
      "type": "text",
      "link": {
        "dataIndex": "properties['ThreatMetrixQueryResponse.SecondaryApplicant']",
        "type": "json"
      }
    },
    "$taskStatus": {
      "label": "Task status",
      "icon": "TaskStatus",
      "dataIndex": ["job.currentStep", "formStatus"],
      "type": "text",
      "sorter": true,
      "filter": {
        "type": "multiselect",
        "options": ["Assigned", "Opened", "Saved", "Completed"]
      }
    },
    "$taskCreated": {
      "label": "Task created",
      "icon": "TaskCreated",
      "dataIndex": "timeCreated",
      "type": "date",
      "format": "relative",
      "sorter": true
    },
    "$assigned": {
      "label": "Assigned to",
      "icon": "Assignee",
      "dataIndex": "userLoginName",
      "type": "text",
      "sorter": true,
      "filter": {
        "type": "multiselect",
        "options": ["[email protected]", "[email protected]"]
      }
    },
    "$taskModified": {
      "label": "Task modified",
      "icon": "LastModified",
      "dataIndex": ["job.timeLastModified", "timeUserLastModified"],
      "type": "date",
      "sorter": true,
      "filter": {
        "type": "picker",
        "options": {
          "minDate": "{{ date('1 month ago') }}",
          "maxDate": "{{ date('now') }}"
        }
      }
    },
    "$appModified": {
      "label": "App modified",
      "icon": "LastModified",
      "dataIndex": "job.timeLastModified",
      "type": "date",
      "sorter": true,
      "filter": {
        "type": "picker",
        "options": {
          "minDate": "{{ date('1 month ago') }}",
          "maxDate": "{{ date('now') }}"
        }
      }
    },
    "$appId": {
      "label": "App ID",
      "icon": "Transaction",
      "dataIndex": ["job.jobRefNumber", "trackingCode"],
      "type": "text",
      "filter": {
        "type": "input"
      }
    },
    "$appStatus": {
      "label": "App status",
      "icon": "AppStatus",
      "dataIndex": "job.status",
      "type": "text",
      "sorter": true,
      "filter": {
        "type": "multiselect",
        "options": ["Saved", "Opened", "Abandoned"]
      }
    },
    "$appCreated": {
      "label": "App created",
      "icon": "AppCreated",
      "dataIndex": "job.timeCreated",
      "type": "date",
      "format": "relative",
      "sorter": true
    }
  }
}

Properties

Mappings

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

Mapping

Property	Description
label	String (Default: null) Required. Text to be displayed as the property label.
icon	String (Default: null) An icon name from the Workspaces Storybook Icon Set.
dataSource	String (Default: null) Used to define a deep data source. The value of this property must be formatted as a JSON string.
properties	Array<Mapping> (Default: []) Required. A list of Mapping objects or Mapping keys.
dataIndex	String (Default: null) The path of the property to be used by this mapping.
type	String (Default: null) The type of the property mapped. The following mapping types are supported: text, date, number.
encoding	String (Default: null) The following encodings are supported: base64.
sorter	Boolean (Default: false) Whether this mapping is sortable.
filter	Object<Filter> (Default: null) A map that describes the filter strategy for this mapping.
link	Object<Link> (Default: null) A map to the linked property.

Filter

Property	Description
type	String (Default: null) Required. The type of filter to use. The following filter types are supported: picker, input, select, multiselect.
options	Object<Option, String/List/Map> (Default: null) Options to pass to the filter component. Options can be a Map, List or String.

Link

Property	Description
type	String (Default: null) Required. The type of the property mapped. The following types are supported: json, xml, html, url, text.
dataIndex	String (Default: null) Required. The path of the property to be used by this link.