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 (accessed by navigating to 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 stores 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.

Attributes

For a list of supported attributes, see Reference > ConfigGlobal.

Example

The following example demonstrates all of the available configuration options. The available attributes are listed in the API reference.

For a list of available icons and their names, see Icons.

Global config

{
  "theme": {
    "primary": {
      "main": "#025197"
    },
    "accent": {
      "main": "#715C95"
    }
  },
  "hideSteps": ["Helpdesk View"],
  "locales": ["en"],
  "currentLocale": "en",
  "spaces": [
    {
      "label": "Process",
      "icon": "BallotOutlined",
      "value": "Process",
      "permissions": {
        "type": "role",
        "value": ["Processing Staff", "Work Spaces Staff"]
      }
    },
    {
      "label": "Helpdesk",
      "icon": "HeadsetOutlined",
      "value": "Helpdesk",
      "permissions": {
        "type": "role",
        "value": ["Helpdesk Staff", "Work Spaces Staff"]
      }
    },
    {
      "label": "Assisted Channel",
      "icon": "AccessibilityNewOutlined",
      "value": "Assist Channel",
      "permissions": {
        "type": "role",
        "value": ["Assisted Channel Staff", "Work Spaces Staff"]
      }
    },
    {
      "label": "Manage",
      "icon": "SupervisedUserCircleOutlined",
      "value": "Manage",
      "permissions": {
        "type": "role",
        "value": ["Manager", "Work Spaces Staff"]
      }
    }
  ],
  "currentSpace": "Process",
  "mappings": {
    "$applicants": {
      "label": "Applicants",
      "icon": "PermIdentityTwoTone",
      "type": "tableExtended",
      "dataSource": "properties['ApplicantsData']",
      "properties": [
        {
          "label": "Status",
          "dataIndex": "checkStatus",
          "type": "alert"
        },
        {
          "label": "Name",
          "dataIndex": "name",
          "type": "text"
        },
        {
          "label": "Email",
          "dataIndex": "email",
          "type": "text"
        }
      ],
      "sections": [
        {
          "label": "Personal Info",
          "type": "list",
          "properties": [
            {
              "label": "Name",
              "dataIndex": "name",
              "type": "text",
              "fullWidth": true
            },
            {
              "label": "SSN",
              "dataIndex": "ssn",
              "type": "text"
            },
            {
              "label": "Email",
              "dataIndex": "email",
              "type": "text"
            }
          ]
        },
        {
          "label": "Applicant Background Checks",
          "type": "listExtended",
          "statusColors": {
            "Black": ["HARDFAIL"],
            "LightGreen": ["LOW"],
            "Green": ["VERIFIED", "PASSED", "ACCEPT", "APPROVE", "TRUSTED", "PASS"],
            "Red": ["FAILED", "DECLINE", "HIGH", "FAIL"],
            "Blue": ["REVIEW", "NEUTRAL", "UNVERIFIED"],
            "Orange": ["INSUFFICIENT", "MEDIUM"]
          },
          "properties": [
            {
              "label": "FIS Chexsystems",
              "properties": [
                {
                  "label": "IDA",
                  "dataIndex": "integrations.[0].properties[0].value",
                  "type": "text"
                },
                {
                  "label": "Qualfile",
                  "dataIndex": "integrations.[0].properties[1].value",
                  "type": "text",
                  "link": {
                    "dataIndex": "integrations.[1].name",
                    "type": "html"
                  }
                }
              ]
            },
            {
              "label": "Threat Metrix",
              "properties": [
                {
                  "label": "DECISION",
                  "dataIndex": "integrations.[1].items[0].value",
                  "type": "text"
                },
                {
                  "label": "RISK RATING",
                  "dataIndex": "integrations.[1].items[1].value",
                  "type": "text",
                  "link": {
                    "dataIndex": "integrations.[1].items[1].link",
                    "type": "html"
                  }
                },
                {
                  "label": "SCORE",
                  "dataIndex": "integrations.[1].items[2].value",
                  "type": "number"
                },
                {
                  "label": "JSON",
                  "dataIndex": "integrations.[1].items[3].value",
                  "type": "text",
                  "link": {
                    "dataIndex": "integrations.[1].items[3].link",
                    "type": "json",
                    "encoding": "base64"
                  }
                },
                {
                  "label": "XML",
                  "dataIndex": "integrations.[1].items[4].value",
                  "type": "text",
                  "link": {
                    "dataIndex": "integrations.[1].items[4].link",
                    "type": "xml"
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "$guarantorApplicant": {
      "label": "Guarantor",
      "type": "listStacked",
      "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"
        }
      ]
    },
    "$primaryApplicant": {
      "label": "Applicants",
      "type": "list",
      "properties": [
        {
          "label": "Primary",
          "properties": [
            {
              "label": "Type",
              "dataIndex": ["properties['PrimaryType']", "formDataMap['PrimaryType']"],
              "type": "text"
            },
            {
              "label": "Name",
              "dataIndex": ["properties['PrimaryName']", "formDataMap['PrimaryName']"],
              "type": "text"
            },
            {
              "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"
            }
          ]
        },
        {
          "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"
            }
          ]
        }
      ]
    },
    "$backgroundChecks": {
      "label": "Background Checks",
      "type": "listExtended",
      "icon": "VerifiedUserTwoTone",
      "statusColors": {
        "Black": ["HARDFAIL"],
        "LightGreen": ["LOW"],
        "Green": ["VERIFIED", "PASSED", "ACCEPT", "APPROVE", "TRUSTED", "PASS"],
        "Red": ["FAILED", "DECLINE", "HIGH", "FAIL"],
        "Blue": ["REVIEW", "NEUTRAL", "UNVERIFIED"],
        "Orange": ["INSUFFICIENT", "MEDIUM"]
      },
      "properties": [
        {
          "label": "FIS Chexsystems",
          "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": "TIN Check",
          "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": "Threat Metrix",
          "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"
            }
          ]
        }
      ]
    },
    "$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"]
      }
    },
    "$beneficiary": {
      "label": "Beneficiary",
      "icon": "InfoTwoTone",
      "type": "list",
      "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",
      "type": "table",
      "dataSource": "properties['EmailList']",
      "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": "VerifiedUserTwoTone",
      "type": "table",
      "dataSource": "properties['GenericContent']",
      "properties": [
        {
          "label": "Type",
          "dataIndex": "type",
          "type": "text"
        },
        {
          "label": "View report",
          "link": {
            "dataIndex": "htmlContent",
            "type": "html",
            "encoding": "base64"
          }
        },
        {
          "label": "View JSON",
          "link": {
            "dataIndex": "jsonContent",
            "type": "json",
            "encoding": "base64"
          }
        },
        {
          "label": "View XML",
          "link": {
            "dataIndex": "xmlContent",
            "type": "xml",
            "encoding": "base64"
          }
        },
        {
          "label": "View PDF",
          "link": {
            "dataIndex": "pdfContent",
            "type": "pdf"
          }
        }
      ]
    },
    "$taskSla": {
      "label": "SLA",
      "dataIndex": "properties['taskSla']",
      "type": "alert",
      "warning": "1 week",
      "filter": {
        "type": "picker",
        "options": {
          "minDate": "{{ date('1 month ago') }}",
          "maxDate": "{{ date('now') }}"
        }
      }
    }
  }
}