Global

The global configuration is where we store global definitions for the Workspaces form. Once deployed it will become the default state in the client, used across the current and subsequent Workspaces sessions.

tip

Some text editors, such as VS Code (which has excellent TypeScript support), can show hints in the editor indicating the available attributes. For example, in VS Code, Ctrl + Space brings up contextual hints about the attributes available, and whether they are for CurrentSpace config or Global config.

Properties

All properties are optional unless otherwise specified.

Property	Description
modalPopoutDisabled	boolean Controls whether the open_in_new Pop Out button on modal windows is available. To learn more, see modalPopoutDisabled.

To review the full list of supported properties, see API Reference.

tip

Some properties define an icon to display. For a list of supported icon names, see Icons.

modalPopoutDisabled

The modalPopoutDisabled property controls whether the open_in_new Pop Out button that allows a form to be opened in a new browser tab appears on modal windows. When set to true, the open_in_new Pop Out button is not available on modal windows.

Example

The following example demonstrates all of the configuration options available in the default Journey Applicants global config.

src/configs/default/applicants-global.ts

import { Config } from '@journey-ui/workspaces/build/ap/types';

export const globalConfig = ({ date }: any): Config => ({
  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',
      },
    },
    $backgroundCheckStatus: {
      label: 'Background Checks Status',
      icon: 'CheckRounded',
      dataIndex: ["properties['IntegrationsReview']"],
      type: 'text',
      sorter: false,
      filter: {
        type: 'input',
      },
    },
    $taskSla: {
      label: 'SLA',
      dataIndex: "properties['taskSla']",
      type: 'alert',
      warning: '1 week',
    },
    $slaDate: {
      label: 'SLA Expiry',
      icon: 'EventOutlined',
      dataIndex: "properties['taskSla']",
      type: 'date',
      format: 'relative',
      sorter: false,
    },
    $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: 'daterangepicker',
        options: {
          minDate: date('1 month ago'),
          maxDate: date('now'),
        },
      },
    },
    $assigned: {
      label: 'Assigned to',
      icon: 'AccountCircleOutlined',
      dataIndex: 'userLoginName',
      type: 'text',
      sorter: true,
      filter: {
        type: 'input',
      },
    },
    $currentStep: {
      label: 'App Stage',
      icon: 'TaskID',
      dataIndex: 'job.currentStep',
      type: 'text',
      sorter: false,
    },
    $dataDeleted: {
      label: 'Data Deleted',
      dataIndex: 'dataDeleted',
      type: 'alert',
      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: 'daterangepicker',
        options: {
          minDate: date('1 month ago'),
          maxDate: date('now'),
        },
      },
    },
    $appLastModified: {
      label: 'Last modified',
      icon: 'LastModified',
      dataIndex: 'job.timeLastModified',
      type: 'date',
      sorter: false,
      filter: {
        type: 'daterangepicker',
        options: {
          minDate: date('1 month ago'),
          maxDate: date('now'),
        },
      },
    },
    $formLastModified: {
      label: 'Last modified',
      icon: 'schedule',
      dataIndex: ['timeUserLastModified'],
      type: 'date',
      sorter: true,
      filter: {
        type: 'daterangepicker',
        options: {
          minDate: date('1 month ago'),
          maxDate: date('now'),
        },
      },
    },
    $appStatus: {
      label: 'App status',
      icon: 'AppStatus',
      dataIndex: ['job.status', 'formStatus'],
      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['Primary SSN']", "formDataMap['Primary SSN']"],
      type: 'text',
      sorter: false,
      filter: {
        type: 'input',
      },
    },
    $email: {
      label: 'Email',
      icon: 'mail',
      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: 'daterangepicker',
        options: {
          minDate: date('1 month ago'),
          maxDate: date('now'),
        },
      },
    },
    $appCreated: {
      label: 'App created',
      dataIndex: 'timeCreated',
      type: 'date',
      sorter: true,
      filter: {
        type: 'daterangepicker',
        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'],
      },
    },
    $applicants: {
      label: 'Applicants',
      icon: 'PermIdentityTwoTone',
      type: 'tableExtended',
      hideEmpty: true,
      dataSource: "properties['ApplicationDetails']",
      properties: [
        {
          label: 'Name',
          dataIndex: 'profile.name',
          type: 'text',
        },
        {
          label: 'Email',
          dataIndex: 'profile.email',
          type: 'text',
        },
        {
          label: 'Trust',
          dataIndex: "products['Trust']",
          type: 'text',
        },
        {
          label: 'Super Saver',
          dataIndex: "products['Super Saver']",
          type: 'text',
        },
        {
          label: 'Standard Checking',
          dataIndex: "products['Standard Checking']",
          type: 'text',
        },
      ],
      sections: [
        {
          label: 'Personal Info',
          type: 'list',
          properties: [
            {
              label: 'Full Name',
              dataIndex: 'profile.name',
              type: 'text',
              fullWidth: true,
            },
            {
              label: 'Address',
              dataIndex: 'profile.address',
              type: 'text',
              fullWidth: true,
            },
            {
              label: 'SSN',
              dataIndex: 'profile.ssn',
              type: 'text',
            },
            {
              label: 'Email',
              dataIndex: 'profile.email',
              type: 'text',
            },

            {
              label: 'Phone #',
              dataIndex: 'profile.phone',
              type: 'text',
            },
            {
              label: 'Date of Birth',
              dataIndex: 'profile.dob',
              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',
        },
        {
          label: 'Sent mail',
          type: 'text',
          link: {
            dataIndex: 'emailContent',
            type: 'html',
            encoding: 'base64',
          },
        },
      ],
    },
    $applicantDetails: {
      label: 'Applicant Details',
      icon: 'InfoTwoTone',
      type: 'table',
      dataSource: "properties['GenericContent']",
      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',
          },
        },
      ],
    },
    $reviewChecklist: {
      label: 'Review Checklist',
      type: 'listStacked',
      icon: 'BallotOutlined',
      properties: [
        {
          label: 'Personal Details',
          dataIndex: ["properties['PersonalDetails']"],
          type: 'text',
        },
        {
          label: 'Background Checks',
          dataIndex: ["properties['BackgroundChecks']"],
          type: 'text',
          filter: {
            type: 'input',
          },
        },
        {
          label: 'Attachments',
          dataIndex: ["properties['Attachments']"],
          type: 'text',
        },
        {
          label: 'Remarks',
          dataIndex: ["properties['Remarks']"],
          type: 'text',
        },
      ],
    },
    $customerMessage: {
      label: 'Information Requested',
      icon: 'priority',
      type: 'table',
      hideEmpty: true,
      dataSource: [ "initial.properties['CustomerMessage']"],
      properties: [
        {
          label: 'New',
          dataIndex: 'status',
          type: 'alert',
        },

        {
          label: 'Date',
          dataIndex: 'date',
          type: 'date',
        },
        {
          label: 'Message',
          dataIndex: 'message',
          type: 'text',
        },
 
        {
          label: 'Complete',
          type: 'text',
          link: {
            dataIndex: 'id',
            type: 'invoke',
            icon: 'mark_chat_read',       
            serviceName: 'DAO - Mark as Read',
            versionNumber: '0.1.0',
          },
        },          
      ],
    },    
    $completedMessages: {
      label: 'Completed Actions',
      icon: 'priority',
      type: 'table',
      hideEmpty: true,
      dataSource: [ "initial.properties['CompletedMessages']"],
      properties: [
        {
          label: 'Date',
          dataIndex: 'date',
          type: 'date',
        },
        {
          label: 'Message',
          dataIndex: 'message',
          type: 'text',
        },
      
      ],
    },    
  },
});

export default globalConfig;