Version: 19.05 (EOL)
Global
The Global config is a JSON object that defines the global state of the Workspaces application. The JSON definition is loaded from the Global property (located in JM > Forms > Form Spaces then Work Spaces > Properties) when Workspaces first runs. For more information about form space properties, see Configure Form Space Properties. Once Workspaces has run, it will store the current state in the client, to be used across the current and subsequent Workspaces sessions.
The following example demonstrates all of the available configuration options.
tip
You can find a list of available icons and their names on https://<your_domain>/workspaces/secure/storybook/index.html in the Icon Set section.
Example
Global config
{
"theme": {
"primary": {
"main": "#025197"
},
"accent": {
"main": "#715C95"
}
},
"hideSteps": ["Helpdesk View"],
"locales": ["en"],
"currentLocale": "en",
"spaces": [
{
"label": "Process",
"icon": "BallotOutlined",
"value": "Process",
"roles": ["Processing Staff", "Work Spaces Staff"]
},
{
"label": "Helpdesk",
"icon": "HeadsetOutlined",
"value": "Helpdesk",
"roles": ["Helpdesk Staff", "Work Spaces Staff"]
},
{
"label": "Assisted Channel",
"icon": "AccessibilityNewOutlined",
"value": "Assist Channel",
"roles": ["Assisted Channel Staff", "Work Spaces Staff"]
},
{
"label": "Manage",
"icon": "SupervisedUserCircleOutlined",
"value": "Manage",
"roles": ["Manager", "Work Spaces Staff"]
}
],
"currentSpace": "Process",
"mappings": {
"$primaryName": {
"label": "Primary applicant",
"icon": "PersonOutlineOutlined",
"dataIndex": ["properties['PrimaryName']", "formDataMap['PrimaryName']"],
"type": "text",
"sorter": false,
"filter": {
"type": "input"
}
},
"$appId": {
"label": "App ID",
"icon": "FontDownloadOutlined",
"dataIndex": ["job.jobRefNumber", "trackingCode"],
"type": "text",
"sorter": false,
"filter": {
"type": "input"
}
},
"$product": {
"label": "Product",
"icon": "WorkOutlineOutlined",
"dataIndex": ["job.name", "formName"],
"type": "text",
"sorter": false,
"filter": {
"type": "input"
}
},
"$currentQueue": {
"label": "Current queue",
"icon": "FlagOutlined",
"dataIndex": "groupName",
"type": "text",
"sorter": true,
"filter": {
"type": "multiselect",
"options": ["Error Review", "Fraud Review", "Manual Review"]
}
},
"$appAge": {
"label": "App age",
"icon": "EventOutlined",
"dataIndex": "job.timeCreated",
"type": "date",
"format": "relative",
"sorter": true,
"filter": {
"type": "picker",
"options": {
"minDate": "{{ date('1 month ago') }}",
"maxDate": "{{ date('now') }}"
}
}
},
"$assigned": {
"label": "Assigned to",
"icon": "AccountCircleOutlined",
"dataIndex": "userLoginName",
"type": "text",
"sorter": true,
"filter": {
"type": "multiselect",
"options": [
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]",
"[email protected]"
]
}
},
"$currentStep": {
"label": "Current Step",
"icon": "TaskID",
"dataIndex": "job.currentStep",
"type": "text",
"sorter": false
},
"$currentTask": {
"label": "Current task",
"icon": "TaskID",
"dataIndex": "formName",
"type": "text",
"sorter": false
},
"$taskCreated": {
"label": "Task Created",
"icon": "TaskCreated",
"dataIndex": "timeCreated",
"type": "date",
"format": "relative",
"sorter": true,
"filter": {
"type": "picker",
"options": {
"minDate": "{{ date('1 month ago') }}",
"maxDate": "{{ date('now') }}"
}
}
},
"$appLastModified": {
"label": "Last modified",
"icon": "LastModified",
"dataIndex": "job.timeLastModified",
"type": "date",
"sorter": false,
"filter": {
"type": "picker",
"options": {
"minDate": "{{ date('1 month ago') }}",
"maxDate": "{{ date('now') }}"
}
}
},
"$formLastModified": {
"label": "Last modified",
"icon": "LastModified",
"dataIndex": ["timeUserLastModified"],
"type": "date",
"sorter": true,
"filter": {
"type": "picker",
"options": {
"minDate": "{{ date('1 month ago') }}",
"maxDate": "{{ date('now') }}"
}
}
},
"$appStatus": {
"label": "App status",
"icon": "AppStatus",
"dataIndex": "job.status",
"type": "text",
"sorter": false
},
"$taskStatus": {
"label": "Task Status",
"icon": "TaskStatus",
"dataIndex": "formStatus",
"type": "text",
"sorter": true,
"filter": {
"type": "multiselect",
"options": ["Assigned", "Opened", "Saved", "Completed", "Abandoned"]
}
},
"$dateOfBirth": {
"label": "Date of birth",
"dataIndex": ["properties['PrimaryDOB']", "formDataMap['PrimaryDOB']"],
"type": "text",
"sorter": false,
"filter": {
"type": "input"
}
},
"$SSN": {
"label": "SSN #",
"dataIndex": ["properties['PrimarySSN']", "formDataMap['PrimarySSN']"],
"type": "text",
"sorter": false,
"filter": {
"type": "input"
}
},
"$email": {
"label": "Email",
"dataIndex": [
"properties['PrimaryEmail']",
"formDataMap['PrimaryEmail']"
],
"type": "text",
"sorter": false,
"filter": {
"type": "input"
}
},
"$phone": {
"label": "Phone #",
"dataIndex": [
"properties['PrimaryPhone']",
"formDataMap['PrimaryPhone']"
],
"type": "text",
"sorter": false,
"filter": {
"type": "input"
}
},
"$appSubmitted": {
"label": "App submitted",
"dataIndex": "job.timeCreated",
"type": "date",
"sorter": true,
"filter": {
"type": "picker",
"options": {
"minDate": "{{ date('1 month ago') }}",
"maxDate": "{{ date('now') }}"
}
}
},
"$appCreated": {
"label": "App created",
"dataIndex": "timeCreated",
"type": "date",
"sorter": true,
"filter": {
"type": "picker",
"options": {
"minDate": "{{ date('1 month ago') }}",
"maxDate": "{{ date('now') }}"
}
}
},
"$formStatus": {
"label": "Form status",
"icon": "TaskStatus",
"dataIndex": "formStatus",
"type": "text",
"sorter": true,
"filter": {
"type": "multiselect",
"options": ["Assigned", "Opened", "Saved", "Completed", "Abandoned"]
}
},
"$primaryApplicant": {
"label": "Primary",
"properties": [
{
"label": "Type",
"dataIndex": [
"properties['PrimaryType']",
"formDataMap['PrimaryType']"
],
"type": "text"
},
{
"label": "Name",
"dataIndex": [
"properties['PrimaryName']",
"formDataMap['PrimaryName']"
],
"type": "text",
"filter": {
"type": "input"
}
},
{
"label": "SSN #",
"dataIndex": [
"properties['PrimarySSN']",
"formDataMap['PrimarySSN']"
],
"type": "text"
},
{
"label": "Email",
"dataIndex": [
"properties['PrimaryEmail']",
"formDataMap['PrimaryEmail']"
],
"type": "text"
},
{
"label": "Date of Birth",
"dataIndex": [
"properties['PrimaryDOB']",
"formDataMap['PrimaryDOB']"
],
"type": "text"
},
{
"label": "Phone #",
"dataIndex": [
"properties['PrimaryPhone']",
"formDataMap['PrimaryPhone']"
],
"type": "text"
}
]
},
"$secondaryApplicant": {
"label": "Secondary",
"properties": [
{
"label": "Type",
"dataIndex": [
"properties['SecondaryType']",
"formDataMap['SecondaryType']"
],
"type": "text"
},
{
"label": "Name",
"dataIndex": [
"properties['SecondaryName']",
"formDataMap['SecondaryName']"
],
"type": "text"
},
{
"label": "SSN #",
"dataIndex": [
"properties['SecondarySSN']",
"formDataMap['SecondarySSN']"
],
"type": "text"
},
{
"label": "Email",
"dataIndex": [
"properties['SecondaryEmail']",
"formDataMap['SecondaryEmail']"
],
"type": "text"
},
{
"label": "Date of Birth",
"dataIndex": [
"properties['SecondaryDOB']",
"formDataMap['SecondaryDOB']"
],
"type": "text"
},
{
"label": "Phone #",
"dataIndex": [
"properties['SecondaryPhone']",
"formDataMap['SecondaryPhone']"
],
"type": "text"
}
]
},
"$guarantorApplicant": {
"label": "Guarantor",
"properties": [
{
"label": "Type",
"dataIndex": [
"properties['GuarantorType']",
"formDataMap['GuarantorType']"
],
"type": "text"
},
{
"label": "Name",
"dataIndex": [
"properties['GuarantorName']",
"formDataMap['GuarantorName']"
],
"type": "text"
},
{
"label": "SSN #",
"dataIndex": [
"properties['GuarantorSSN']",
"formDataMap['GuarantorSSN']"
],
"type": "text"
},
{
"label": "Email",
"dataIndex": [
"properties['GuarantorEmail']",
"formDataMap['GuarantorEmail']"
],
"type": "text"
},
{
"label": "Date of Birth",
"dataIndex": [
"properties['GuarantorDOB']",
"formDataMap['GuarantorDOB']"
],
"type": "text"
},
{
"label": "Phone #",
"dataIndex": [
"properties['GuarantorPhone']",
"formDataMap['GuarantorPhone']"
],
"type": "text"
}
]
},
"$threatmetrix": {
"label": "Threat metrix",
"properties": [
{
"label": "Primary",
"properties": [
{
"label": "Score",
"dataIndex": [
"properties['ThreatMetrixScore.PrimaryApplicant']",
"formDataMap['ThreatMetrixScore.PrimaryApplicant']"
],
"type": "number"
},
{
"label": "Decision",
"dataIndex": [
"properties['ThreatMetrixDecision.PrimaryApplicant']",
"formDataMap['ThreatMetrixDecision.PrimaryApplicant']"
],
"type": "text",
"link": {
"dataIndex": [
"properties['ThreatMetrixQueryResponse.PrimaryApplicant']",
"formDataMap['ThreatMetrixQueryResponse.PrimaryApplicant']"
],
"type": "json"
}
},
{
"label": "Risk rating",
"dataIndex": [
"properties['ThreatMetrixRiskRating.PrimaryApplicant']",
"formDataMap['ThreatMetrixRiskRating.PrimaryApplicant']"
],
"type": "text"
}
]
},
{
"label": "Secondary",
"properties": [
{
"label": "Score",
"dataIndex": [
"properties['ThreatMetrixScore.SecondaryApplicant']",
"formDataMap['ThreatMetrixScore.SecondaryApplicant']"
],
"type": "number"
},
{
"label": "Decision",
"dataIndex": [
"properties['ThreatMetrixDecision.SecondaryApplicant']",
"formDataMap['ThreatMetrixDecision.SecondaryApplicant']"
],
"type": "text",
"link": {
"dataIndex": [
"properties['ThreatMetrixQueryResponse.SecondaryApplicant']",
"formDataMap['ThreatMetrixQueryResponse.SecondaryApplicant']"
],
"type": "json"
}
},
{
"label": "Risk rating",
"dataIndex": [
"properties['ThreatMetrixRiskRating.SecondaryApplicant']",
"formDataMap['ThreatMetrixRiskRating.SecondaryApplicant']"
],
"type": "text"
}
]
},
{
"label": "Guarantor",
"properties": [
{
"label": "Score",
"dataIndex": [
"properties['ThreatMetrixScore.Guarantor']",
"formDataMap['ThreatMetrixScore.Guarantor']"
],
"type": "number"
},
{
"label": "Decision",
"dataIndex": [
"properties['ThreatMetrixDecision.Guarantor']",
"formDataMap['ThreatMetrixDecision.Guarantor']"
],
"type": "text",
"link": {
"dataIndex": [
"properties['ThreatMetrixQueryResponse.Guarantor']",
"formDataMap['ThreatMetrixQueryResponse.Guarantor']"
],
"type": "json"
}
},
{
"label": "Risk rating",
"dataIndex": [
"properties['ThreatMetrixRiskRating.Guarantor']",
"formDataMap['ThreatMetrixRiskRating.Guarantor']"
],
"type": "text"
}
]
}
]
},
"$tincheck": {
"label": "TIN check",
"properties": [
{
"label": "Primary",
"properties": [
{
"label": "TIN verification",
"dataIndex": [
"properties['TINCheckResult.Primary.result']",
"formDataMap['TINCheckResult.Primary.result']"
],
"type": "text",
"link": {
"dataIndex": [
"properties['TINCheckSOAPReponse.Primary.result']",
"formDataMap['TINCheckSOAPReponse.Primary.result']"
],
"type": "xml"
}
}
]
},
{
"label": "Secondary",
"properties": [
{
"label": "TIN verification",
"dataIndex": [
"properties['TINCheckResult.Joint.result']",
"formDataMap['TINCheckResult.Joint.result']"
],
"type": "text",
"link": {
"dataIndex": [
"properties['TINCheckSOAPReponse.Joint.result']",
"formDataMap['TINCheckSOAPReponse.Joint.result']"
],
"type": "xml"
}
}
]
},
{
"label": "Guarantor",
"properties": [
{
"label": "TIN verification",
"dataIndex": [
"properties['TINCheckResult.Guarantor.result']",
"formDataMap['TINCheckResult.Guarantor.result']"
],
"type": "text",
"link": {
"dataIndex": [
"properties['TINCheckSOAPReponse.Guarantor.result']",
"formDataMap['TINCheckSOAPReponse.Guarantor.result']"
],
"type": "xml"
}
}
]
}
]
},
"$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"
}
}
]
},
{
"label": "Guarantor",
"properties": [
{
"label": "IDA",
"dataIndex": "properties['FisIda.Guarantor.verifyStatus']",
"type": "text"
},
{
"label": "IDV",
"dataIndex": "properties['FisIdv.Guarantor.idvVerifyStatus']",
"type": "text",
"link": {
"dataIndex": "properties['FisIdv.Guarantor.htmlReport']",
"type": "html"
}
},
{
"label": "OFAC",
"dataIndex": "properties['FisIdv.Guarantor.ofacStatus']",
"type": "text"
},
{
"label": "Qualfile",
"dataIndex": "properties['FisQualiFile.Guarantor.accountAcceptanceTxt']",
"type": "text",
"link": {
"dataIndex": "properties['FisQualiFile.Guarantor.htmlReport']",
"type": "html"
}
}
]
}
]
},
"$beneficiary": {
"label": "Beneficiary",
"icon": "InfoTwoTone",
"properties": [
{
"label": "Type",
"dataIndex": [
"properties['BeneficiaryType']",
"formDataMap['BeneficiaryType']"
],
"type": "text"
},
{
"label": "Name",
"dataIndex": [
"properties['BeneficiaryName']",
"formDataMap['BeneficiaryName']"
],
"type": "text"
},
{
"label": "SSN #",
"dataIndex": [
"properties['BeneficiarySSN']",
"formDataMap['BeneficiarySSN']"
],
"type": "text"
},
{
"label": "Email",
"dataIndex": [
"properties['BeneficiaryEmail']",
"formDataMap['BeneficiaryEmail']"
],
"type": "text"
},
{
"label": "Date of Birth",
"dataIndex": [
"properties['BeneficiaryDOB']",
"formDataMap['BeneficiaryDOB']"
],
"type": "text"
},
{
"label": "Phone #",
"dataIndex": [
"properties['BeneficiaryPhone']",
"formDataMap['BeneficiaryPhone']"
],
"type": "text"
}
]
},
"$sentEmails": {
"label": "Sent emails",
"icon": "InfoTwoTone",
"dataSource": "properties['EmailList']",
"foreach": true,
"properties": [
{
"label": "Date sent",
"dataIndex": "dateAttempted",
"type": "date"
},
{
"label": "Info",
"dataIndex": "name",
"type": "text"
},
{
"label": "Delivery status",
"dataIndex": "emailSent",
"type": "text"
},
{
"label": "Follow up",
"dataIndex": "followUp",
"type": "text"
}
]
},
"$applicantValidations": {
"label": "Applicant validations",
"icon": "InfoTwoTone",
"dataSource": "properties['GenericContent']",
"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"
}
}
]
}
}
}
Properties
All properties are optional unless otherwise indicated.
Global
| Property | Description |
|---|---|
theme | Object<Theme> (Default: null)Default theme color definitions. |
spaces | Array<Space> (Default: [])List of space configurations, used to set the |
currentSpace | String (Default: null)Required. Space value to be used as the default current space. |
locales | Array<String> (Default: [])List of locale values used to fetch the corresponding locale file. |
currentLocale | String (Default: en)Locale value to be used as the default locale. |
hideSteps | Array<String> (Default: [])List of Step names from JM Collaboration Job configuration. |
mappings | Object<Mapping> (Default: null)Required. Map of mappings. |
Space
| Property | Description |
|---|---|
label | String (Default: null)Required. Text to be displayed as the menu item. |
icon | String (Default: null)Required. Icon name from the Workspaces Storybook |
value | String (Default: null)Required. Name of the space property on JM. |
roles | Array<String> (Default: [])Required if |
groups | Array<String> (Default: [])Required if |