Download as pdf or txt
Download as pdf or txt
You are on page 1of 181

Vlocity Government

Copyright 2022 Vlocity LLC, a Salesforce company. All rights reserved. Information in this document is subject to change without
notice. This documentation and the software, tools, templates and other material described in this document (“Vlocity Materials”)
are furnished exclusively under a subscription services agreement or nondisclosure agreement. The Vlocity Materials may be used
or copied only in accordance with the terms of those agreements. No part of the Vlocity Materials may be reproduced, stored in
a retrieval system, or transmitted in any form or any means electronic or mechanical, including photocopying or recording for any
purpose other than the licensee’s personal use as set forth in the applicable agreement without the prior written permission of Vlocity
LLC. Vlocity is a trademark of Vlocity LLC, a Salesforce company, as are other names and marks. Other marks appearing herein may
be trademarks of their respective owners.
Vlocity Government

Table of Contents
Vlocity Government .................................................................................................................... 1

Vlocity Government Release Notes .............................................................................................. 2


Become Familiar with the Data Model .................................................................................. 2
Package Index .................................................................................................................... 2
Government Release Notes Summer '22 .............................................................................. 2
OmniStudio for Vlocity Updates ................................................................................... 2
Government Release Notes Spring '22 ................................................................................. 2
Vlocity Contract Lifecycle Management ........................................................................ 3
OmniStudio for Vlocity Updates ................................................................................... 3
Government Release Notes Winter '22 ................................................................................. 3
Vlocity Contract Lifecycle Management ........................................................................ 3
OmniStudio for Vlocity Updates ................................................................................... 3
2021 Government Release Notes ........................................................................................ 3
Government Release Notes Summer '21 ...................................................................... 3
Government Release Notes Spring '21 ......................................................................... 4
Government Release Notes Winter '21 ........................................................................ 12
2020 Government Release Notes ....................................................................................... 21
Government Release Notes Spring '20 ........................................................................ 21
2019 Government Release Notes ....................................................................................... 35
Government Release Notes Summer '19 ..................................................................... 35
Vlocity Government Winter '19 .................................................................................... 39
2018 Government Release Notes ....................................................................................... 40
Vlocity Government Winter 2018 Version 101.1.1.910.15.2 ........................................... 40
Vlocity Government Release Notes Winter 2018 Version 910.15 ................................... 40
Vlocity Government Winter 2018 ................................................................................. 42
2017 Government Release Notes ....................................................................................... 42
Vlocity Government Summer 2017 .............................................................................. 42
Vlocity Government Spring 2017 ................................................................................. 43
Vlocity Government Winter 2017 ................................................................................. 51
2016 Government Release Notes ....................................................................................... 57
Vlocity Government V15 ............................................................................................. 57
Vlocity Government V14 ............................................................................................. 58
Vlocity Government V13 ............................................................................................. 60
Vlocity Government V12 ............................................................................................. 61

Upgrade Vlocity Government ...................................................................................................... 63


Upgrade to the Latest Vlocity Government Release ............................................................. 63
Confirming System and Salesforce Requirements for Vlocity Government ..................... 63
Pre-Upgrade Tasks for Vlocity Government ................................................................. 64
Upgrading Vlocity Government ................................................................................... 66

© 2022 Vlocity LLC, a Salesforce


company
Vlocity Government

Post-Upgrade Tasks for Vlocity Government ................................................................ 68


Vlocity Government Package Links ..................................................................................... 69
Picklist Values to Add to Vlocity Government Spring '20 ....................................................... 71
Adding Picklist Values ................................................................................................ 73
Upgrade to Vlocity Government Winter '18 .......................................................................... 73
Upgrade Other Vlocity Components .................................................................................... 74

Configure Vlocity Government .................................................................................................... 75


Field Sets .......................................................................................................................... 75
Edit Benefit Case Associations Fields ......................................................................... 75
Edit Incident Association Fields .................................................................................. 75
Edit Service Plan Picker Fields ................................................................................... 76
Edit Outcomes and Steps Fields ................................................................................. 77
Change of Circumstances .................................................................................................. 77
Create a Change of Circumstances Form using an OmniScript ..................................... 77
Set a Change of Circumstances Type ......................................................................... 78
Deploy a Change of Circumstances Form ................................................................... 78
Screening Rules ................................................................................................................ 79
Add a New Screening Rule Group .............................................................................. 79
Add a New Screening Rule ......................................................................................... 79
Add Rule Properties to the Screening Rule .................................................................. 80
Create Classes for Application Screening ............................................................................ 81
Generate the Validator Class ...................................................................................... 81
Edit the Validator Class .............................................................................................. 84
Generate a JSON Parser Class .................................................................................. 87
Generate a Screening Class ....................................................................................... 89
Generic Implementation of Vlocity Custom Classes ...................................................... 92
SmartySteets for Using External Systems for Screening ....................................................... 92
Sign up for SmartyStreets .......................................................................................... 93
Add SmartyStreets Credentials to Vlocity Government ................................................. 93
Cases to Service Requests ................................................................................................ 93
Relabel Cases to Service Requests ............................................................................ 93
Modify the Service Request Picklists ........................................................................... 94
Set Up Benefit Case Types and Stages ............................................................................... 95
Adding Values to Type Picklists ................................................................................... 96
Add Values to Stage Picklists ..................................................................................... 96
Set Up State Transitions ..................................................................................................... 97
Add Stages to the From and To Picklists ..................................................................... 97
Set Field Dependencies Between the From and To Fields ............................................ 97
Modify the Status of Open Activities Picklist ................................................................. 98
Create a New State Transition .................................................................................... 98
Create a New Assessment Template ................................................................................. 100
Creating a New Assessment Question ...................................................................... 102
Add Answers to Assessment Questions .................................................................... 104

© 2022 Vlocity LLC, a Salesforce


company
Vlocity Government

Create Question Tables ............................................................................................ 105


Activity Templates .................................................................................................... 106
Set Up Service Providers ................................................................................................. 109
Configure the Service Provider Account Record ......................................................... 110
Add Values to the Regions Served Picklist ................................................................. 111
Turn Off Matching by Region .................................................................................... 111
Activate Service Provider for Matching ...................................................................... 111
Add Contracts to a Service Provider .......................................................................... 112
Add Sites and Site Offerings to a Service Provider ..................................................... 112
Automate Service Provider Deactivation .................................................................... 112
Operating Hours .............................................................................................................. 113
Create Standard Operating Hours ............................................................................. 113
Create Exceptions to Operating Hours ...................................................................... 113
Create an Operating Hours Template ........................................................................ 114
Vlocity List Overview ........................................................................................................ 114
Define a Vlocity List ................................................................................................. 114
Deploy a Vlocity List ................................................................................................. 115
Use Select Clause to Define Columns in Vlocity List .................................................. 117
Use WHERE Conditions to Determine Applicants Added to a Vlocity List .................... 117
Define a Vlocity List Sort Order ................................................................................. 118
Add Filters to Vlocity Lists ........................................................................................ 118
Set the Number of Records Per Vlocity List Page ....................................................... 118
Document Generation In Vlocity Government .................................................................... 119
Importing the Templates To Create Documents .......................................................... 119
Creating a Document Template ................................................................................. 119
Deploying a Document Template .............................................................................. 120
Import Benefit Cases Using the Salesforce Data Import Wizard .......................................... 120
Restrict Users From Benefits and Incidents Cards ............................................................. 121
Why Do I Receive the "Missing Organization Feature: WorkOrder" Error When Installing
Vlocity Government? ........................................................................................................ 121

Case Management .................................................................................................................. 123


Benefit Cases .................................................................................................................. 123
Benefit Case Tasks .................................................................................................. 123
Benefit Case Task Assignment ................................................................................. 124
View Contacts On a Benefit Case ............................................................................. 125
Update the Benefit Case Layout (Vlocity 2.7) ............................................................. 125
Program Enrollments ....................................................................................................... 126
Program Enrollment Detail ....................................................................................... 126
Eligibility Determination ............................................................................................ 126
Program Enrollment Card ......................................................................................... 126
Enrollment Determinations ............................................................................................... 129
Configure the Parties That Transfer From an Incident to a Benefit Case .............................. 130
Case Management Case Finances Objects ....................................................................... 130

© 2022 Vlocity LLC, a Salesforce


company
Vlocity Government

Account Balance Object and Page Layout ................................................................. 131


Payment Method Object and Page Layout ................................................................. 132
Payment Transaction Object and Page Layout ........................................................... 134
Statement Object and Page Layout ........................................................................... 136
Statement Line Item Object and Page Layout ............................................................ 138
Referral Card ................................................................................................................... 140
Requirements .......................................................................................................... 140
Card Layout ............................................................................................................ 141
Cards ...................................................................................................................... 141

Housing Program Administration ............................................................................................... 142


Manage Buildings and Units ............................................................................................. 142
Building Detail ......................................................................................................... 142
Unit Features ........................................................................................................... 142
Address Information ................................................................................................. 142
Units ....................................................................................................................... 143
Unit Detail ............................................................................................................... 143
Housing Directory Administration .............................................................................. 143
Unit Information ....................................................................................................... 143
Interested Parties .................................................................................................... 144
Unit Images ............................................................................................................. 144
Application for Housing Benefits ....................................................................................... 144
Send Application Data to Salesforce ......................................................................... 145
Integrate Eligibility Calculation .................................................................................. 146
Housing Eligibility Entity Filters ......................................................................................... 146
Define Housing Eligibility Rules ................................................................................ 146
Activate the Housing Eligibility Filter .......................................................................... 147
Program Enrollment Entity Filter ............................................................................... 148
Requests for Housing and Placements .............................................................................. 149
Request for Placement ............................................................................................. 149
Placement ............................................................................................................... 150
Configure Housing Listing Filters ...................................................................................... 151

Building a Provider or Client Portal Using Vlocity on Salesforce Communities .............................. 152
Set Up a Housing Community Overview ............................................................................ 152
Import Layout and Cards for Housing Setup .............................................................. 152
Import Templates for Housing Setup ......................................................................... 152
Create a Housing Listing Visualforce Page ................................................................ 153
Community Permissions ........................................................................................... 153
Set Up the Community ............................................................................................. 153
Add a Header for the Housing Listing ........................................................................ 153
Add a Default Housing Unit Image ............................................................................ 153
Enable Translations and Custom Labels .................................................................... 154

© 2022 Vlocity LLC, a Salesforce


company
Vlocity Government

Set a Maximum Number of Expressions of Interest .................................................... 154


Create a Community User from an Application ................................................................... 155
Tenant Self-Service Actions Overview ............................................................................... 155
Import Layout & Cards ............................................................................................. 155
Import Templates ..................................................................................................... 156
Visualforce Pages .................................................................................................... 156
Housing Listing ........................................................................................................ 157
Message Center ...................................................................................................... 157
Set Up Message Center ................................................................................................... 157
Enable Message Center in Communities ................................................................... 158
Send Private Messages ........................................................................................... 158
Send Automatic Messages for Field Updates ............................................................. 158
Send Automatic Messages at Application Submission ................................................ 159
Enable Clients to Send Messages ............................................................................. 159
Add a New Announcement Type ....................................................................................... 160
Add the New Type to the Picklist on the Event Directory Object .................................. 160
Add Announcement Type to the Filter List in the Announcements Vlocity UI Template .. 160
Upload Icon to Static Resources ............................................................................... 161
Add Announcement Icon to the Icons in the Announcements Vlocity UI Template ........ 161
Make Similar Updates on Home Page Vlocity UI Template ......................................... 162
Configure and Use Trailing Documents Requirements ........................................................ 162

Vlocity Government Data Model ................................................................................................ 164


Child Welfare ERD ........................................................................................................... 165
Program Enrollment ERD ................................................................................................. 166
Vlocity Government Object List ......................................................................................... 166

Vlocity Government Cards Reference ....................................................................................... 167

Vlocity Government APIs .......................................................................................................... 168


Express Interest .............................................................................................................. 168
Inventory Item ................................................................................................................. 169

© 2022 Vlocity LLC, a Salesforce


company
Vlocity Government

Vlocity Government

Salesforce public sector products support a range of social assistance programs, helping agencies and
external providers to effectively deliver services to people and households. Which products apply to you
depends on your initial purchase date.

NOTE
You can upgrade the products you initially purchased. If you're a new customer, don't
install Vlocity Insurance or Vlocity Government.

Initial Purchase Date Range Products Purchased Documentation


February 15, 2022 or later Salesforce Public Sector Solutions, Salesforce Public Sector Solutions Administration
which includes OmniStudio Guide

Salesforce Public Sector Solutions Data Model


Overview

OmniStudio
October 2020 through Salesforce Public Sector Solutions, Salesforce Public Sector Solutions Administration
February 14, 2022 which includes Vlocity Insurance for use Guide
of OmniStudio for Vlocity
Salesforce Public Sector Solutions Data Model
Overview

Vlocity Insurance
September 2020 or before Vlocity Government This documentation

© 2022 Vlocity LLC, a Salesforce


company 1
Vlocity Government

Vlocity Government Release Notes

This topic lists the release history for Vlocity Government. Before you upgrade, see the upgrade
instructions and be sure to follow the recommended upgrade path.

When performing a new installation or upgrade, use a major release. After upgrading, you cannot
downgrade to an earlier release. Install minor releases only as directed by Vlocity Support.

NOTE
To install in a sandbox rather than a production org, alter the download URL by changing
"login" to "test". For example:

Production URL: https://login.salesforce.com/packaging/


installPackage.apexp?p0={package-id...}

Sandbox URL: https://test.salesforce.com/packaging/


installPackage.apexp?p0={package-id...}

Become Familiar with the Data Model


• If you're a new customer, see the section on the Salesforce Public Sector Solutions Data Model
Overview.
• If you're an existing Vlocity customer, see the Vlocity Government Data Model.

Package Index
Vlocity Government Package Links

Government Release Notes Summer '22


Vlocity Government Summer '22 Major Release was approved for release on June 3, 2022. To download
the release, see the Vlocity Package Downloads Index. This topic describes the key new features and
enhancements in this release.

OmniStudio for Vlocity Updates


See OmniStudio for Vlocity Summer '22 Release Notes.

Government Release Notes Spring '22


Vlocity Government Spring '22 Major Release was approved for release on March 1, 2022. To download
the release, see the Vlocity Package Downloads Index. This topic describes the key new features and
enhancements in this release.

© 2022 Vlocity LLC, a Salesforce


company 2
Vlocity Government

Vlocity Contract Lifecycle Management


System administrators can now enable the server-side document generation feature for new
customers who have Document Generation licenses auto-provisioned as a result of buying new Vlocity
SKUs, and have installed a Salesforce Industries Spring '22 package. Existing customers upgrading to
Spring '22 must continue to contact the Salesforce Support to enable the server-side document generation
feature.

From Setup, the system administrator can configure the document generation setting. For more
information, see Enable Server-Side Document Generation Setting for the Salesforce Industries Package.

OmniStudio for Vlocity Updates


See OmniStudio for Vlocity Spring '22 Release Notes.

Government Release Notes Winter '22


Vlocity Government Winter '22 Major Release was approved for release on October 29, 2021. To download
the release, see the Vlocity Package Downloads Index. This topic describes the key new features and
enhancements in this release.

Vlocity Contract Lifecycle Management


Vlocity Contract Lifecycle Management has a new feature for the Winter '22 release: server-side document
generation is generally available with the proper licenses.

Use server-side document generation for automatic or asynchronous invocation, and for documents with
lots of token processing, tabulation, or line items. A sample OmniScript is provided that can perform
server-side document generation based on any Microsoft Word or PowerPoint template with data from any
Salesforce object.

Server-side document generation isn't enabled by default. To enable this feature, see the Request Access
to Server-Side Document Generation knowledge article.

For details, see Using the docGenerationSample/singleDocxServersideLwc OmniScript.

OmniStudio for Vlocity Updates


See OmniStudio for Vlocity Winter '22 Release Notes.

2021 Government Release Notes


The following releases became available in 2021.

Government Release Notes Summer '21


Vlocity Government Summer '21 Major Release was approved for release on June 22, 2021. To download
the release, see the Vlocity Package Downloads Index. This topic describes the key new features and
enhancements in this release.

Vlocity Contract Lifecycle Management


Vlocity Contract Lifecycle Management has one new pilot feature for the Summer '21 release: server-side
document generation.

© 2022 Vlocity LLC, a Salesforce


company 3
Vlocity Government

Use server-side document generation for automatic or asynchronous invocation, and for documents with
lots of token processing, tabulation, or line items. A sample OmniScript is provided that can perform
server-side document generation based on any Microsoft Word or PowerPoint template with data from any
Salesforce object.

Server-side document generation is a pilot feature. To request consideration for the pilot program, contact
Salesforce Support.

For details, see Using the docGenerationSample/singleDocxServersideLwc OmniScript.

OmniStudio for Vlocity Updates


See OmniStudio for Vlocity Summer '21 Release Notes.

Government Release Notes Spring '21


Vlocity Government Spring '21 Major Release was approved for release on April 9, 2021. To download
the release, see the Vlocity Package Downloads Index. This topic describes the key new features and
enhancements in this release.

OmniStudio Enhancements, Spring '21


This section summarizes the OmniStudio features and enhancements for the Vlocity Government Spring
'21package.

Hello OmniStudio, Farewell Vlocity Digital Interaction Platform


As part of Vlocity's integration into Salesforce, the Vlocity Digital Interaction Platform is now called
OmniStudio. Most of the names of the tools within the OmniStudio suite have changed accordingly.

The terminology change does not affect how your products work. Nothing at the data level, such as
DataPacks or objects, has changed.

Here’s a quick summary of the key terminology changes.

WE USED TO SAY... NOW WE SAY...


Vlocity Digital Interaction Platform OmniStudio
Vlocity OmniScripts OmniScripts
Vlocity DataRaptors OmniStudio DataRaptors
Integration Procedures OmniStudio Integration Procedures
FlexCards OmniStudio FlexCards
Vlocity Calculation Procedures OmniStudio Calculation Procedures
Vlocity Calculation Matrices OmniStudio Matrices
Vlocity DataPacks OmniStudio DataPacks
Vlocity DX IDX CLI or IDX Workbench
Vlocity Industry Console OmniStudio Industry Console
Vlocity LWC OmniStudio LWC
Vlocity Interaction Launcher OmniStudio Interaction Launcher
Vlocity OmniAnalytics OmniAnalytics

© 2022 Vlocity LLC, a Salesforce


company 4
Vlocity Government

The name changes are not yet integrated into our documentation.

OmniStudio DataRaptors
Users can't run DataRaptors unless they have permissions to access the Vlocity DataRaptor Bundles and
Vlocity DataRaptor Map Items custom objects. For the steps to grant access, see Grant Custom Object
Permissions.

OmniStudio FlexCards
Download FlexCard LWCs from the FlexCard Designer. Get notified when you need to grant access to your
org domains. Control the format of the date, time, and currency on a Field element. Control the proportions
of your Chart element. Generate unmanaged versions of managed components in the FlexCard Designer.
Limit user access to FlexCards and Apex classes.

Download FlexCard LWCs


Download both on and off-platform FlexCard LWCs.

Where: Available in Spring '21 and later releases.

Why: Download FlexCard LWCs to debug and inspect issues.

How: From the FlexCard Designer submenu, click the down arrow next to Activate, and click Download
LWC or Download Off-Platform LWC.

What's Next

• Download a FlexCard LWC from the FlexCard Designer.


• Download an Off-Platform FlexCard LWC from the FlexCard Designer.

View Notification to Update Remote Site Settings


Get notified when your Remote Site Settings need an update to grant access to your org domains to enable
LWC features such as Preview.

Where: Available in Spring '21 and later releases.

Why: When spinning a new org or new installation, the Tooling API calls necessary for LWC may fail if the
Remote Site Settings page in your org does not include the URLs required. A Warnings button alerts you
that your org's lightning.force.com URL and the visualforce.com URL of the Visualforce page that contains
the FlexCard Designer are missing in the Remote Site Settings.

How: Click the Warnings button on the OmniStudio FlexCards home page. Copy the two URLs provided.
In Setup > Security > Remote Site Settings, create a new Remote Site for each URL.

What's Next
Update Remote Site Settings to Preview Your FlexCard

Use User Locale to Format the Field Element


Use the logged-in user's locale to format the date, time, and currency on a Field element.

© 2022 Vlocity LLC, a Salesforce


company 5
Vlocity Government

Where: Available in Spring '21 and later releases.

Why: By default, the FlexCard Author's user locale determines the format. If your FlexCard is used on
an application accessible across different locales, enable Use User Locale For Formatting to use the
logged-in user's locale to determine the format of your date, time, and currency.

How: Check the Use User Locale For Formatting checkbox in the Properties panel when you select a
Field element.

What's Next
Add a Field to a FlexCard

Use an Absolute Date on a Field Element


Prevent converting the date based on the timezone when you update the Format property of a Field
element.

Where: Available in Spring '21 and later releases.

How: When Date is selected for Field Type, check the Use Absolute Date checkbox.

What's Next
Add a Field to a FlexCard

Set a Chart Element's Aspect Ratio or Height


Adjust the proportions of a Chart element with the Aspect Ratio, Maintain Aspect Ratio, and Chart
Height features in the FlexCard Designer.

Where: Available in Spring '21 and later releases.

Why: By default, the aspect ratio of a Chart element is 1, such as 1:1. The chart width is always the
maximum width available given the number of columns it spans on the 12-column grid of the canvas in the
designer. Increase the aspect ratio to make your chart smaller or decrease it to make it taller. Maintain the
aspect ratio to set fixed proportions. Set a fixed height to override the aspect ratio entirely.

How: Add a Chart element to your FlexCard in the FlexCard Designer. In the Properties panel, update the
Aspect Ratio to a whole number or a decimal, and if needed, select the Maintain Aspect Ratio checkbox.
To override the aspect ratio, enter a number in the Chart Height field.

What's Next
FlexCard Chart Element Aspect Ratio

See Also

• Add a Chart to a FlexCard

Add an Apex Class Permissions Checker


Configure an Apex class permissions checker to require that users have explicit access to Apex classes
that administer remote actions called from FlexCards or Classic Cards (Vlocity Cards).

© 2022 Vlocity LLC, a Salesforce


company 6
Vlocity Government

Where: Available in Spring '21 and later releases.

How: In Setup, go to Custom Settings > General Settings > Manage to create the ApexClassCheck with a
Value of true.

What's Next
Add an Apex Class Permissions Checker

Limit User Acces to a FlexCard or Classic Card in a Managed Package


For managed packages, you must add the vlocityRequiredPermissionCheck Apex class to use the
FlexCard Designer's FlexCard and Classic Card Designers' Required Permissions feature to limit user
access based on custom permissions.

Where: Available in Spring '21 and later releases.

How: From Setup > Apex Classes, click New, and enter the code for the
vlocityRequiredPermissionCheck Apex class provided in the topics in the What's Next section on
this page.

What's Next
Limit User Access to a FlexCard with Custom Permissions

Limit User Access to a Card Layout in a Managed Package

Classic Cards
Limit user access to Classic Cards (Vlocity Cards) and Apex classes.

Add an Apex Class Permissions Checker


Configure an Apex class permissions checker to require that users have explicit access to Apex classes
that administer remote actions called from FlexCards or Classic Cards (Vlocity Cards).

Where: Available in Spring '21 and later releases.

How: In Setup, go to Custom Settings > General Settings > Manage to create the ApexClassCheck with a
Value of true.

What's Next
Add an Apex Class Permissions Checker

Limit User Acces to a FlexCard or Classic Card in a Managed Package


For managed packages, you must add the vlocityRequiredPermissionCheck Apex class to use the
FlexCard Designer's FlexCard and Classic Card Designers' Required Permissions feature to limit user
access based on custom permissions.

Where: Available in Spring '21 and later releases.

© 2022 Vlocity LLC, a Salesforce


company 7
Vlocity Government

How: From Setup > Apex Classes, click New, and enter the code for the
vlocityRequiredPermissionCheck Apex class provided in the topics in the What's Next section on
this page.

What's Next
Limit User Access to a FlexCard with Custom Permissions

Limit User Access to a Card Layout in a Managed Package

OmniScripts
Run OmniScripts through Adobe Experience Manager, and enable users to restart an OmniScript.

Deploy OmniScripts to Adobe Experience Manager


Host OmniScripts on your external Adobe Experience Manager application using LWC OmniOut.

Where: Available in Spring '21 and later releases.

Why: Add powerful, easy-to-use OmniScript forms to an existing Adobe Experience Manager server.

How: Download the LWC OmniOut Static Resource, and add your AEM credentials to the ./
aem.ui.apps/pom.xml file. Deploy LWC OmniOut to your server and add the Vlocity LWC OmniOut
component to an AEM page.

What's Next
Add OmniScripts to Adobe Experience Manager

See Also

• OmniOut
• Download the OmniOut Static Resource
• Run OmniOut in Development Mode

Restart OmniScripts
Enable users to restart an OmniScript using the Navigate Action's Restart OmniScript target type.

Where: Available in Spring '21 and later releases.

Why: Provide users with an option to start over or conditionally perform a restart between steps if a critical
error occurs.

How: From a Navigate Action's properties panel, click Edit Properties As JSON. Locate the
"targetType" JSON Node. Set the value for "targetType" to "Restart OmniScript". The
node should read "targetType": "Restart OmniScript". Return to your OmniScript and test the
functionality.

What's Next
Restart an OmniScript

© 2022 Vlocity LLC, a Salesforce


company 8
Vlocity Government

See Also

• Navigate Action
• Navigate Action Properties

Formulas and Functions


Filter list items with |n syntax and use the MAXSTRING and FUNCTION functions.

List Items with |n Syntax in Formulas


List items with |n syntax are supported in formulas that filter lists.

Where: Available in Spring '21 and later releases.

Who: Salesforce administrators use functions within formulas in DataRaptors and Integration Procedures.

Why: If the list item you want to filter on is at a known position in the list, you can reference that position in
your filtering function.

How: Use a list item with |n syntax in any function that accepts a list.

See Also

• List Input for DataRaptors


• Function Reference

MAXSTRING Function
The MAXSTRING function returns the last string alphabetically. For example,
MAXSTRING("Amy","Ziggy") returns "Ziggy". The MAX function no longer works for Strings.

Where: Available in Spring '21 and later releases.

Who: Salesforce administrators use functions within formulas in DataRaptors and Integration Procedures.

See Also
Function Reference

FUNCTION Function
Creating a custom function no longer requires creating metadata. Just create an Apex class and call the
function with FUNCTION('ClassName.MethodName',input).

Where: Available in Spring '21 and later releases.

Who: Salesforce administrators use functions within formulas in DataRaptors and Integration Procedures.

Why: Creating metadata for a custom function is no longer necessary, which makes implementing custom
functions more efficient.

© 2022 Vlocity LLC, a Salesforce


company 9
Vlocity Government

See Also

• Function Reference
• Sample Apex Code for a Custom Function
• List Input in Custom Functions

IDX Workbench
Migrated OmniScripts and Integration Procedures are activated automatically.

ParentInteractionToken in Integration Procedure Tracking Entry


A Vlocity Tracking Entry written by an Integration Procedure includes the ParentInteractionToken, which is
the VlocityInteractionToken from the calling OmniScript or parent Integration Procedure.

Where: Available in Spring '21 and later releases.

Who: Salesforce administrators use the Tracking Service to monitor the performance of OmniStudio
components.

Why: You can see how a tracked Integration Procedure was invoked.

How: The ParentInteractionToken is automatically included when you enable the Tracking Service and
configure it to track Integration Procedures.

See Also
Integration Procedure Event Tracking

OmniStudio Tracking Service


A Tracking Entry for an Integration Procedure references the OmniScript or Integration Procedure that
invoked it.

Automatic OmniScript and Integration Procedure Activation


OmniScripts and Integration Procedures migrated using IDX Workbench are automatically activated in the
target org.

Where: Available in Spring '21 and later releases.

Who: Salesforce administrators use IDX Workbench to migrate objects between orgs and Git repositories.

Why: You no longer need to activate migrated OmniScripts and Integration Procedures individually.

How: On Chrome this happens by default. If you use a browser other than Chrome, you must perform a
one-time setup of this activation.

See Also
Configure LWC OmniScript and FlexCard Activation and Compilation

© 2022 Vlocity LLC, a Salesforce


company 10
Vlocity Government

Relationship Graphs
Refresh Relationship Graphs programmatically, use additional filter operators, and include one-to-many
relationships in Timeline graphs.

JavaScript Method for Refreshing Relationship Graphs


If you embed a Relationship Graph in another Lightning Web Component, you can use the JavaScript
refreshGraph method to refresh the Relationship Graph.

Where: Available in Vlocity Health and Insurance Spring '21 and later releases.

Who: Lightning Web Component developers can use this method in .js files.

Why: If another embedded Lightning Web Component lets you change data that might affect the graph,
that Lightning Web Component component can refresh the graph after any such change.

How: In the Lightning Web Component's .html file, embed the Relationship Graph component. In the .js
file, call the refreshGraph method.

See Also
JavaScript refreshGraph Method for Lightning Web Components

Relationship Graph Node Filter Operators


In previous releases, node filters had only an equals operator. Beginning with this release, supported
operators are equals, not equals, like, greater than, greater than or equal, less than, and less than or
equal.

Where: Available in Vlocity Health and Insurance Spring '21 and later releases.

Who: Salesforce administrators can use these operators in Relationship Graph configurations.

Why: Additional filter operators make node filters more flexible. For example, you can filter for senior
citizens with Age greater than 64.

How: In the Relationship Graph's Config tab, under Node Display Field Configuration, in Filter
Configuration, click Add Filter. Select a Field Name, Operator, and Compare Value. Click Apply Filter.

See Also
Settings for All Graph Types

Timeline Graphs Support One-to-Many Relationships


In previous releases, Timeline graphs supported only many-to-many relationships. Beginning with this
release, Timeline graphs also support one-to-many relationships.

Where: Available in Vlocity Health and Insurance Spring '21 and later releases.

Who: Salesforce administrators can use one-to-many relationships in Timeline graph traversal
configurations.

© 2022 Vlocity LLC, a Salesforce


company 11
Vlocity Government

Why: Adding one-to-many relationship support makes Timeline Graphs more flexible. And one-to-many
relationships are easier to configure than many-to-many relationships are.

How: Configure a one-to-many relationship traversal in a Relationship Graph. Then reference the
Relationship Graph in a Vlocity Timeline component in Lightning App Builder.

See Also
Relationship Graph Traversal Object Fields and Mappings

Government Release Notes Winter '21


Vlocity Government Winter '21 Major Release was approved for release on November 4, 2020. To
download the release, see the Vlocity Package Downloads Index. This topic describes the key new features
and enhancements in this release.

Supported Apex Class API Version


The Apex version is 49.0.

Trailing Documents Feature Supported


Vlocity Government supports trailing documents requirements on Accounts, Applications, Cases,
Contacts, Contracts, Incidents, ProgramEnrollments, ProgramEnrollmentMembers, PublicPrograms, and
ServicePlans, which allows Community and internal users to upload documents up to 38 MB in size. See
Configure and Use Trailing Documents Requirements.

Data Model Changes


The Vlocity Government Data Model has been enhanced in the Winter '21 release.

Table 1. New Data Model Objects for Vlocity Government in Winter '21
New Data Model Object Description
Contract Group Groups a collection of service points, service accounts, or any other grouping object for use in
a Contract.
Generic DocuSign Document Provides information about attached documents in a DocuSign eSignature envelope.
Generic DocuSign Envelope Stores information about DocuSign envelopes.
Generic DocuSign Recipient Provides information about the status of each recipient in a DocuSign eSignature envelope.
Vlocity Contract Service Log Contains details about contract service requests made.
Cached Data Set Groups records present in caching objects, such as Datastores, into sets, and controls
activation of the sets using the IsActive flag.
Omni User Session Stores user session details.
Vlocity Tracking Component Describes a component (Card, OmniScript) referenced in a Tracking Group.
Vlocity Tracking Group Specifies an OmniAnalytics tracking definition, including a set of components to be tracked.
Vlocity Web Tracking Configuration Specifies tracking method definition metadata, including vendor-specific information.
Vlocity Web Tracking Event Type Calls the tracker API when an event of the specified type fires, using substitution variables to
represent dynamic parts of the payload.
Vlocity Tracking Event Stores an OmniAnalytics event record in an event queue. OmniAnalyticsEnabled and
OmniAnalyticsTrackAsEvent must be set to true in General Settings > Custom Settings.
Recommendation Represents an Einstein Recommendation used to power an Einstein Next Best Action.

© 2022 Vlocity LLC, a Salesforce


company 12
Vlocity Government

New Data Model Object Description


Opportunity Group Groups a collection of service points, service accounts, or any other grouping object for use in
an Opportunity.
Order Group Groups a collection of service points, service accounts, or any other grouping object for use in
an Order.
Quote Group Groups a collection of service points, service accounts, or any other grouping object for use in
a Quote.
Test Result Stores a Test Procedure execution result. See Test Procedures: Integration Procedures for
Unit Testing.
Trailing Document Placeholder Tracks documents needed to make decisions about government processes. See Configure
and Use Trailing Documents Requirements.

Vlocity Contract Lifecycle Management

Overview of New and Enhanced Features


This release of Contract Lifecycle Management for Vlocity Government includes the following new features:

DocuSign Functionality Enhancements


You can send documents for eSignature for objects such as quote, opportunity, order, and any custom
object. You can use a new sample OmniScript (Generic DocuSign Send E-Signature) that you can add to
record pages or another OmniScript. For details, see Set Up Generic Documents For DocuSign eSignature.

Document Reconciliation Enhancements


CLM supports customer redlined reconciliation of Microsoft Word documents generated from Microsoft
Word DOCX templates. For details, see Reconcile Documents for Microsoft Word DOCX Templates.

Clause and Context Section


You can use context sections and clause sections to create areas of the Microsoft Word document that you
want to reconcile with changes.

Reconciliation Details View


For Microsoft Word DOCX templates, you can see sections that were updated and not updated based on
whether there were changes. You can see the text marked with the "Track Changes" feature from Microsoft
Word.

For Web templates, you can see the sections that were not updated because they were restricted, and
CLM displays a message describing that these sections are restricted.

Web Template Enhancements


Vlocity made the following enhancements to Web templates:

• You have new options of customizing your Word documents created from Web templates. You can select
whether to remove a blank line between sections, and you can select line-height spacing within the
paragraphs in the sections. These options help you reduce the total size of the Word document that CLM
creates. You define these when you create the sections for Web templates. For details, see Creating a
Document Template Section in CLM.

© 2022 Vlocity LLC, a Salesforce


company 13
Vlocity Government

• You can use the PDF generation option called VlocityClientSide for Web templates. For details about
PDF generation, see Understanding PDF Conversion in CLM.

Extended Fonts Support


CLM supports the extended fonts Roboto, Robot Mono, Tinos, Noto Sans Thai, MS Mincho (Japanese), MS
Gothic (Japanese), and Cousine (Courier New). CLM also supports large size extended fonts (greater than
2.9 MB), such as MS Mincho (Japanese). For details, see Fonts for Client-Side Document Generation in
CLM.

Document Templates For Community Users


You can publish the active document templates for specific community portals to enable community users
who have a license to complete document generation with an OmniScript. Go to the Diagnostics tab in the
Vlocity Installation Assistant called Publish Document Templates to Community Portal for details.

Vlocity Intelligence End of Life


September 1, 2020

Editions affected: All existing releases of:

• Vlocity Insurance
• Vlocity Health
• Vlocity Communications
• Vlocity Media
• Vlocity Energy
• Vlocity Public Sector

Beginning December 31, 2020, Salesforce will end support for Vlocity Intelligence. We believe we can offer
customers better options for recommending actions and offers through tighter integration with Salesforce
Einstein.

The feature will not be included in any renewals beyond September 1st, 2020. Existing customers may
continue to use Vlocity Intelligence if installed. However, it will not be supported after the end of 2020 and
new releases thereafter will not include the feature.

Vlocity Platform Changes


This section summarizes the Digital Interaction Platform features and enhancements for the Government
Winter '21 release.

FlexCard Designer

• With the FlexCard Designer, preview while you build dynamic, context-aware user experiences using a
drag and drop interface with WYSIWYG editing. Step through a configuration wizard to create a configure
basic settings and a data source for a FlexCard. Drag elements onto a Canvas, style elements using
design interfaces and custom CSS, and enable responsiveness. The FlexCard Designer is built with the
Salesforce Lightning Web Component programming model. See FlexCard Designer. For changes and
enhancements, see FlexCard Designer Changes and Enhancements.

© 2022 Vlocity LLC, a Salesforce


company 14
Vlocity Government

• Find context-sensitive help specific to an element or property using the FlexCard Designer's in-product
help tray feature. View specific field information by hovering over tooltips that appear next to properties.

Vlocity Cards

• View a sample APEX Class for getting Einstein NBA offers for a card. See IndustryNBA Class.
• When passing a parameter to a page in Lightning you must use a namespace prefix. For backward
compatibility, an Angular card inside the aura wrapper can read the parameters with both c__ and no
prefix. See Backward Compatibility Support for Passing Page Params.
• New "Action" picklist added to the Interaction Topic object with seed values "Discussed", "Created", and
"Resolved", and the option to add additional values to the picklist.
• Two record types, Classic and Flex, added to the VlocityCard__c Data Model. The default is Classic. 'Is
Child Card' checkbox filters child cards from parent cards.

LWC Cards
Target Parameters added to 'Community Named Page' and 'Named Page' Target Types on a Custom
Action. Target Names updated for all Target Types. See Adding a Custom Action to an LWC Card.

Vlocity Lightning Web Components

• The Datatable LWC cell title is customizable with the "field-label" and "field-title" properties of the
OutputField LWC. See OutputField Lightning Web Component ReadMe.
• Tracking fields added to the Interaction Wrapper LWC. See InteractionWrapper Lightning Web
Component ReadMe.
• The Interaction Wrapper LWC listens to pubsub events fired by FlexCards, triggers the Create Interaction
IP on load, and the Create Topic IP on event received. See InteractionWrapper Lightning Web
Component ReadMe.
• In the DataTable LWC, select 'icon' as a Type attribute value to display a check icon for a boolean value
that returns true. See DataTable Lightning Web Component ReadMe.
• Additional customizable attributes added to the DataTable LWC, such as user-selectable-row, active-
groups, hideExtraColumn, sortAcrossGroup, fireeventOnDeleteconfirm groupNameWrapperClass, style,
and preventNavigation. See DataTable Lightning Web Component ReadMe.
• Display an available image with the Img LWC. See Img Lightning Web Component ReadMe.
• With the Toggle LWC, enable users to pick between two states, enable or disable an option, or select
multiple options. The Toggle LWC supports attributes available in the CheckboxGroup Lightning Web
Component. See Toggle Lightning Web Component ReadMe.
• Enable tracking and specify tracking objects in the Action LWC. See Action Lightning Web Component
ReadMe.

LWC OmniScript
All of the LWC OmniScript changes and enhancements apply to both the LWC OmniScript Designer and
the Classic OmniScript Designer. To view changes and enhancements specific to the LWC OmniScript
Designer, see LWC OmniScript Designer Changes and Enhancements.

Download the LWC HTML, CSS, and ReadMe files for this release by clicking here.

© 2022 Vlocity LLC, a Salesforce


company 15
Vlocity Government

Added OmniScript Element Support


LWC OmniScript supports these elements:

Element LWC Behavior Angular Behavior


PDF Action No change No change

New Properties
New LWC OmniScript properties appear in the LWC OmniScript Designer only. See LWC OmniScript
Designer Changes and Enhancements.

Added Property Support


LWC OmniScript supports these OmniScript properties:

Property LWC Behavior Angular Behavior


Enable Unload Warning No change No change

New Functionalities
These new functionalities are exclusive to LWC OmniScripts:

Functionality Description
Browser Navigation A browser's forward and back buttons navigate an LWC OmniScript to the next or previous Step.
Custom Styling Support for Add custom styling for right-to-left languages using static resources. See Custom Stylesheet
RTL Language Static Resource.
Download Off-Platform LWC Download the OmniScript LWC to add it to OmniOut. See OmniOut.
Expanded Google Maps Type Ahead's Google Maps functionality returns an expanded response containing more JSON
Response Node nodes. See Use Google Maps Autocomplete in LWC OmniScripts.
Improved Readability Readability has been improved for screenreaders.
Messaging Framework Pass a value in the c__messagingKey URL parameter to change the node that stores the
messaging payload for window.postMessage and session storage message. See Message with
Window Post Messages and Session Storage Messages.
Place Custom LWC Elements in Custom LWC Elements are usable in a non-repeatable Block element. The Block cannot be
Blocks nested. See Custom LWC Element.
Run OmniScripts Off-Platform Add OmniOut to an application to run OmniScripts on a third-party website.
with OmniOut
Translate Tooltip Help Text in Provide translations for tooltip help text in multi-language OmniScripts by defining and adding
Multi-Language OmniScripts custom labels. See Translate Tooltip Help Text in OmniScripts.

Added Functionality Support


LWC OmniScript supports these OmniScript functionalities:

Functionality LWC Behavior Angular


Behavior
Beta support for right-to-left Multi-language and single language OmniScripts provide beta support for No change
languages right-to-left languages.

© 2022 Vlocity LLC, a Salesforce


company 16
Vlocity Government

Functionality LWC Behavior Angular


Behavior
Mobile View in App Builder Preview how your OmniScript displays on a mobile device by Lightning No change
App Builder's device view to Phone. See Add an LWC OmniScript to a
Lightning or Experience Page.

LWC OmniScript Designer


This section lists changes and enhancements specific to the LWC OmniScript Designer. To view LWC
OmniScript changes and enhancements that apply to both the LWC OmniScript Designer and the classic
designer, see LWC OmniScript Changes and Enhancements.

New Setup Properties

Section: Property Description


Enable Unload Warning The Enable Unload Warning property is available in LWC OmniScripts.
Styling Options: Custom Lightning Reference a static resource that contain a custom Lightning stylesheet. See Apply Custom
Stylesheet File Name Styling to OmniScripts with Static Resources.
Styling Options: Custom Newport Reference a static resource that contain a custom Newport stylesheet. See Apply Custom
Stylesheet File Name Styling to OmniScripts with Static Resources.
Styling Options: Scroll Animation Turn scroll animation on to add a smooth scroll animation to your OmniScript.
Cancel Options: Tracking Business Define a business category for a tracking entry. See Enable Tracking for OmniStudio
Category Components.
Cancel Options: Tracking Business Define a business tracking event for a tracking entry. See Enable Tracking for OmniStudio
Event Components.

New Element Properties


These properties are now available in LWC OmniScript Designer

Property Description
Tracking Business Category Define a business category for a tracking entry. See Enable Tracking for OmniStudio Components.
Tracking Business Event Define a business tracking event for a tracking entry. See Enable Tracking for OmniStudio
Components.

Added Element Property Support


The LWC OmniScript Designer now supports these properties.

Property Description
Edit Block Label LWC Edit Block's Cards and Long Cards modes support the Edit Block Label LWC Component
Component Override Override. See Extend the Edit Block Label LWC.
Edit Block New LWC Edit Block's Cards mode supports the Edit Block New LWC Component Override. See Extend the
Component Override Edit Block New LWC.
Use Continuation The Remote Action's Use Continuation property, which enables you to invoke apex classes that
return continuation objects, appears in the UI. See Remote Action.

Added Element Support


The LWC OmniScript Designer now supports these elements.

© 2022 Vlocity LLC, a Salesforce


company 17
Vlocity Government

Element Description
Matrix Action Call a Calculation Procedure with specific inputs and retrieve a value.
PDF Action Fill and display PDFs using OmniScript data.
Set Errors Action Render validation messaging on one or more elements in a Step.

New Functionalities
The LWC OmniScript Designer now includes these functionalities.

Functionality Description
Cancel Options Configure Cancel Options to direct users to different Salesforce experiences. See Enable and
Configure Cancel Functionality in an LWC OmniScript.
Download Off-Platform Download the OmniScript LWC to add it to OmniOut. See OmniOut.
LWC
Hide Conditional Elements Hide conditional elements in the designer by checking the hide conditional elements checkbox in the
canvas. See Conditionally Display Elements Using the Conditional View Property.

Added Functionality Support


The LWC OmniScript Designer now supports these functionalities.

Functionality Description
Edit Block SObject The SObject mapping section appears in the UI of the Edit Block properties.See Configure an Edit
Mapping Block
Full-width Preview Collapse the Debug Panel to hide the Data JSON and Action debugger and preview the OmniScript
in a full-width page. See Preview an OmniScript in the LWC OmniScript Designer.
Multi-Language: Custom Configure custom label translations from the LWC OmniScript Designer when designing a multi-
Label Translations language OmniScript. See Define Custom Label Translations in Multi-Language OmniScripts.

Changes in Functionality
The File and Image elements no longer contain the Upload to Content Document checkbox property.
LWC OmniScripts always upload files and images to the content document. See Add a File or Image to
OmniScript.

Formulas and Functions

• The ~= operator performs a case insensitive String comparison. For example, "ABC" ~= "abc" returns
true. See Function Reference.

DataRaptors

• The process and processFromApex methods of the DRGlobal class have locale parameters of
type String. See DRGlobal Class and Methods.
• DataRaptors use API version 49.

© 2022 Vlocity LLC, a Salesforce


company 18
Vlocity Government

Integration Procedures

• Cache Blocks have an Add To Cache Conditional Formula property. If a formula is present in this
property, the block is cached only if the formula evaluates to true. If this property is blank, the block is
always cached. See Enhance Performance Using Cache Blocks.
• Test Procedures are a major new feature:
• An Integration Procedure is a Test Procedure if its Is Test property is checked. A Test Procedure can
run another Integration Procedure to test it, and the Integration Procedure being tested can contain
mock results that are only for the tests. After a Test Procedure finishes running, any changes it
produced aside from its test results are rolled back. See Test Procedures: Integration Procedures for
Unit Testing.
• An Assert Action in a Test Procedure compares expected results to actual results. It can evaluate
the results or the performance of anything the Test Procedure invokes. To evaluate performance, its
Assert Conditional Formula can reference performance variables. See Assert Action for Integration
Procedures.
• The results of Test Procedures are logged to the Vlocity Tracking Entry object as Assert, Error, and
TestResult event records. See Integration Procedure Event Tracking.

OmniAnalytics

• Using Vlocity OmniAnalytics, you can track user interactions with LWC OmniScripts and FlexCards with
or without a third-party system such as Google Analytics. All Vlocity industry products can use Vlocity
OmniAnalytics. See Vlocity OmniAnalytics Overview.
• Vlocity OmniAnalytics tracks LWC OmniScript user interaction data. LWC OmniScripts can send data to
an external analytics vendor such as Google Analytics using the Messaging Framework. See Workflow
for Adding Ecommerce Data to the Example OmniScript and Card.
• Vlocity OmniAnalytics tracks FlexCard user interaction data. FlexCards can send data internally or to an
external analytics vendor such as Google Analytics using the Business Category and Business Event
properties. See Workflow for Adding Ecommerce Data to the Example OmniScript and Card.
• When included in a Lightning App Page, the Vlocity Tracking Manager LWC listens for Vlocity
OmniAnalytics events. It can send these events to Vlocity Tracking Groups and to external analytics
vendors. See Create a Lightning App Page with a Tracking Manager.
• Vlocity OmniAnalytics can record tracking data to Vlocity Tracking Entry objects in the Vlocity Tracking
Service or to Vlocity Tracking Event records as Platform Events. See Enable OmniAnalytics and Store
Tracking Data.
• Vlocity OmniAnalytics provides dashboards for the tracking data it collects from LWC OmniScripts and
FlexCards. You can also create your own custom Salesforce Reports. See View the Tracking Data in the
Vlocity Tracking Group Page and Create a Report Using Vlocity Tracking Entry Data.
• You can specify conditions that determine whether events that Vlocity OmniAnalytics tracks are sent to
external analytics vendors. See Create an Inclusion Rule for an Event Type.

IDX Workbench

• IDX Workbench includes a Test Console where you can run Test Procedures and view Gantt charts
of their step performance, success/failure summaries, and Vlocity Tracking Entry result data. You can

© 2022 Vlocity LLC, a Salesforce


company 19
Vlocity Government

expand an Integration Procedure Action to view step data for the Integration Procedure being tested. See
Run Test Procedures.
• The Process Profiler in IDX Workbench can display OmniScript performance data collected by Vlocity
OmniAnalytics. See Use the IDX Workbench Process Profiler.
• In both the Process Profiler and the Test Console, you can right-click an OmniScript or Integration
Procedure step and go to that step in the org in the browser. See Use the IDX Workbench Process
Profiler and Run Test Procedures.
• IDX Workbench supports custom domains and community user logins, which allow testing based on a
user's level of access to an org. See Configure an Org Using a Community User Login.
• In IDX Workbench migration configuration, you can select a Project object in a Git repository as well as in
an org. See IDX Workbench Configuration for Migration.
• IDX Workbench can migrate the following additional object types. See Supported DataPack Object
Types.
• Specific Calculation Procedure and Calculation Matrix versions
• Vlocity Tracking Group, Vlocity Tracking Component, Vlocity Web Tracking Configuration, and Vlocity
Web Tracking Event Type objects relevant to Vlocity OmniAnalytics
• Spec Template and Spec Template Mappings objects relevant to GoDigital Matrixx integration

Security Updates
These security updates include moved resources, deleted resources, and upgraded resources.

Upgraded and Moved Resources

• bootstrap/bootstrap-3.2.0-dist upgraded to bootstrap/bootstrap-3.4.1-dist


• angular_bundle_1_6.js (jquery upgraded from 2.2.0 to 3.1.6
• OmniScriptCPThirdParty.resource (lodash upgraded from 3.8.0 to 4.17.15)
• tinymc upgraded to 4.9.11
• tinymce_5 upgraded to 5.4.1
• vlocity_assets:
• upgraded: papaparse 4.1.2 to 4.6.3
• removed: angular, angular-sanitize, jquery, jquery-ui, moment, lodash
• vlocity_core_assets removed: v101, v102, v105, v106, v107, and v108
• cardframework_core_assets:
• moment upgraded in v106, v107, v108 to 2.20.1
• removed: v101, v102
• vlocityoui_assets removed uimask, ui-bootstrap, moment, lodash, leaflet, json-tree, json-
formatter, jquery-1.8.2, forcetk, angularleaflet, angular, angular-strap, angular-sanitize, angular-
route, angular-inputmask, angular-animate
• vstrap removed angular, angular-animate, angular-strap, bootstrap, foundation, jquery, jquery-ui,
ui-router, fonts, css
• vstrap14
• treeGrid - removed local copy of Jquery
• JqueryGrid - removed local copy of Jquery
• chart_bundle - removed local copy of moment and n

© 2022 Vlocity LLC, a Salesforce


company 20
Vlocity Government

• Jquery - removed local copy of Jquery

Deleted Resources

• ps_assets
• angular
• BootstrapCSS
• JQuery_1_5_1
• jquery_2_2_4
• JQUERY211
• JQUERYJS
• tinymceIce
• vstrap14
• textangular
• AngularSanitizeJS
• vkBeautify
• external

2020 Government Release Notes


The following releases became available in 2020.

Government Release Notes Spring '20


Vlocity Government Spring '20 Major Release was approved for release on June 12, 2020. To download
the release, see the Vlocity Package Downloads Index. This topic describes the key new features and
enhancements in this release.

Data Model Changes


Vlocity Government Spring '20 includes the following changes to the data model:

• New child welfare data objects have been added to the Vlocity Government package: Episode,
Placement, Court Action, and Court Action Outcome. Existing data model objects that support Child
Welfare have updated fields: Incident, Assessment, Incident Allegations, Benefit Case, Note, and Service
Plan.
• The Public Program object has a lookup field, Product, that references the related Product2 object. This
relationship allows for products to be defined per Program as is customary in Government programs.

After installing or upgrading to Vlocity Government Spring '20, you must add picklist values to the child
welfare data objects. See Picklist Values to Add to Vlocity Government Spring '20.

Lightning Support
Vlocity Government supports Lightning Experience and Lightning Web Components.

Minor Enhancements
Vlocity Government Spring '20 includes the following minor enhancements and upgrades:

© 2022 Vlocity LLC, a Salesforce


company 21
Vlocity Government

• The CommunityUserInformation and CommunityUserInformationSlds pages contain a snippet of code


licensed CC-BY-SA-4.0 from Stack Overflow. This code snippet formats phone and credit card numbers
in Angular JS.
• The jquery version has been upgraded to 1.12.4.

Bug Fixes
Vlocity Government Spring '20 includes the following fixes to known issues:

• Sometimes adding or deleting Products and Services in a Service Plan wasn’t working correctly. This has
been fixed.
• Checkmarc code scanner traced an outdated JSON file due to an outdate version of jquery. This has
been fixed.

Vlocity Platform Changes


Vlocity Government Spring '20 includes Platform changes from the previous three Vlocity platform releases.

Digital Interaction Platform Enhancements, Spring '20


This section provides a summary of the Digital Interaction Platform features and enhancements for the
Vlocity Spring '20 release.

LWC OmniScript Designer

• The Vlocity LWC OmniScript Designer enables you to preview while you build dynamic customer
interactions without code using a user-friendly drag-and-drop interface with WYSIWYG editing. While
building your script, preview elements inside steps, view property changes live, and access contextual
guidance with in-product help to discover and learn about functionality without leaving your script. See
LWC OmniScript Designer Overview. For changes and enhancements, see LWC OmniScript Designer
Changes and Enhancements.
• Find context-sensitive help specific to an element or property using the LWC OmniScript Designer's
in-product help tray feature. View specific field information by hovering over tooltips that appear next to
properties.

Vlocity Lightning Web Components

• A new Lightning Web Component named Vlocity State Transition displays the states in a State Model in
an interactive flow. See Workflow for Preparing the Base Object for a State Model.
• A new Lightning Web Component named Vlocity Rules Log displays the results of invoked rules in a
State Model. See Workflow for Preparing the Base Object for a State Model.
• Expose Input LWC, DateTimePicker LWC, DatePicker LWC, and TimePicker LWC custom labels to
enable customization as API properties. See ???.
• Multi-language custom label support is available for DatePicker LWC, Alert LWC, Interaction Wrapper
LWC, Power Launcher LWC, Wizard LWC, Pill LWC, and ProgressBar LWC. See ???.
• Direct users to Login pages, Logout pages, Community Named Pages, and App pages using the
Navigate Action LWC. See ???.
• The disableCache attribute is available in the Action LWC. See ???.

© 2022 Vlocity LLC, a Salesforce


company 22
Vlocity Government

• The Label attribute is available in the Menu Item LWC. See ???.
• The Tooltip LWC supports custom HTML. See Tooltip Lightning Web Component ReadMe.
• The AsyncUtils Module exposes a collection of utilities designed to simplify asynchronous operations.
See AsyncUtils ReadMe.
• The NavigationUtils Module exposes a collection of utilities designed to simplify navigational functions.
See NavigationUtils ReadMe.
• The Pubsub Component enables custom logic before executing a callback function when an event is
fired. See Pubsub Component.
• The new ActionGridState LWC card state template displays a vertical list of actions as icons followed by
labels, and an optional title at the top. See Base LWC Card and Layout Templates and Action Grid State
LWC Card Template.

New Vlocity Base Lightning web components include these components:

Component Description
Wizard LWC Displays a modal that enables navigation between steps in a process and displays a progress bar that shows
where a user is in the process. See Wizard Lightning Web Component ReadMe.
Wizard Item LWC Creates the template for each wizard item inside the Wizard LWC. See Wizard Item Lightning Web Component
ReadMe.
Related List LWC Displays a table of data with a header that supports actions. See Related List Lightning Web Component
ReadMe.
SLDS Header LWC Displays a page header, which contains a title, an icon, field data, and action links. See SLDS Header Lightning
Web Component ReadMe.

LWC Cards

• Grant access to your org domains to enable LWC features by adding required URLs to Remote Site
Settings from the Vlocity Cards home. See Fixing Inactive/Invalid Error When Enabling LWC on a Card
Layout.
• LWC state templates style and layouts updated. See Base LWC Card and Layout Templates.
• Style updates made to the title font, icon size, and button label for LWC storyOngoingState template.
• Style and layout updates made to the title font, attribute pills, actions, and the address field for the LWC
profileCardState template.
• Style and layout updates made to fonts, icon sizes, labels, fields, and actions for the LWC
wideCardSmart state template.
• CardMiniActive template has max-height and truncates description at two lines.
• Configure ContextId, console tab icon, and console tab label on an OS Action when an LWC OmniScript
is selected. See Launching an LWC OmniScript from an OS Action on a Card.
• Fire pubsub events from an action to notify another component on a page or application of an event
occurring on an LWC enabled card. See Firing a Pubsub Event from an Action on an LWC Card.
• Configure metadata properties on an LWC enabled card with an updated, more user-friendly Show XML
Interface feature. See Configuring the Metadata Values for an LWC Card.
• The Lightning Web Component Bundle API Name must only contain underscores and alphanumeric
characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not
contain two consecutive underscores. See Card and Card Layout Naming Conventions.

© 2022 Vlocity LLC, a Salesforce


company 23
Vlocity Government

• From the Layout LWC and State LWC fields in the Card Designer, only custom unmanaged LWCs are
downloadable. See Downloading Custom Unmanaged LWCs From the Card Designer.
• The Name of a custom LWC attribute must match the custom LWC attribute's markup name. See
Embedding a Vlocity Lightning Web Component Inside an LWC Card State.

Angular Cards

• Disable caching across the Vlocity Cards Framework. See Disable Platform Cache.
• The GetObjectFromInteraction class leverages platform caching (when available) to store the
descriptions of the field lists and pull them, and adds optional inputs to increase performance. See
GetObjectIdFromInteractionObject Method.

DataRaptors

• DataRaptor Extracts, Turbo Extracts, and Transforms support metadata and data caching. See
DataRaptor Extract Output.
• The Preview tab has an Ignore Cache checkbox for testing. See Test a DataRaptor Extract.
• DataRaptor Turbo Extracts support relationship query notation for including fields from related objects.
See DataRaptor Turbo Extract Overview.
• DataRaptor Extracts and Turbo Extracts can enforce field-level security directly. See DataRaptor Extract
Output.

Integration Procedures

• Integration Procedures support DataRaptor Turbo Action components, which invoke DataRaptor Turbo
Extracts. See DataRaptor Turbo Action for Integration Procedures.
• Integration Procedures support Chatter Action components, which create Chatter posts and send them to
Chatter feeds. See Chatter Action for Integration Procedures.
• Vlocity Scheduled Jobs and the Batch Actions that call them support List Input as a Data Source Type,
which simplifies Batch Action configuration. See Batch Action for Integration Procedures.
• Try-Catch Block failure responses support merge fields. See Handle Errors Using Try-Catch Blocks.

Functions

• The VALUELOOKUP function returns the value of a JSON node referenced by another JSON node. This
lets you dynamically specify the node to retrieve from. See Function Reference.
• The SUBSTRING function converts the first parameter to a String automatically. See Function Reference.

LWC OmniScripts
Download the HTML, CSS, and ReadMe files for this release by clicking here.

LWC OmniScript Designer


The Vlocity LWC OmniScript Designer enables you to preview while you build dynamic customer
interactions without code using a user-friendly drag-and-drop interface with WYSIWYG editing. While
building your script, preview elements inside steps, view property changes live, and access contextual
guidance with in-product help to discover and learn about functionality without leaving your script. See LWC

© 2022 Vlocity LLC, a Salesforce


company 24
Vlocity Government

OmniScript Designer Overview. For changes and enhancements, see LWC OmniScript Designer Changes
and Enhancements.

New Elements
These new elements are available in LWC OmniScripts.

Element Description
Action Block Groups Action elements together to enable backend calls to fire asynchronously using the same
configuration.
DataRaptor Turbo Extract Action Invokes a DataRaptor Turbo Extract.

Added OmniScript Element Support


LWC OmniScript supports these elements:

Element LWC Behavior Angular Behavior


Calculation Action Calculation Action's Pre-Transform DataRaptor Calculation Action's Pre-Transform DataRaptor
Interface and Post-Transform DataRaptor Interface Interface and Post-Transform DataRaptor Interface
properties are now in the remote properties section. properties are now in the remote properties section.
This enables both DataRaptors to run in a single This enables both DataRaptors to run in a single
Apex call. Apex call.
Delete Action No change No change
Matrix Action No change No change
Set Errors Action No change No change

New Properties
These new properties are exclusive to LWC OmniScripts:

Property Description
Send only Extra Pass an Extra Payload's Key/Value pairs without sending an OmniScript's data JSON by using the Send
Payload Only Extra Payload property available in these actions: Calculation Action, HTTP Action, Integration
Procedure Action, and Remote Action.
Step: Messaging Steps support the pubsub, window post message, and session storage message properties. See
Framework Communicate with OmniScript from a Lightning Web Component.

Added Property Support


LWC OmniScript supports these OmniScript properties:

Property LWC Behavior Angular Behavior


Conditional View: Set element to The conditional view property takes precedence The element's Read Only property
readonly if false over an element's Read Only property. takes precedence.
Conditional View: Set required The conditional view property takes precedence The element's Required property
element to optional if false over an element's Required property. takes precedence.
Repeat No change No change

New Functionalities
These new functionalities are exclusive to LWC OmniScripts:

© 2022 Vlocity LLC, a Salesforce


company 25
Vlocity Government

Functionality Description
Custom Stylesheet Static Resource Add custom styling to an OmniScript using a custom style sheet static resource.
Enable LWC OmniScripts with Create LWC OmniScripts or convert Angular OmniScripts with a Type that begins with an
UpperCase Type uppercase letter with no additional configuration. See Create an LWC OmniScript.
Inline OmniScripts Display OmniScripts inline in Community and Lightning pages.
Navigate to Additional Direct users to an App, Community Named Page, Logout, or Login page using the Navigate
PageReference Types Action. See Navigate Action.
Override the Edit Block LWC Override an Edit Block LWC, Edit Block New LWC, and Edit Block Label LWC, to add custom
functionality and styling to an Edit Block.
Override the Modal LWC Extend and override the OmniScript Modal LWC.
Override the Save For Later Override the Save For Later Acknowledgment LWC to add customizations.
Acknowledgement LWC
Override the Type Ahead LWC The LWC Type Ahead element's LWC Component Override field overrides the Type Ahead
component instead of overriding the Type Ahead Block component.
SEO OmniScripts Enable OmniScripts to appear in online searches and direct users to specific Steps in the
OmniScript by configuring OmniScript's SEO options.
SLDS Token Override Add customizations to SLDS Design Tokens in the OmniScript.
Stateful OmniScripts Store the state of an OmniScript's progression in the URL to direct users to specific Steps in
an OmniScript and temporarily store data.
Time Tracking in Navigate Action The Navigate Action supports time tracking. The action is tracked in the StepActionTime time
tracking entry. See Vlocity OmniStudio Tracking Service.

Added Functionality Support


LWC OmniScript supports these OmniScript functionalities:

Functionality LWC Behavior Angular Behavior


Cancel Add a cancel option to an LWC OmniScript by configuring The Cancel button options appear in
the Navigate Action. See Enable and Configure Cancel the Script Configuration's Cancel Options
Functionality in an LWC OmniScript. section.
Edit Block Cards Override the Card with an LWC to add customizations. Use templates to add customizations to the
Card.
Multi-Language • Add and access custom labels in custom LWCs. • Angular Multi-Language OmniScripts
OmniScripts • Provides Beta support for right-to-left languages. cannot use LWCs.
• Requires different custom label translations • Supports right-to-left languages
• Requires different custom label translations

Angular OmniScripts

• Improved messaging and error handling has been added for SFDC authentication in AEM deployments.
• Content Ids appear in the OmniScript's data JSON when a Content Document is uploaded.
• The prettify filter has been removed due to the CC-BY-SA-4.0 licensed snippet. Create a solution to
replace this functionality by referencing this document, pretty-print-json.
• Step elements support window post message, session storage message, and the message property. See
Message with Window Post Messages and Session Storage Messages.

© 2022 Vlocity LLC, a Salesforce


company 26
Vlocity Government

State Model Core Functionalities

• State Models support almost any base object type, not just Asset, Quote, Contract, or
InsuranceClaim__c. See Workflow for Preparing the Base Object for a State Model.
• State Model Versions support rules that determine whether state transitions can occur. A transition can
have no rules, one rule, or more than one rule with Any True or All True logic. Each rule can have an
associated Vlocity Action and success and failure messages. See Workflow for Creating State Transition
Rules.
• States can also have associated Vlocity Actions, one of which can be a default action. See Workflow for
Creating Actions for States and Rules.
• State Model Versions also support an optional Trigger-enabled On Creation Action. See Workflow for
Using a Trigger and an On Creation Action.
• State Model Versions also support an optional custom rule evaluation Apex class. See Custom Rule
Evaluator Class.
• You can cache State Model states, transitions, rules, and actions for better performance. See Workflow
for Setting Up Caching for State Models.
• You can invoke state transitions automatically on a schedule. See Automatic State Model Transitions.

IDX Workbench

• The Version Compare dashboard lets you compare two versions of an OmniScript or Integration
Procedure in the same Source or Target org. See Compare OmniScript and Integration Procedure
Versions.
• You can specify a Project object in your Source org instead of configuring a project. See IDX Workbench
Configuration for Migration.

Digital Interaction Platform Enhancements, Winter '20


This section provides a summary of the Digital Interaction Platform features and enhancements for the
Vlocity Winter '20 release.

Vlocity Lightning Web Components

• Make remote calls from any custom LWC using the Common Action Utility. See Make Remote Calls from
Lightning Web Components using the LWC OmniScript Action Framework.
• Enable Salesforce's Debug Mode to view Lightning web component errors. See Enable Debug Mode.

Cards

• Limit user access to a card layout with custom permissions. See Creating a Card Layout Using Card
Designer.
• Clear user sessions, custom labels, card layouts, cards, and card template caches across the Vlocity
platform with the new Cache Settings feature in the Cards Designer. See Clear Platform and User
Session Caches.
• Update information on a card after making a change to an LWC OmniScript by passing a reload event to
the OmniScript through a URL parameter on the OS Action. See Launching an LWC OmniScript from an
OS Action on a Card.

© 2022 Vlocity LLC, a Salesforce


company 27
Vlocity Government

• Use the $root.vlocity variable to return information about the logged-in user from the data source of a
card on an LWC enabled card layout. See Creating an LWC Card Layout.
• In the new Vlocity Interaction Wrapper component, access all available actions on a customer interaction,
complete, cancel, or resume customer interactions, and view a list of tracking events submitted during a
customer interaction. See Access Actions and Manage Interactions with the Vlocity Interaction Wrapper.
• On a Customer Story card, replace the preconfigured list of actions that create new records with a
customized list of actions. See Replacing Actions on an LWC Customer Story Card.
• The cardActiveState, wideCard, wideCardSlim, and wideCardSmart LWC card templates support field
tracking.
• On a card state, configure a Smart Action and one or more standard actions, such as Vlocity Actions,
Custom Actions, and OS Actions. Prior to this release, you must configure a Smart Action or one or more
standard actions on a card state, not both. See Configuring Smart Actions on an LWC Card.
• Cards with Smart Actions reload when profile attributes update on Lightning or Community pages with
the Vlocity Lightning Profiler component. See Reloading a Smart Card After Updating Profile Attributes.
• New Description field on the Vlocity Action object describes the action. See Vlocity Actions.
• Custom Actions on an LWC enabled card supports Salesforce PageReference Types that enable
navigation within Lightning Experience, within Communities, or to an external web address. See Adding a
Custom Action to an LWC Card.
• OS Actions are fully supported on LWC enabled cards.
• Explicitly deploy and save your LWC enabled card layout, and update the card preview by clicking the
new Deploy button. Autosave triggers only when the card’s layout or card is activated. See Creating an
LWC Card Layout.
• Embed any Vlocity Lightning Web Component, such as an LWC OmniScript, an LWC enabled card, or
any other custom LWC, inside an LWC Card state, and set the attributes of the embedded component.
See Embedding a Vlocity Lightning Web Component Inside an LWC Card State.
• LWC enabled cards and card layouts support Async/Queueable support on Integration Procedures
and Apex Remotes, Dual, and Streaming API data sources. The Preview pane does not support the
Streaming API data source. See LWC Cards Changes and Enhancements.
• New Accordion LWC displays content as vertically stacked sections. Sections can embed other
components. See Accordion Lightning Web Component ReadMe.
• New leftAccountInfoState LWC card state template displays account data listed in rows. See
LeftAccountInfoState LWC Card Template.
• New leftProfileState LWC card state template displays account information as a google map image, up to
three data fields, and up to three actions. See LeftProfileState LWC Card Template.
• Configure the attributes of a Vlocity Lightning Web Component used as a flyout on an LWC enabled card
layout. See Creating an LWC Flyout.
• View a comprehensive list of available LWC card templates and their compatible card layouts, and LWC
layout templates and their compatible cards. See Base LWC Card and Layout Templates.

DataRaptors

• A DataRaptor Turbo Extract retrieves data from a single Salesforce object type. You can filter the data
and select the fields to return. Unlike a standard DataRaptor Extract, a DataRaptor Turbo Extract doesn't
support formulas or complex field mappings. See DataRaptor Turbo Extract Overview.

© 2022 Vlocity LLC, a Salesforce


company 28
Vlocity Government

• Beginning with the Winter '20 Salesforce release, Guest Users, also called anonymous users, cannot
access any records by default. Criteria-based Sharing Rules grant them read-only access. This affects all
Salesforce orgs. However, Vlocity allows guest users to create and update the records to which Sharing
Rules grant access. No additional configuration is necessary for this expanded access.
• Prior to Winter '20, the result of a LIST function in a formula was saved to a VLOCITY-FORMULA-LIST
node under the Formula Result Path. Beginning with Winter '20, the result is saved directly under the
Formula Result Path.

Functions
To enable conversions between Strings and JSON objects, the DESERIALIZE, RESERIALIZE, SERIALIZE,
and TOSTRING functions are supported. See Formulas and Functions.

Integration Procedures

Error Logging

• Write Integration Procedure errors to Vlocity Error Log Entry SObject records by setting
ErrorLoggingEnabled to true. ErrorLoggingEnabled is a Custom Setting under General Settings. See
Error Handling in Integration Procedures.
• Integration Procedures can write Failure Response values to specific fields, including custom fields, in
Vlocity Error Log Service SObject records. See Error Handling in Integration Procedures.

Security

• If a user has access to a parent Integration Procedure, the parent can invoke child Integration
Procedures and DataRaptors even if the user doesn’t have direct access to them. See Create an
Integration Procedure.
• You can call DataRaptors and Integration Procedures privately from Apex, ignoring Sharing Rules. See
DRGlobal Class and Methods and IntegrationProcedureService.

Chainable Settings

• The Chainable Actual Time setting specifies the number of seconds an Integration Procedure can run
before chaining occurs to avoid reaching the Salesforce Concurrent Request Limit. It has no default. See
Settings for Long-Running Integration Procedures.
• Integration Procedure Actions in Integration Procedures have a Disable Chainable checkbox, which
is unchecked by default. If checked, this setting disables the Chainable settings of the subordinate
Integration Procedure. It doesn't affect the Queueable settings. See Integration Procedure Action and
Settings for Long-Running Integration Procedures.

Unit Testing
The setMockHttpResponseByUrlOrActionName method enables unit testing of Integration Procedures that
include more than one HTTP Action. See Integration Procedure Unit Testing from Apex.

© 2022 Vlocity LLC, a Salesforce


company 29
Vlocity Government

Caching
The IntegrationProcedureService class provides methods to clear Integration Procedure data from
the cache: clearSessionCache, clearOrgCache, clearSessionCacheBlock, and clearOrgCacheBlock. See
Cache for DataRaptors and Integration Procedures.

LWC OmniScripts

NOTE
Beginning with the Winter '20 Salesforce release, Guest Users, also called anonymous
users, cannot access any records by default. Criteria-based Sharing Rules grant them
read-only access. This affects all Salesforce orgs. However, Vlocity allows guest users
to create and update the records to which Sharing Rules grant access. No additional
configuration is necessary for this expanded access.

New Properties
These new properties are exclusive to LWC OmniScripts:

Property Description
Action Message Enables custom action messages to render under an action's loading spinner when an Action runs. For
more information, see Common Action Element Properties.
Display Outside Enables Knowledge base articles to display in a separate Lightning web component in a Lightning page.
OmniScript For more information, see Opening Knowledge Base Articles Outside of a Classic OmniScript.
Merge Saved Data JSON Enables a saved OmniScript to merge data into an updated version of the OmniScript. For more
into updated OmniScript information, see Configure Save Options.

Added Property Support


LWC OmniScript supports these OmniScript properties:

• Console Tab Title and Console Tab Icon


• Custom Tracking Data
• Enable Tracking
• Fetch Picklist Values At Script Load
• Hide
• Knowledge
• Repeat - Only Block elements are supported

New Functionalities
These new functionalities are exclusive to LWC OmniScripts:

• Make remote calls from any custom LWC using the Common Action Utility. Make Remote Calls from
Lightning Web Components using the LWC OmniScript Action Framework.

© 2022 Vlocity LLC, a Salesforce


company 30
Vlocity Government

• View Knowledge Base articles outside of the OmniScript using the Vlocity OmniScript Knowledge Base
Component. See Opening Knowledge Base Articles Outside of a Classic OmniScript.
• Pass parameters into LWC OmniScripts in a Community. See Launch an LWC OmniScript with LWC
OmniScript Wrapper.
• Launch an OmniScript from a Card in a Community. See Launching an LWC OmniScript from an OS
Action on a Card.
• Override the default save for later error message with a custom message. See Configure Save Options.
• Pass events to an LWC OmniScript in the c_vlocEvents parameter, and fire the event by configuring
the Navigate Action. See Navigate Action.
• Hide the Next and Previous button on a Step by setting the width for each button to 0. See Hide the Next
and Previous Buttons.
• Override the Step Chart Lightning web component. See Customize the Step Chart Component.
• The OmniScript Base Mixin component includes methods to enable these functionalities:
• Navigating to a Step
• Saving a state in a disconnected callback
• Clearing a saved state when a user navigates to a previous Step
• Making remote calls
• Applying response data to an OmniScript's data JSON
• In LWC OmniScripts, validation runs when a user clicks out of a field by using the onBlur function. In
Angular OmniScripts, validation runs when a user types in a field by using the onChange function.
To enable the LWC OmniScript to run validation when a user types:
1. In the Setup properties, click Edit as JSON.
2. Add the property "commitOnChange": true.
3. Preview the behavior.

NOTE
In LWC OmniScripts, the onChange behavior runs after a half-second delay.

Added Functionality Support


LWC OmniScript supports these OmniScript functionalities:

• Displaying Knowledgebase articles in OmniScript. For more information, see Initial Configuration for the
Knowledge Component in Classic OmniScript.
• Saving and resuming OmniScripts. Saving and resuming LWC OmniScripts requires additional
configuration due to new behavior. For more information, see Configure Save Options.
• Group elements support the validation framework. For example, when a Group element, such as a Block,
is hidden, validation does not apply to any element inside of the hidden group element.
• Prefilling repeatable blocks. For more information, see Prefill Repeatable Blocks

Added OmniScript Element Support


LWC OmniScript supports these elements:

© 2022 Vlocity LLC, a Salesforce


company 31
Vlocity Government

Element LWC Behavior Angular Behavior


Block No change No change
Edit Block The Edit Block replaces HTML templates with the Select Modes property. For more Edit Block uses
information, see Configure an Edit Block. HTML templates to
display different Edit
Block styles.
Email Action No change No change
DocuSign No change No change
Envelope
DocuSign LWC OmniScripts use a new Visuaforce page to render the DocuSign Signature modal. The Visualforce page
Signature To use the DocuSign Signature Action in Communities, add user profile permission for does not exist.
the Visualforce page. For more information, see Using the DocuSign Signature Action to
Sign Documents From Within an OmniScript.
File Supports uploads up to 2GB. For more information, see Upload Files and Images in Supports uploads up
OmniScripts. to 25 MB.

NOTE
The Image and File elements do not work in the LWC preview
due to a Salesforce limitation. When Image and File elements are
required in a Step, the LWC Preview cannot advance past the
Step. Vlocity recommends marking File and Image elements as
Required only before activating the OmniScript.

Image Supports uploads up to 2 GB. For more information, see Upload Files and Images in Supports uploads up
OmniScripts. to 25 MB.

NOTE
The Image and File elements do not work in the LWC preview
because they use Salesforce components. When Image and
File elements are required in a Step, the LWC Preview cannot
advance past the Step. Vlocity recommends marking File
and Image elements as Required only before activating the
OmniScript.

Messaging Validation runs when a user clicks out of a field. See Display Messages in OmniScripts. Validation runs when
a user types.
Password No change No change
Type Ahead The Type Ahead Block displays a progress bar instead of a spinner when retrieving data There is no progress-
Block results. See ProgressBar Lightning web component ReadMe. bar component

Relationship Graphs

All Graph Types

• You can filter nodes based on field values in the configuration or the published graph. See Use the
Relationship Graph Admin Config Tool.

© 2022 Vlocity LLC, a Salesforce


company 32
Vlocity Government

• If Context Direction is set to true, the direction of each relationship is defined relative to the context
node. If Context Direction is false, the source and target of each traversal define the direction of each
relationship. The default is false. See Use the Relationship Graph Admin Config Tool.
• A Relationship Graph can get its context ID in one of three ways: from the context Id of the page, from a
hard-coded Id in the Vlocity Graph component configuration, or from an Apex class. See Use the Vlocity
Graph Component Editor.

Radial Graphs
In Radial type Relationship Graphs, you can use a custom Record Page Layout for the View/Edit pop-up.
See Use the Relationship Graph Admin Config Tool.

Hierarchy Graphs
• Hierarchy type Relationship Graphs are collapsible. You can set the initial number of levels to which the
graph is collapsed. See Use the Relationship Graph Admin Config Tool.
• You can traverse up the hierarchy from the context node as well as down. See Use the Relationship
Graph Admin Config Tool.
• You can set the node dimensions, fill color, outline appearance, and display information. See Use the
Relationship Graph Admin Config Tool.
• Hierarchy type Relationship Graphs provide Beta support for a Treelist option, in which the root node
is at the top left, and each level away from the root node is indented farther to the right. See Use the
Relationship Graph Admin Config Tool.

SDK Enhancements
Translation SDK now supports anonymous users.

Digital Interaction Platform Enhancements, Summer '19


This section provides a summary of the Digital Interaction Platform features and enhancements for the
Vlocity Summer '19 release.

Vlocity Lightning Web Components


Vlocity provides Salesforce Lightning Web Components support with Vlocity Lightning Web Components.
Vlocity Lightning Web Components enable you to use standard JavaScript and HTML to modify and extend
Vlocity products. Vlocity Lightning web components are fast, easy to use and reuse, and are supported by
all major browsers because it uses web components standards set by the W3C instead of AngularJs.

Vlocity Cards and Vlocity OmniScript both support Lightning Web Components.

For more information, see OmniStudio Vlocity Lightning Web Components.

To access the introductory training course for Vlocity Lightning web components, see Introduction to Vlocity
Lightning Web Components.

Cards
Vlocity Cards supports Salesforce’s Lightning Web Components programming model by including
components, functionalities, and templates exclusive to LWC Cards. LWC Cards enable the use of custom
components built with standard JavaScript and HTML.

© 2022 Vlocity LLC, a Salesforce


company 33
Vlocity Government

For more information, see LWC Cards.

DataRaptor

• If emails are configured in Case assignment rules, checking Use Assignment Rules in a DataRaptor Load
automatically sends emails to users when Cases are assigned.
For more information, see Create a DataRaptor Load.
• The Required Permissions setting limits access to DataRaptors and Integration Procedures based on the
user's Profiles and Permission Sets.
For more information, see Security for DataRaptors and Integration Procedures.
• DataRaptor metadata is cached for better performance.
For more information, see Cache for DataRaptors and Integration Procedures.
• Moving product relationships between orgs is supported.

Integration Procedure

• An Integration Procedure can include a Try-Catch Block, which returns specified output or calls an Apex
class if a step within it fails.
For more information, see Handle Errors Using Try-Catch Blocks.
• You can cache metadata and JSON data for an entire Integration Procedure. A Cache Block lets you
cache data for specific actions and use cache keys. Caching improves performance.
For more information, see Cache for DataRaptors and Integration Procedures.
• An Integration Procedure can include a Batch Action, which runs a Vlocity Scheduled Job.
For more information, see Batch Action for Integration Procedures.
• You can use the Wrap Up Process Name and Wrap Up Process Type fields to run a different Integration
Procedure or VlocityOpenInterface as a child of the initial process, in the same transaction, once the
initial process finishes.
For more information, see Batch Jobs for Integration Procedures and Vlocity Open Interfaces.
• In an Integration Procedure, you can increase Salesforce governor limits by allowing a chainable step to
start a queueable job. You can also configure heap size, CPU, and query limits for a queueable/chainable
Integration Procedure.
For more information, see Settings for Long-Running Integration Procedures.
• Send/Response Transformation fields support merge field syntax. This lets you include variables
(%variable%) to generate path and node values dynamically.
For more information, see Manipulate JSON with the Send/Response Transformations Properties.

OmniScript
OmniScript supports Salesforce’s Lightning Web Components programming model by including
components, functionalities, and elements exclusive to LWC OmniScripts. LWC OmniScripts enable the
use of custom components built with standard JavaScript and HTML.

For more information, see LWC OmniScripts.

© 2022 Vlocity LLC, a Salesforce


company 34
Vlocity Government

Relationship Graph
Relationship Graphs have been completely redesigned and are no longer limited to Party Relationship
objects. Relationship Graphs support almost any objects and several graph types, including radial graphs,
hierarchical graphs, Sankey diagrams, and timelines.

For more information, see Any-Object Relationship Graphs.

Upgrade OmniScript and Integration Procedures

1. Upgrade OmniScript by adding these values to the Type picklist in the Vlocity OmniScript Element
(ns_Element_c) table:
• Custom Lightning Web Component
• Navigate Action
For more information, see Adding OmniScript Elements to an Upgraded Org.
2. Upgrade Integration Procedures by adding these values to the Type picklist in the Vlocity OmniScript
Element (ns_Element_c) table:
• Batch Action
• Cache Block
• Try Catch Block
For more information, see Add Integration Procedure Components to an Upgraded Org.

Known Issue Workaround


A DataRaptor Transform adds a year to a date if the year is within 1974-1976, the day is within
12/28-12/31, and the format is Date(MM/dd/YYYY). To avoid this issue, use the Date(MM/dd/yyyy) format.

2019 Government Release Notes


The following releases became available in 2019.

Government Release Notes Summer '19


Vlocity Government Summer '19 Major Release was approved for release on August 16, 2019. To
download the release, see the Vlocity Package Downloads Index. This topic describes the key new features
and enhancements in this release.

Enhanced Service Provider Matching


Administrators now have more control over matching Service Plans with an appropriate Services Provider
with these new settings for Service Provider Matching. This feature enables Vlocity customers to automate
the matching of clients with Service Providers based on a wider range of criteria than was previously
available. Administrators can determine whether contracts are required to be used as part of the matching
process, and have multiple options for using geography as part of the criteria. They can also control
whether partial matches are displayed in the result set. In addition, administrators can set up custom
criteria to be used in the matching process, based on custom fields that have been added to the Service
Plan and Service Provider objects. To set up the Service Provider Matching controls, download and install
the Service Provider Matching Administration process from the Vlocity Process Library. To adjust the
matching settings, edit the Service Provider Matching settings, as shown in the following figure (click to
enlarge).

© 2022 Vlocity LLC, a Salesforce


company 35
Vlocity Government

New Objects to Support Eligibility Determination


The new objects, which include Income, Expense and Employment, enable caseworkers to collect and
view a client’s complete employment and financial history. This data can be used in integrated eligibility
processes or in applications for individual programs.

© 2022 Vlocity LLC, a Salesforce


company 36
Vlocity Government

Referral Support
To support referrals, this release includes a new 'Create Referral' OmniScript and Referral card. The card
has two states, closed and open, set according to the status of referral record.

New Enrollment Layout and Cards


This release provides a new layout that contains three new cards, for Housing, Employment Assistance,
and Child Care. The type of Program Enrollment determines which card is launched by the layout. The
state of the card reflects the state of program enrollment status: Enrolled, Not Enrolled, or None (no
enrollment exists for the specified program). Each card supports relevant related, which are clickable and
functional.

Vlocity Platform Changes


DataRaptor
By default, if a value is null, DataRaptor Extracts and Transforms do not return the corresponding node in
the Data JSON. To return an empty node for null fields, set the Overwrite Target For All Null Inputs option
on the Options tab.

Integration Procedures
To enable long-running Integration Procedures to avoid the Salesforce transaction timeout limit, you can
enable chaining in the calling OmniScript. See Configuring Long-Running Integration Procedures.

OmniScript

• Actions now support the Abort error modal through the property Enable Default Abort. See OmniScript
Action Elements Overview.
• The default behavior when an action fails between steps is now a Go Back button that enables users to
return to the previous step. The Abort functionality can be enabled by checking the checkbox property
labeled Enable Default Abort. See OmniScript Action Elements Overview.
• The Knowledge Persistent Component is now supported in Newport.
• The Console Tab Title and Console Tab Icon settings in OmniScript will only apply if the OmniScript owns
the entire tab or subtab. The Console Tab Label and Console Tab Icon settings will not be used if the
OmniScript is embedded on a page with other components.
• Off-platform OmniScripts can now be forced to use a local definition even when a Salesforce connection
exists. See Adding a Local OmniScript Definition to Adobe Experience Manager.
• Off-platform OmniScripts that are locally defined can now retrieve User information for logged in Users.
See Adding a Local OmniScript Definition to Adobe Experience Manager.
• The new preview layouts Newport Mobile iPhone and Newport Mobile iPad have been added to the
preview dropdown in OmniScript Designer. See Previewing OmniScripts.
• The code in the static resources vlocityomnimobile, vlocityomniout, and vlocityomniaem, is now minified.
• The HTML Template Id property now supports a typeahead capability.
• Activating and Deactivating an OmniScript in Lightning console no longer forces the console tab to close.
• OmniScript's Console Tab Title and Console Tab Icon fields can now be left blank.
• The Cancel Button can now be removed from the UI by unchecking the Allow Cancel checkbox in an
OmniScript's Script Configuration. See Configuring the Cancel Link in an OmniScript.

© 2022 Vlocity LLC, a Salesforce


company 37
Vlocity Government

• Error messages can now be configured to return custom error messages that are displayed dynamically
based on the original error's path and text. A Default Error Message can also be displayed in place of
custom messages. See Customizing Error Messages for OmniScript Actions.
• The function RANDOM() has been added to the Formula Element. This method generates a random
number between 0 and 1 and does not accept parameters. See OmniScript Functions.
• A message reminding users that the Communities page layout and Classic page layouts are no longer
supported now displays on unsupported page layouts.
• Datapacks now support Element Type to HTML Template Mapping.
• Edit Block now has an inline template that is available when using the lightning styling. The template
enables users to edit information inline instead of in a modal. See Configuring an Edit Block.
• A link now appears next to the HTML Template Id field when a template is entered. This link takes you to
the specified template when clicked.
• Tooltips have been added to many Action element properties in the OmniScript Designer to help clarify
their purpose.
• Writing to the Salesforce Custom Time field is supported.
• Clicking the browser's back and forward buttons while in an OmniScript will now move a User to the
previous step or the next step.
• The Save For Later functionality can now be enabled or disabled on a per step basis. See Configuring an
OmniScript for Save and Resume.
• The Action property Invoke Mode can be set to Fire and Forget to have the action run asynchronously
with no response applied to the JSON. See OmniScript Action Elements Overview.
• The Action property Invoke Mode can be set to Non-Blocking to have the action run asynchronously with
the response applied to the JSON. See OmniScript Action Elements Overview.
• Picklists in the Lookup element can now be filtered by Record Type. See Lookup Element.
• The min and max values for the Range element can now be set dynamically. See Range.
• The Integration Procedure Action can now be used inside of a Type Ahead Block.
• Type Ahead Blocks now return unfiltered results when the Disable Data Filter property is checked. See
Make an HTTP Call from a Type Ahead Block.
• A CSS class has been added to prevent OmniScript CSS from affecting other markup on the page.
As a result, any custom styling using the .via-slds selector must be changed to .via-slds.via-omni. It is
necessary to append .via-omni in order for the styles to appear correctly.
• The IP Action returns the individual element names for action elements that are running in a chainable
Integration Procedure. These names render underneath the progress spinner visible to the user. See
OmniScript Integration Procedure Action.

Upgrade and Installation Instructions

• Add Delete Action to the Type picklist in the Vlocity OmniScript Element (ns_Element_c) table.
• If you are using the File element to map files to Salesforce, you must go to any OmniScript using the
File element and uncheck Upload to Content Document. File elements using the Upload to Content
Document functionality cannot be mapped in DataRaptor. If Upload to Content Document is checked and
the file is mapped in DataRaptor the file will be corrupted.

© 2022 Vlocity LLC, a Salesforce


company 38
Vlocity Government

Cards Framework

• The Tracking Entries feature in the Card Designer has been updated.
• When Track.CardFramework is enabled, Tracking entries get created for runtime
• When Track.CardPreview is enabled, Tracking entries get created for the designer preview
• Cards now provide proxy support for forceNG. You need to make a GitHub pull request to download
forceNG proxy support.
• If you're using a multi-currency org, the response of the GenericInvoke endpoint is not the same as that
of the ApexRemote endpoint. The user needs to run a manual query on the ApexRemote endpoint to
display the desired field(s) in the rest API response.
• Template Activation
When a user activates a new or cloned template, the template status is updated in the Template
Manager, however, the previous template version remains activated.
• Added settings for Lightning iframeComponent:
• Page (via a dropdown like the cards component)
• Height (default 100% if not set)
• Max Height
• Width (default 100% if not set)
• Enable New Template Designer deprecated
The deprecated option Enable New Template Designer is no longer included in the Card Framework
Configuration custom settings. Instead, use the Template Designer provided in Vlocity Templates.
• New field in Vlocity Action
There is an additional field named customLabel_c that is used for the Custom Label name in
VlocityAction_c. Use this field as a placeholder for the Salesforce Label name, which you can use
instead of (action.DisplayName).
• Relative URL links now work on Vlocity Actions. To make Vlocity Actions with a relative URL work in the
LEX Console, make sure the Action uses the following configuration:
• The Target URL value must start with ltng as its prefix
• The Open URL in value must be set to New Tab / Window, so that the relative URL link will open in a
new window
• You can now create Interaction Launcher flows using OmniScript. See Creating an Omniscript-based
Interaction Launcher.

Vlocity Government Winter '19


Vlocity Government Winter '19 Major Release was approved for release on January 14, 2019. The newest
version of the generally available Vlocity managed package is available from Vlocity Government Release
Summary.

[Download managed package]

This release fixes the following issues:

• Billing detail page link has been removed from the Account Object.
• A Stored XSS security issue related to the DocumentPdf component has been fixed.

© 2022 Vlocity LLC, a Salesforce


company 39
Vlocity Government

• Content that was not displayed due to a too-long custom setting name is now correctly displayed.
• The HousingCards VisualForce page now loads correctly.

2018 Government Release Notes


The following releases became available in 2018.

Vlocity Government Winter 2018 Version 101.1.1.910.15.2


Vlocity Government Winter '18, Minor release, Version 101.1.1.910.15.2 was approved for release on May
8, 2018. The newest version of the Vlocity managed package is available from Vlocity Government Release
Summary.

• New Features and Enhancements


• Upgrade and Installation Instructions

New Features and Enhancements in Vlocity Government Winter '18


Vlocity Government Winter '18, Minor release, Version 101.1.1.910.15.2 includes the following
enhancements.

• You can now populate radio button values when filling a PDF from an OmniScript using DataRaptor.

NOTE
Firefox and Safari browsers cannot fill some fields without taking additional steps. To use
Firefox and Safari, see Configuring your browser to use the Adobe PDF plug-in.

• Fixes potential cross-site scripting vulnerabilities that were discovered in a security scan.

Upgrade and Installation Instructions


• Preparing to Install the Salesforce Industries Communications, Media, and Energy Vlocity Applications
Package
• Upgrading to Winter '18

Vlocity Government Release Notes Winter 2018 Version 910.15


Vlocity Government Winter '18, Minor release, version 910.15 was approved for release on March 26,
2018. The newest version of the Vlocity managed package is available from Vlocity Government Release
Summary.

• New Features and Enhancements


• Upgrade and Installation Instructions
• Known Issues

New Features and Enhancements in Vlocity Government Winter '18


Vlocity Government Winter '18 includes the following new features and enhancements:

© 2022 Vlocity LLC, a Salesforce


company 40
Vlocity Government

• You can use Vlocity Document Generation with Vlocity Government. For more information, see
Document Generation In Vlocity Government.
• Vlocity provides the capability to create client documents in Microsoft Word, HTML, and PDF using
data from Salesforce or other systems, using a tool that is 100% native to the Salesforce platform.
• Administrators can set up document templates with text formatting options and conditional logic to
tailor the document to a client’s circumstances.
• Employees can select from available templates when creating a document. Vlocity uses the
appropriate data from Salesforce to populate the template, creating a client-specific document in
seconds.

NOTE
Vlocity Document Generation is a separate component that customers must purchase in
addition to Vlocity Government.

• To track the financial payments associated with a benefit case, there are five new objects in the Vlocity
Government data model. There is a corresponding page layout for each object. Your organization can
enable caseworkers and other employees to access and take action on the financial information related
to a client’s case. For more information, see Case Management Case Finances Objects.

NOTE
These objects are intended to facilitate integration with your organization’s existing
financial management system, not to be the primary source of this financial data.

• A new community template is available to assist customers with rapidly developing client- or provider-
facing portals. Called “Newport”, this template is optimized for Vlocity Cards and OmniScripts to create a
modern, easy-to-use portal for your customers. The Newport Community template is available from the
Vlocity Government Process Library.
• The ContactName custom field has been deprecated. It is no longer included in the Vlocity Government
package. If you require it, you can create it. For more information, see Create Custom Fields in the
Salesforce Help.

Upgrade and Installation Instructions


• Preparing to Install the Salesforce Industries Communications, Media, and Energy Vlocity Applications
Package
• Upgrading to Winter '18

Known Issues
The following are known issues with Vlocity Government Winter '18:

• The user receives an error message when trying to export or import a Vlocity Document Template. There
is a manual workaround to this issue. For more information, see Upgrading to Winter '18.
• In Salesforce Lightning Experience only, there is an intermittent issue with cards not loading correctly.
There is a known fix to this issue that will be made available in a future patch.

© 2022 Vlocity LLC, a Salesforce


company 41
Vlocity Government

• The package has been mistakenly labeled with the version "Spring 2018.” The true product version is
Vlocity Government Winter '18. In Setup, please see the version number, which should be 910.15.

Vlocity Government Winter 2018


Vlocity Government Winter '18 Major Release Version 910.9 was approved for release on October 16,
2017. The newest version of the generally available Vlocity managed package is available from Vlocity
Government Release Summary.

• Upgrade and Installation Instructions


• Known Issues

Upgrade and Installation Instructions


• Preparing to Install the Salesforce Industries Communications, Media, and Energy Vlocity Applications
Package
• Upgrade to the Latest Vlocity Government Release

Known Issues
The following are known issues with Vlocity Government Summer '17 and Vlocity Government Winter '18:

• PS-1061: Standard Salesforce pages rendered in an iFrame in the housing portal appear with a header
and sidebar. This is standard Salesforce behavior. Vlocity cannot change it.
• PS-1040: Browser Back button navigation does not work properly in the housing portal due to iFrame
structure.
• PS-1053: [Intermittent] Related object (lookup) fields are not rendering in the field picker user interface in
Query Builder.
• PS-1194: When using default configuration, the housing portal sidebar navigation requires at least one
active (category) parent action to display.
• PS-623: In the Products/Services Picker, clicking the magnifying glass does not execute search.
• PS-1312, PS-1311: Inventory item directory eligibility using Vlocity Entity Filters is failing when using
objects other than an inventory Item, such as Program Enrollment, Program Enrollment Extension, and
so on.

Vlocity Cards, Layouts, and Templates created in Salesforce Industries Communications, Media, and
Energy Summer '17 are not backwards compatible. However, Vlocity Cards, Layouts, and Templates
created in earlier versions of Salesforce Industries Communications, Media, and Energy will work in Vlocity
Government Summer '17 and Vlocity Government Winter '18.

2017 Government Release Notes


The following releases became available in 2017.

Vlocity Government Summer 2017


Vlocity Government Summer '17 Major Release Version 910.8 was approved for release on August 2,
2017. The newest version of the generally available Vlocity managed package is available from Vlocity
Government Release Summary.

© 2022 Vlocity LLC, a Salesforce


company 42
Vlocity Government

• New Features and Enhancements


• Upgrade and Installation Instructions
• Known Issues

New Features and Enhancements in Vlocity Government Summer '17


Vlocity Government Summer '17 includes the features and enhancements to the Vlocity Guided Interaction
Platform. For more information, see Vlocity Digital Interaction Platform Summer 2017.

Vlocity Government Summer '17 also includes a fix for a commonly encountered error. Previously, users
received an error when trying to edit and save tasks that were assigned to them. This error no longer
occurs.

Upgrade and Installation Instructions


• Preparing to Install the Salesforce Industries Communications, Media, and Energy Vlocity Applications
Package
• Upgrade to the Latest Vlocity Government Release

Known Issues
The following are known issues with Vlocity Government Summer '17:

• PS-1061: Standard Salesforce pages rendered in an iFrame in the housing portal appear with a header
and sidebar. This is standard Salesforce behavior. Vlocity cannot change it.
• PS-1040: Browser Back button navigation does not work properly in the housing portal due to iFrame
structure.
• PS-1053: [Intermittent] Related object (lookup) fields are not rendering in the field picker user interface in
Query Builder.
• PS-1194: When using default configuration, the housing portal sidebar navigation requires at least one
active (category) parent action to display.
• PS-623: In the Products/Services Picker, clicking the magnifying glass does not execute search.
• PS-1312, PS-1311: Inventory item directory eligibility using Vlocity Entity Filters is failing when using
objects other than an inventory Item, such as Program Enrollment, Program Enrollment Extension, and
so on.

Vlocity Cards, Layouts, and Templates created in Salesforce Industries Communications, Media, and
Energy Summer '17 are not backwards compatible. However, Vlocity Cards, Layouts, and Templates
created in earlier versions of Salesforce Industries Communications, Media, and Energy will work in Vlocity
Government Summer '17.

Vlocity Government Spring 2017


Vlocity Government Spring 2017 is now generally available. This release includes a number of
enhancements to help organizations provide a more client-centric case management process. The
following new features are part of this release.

OmniScript: Lightning Player


Vlocity OmniScript’s Lightning Player is now generally available! The Lightning Player’s design is based on
the Salesforce Lightning Design system, allowing you to create OmniScripts that are consistent with the

© 2022 Vlocity LLC, a Salesforce


company 43
Vlocity Government

Lightning Experience. The responsive design of the Lightning Player allows you to build OmniScripts once
and use them on a variety of devices. Going forward, all new OmniScript features will be developed on the
Lightning Player.

OmniScript: Auto Advance


The new Auto Advance option enables you to streamline OmniScripts by reducing unnecessary clicks. If
Auto Advance is enabled on a Select or Radio Button element, the script will automatically move to the next
step once a user selects an option.

To create more visually appealing radio buttons, you can now use images in place of text for the selectable
options!

© 2022 Vlocity LLC, a Salesforce


company 44
Vlocity Government

Figure 1. Example: Woodgreen uses images for selectable options instead of text.

Vlocity Interaction Launcher


The Interaction Launcher provides call center agents with a way to verify callers by fields such as
Birthdate, Address, and Social Security Number. Only after a caller is verified, the call center agent
will see a dynamic view of the client based on the caller’s role.

Take advantage of the new lightning-style Vlocity Cards templates!

© 2022 Vlocity LLC, a Salesforce


company 45
Vlocity Government

© 2022 Vlocity LLC, a Salesforce


company 46
Vlocity Government

Vlocity Intelligence
Vlocity now provides organizations with a way to introduce artificial intelligence into processes. With
Vlocity Intelligence, administrators can tune an intelligent recommendations engine to match clients with
the appropriate programs and services to fit their needs. For example, you can present clients with new
programs that they may be qualified for based on their age group, citizenship status, or other profile
attributes.

© 2022 Vlocity LLC, a Salesforce


company 47
Vlocity Government

Vlocity DataRaptor
Vlocity has introduced DataRaptor Data Transform capabilities, making DataRaptor an even more powerful
ETL tool. Administrators can now modify data values through IF/ELSE formulas and functions such as
SUM, MIN, and MAX.

© 2022 Vlocity LLC, a Salesforce


company 48
Vlocity Government

With DataRaptor Workbench, administrators can easily test their DataRaptor mappings without using
external tools.

© 2022 Vlocity LLC, a Salesforce


company 49
Vlocity Government

Relationship Graph
Vlocity has continued to make the relationship graph richer in features and easier to configure. You can
now display additional fields, such as age or address, on relationship graph nodes. The fields you display
can vary based on the object type, giving you the flexibility to show different fields on a Contact, Household
or Account nodes.

In addition, you can now create multiple relationship graphs for a single Contact, Household or Account.
A user can toggle between different types of relationship graphs with a pull-down menu. For example, you
can choose to display only a client’s familial relationships.

Case Notes
Vlocity Government now includes a Case Notes object to allow caseworkers to keep a record of notes
about a client’s case. The Vlocity Case Notes object does not have a master-detail relationship with
any other object, which means administrators have full flexibility when configuring sharing settings. For
instance, a case note can be set up to be private to the caseworker or shared with any caseworker in the
program the client is enrolled in. Case notes can be related to a client’s benefits case, service plan, or
program enrollment.

Program Enrollment Members


Vlocity has added a new object called Program Enrollment Members to the data model, to track people
related to a program enrollment. This object is particularly useful when family members or household
members participate in a program alongside the primary enrollee.

© 2022 Vlocity LLC, a Salesforce


company 50
Vlocity Government

Reporting
Vlocity has included 10 new out of the box reports, enabling program managers to glean key insights
about program enrollments, referrals, service plans, and other important objects. For example, the following
reports are now available:

• Enrollments by eligibility determination


• Referrals by service provider
• Service plans by status

For more information about Vlocity Government Spring '17, see our webinar, Introducing Vlocity
Government Spring '17.

Vlocity Government Winter 2017


Vlocity Government Winter 2017 is now generally available. This release includes a number of
enhancements to help Health and Human Services agencies provide a more client-centric case
management process. This topic describes the new features in Winter 17, also known as Vlocity
Government V13.

© 2022 Vlocity LLC, a Salesforce


company 51
Vlocity Government

OmniScript
Vlocity OmniScript has a new look! Vlocity invites you to beta test the new OmniScript Lightning Player,
based on the Salesforce Lightning Design System.

In this release, OmniScript has three new element types.

• With the Email Action, administrators can configure email templates to be sent directly from an
OmniScript. For example, upon submission of an intake form, the applicant can receive an email
confirming their application has been received.
• The new Type Ahead field returns a list of selectable suggestions as the user types into a text box. With
minimal set up, administrators can configure the Type Ahead field to display Contacts, Addresses, and
other custom results lists. The Type Ahead element is integrated with Google Maps, so users can verify
that they have selected the right address.

© 2022 Vlocity LLC, a Salesforce


company 52
Vlocity Government

NOTE
Google API Key needed for Google maps integration, https://developers.google.com/
maps/documentation/javascript/get-api-key

• The DocuSign Signature Action enables administrators to embed a DocuSign document directly into an
OmniScript, allowing clients to sign application forms, lease agreements, and other documents in real
time.

© 2022 Vlocity LLC, a Salesforce


company 53
Vlocity Government

NOTE
DocuSign license required for DocuSign signature integration.

DataPacks
With Vlocity DataPacks, administrators can easily move Vlocity components between orgs. OmniScripts,
DataRaptors, and Vlocity Cards can be exported in individual DataPacks or grouped in a MultiPack (group
of DataPacks) and migrated all at the same time.

Enhanced Portal User Interface and Administration


Vlocity has continued to make the client and provider portals faster, richer in features, and easier to
configure.

With the improved Message Center, caseworkers can communicate securely with their clients. Human
Services agencies can send automated messages to inform clients of changes to their application or
remind them about upcoming appointments.

© 2022 Vlocity LLC, a Salesforce


company 54
Vlocity Government

Providers can manage their housing listings through an MLS-style Listing Administration page. Property
Managers can make changes to unit attributes directly in the housing card or navigate to the Salesforce
record.

Vlocity also added the ability for clients and providers to take action on requests logged through the portal.
For example, clients can escalate or cancel repairs they have requested for their unit.

© 2022 Vlocity LLC, a Salesforce


company 55
Vlocity Government

Referrals
Vlocity Government now includes a Referrals object to allow caseworkers to track when they refer a client
to an independent agency for services outside of the caseworker’s agency. For instance, a client receiving
housing assistance may receive a referral to a non-profit that provides training courses to aid with their job
search. Referrals can be stored as part of the client’s Benefits Case file.

Lightning Ready
Vlocity has invested significant engineering efforts in making sure that all Vlocity customers can take
advantage of the Salesforce Lightning Experience. With this release, all Vlocity Government custom objects
can now be used with the more intuitive Lightning user interface.

Not all Salesforce and Vlocity features are currently supported in the Lightning Experience. Please discuss
with Vlocity Support before making a decision to migrate to Lightning in your Salesforce org.

© 2022 Vlocity LLC, a Salesforce


company 56
Vlocity Government

2016 Government Release Notes


The following releases became available in 2016.

Vlocity Government V15


Vlocity Government V15 was approved for release on May 9, 2017. The newest version of the generally
available Vlocity managed package is available from Vlocity Government Release Summary.

• New Features and Enhancements


• Upgrade and Installation Instructions
• Known Issues

New Features and Enhancements in Vlocity Government V15


• Case Notes
• Vlocity Case Notes enable customers to create secure notes related to Contracts, Program
Enrollments, Benefit Cases, Service Plans, and other objects.
• Case Notes do not have a master-detail relationship with any object. Customers have full control over
who can see the notes. Configure notes to be private to the person who created them, or share them
with a case team using the Salesforce sharing rules. For more information about Salesforce sharing
rules, see Sharing Rules in the Salesforce Help.
• Program Enrollment Members
• Using the new Program Enrollment Members object, you can add related people, such as household
members, to a program enrollment.

Upgrade and Installation Instructions


• Preparing to Install the Salesforce Industries Communications, Media, and Energy Vlocity Applications
Package
• Upgrade to the Latest Vlocity Government Release

Known Issues
The following are known issues with Vlocity Public Section V15:

• PS-1061: Standard Salesforce pages rendered in an iFrame in the housing portal appear with a header
and sidebar. This is standard Salesforce behavior. Vlocity cannot change it.
• PS-1040: Browser Back button navigation does not work properly in the housing portal due to iFrame
structure.
• PS-1053: [Intermittent] Related object (lookup) fields are not rendering in the field picker user interface in
Query Builder.
• PS-1194: When using default configuration, the housing portal sidebar navigation requires at least one
active (category) parent action to display.
• PS-623: In the Products/Services Picker, clicking the magnifying glass does not execute search.
• PS-1312, PS-1311: Inventory item directory eligibility using Vlocity Entity Filters is failing when using
objects other than an inventory Item, such as Program Enrollment, Program Enrollment Extension, and
so on.

© 2022 Vlocity LLC, a Salesforce


company 57
Vlocity Government

In addition, Vlocity Cards, Layouts, and Templates created in Vlocity Apps V15 are not backwards
compatible. However, Vlocity Cards, Layouts, and Templates created in earlier versions of Vlocity Apps
will work in Vlocity Apps V15.e

Vlocity Government V14


Vlocity Government V14 was approved for limited release on December 12, 2016. The newest version of
the generally available Vlocity managed package is available from Vlocity Government Release Summary.

• New Features and Enhancements


• Upgrade and Installation Instructions
• Known Issues

New Features and Enhancements in Vlocity Government V14

Relationship Graph

• Display additional fields, such as age or address, on relationship graph nodes. The fields you display can
vary based on the object type—for example, Contact, Account, or Household.
• Create multiple relationship graphs for a single contact, household or account. Toggle between different
types of relationship graphs, for example Family or Natural Supports using a list.

Housing Portal
Choose which users can view announcements in the Portal. You can configure announcements to display
only for users of a specific profile or for users who have a Program Enrollment of a specific Program and
Type.

DataPacks
Easily move Vlocity Query Builders and Vlocity Actions from one Salesforce environment to another using
DataPacks.

Other Enhancements and Fixes

• Query Builder tables and Housing Portal templates have been enhanced to match Salesforce Lightning
Design System look and feel.

© 2022 Vlocity LLC, a Salesforce


company 58
Vlocity Government

• PS-1224: Display sequence can now be used to determine the image sequence in the housing directory.

NOTE
The photo with display sequence of “1” is displayed as the primary image. Vlocity does
not recommend using the Default Image check box.

• PS-1282: The InventoryStatus trigger is now turned off by default to avoid conflicts with workflows. To
enable, from Setup, click Custom Settings. Click Trigger Setup. Click Inventory Status Trigger. Select
Enable.

Upgrade and Installation Instructions


• Preparing to Install Vlocity Applications
• Upgrade to the Latest Vlocity Government Release
• Update the Benefit Case Layout (Vlocity 2.7)
• Adding OmniScript Elements to an Upgraded Org

© 2022 Vlocity LLC, a Salesforce


company 59
Vlocity Government

Known Issues
• PS-1061: Standard Salesforce pages rendered in an iFrame in the housing portal appear with a header
and sidebar. This is standard Salesforce behavior. Vlocity cannot change it.
• PS-1040: Browser Back button navigation does not work properly in housing portal due to iFrame
structure.
• PS-1053: [Intermittent] Related object (lookup) fields are not rendering in field picker UI in Query Builder.
• PS-1194: When using default configuration, housing portal sidebar navigation requires at least one active
(category) parent action to display.

Vlocity Government V13


Vlocity Government V13 was approved for release on September 9, 2016. The newest version of the
Vlocity managed package is available from Vlocity Government Release Summary.

• New Features and Enhancements


• Upgrade and Installation Instructions
• Known Issues

New Features and Enhancements in Vlocity Government V13


• Improvements in Vlocity Query Builder
• Add a Global Action to any Query Builder table to allow users to perform actions such as New Request
or Send Message.
• Configure destination, display text, and context using Vlocity Actions.
• Add a Row Action to any Query Builder table row to allow users to perform record-specific actions such
as Close Case, Provide Feedback, and Reply to Message.
• Create dynamic actions based on a value in the record, such as Status.
• PS-942: Related object lookup fields are now available for display in Query Builder tables.
• PS-1215: The Housing directory is now supported in Salesforce Sites for external users.
• PS-1217: The Loading icon is supported on the Housing Portal.
• PS-1229 and PS-1149: The Housing directory page options are more flexible. For each housing listing
page, you can determine the following:
• Whether the system should check the eligibility of listing items
• Whether users can express interest in a listing items
• Which View options appear—View All, View Eligible, View Interested
• PS-1209: Custom sort is supported with Query Builder pagination
• PS-1147: You can add video attachments to Housing directory items

Upgrade and Installation Instructions


• Preparing to Install the Salesforce Industries Communications, Media, and Energy Vlocity Applications
Package
• Upgrade to the Latest Vlocity Government Release
• Update the Benefit Case Layout (Vlocity 2.7)

© 2022 Vlocity LLC, a Salesforce


company 60
Vlocity Government

• Adding OmniScript Elements to an Upgraded Org

Known Issues
• PS-1061: Standard Salesforce pages rendered in an iFrame in the Housing portal appear with a header
and sidebar. This is standard Salesforce behavior; Vlocity cannot change it.
• PS-1040: Web browser Back button navigation does not work properly in the Housing portal due to the
iFrame structure.
• PS-1053: Related object fields, also known as look up fields, may not render in the field picker user
interface in Query Builder.
• PS-1224: Display sequence and Default Image values are not considered in the Housing directory.

Vlocity Government V12


Vlocity Government V12 was approved for release on April 6, 2016. The newest version of the Vlocity
managed package is available from Vlocity Government Release Summary.

• New Features and Enhancements


• Upgrade and Installation Instructions
• Known Issues

New Features and Enhancements in Vlocity Government V12


• Create an application for housing
For more information, see Application for Housing Benefits.
• Program enrollment
For more information, see Program Enrollments.
• Enrollment determination
For more information, see Enrollment Determinations.
• Eligibility Entity Filters
For more information, see Housing Eligibility Entity Filters.
• Set up housing listings
For more information, see Set Up a Housing Community Overview.
• Configure filters
For more information, see Configure Housing Listing Filters.
• Manage buildings
For more information, see Manage Buildings and Units.
• Housing placement requests and housing placements
For more information, see Placement.
• Create a Community user from an application
For more information, see Create a Community User from an Application.
• Set up Message Center
For more information, see Set Up Message Center.
• Change of circumstances
For more information, see Change of Circumstances.

© 2022 Vlocity LLC, a Salesforce


company 61
Vlocity Government

• Waitlists
For more information, see Waitlist Overview.
• Tenant self-service actions
For more information, see Tenant Self-Service Actions Overview.

Upgrade and Installation Instructions


• Preparing to Install the Salesforce Industries Communications, Media, and Energy Vlocity Applications
Package
• Adding OmniScript Elements to an Upgraded Org
• Upgrade to the Latest Vlocity Government Release

Known Issues
None.

© 2022 Vlocity LLC, a Salesforce


company 62
Vlocity Government

Upgrade Vlocity Government

Find out how to upgrade Vlocity Government.

IMPORTANT
If you purchased Public Sector Solutions, see Salesforce Public Sector Solutions
Administration Guide.

Upgrade to the Latest Vlocity Government Release


You can upgrade the latest generally available (GA) release for an existing sandbox or production org.

Vlocity provides a standard profile called Vlocity Basic Access that provides the following:

• Universal access to all Vlocity classes and Visualforce pages


• Create, read, edit, and delete (CRED) permissions on all Vlocity custom objects
• Visibility of all Vlocity custom fields
• Access to all custom record types

The standard profile does not provide access to custom tabs or applications. After mapping this Vlocity
Basic Access profile to a production profile, you can choose what tabs and apps the profile can access.

When upgrading Vlocity Government, coordinate your upgrade with Vlocity Support to ensure proper
licensing behavior.

Confirming System and Salesforce Requirements for Vlocity Government


Before you can upgrade Vlocity Government you must ensure that your web browser and Salesforce
version meet at least these minimum requirements.

1. Ensure that your browser works with Vlocity.


Vlocity uses the same browser requirements as Salesforce, for both Salesforce Classic and Lightning
Experience. See Supported Browsers in Salesforce Help.
We recommend that you don't use Microsoft Internet Explorer.
2. Your system has a minimum of 4 GB of RAM.
3. Your Salesforce Edition is Enterprise, Unlimited, or Performance. To verify the edition:
a. Click Setup.
b. In the Quick Find box, enter Company Info.
c. Click Company Information.
d. Look at the value in the Organization Edition field.

© 2022 Vlocity LLC, a Salesforce


company 63
Vlocity Government

4. You have Salesforce licenses for all users who need access to Vlocity.
All customers who install the Vlocity Government package must have two full Salesforce licenses for
adequate cached data storage in the org. The package includes custom settings that use 1.1 MB. For
more information, see Custom Settings Limits and Considerations in Salesforce Help.
5. You have a valid subscription to Salesforce Customer Community, Salesforce Customer Community
Plus, or Salesforce Partner Community. (Required to use Vlocity Community.)
6. You have a minimum 10 MB Platform Cache Partition configured in Salesforce. See Allocate Space in
the Platform Cache Partitions.
7. Allocate at least 2 MB for Vlocity metadata in the org metadata cache for all production and testing
orgs.

Pre-Upgrade Tasks for Vlocity Government


You must complete the following tasks to prepare your org for upgrade of the Vlocity Government package.

1. Before you begin, ensure you have a backup of your configurations.


2. Ensure the Salesforce Recycle Bin is empty, and that your strategic backup plan that doesn’t involve
using the Recycle Bin.

IMPORTANT
If the Salesforce Recycle Bin isn’t empty, the package deployment can fail.

• In Salesforce Classic, the Recycle Bin is at the bottom of the navigation panel on the Home page.
Click Recycle Bin, then click Empty your organization's recycle bin.
• In Salesforce Lightning, you can use the App Launcher to find the Recycle Bin.
Click Empty Org Recycle Bin.
If you can't find the Recycle Bin in Lightning, switch to Classic to complete this step.
3. Enable Lightning Components. To enable Lightning Components for Vlocity, you must set up a domain
for your Salesforce org, then deploy it to all users.
a. From Setup, in the Quick Find box, enter My Domain.
b. Click My Domain.
If you land on the My Domain Settings page, your domain is already configured and you can skip
this task.
c. Choose a domain to use for Vlocity, then click Check Availability.
d. Click Register Domain, then wait for an email that confirms your domain is registered and ready
for testing.
e. Return to My Domain in Setup and click Log in.
f. Click Deploy Domain to All Users, then click OK to confirm.
If you don't complete the final step, an error can occur when you load records in Salesforce Lightning
Experience.
4. Enable Scheduling. You can use product schedules to determine the payment and delivery cycles for
products that are paid or delivered over time. For more information about product scheduling, see
the Salesforce documentation.
a. From Setup, in the Quick Find box, enter schedule.

© 2022 Vlocity LLC, a Salesforce


company 64
Vlocity Government

b. Click Product Schedules Settings.


c. On the Schedule Setup page, select Enable quantity scheduling and Enable for all products.
d. Select Enable revenue scheduling and Enable for all products.
e. Click Save.
5. Ensure the email deliverability access level is set to All email.
a. From Setup, in the Quick Find box, enter deliverability.
b. Set Access level to All email.
c. Click Save.
6. Ensure Enhanced Email is enabled.
a. From Setup, in the Quick Find box, enter enhanced.
b. Click Enhanced Email.
c. Click Enable.
If you see a Disable button, Enhanced Email is already enabled.
7. Enable Notes.
a. From Setup, in the Quick Find box, enter notes.
b. Click Notes Settings.
c. Check the Enable Notes checkbox.
d. Click Save.
8. Enable Quotes:
a. From Setup, in the Quick Find box, enter quote.
b. Click Quotes Settings and click Enable.
If you see a Disable button, Quotes are already enabled.
c. Click Save.
9. Enable Orders.
a. From Setup, in the Quick Find box, enter order.
b. Click Order Settings and check Enable Orders.
c. Click Save.
10. Enable work orders in Salesforce.
a. From Setup, in the Quick Find box, enter Field Service.
b. Click Field Service Settings.
If Field Service Settings isn’t available, contact Salesforce support to create Field Service
Settings for you.
c. Enable Field Service. If the setting is for work orders, then enable Work Orders.
11. Allow users to relate a contact to multiple accounts.
a. From Setup, in the Quick Find box, enter account.
b. Click Account Settings.
c. Click Edit.
d. Check the Allow users to relate a contact to multiple accounts box.
e. Click Save.
12. Verify that Advanced Currency Management is disabled.
From Setup, in the Quick Find box, enter Manage Currencies.
• If you can’t find Manage Currencies, then Advanced Currency Management is disabled and you can
go to the next step.

© 2022 Vlocity LLC, a Salesforce


company 65
Vlocity Government

• If you find Manage Currencies and Advanced Currency Management is enabled, then disable it.
For more information, see Enabling or Disabling Advanced Currency Management in Salesforce Help.
13. Enable Feed Tracking for Work Orders and Work Order Line Items.
a. From Setup, in the Quick Find box, enter feed.
b. Click Feed Tracking.
c. Scroll to the end of the list of objects and click Work Order.
d. Check the box for Enable Feed Tracking.
e. Check the boxes for Parent Work Order and Work Order Number.
f. Click Save.
g. Scroll to the end of the list of objects again and click Work Order Line Item.
h. Check the box for Enable Feed Tracking.
i. Check the boxes for Work Order and Work Order Line Item Number.
j. Click Save.
14. Ensure that the Party.EnablePartyModel custom trigger exists in your org and is enabled.
a. From Setup, in the Quick Find box, enter Custom Settings.
b. Click Custom Settings.
c. Click the letter T.
d. Click Trigger Setup.
e. Next to Trigger Setup click Manage.
f. Click New. The Trigger Setup Edit page appears.
g. In the Name field, enter Party.EnablePartyModel.
h. Click the Trigger On checkbox to enable the trigger.
i. Click Save.
If you must enable this trigger, you can disable it after the managed package has been successfully
installed.

Upgrading Vlocity Government


After you've prepared your org, you're ready to upgrade the Vlocity Government package.

1. Log out of all Salesforce orgs.


2. Click the link for the appropriate Vlocity package. See Vlocity Government Package Links.

IMPORTANT
When upgrading, use a major release. To upgrade to a Vlocity minor release, you
must start from the most recent major release. After upgrading, you can’t downgrade
to an earlier release. Upgrade to minor releases only as directed by Salesforce
support.

© 2022 Vlocity LLC, a Salesforce


company 66
Vlocity Government

NOTE
To install in a sandbox rather than a production org, alter the download URL by
changing "login" to "test". For example:

Production URL: https://login.salesforce.com/packaging/


installPackage.apexp?p0={package-id...}

Sandbox URL: https://test.salesforce.com/packaging/


installPackage.apexp?p0={package-id...}

You can also right-click the package URL, select Copy Link Address, and paste the portion of the
URL containing the package ID after your domain name in your URL. For example:
https://login.salesforce.com/ packaging/installPackage.apexp?
p0=04t1J000000mAMe
3. Log into the org on which you’re upgrading Vlocity Government.
The Package Installation Details page opens.
4. Select an install option. Vlocity recommends Install for All Users.

If you map Vlocity profiles during the upgrade process:


• Permissions don't change for existing objects. Permissions apply to new objects.
• The upgrade can include changes to page layouts for existing objects or record types. When you
upgrade, changed layouts don’t overwrite production page layouts. You can go to them to see which
new fields have been added to the layout, or you can apply them to profiles. For more information,
see Applying Vlocity Page Layouts or Configuring Vlocity Insurance After Installation.
5. If you see a box with text about Salesforce’s AppExchange Partner Program, check it.
6. Click Upgrade.
7. If you see the Approve Third-Party Access window, select the option to grant access and click
Continue.
Vlocity packages are large and take longer to install than Salesforce's timeout window allows. You'll get
an email message when Vlocity installation is finished.
8. If package installation fails with a ManyWho error, change this Activity setting and try installation again.
a. From Setup, in the Quick Find box, enter activity.
b. Click Activity Settings.
c. Click Allow Users to Relate Multiple Contacts to Tasks and Events.

© 2022 Vlocity LLC, a Salesforce


company 67
Vlocity Government

d. Click Submit.
9. When package installation is finished, click Done.
When package installation is finished, you receive an email informing you that the installation or
upgrade was successful.
You can check the progress of your deployment:
a. Click Setup.
b. Type Environments in the Quick Find field.
c. From the search results, click Deployment Status.

After the deployment is complete, the status automatically turns green and the version number
updates. You don't have to refresh your browser.

Post-Upgrade Tasks for Vlocity Government


After you've upgraded the Vlocity Government package, you have a few more configuration tasks.

1. For Summer '21 and later releases, add Remote Site Settings for Vlocity Cards.

NOTE
If the Remote Site Settings are incorrect or missing, a warning message on the
OmniStudio FlexCards tab lists the URLs you must configure. This message begins
with Urls, needed for LWC, not added to Remote Site Settings.

© 2022 Vlocity LLC, a Salesforce


company 68
Vlocity Government

a. From Setup, enter Remote in the Quick Find box, then select Remote Site Settings.
b. Click New Remote Site.
c. Enter any Remote Site Name you like.
d. For the Remote Site URL, enter a URL with this pattern:

https://domain--namespace.ap1.visualforce.com

The domain is typically in your org's hostname. For example, if the hostname is
acme.lightning.force.com, the domain is acme. If the namespace contains an underscore,
use a dash instead. For example, if the domain is acme and the namespace is omnistudio, the
URL is:

https://acme--vlocity-ps.ap1.visualforce.com
e. Click Save.
f. Repeat these steps to create a second remote site for a URL with this pattern:

https://domain.lightning.force.com

For example, if the domain is acme, the URL is:

https://acme.lightning.force.com
2. Install the cards, templates, and OmniScripts according to the instructions in Installing Cards,
Templates, and OmniScripts.
3. Due to a compiler change, redeploy any active Lightning Web Component OmniScripts you’ve created.
Go to Vlocity OmniScript Designer and follow the steps in Deploy an LWC OmniScript to deploy.
4. For the Spring '21 release, assign custom object permissions for Vlocity DataRaptor Interfaces (or
Vlocity DataRaptor Bundles) and Vlocity DataRaptor Map Items custom objects so you can run
DataRaptors.
a. From Setup, enter User in the Quick Find box, then click User Management Settings.
b. Set the Enhanced Profile User Interface option to Disabled.
c. From Setup, enter User in the Quick Find box, then click Profiles.
d. Clone the profiles to be assigned to users. Cloning creates custom Profiles.
You can't edit custom object permissions in standard Profiles, but you can edit them in custom
Profiles.
e. Choose one of the user Profiles and click Edit.
f. Scroll to the Custom Object Permissions section.
g. Select the appropriate permissions for the Vlocity DataRaptor Interfaces (or Vlocity DataRaptor
Bundles) and Vlocity DataRaptor Map Items custom objects.
Designer users need all permissions. Other users need Read permission only.
h. Click Save.
i. Repeat steps c to g for all profiles that need access to DataRaptors.

Vlocity Government Package Links


Use the links in this table to upgrade to a specific version of Vlocity Government.

© 2022 Vlocity LLC, a Salesforce


company 69
Vlocity Government

IMPORTANT
If you purchased Public Sector Solutions, see Salesforce Public Sector Solutions
Administration Guide.

Summary Package Released Download Sandbox Release Notes


Version Link Link
PS 238.12.910.75.2 910.75.2 Sep 1, Production Sandbox Fixed issues: Deactivating a reused
(Summer 2022) 2022 Download Download child OmniScript on the Embedded
OmniScript Page throws an Apex
CPU Limit Error if the child has too
many parents. Depending on whether
useAppearanceObject is true or false,
an OmniScript PDF Action generates a
PDF file with field values that are either
partially wrapped or invisible until clicked.
PS 910.72.3 Sep 1, Production Sandbox Fixed issue: Depending on whether
236.2.13.910.72.3 2022 Download Download useAppearanceObject is true or false,
(Spring 2022) an OmniScript PDF Action generates a
PDF file with field values that are either
partially wrapped or invisible until clicked.
PS 236.2.6.910.72.2 910.72.2 June 23, Production Sandbox Fixed issue: When PDF files generated
Package (Spring 2022 Download Download from Angular OmniScripts were opened
2022) in Adobe products, data in fillable fields
was missing.
PS 238.1.910.75 910.75 June 3, Production Sandbox Includes OmniStudio Summer '22
Package (Summer 2022 Download Download updates.
2022)
PS 236.2.1.910.72.1 910.72.1 Apr 25, Production Sandbox Fixed issues: A custom LWC in
Package (Spring 2022 Download Download a child OmniScript that called
2022) (this.omniNextStep()) advanced
the parent OmniScript instead of
the child. When an OmniScript step
displayed a message about missing or
invalid data, an unnecessary Sorry to
interrupt pop-up appeared.
PS 236.2.910.72 910.72 Apr 4, Production Sandbox Fixed issues: Newport wasn't loaded
Package (Spring 2022 Download Download in communities with no URL prefix.
2022) The lightning record page view
and embedded OmniScript preview
showed different numbers of FlexCards.
FlexCards embedded in OmniScripts
weren't responsive in lightning record
pages. Repeatable Blocks didn't refresh
with new data subsets. Rollback IP
Changes was enabled by default.

© 2022 Vlocity LLC, a Salesforce


company 70
Vlocity Government

Summary Package Released Download Sandbox Release Notes


Version Link Link
PS 234.4.910.69.1 910.69.1 Mar 17, Production Sandbox Fixed issues: The lightning record page
(Winter 2022) 2022 Download Download view and embedded OmniScript preview
showed different numbers of FlexCards.
FlexCards embedded in OmniScripts
weren't responsive in lightning record
pages. Edit Blocks didn't refresh with
new data subsets. OmniScripts launched
from the utility bar didn't load correctly.
PS 236.0.910.71 910.71 Mar 1, Production Sandbox New customers with Contract Lifecycle
Package (Spring 2022 Download Download Management Document Generation
2022) licenses can enable server-side
document generation without contacting
Salesforce support.
PS 234.3.1.910.69 910.69 Feb 14, Production Sandbox Fixed issue: OmniScript Time elements
Package (Winter 2022 Download Download weren't rendered. A missing oldDate
2022) variable in the timepicker LWC was
responsible.
PS 234.3.910.68 910.68 Feb 10, Production Sandbox Fixed issues: Moving to the previous
Package (Winter 2022 Download Download step in an Omniscript caused the Date/
2022) Time element to add an hour to the
time field (a daylight savings time
calculation in the daytimepicker LWC
was responsible). In the prescreening
OmniScript, checkboxes and text
overlapped.
PS 234 Package 910.67 Oct 29, Production Sandbox With the proper licenses, server-side
(Winter 2022) 2021 Download Download document generation is available in
Contract Lifecycle Management.
PS 232.0.910.66 910.66 Jun 22, Production Sandbox Server-side document generation is
Package (Summer 2021 Download Download a pilot feature in Contract Lifecycle
2021) Management.
PS 230.0.910.63 910.63 Mar 30, Production Sandbox
Package (Spring 2021 Download Download
2021)
PS 108.0.2.910.56.2 910.56.2 Mar 25, Production Sandbox
Package (Spring 2021 Download Download
2020)
PS 109.0.910.61 910.61 Oct 30, Production Sandbox Trailing documents are supported on
Package (Winter 2020 Download Download Accounts and many other objects, which
2021) allows Community and internal users to
upload documents.
PS 108.0.1.910.56.1 910.56 Sep 25, Production Sandbox The Application Reference Number is
Package (Spring 2020 Download Download generated for Guest Users and displays
2020) after you submit the application.
PS 108.0.910.56 910.56 May 28, Production Sandbox Contains fixes and enhancements
Package (Spring 2020 Download Download including Lightning Web Components.
2020)

Picklist Values to Add to Vlocity Government Spring '20


After you upgrade from a previous version of Vlocity Government to Vlocity Government Spring '20, you
must add picklist values to the child welfare data objects.

© 2022 Vlocity LLC, a Salesforce


company 71
Vlocity Government

The following table lists the values to add. See Adding Picklist Values for the steps.

Object Name Picklist Name Picklist Values to Add


Incident Type Child Abuse

Neglect
Incident Status Sent for Approval

Rejected

Returned

New

Approved-Closed

Rejected-Closed
Incident Category Family Services

Child Protection Services

Inter-Jurisdictional

Provider Inquiry

Informational
Incident, Investigation record type only Type Family Assessment

CPS Investigation
Incident, Investigation record type only Status Pending

Unfounded-Closed

Founded-Transfer to Ongoing
Case Note Type (Forensic) Interview

(Initial Responder) Interview

Home Visit

Foster Home Visit

Family Team Meeting


Case Note SubType Initial Contact with Alleged Victim

Initial Contact with Alleged Perpetrator

Contact with Alleged victim

Contact with Alleged Perpetrator

Contact with Household Members


Benefit Case Type In-Home

Out-of-Home

Foster Care

Permanency

© 2022 Vlocity LLC, a Salesforce


company 72
Vlocity Government

Adding Picklist Values


During a package upgrade, picklist values cannot be installed into your org for existing fields. As a result,
after an upgrade, you must manually add the new picklist values specified in the post-upgrade steps.

To add values to a picklist:

1. In Lightning Experience:
a. Go to Setup → Object Manager, and find the object that contains the picklist field that you need
to change.
b. Click Fields & Relationships.
c. Click the picklist field.
d. Under the Values section, click New.
e. Enter the new picklist values.
f. To apply the new values to a specific record type, check the box next to the Record Type Name.
If no Record Type Name boxes are checked, the values apply to all record types.
g. Click Save.
2. In Salesforce Classic (Aloha) interface:
a. Go to Setup.
b. Find the object that contains the picklist field that you need to change, either under Build →
Customize or Build → Create → Objects.
c. In Fields, click the picklist field.
d. Under the Values section, click New.
e. Enter the new picklist values.
f. To apply the new values to a specific record type, check the box next to the Record Type Name.
If no Record Type Name boxes are checked, the values apply to all record types.
g. Click Save.

Upgrade to Vlocity Government Winter '18


Before you upgrade from a previous version of Vlocity Government to Vlocity Government Winter '18, Minor
release, Version 910.15, you must download and import a DataPack containing the settings required to
enable Vlocity Document Generation.

To download and import the DataPack, perform the following steps:

1. Download and save the DataPackSettings.json file.


2. Go to the Vlocity DataPacks page.
3. Click Installed, then click Import From and choose From File.
4. Import the DataPackSettings.json file that you downloaded in step 1.
5. Click Next.
6. Ensure that all items are selected and then click Next.
7. Review the items to import and then click Next.
8. Click Activate Now.
9. Click Start Activation.
10. Click Done.

© 2022 Vlocity LLC, a Salesforce


company 73
Vlocity Government

Upgrade Other Vlocity Components


After you upgrade the Salesforce Industries Communications, Media, and Energy package, you might need
to update other components in theVlocity application.

Salesforce Industries Communications, Media, and Energy


If you are upgrading from Salesforce Industries Communications, Media, and Energy Winter '18 to
Salesforce Industries Communications, Media, and Energy Summer '18, see Upgrading Winter '18 to
Summer '18 .

If you are upgrading from Salesforce Industries Communications, Media, and Energy Summer '17 to
Salesforce Industries Communications, Media, and Energy Winter '18, see Upgrading Vlocity CME
Summer '17 to Vlocity CME Winter '18.

You cannot upgrade directly from Vlocity CMT V15 to Salesforce Industries Communications, Media, and
Energy Winter '18. You must first upgrade Vlocity CMT V15 to Salesforce Industries Communications,
Media, and Energy Summer '17. For more information, see Upgrading Vlocity CME From Version 15 to
Summer '17.

Vlocity Insurance and Health Insurance


If you are upgrading to the Vlocity Insurance or Vlocity Health, see Upgrading to Vlocity Insurance and
Vlocity Health Spring '18 Release.

Vlocity Contract Life Cycle Management


If you use Vlocity Contract Life Cycle Management (Vlocity CLM), see Post-Upgrade Steps for Vlocity CLM.

Vlocity Order Management


If you are upgrading Vlocity Order Management, see Upgrading Vlocity Order Management.

© 2022 Vlocity LLC, a Salesforce


company 74
Vlocity Government

Configure Vlocity Government

Once you have installed or upgraded to the latest version, there are many items that you must configure.

Field Sets
Using Field Sets, you can customize fields and the sequence in which they appear throughout the app. You
can also use Field Sets to hide sensitive information, such as addresses and phone numbers.

See About Field Sets.

Field sets appear on the following pages:

• Benefit Case detail page


• Incident detail page
• Service Plan Picker
• Households
• Outcomes and Steps

Edit Benefit Case Associations Fields


Benefit case associations, including people, accounts, and households, appear on the Benefit Case detail
page. You can edit the field sequence or remove fields.

To edit the displayed fields:

1. From Setup, click Create, and then click Objects, and then click Benefit Case Party Relationship.
2. Scroll to field sets.
3. Next to Accounts, Households, or People, click Edit.
4. Modify the field sequence or remove fields.
5. Click Save.

Edit Incident Association Fields


Incident associations, appear on the Incident detail page. You can modify the field sequence or remove
fields.

© 2022 Vlocity LLC, a Salesforce


company 75
Vlocity Government

To edit the displayed fields:

1. From Setup, click Create, and then click Objects, and then click Incident Party Relationship.
2. Scroll to field sets.
3. Next to Accounts, Households, or People, click Edit.
4. Modify the field sequence or remove fields.
5. Click Save.

Edit Service Plan Picker Fields


The Service Plan Picker includes columns that describe available products when creating a Service Plan.
You can modify the order or add or remove fields.

To edit the Service Plan Picker fields:

1. From Setup, click Customize, and then click Products, and then click Field Sets.
2. Next to Product Selection, click Edit.
3. Modify the order or add or remove fields.
4. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 76
Vlocity Government

Edit Outcomes and Steps Fields


Outcomes and steps include columns that describe what achieves the outcome. You can modify the
sequence or remove fields.

To edit the displayed fields:

1. From Setup, click Create, and then click Objects, and then click Outcome (Service Plan).
2. Scroll to field sets.
3. Next to Default, click Edit.
4. Modify the sequence or remove fields.
5. Click Save.
6. Repeat for the Task object.

Change of Circumstances
After an application has been submitted, a client (or employee on behalf of the client) can make changes to
his or her profile using a Change of Circumstances form. Information that was previously submitted will be
pre-populated in the form, making it easy for the user to spot incorrect information and correct it.

Create a Change of Circumstances Form using an OmniScript


You can create an OmniScript that embeds the Change of Circumstances form, calls the
ApplicationDetailService class, and writes the data to Salesforce.

1. Make the original application for benefits reusable.


To skip sections of the application in the Change of Circumstances form, break the application for
benefits into multiple reusable OmniScripts.
2. Embed the application for benefits into the Change of Circumstances form.
3. Prior to the embedded application, add a Remote Action.

If Then
The form will be launched from Salesforce • Remote Class: ApplicationDetailService
• Remote Method: InternalProcess
The form will be launched from a community • Remote Class: ApplicationDetailService
• Remote Method: ExternalProcess

4. Add a DataRaptor Post Action to map the results of the Change of Circumstances to a new Enrollment
Determination and new Application.
Here is a sample DataRaptor Post Action:

© 2022 Vlocity LLC, a Salesforce


company 77
Vlocity Government

Set a Change of Circumstances Type


Since a client’s enrollment determination can be changed in a variety of ways, it is important to distinguish
between a Change of Circumstance or other type of update (such as a Scheduled Determination). Vlocity
recommends using the “Type” field on the Application and Enrollment Determination to do this.

To set a Type for the Change of Circumstances form:

1. Create a formula field and add to any step in the Change of Circumstances OmniScript.
2. In the expression area, add the Type value in single quotes, for example, Change of Circumstances.
3. In the DataRaptor mappings, map the Type formula element in the OmniScript to the Type field on the
Application and the Type field on the Enrollment Determination.

Deploy a Change of Circumstances Form


You must create and deploy your OmniScript, create an action, and launch the action from a Program
Enrollment record or from the Self-Service portal.

1. Create a Visualforce page for your OmniScript. For more information, see Deploy an OmniScript.
2. Create a new Vlocity Action and fill out the following fields. For more information about how to launch
an OmniScript from an Action, see Launch an OmniScript From the Action Toolbar.
3. Launch the action from a Program Enrollment record:
a. Go to Setup and click Create, and then click Objects.
b. Click Vlocity Actions.
c. Add vlocity_ps__ProgramEnrollment__c to the Applicable Types picklist.
d. .Id field, type URL ParameterIn the
e. In the Applicable User Profile field, select the profiles that will have access to launch the
OmniScript from the Program Enrollment.
4. Optionally, launch the action from the Self-Service portal:
a. In the Applicable Type field, add All to the selected values.
b. In the URL Parameter field, type User.ContactId.
c. In the Applicable User Profile field, select the profiles that will have access to launch the
OmniScript from the Program Enrollment. Make sure this includes the client community user
profile.

© 2022 Vlocity LLC, a Salesforce


company 78
Vlocity Government

Screening Rules
Screening Rules are used to validate data collected in the intake process against criteria that has been set
up by an Administrator.

A Screening Rule Group contains all of the Screening Rules for a particular type of application. From a
Screening Rule Group page, you can create a series of Screening Rules and generate the necessary Apex
code that will perform the validation during Intake. Screening Rules have their own validators and you can
generate a JSON Parser Class, which parses the JSON data blob (from the application intake form), and a
Screening Class template.

You can:

• Add a New Screening Rule Group


• Add a New Screening Rule
• Create Classes for Application Screening
• Configure Vlocity to Use External Systems for Screening

Add a New Screening Rule Group


A Screening Rule Group contains all of the Screening Rules for a particular type of application. From a
Screening Rule Group page, you can create a series of Screening Rules and generate the necessary Apex
code that will perform the validation during Intake.

To set up a new Screening Rule Group:

1. On the Screening Rule Groups tab, click New.


2. In the Name field, enter the name of the screening rule group.
3. In the Type field, select the type of application for which at the screening rules will be used.
4. In the JSON Parser Class field, enter the name of the class used to parse data from the application.
Leave blank if this application does not use a parser class.
5. In the Screening Class field, enter the Apex class used by the application to parse data in the correct
structure to be compared against the Screening Rules.
Either specify an existing class, or enter a new name and click Generate Screening Class on the
following page to create the template class. For more information on screening classes, see Create
Classes for Application Screening.
6. Click Save.

Add a New Screening Rule


A Screening Rule Group contains all of the Screening Rules for a particular type of application. From a
Screening Rule Group page, you can create a series of Screening Rules and generate the necessary Apex
code that will perform the validation during Intake. Screening Rules have their own validators and you can
generate a JSON Parser Class, which parses the JSON data blob (from the application intake form), and a
Screening Class template.

To add screening rules to a screening rule group:

© 2022 Vlocity LLC, a Salesforce


company 79
Vlocity Government

1. From the Screening Rule Groups tab, select the Screening Rule Group that you want to add a rule to.
2. Click New Screening Rule.
3. In the Name field, enter the name of the rule.
4. In the Rule Detail field, enter a description of what the rule is validating.
5. If there is more than one rule, the Priority Order determines the order in which the rules are run.
6. In the Validator Class field, enter the name of the Apex class that will be used to validate the
application against this particular screening rule.
Either specify an existing class, or enter a new name and click Generate Validator Class on the
following page to create the class. If a validator class does not already exist, set the rule properties
before generating one. For more information on screening and validator classes, see Create Classes
for Application Screening.
7. In the Validate Method field, enter the Apex code for the Validator Class to use to check the criteria
specified in the rule properties. Leave this blank if you want to add the method to the Apex class after
generating it.
8. Click Save.

Add Rule Properties to the Screening Rule


Each Rule Property is an input for the screening rule. For example, a rule that checks that a social security
number is nine digits might define a property SSN that is of type String or <List>String, if there are
multiple SSNs passed to the validator).

NOTE
Define all rule properties before generating a validator class interface.

To add a new Rule Property:

1. From Screening Rule, click New Rule Property.


2. In the Property Name field, enter the name of the property.
3. In the Property Type field, select the Apex data type.
4. Enter a Default Value if the property is a static value compared to other values from the application.
For example, a property called IncomeThreshold could have a default value of 1000 if the maximum
income of an applicant must be less than $1000.
5. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 80
Vlocity Government

Create Classes for Application Screening


This is a process to walk you through creating the necessary classes for a Screening Rule Group. Each
rule group is applied to a specific application and contains one or more screening rules which validate data
captured in the application.

Application->JSON blob*->JSON Parser Class*->Screening Class->Validator Class

The data captured in the applications included with Vlocity Government are stored in a JSON blob. A JSON
parser class parses the data from the blob. If you add a new step to the application flow or want to collect a
new attribute in the current flow, update the Application Flow custom setting, delete or edit the name of the
current parser class, and generate a new parser class from the Screening Rule Group page.

If your organization does not use JSON to collect information, you can generate a screening class to pull in
the information from other sources—for example, fields or forms.

For these topics, a very simple screening rule example is used that checks to see if the social security
numbers on an application are nine digits. The topics use a Child Welfare application, which captures all
data in a JSON blob.

1. Generate the Validator Class


2. Edit the Validator Class
3. Generate a JSON Parser Class
4. Generate a Screening Class

Generate the Validator Class


Generating a validator class creates a skeleton class with get and set for the defined rule properties. The
class receives the inputs from the screening class and will either pass or fail the application. For this
example, the application passes if all social security numbers on the application are nine digits.

To generate the validator class:

1. On the Screening Rule Group page, add a new screening rule, ssn validator.
2. The Validate Method is the Apex code used to check the criteria specified in the rule properties.
Before generating the class, enter the method in the Validate Method field.
After generating the class, you can enter the method in the Apex class found in Setup Apex Classes.

© 2022 Vlocity LLC, a Salesforce


company 81
Vlocity Government

3. Create a new Rule Property of type List <String>.


4. Before generating the Validator Class DemoSSNValidator, you can add the validation method directly
to the Validate Method field. Click Generate Validator Class.

NOTE
After the validator class is generated, it is decoupled and can not be modified from
this page. Vlocity recommends that if you are modifying only the validate method, do
it in the Apex class DemoSSNValidator. If you are adding or editing rule properties,
delete the class and generate a new one.

© 2022 Vlocity LLC, a Salesforce


company 82
Vlocity Government

5. Click Save.
Any errors in the validation method will be displayed in a pop-up window.

© 2022 Vlocity LLC, a Salesforce


company 83
Vlocity Government

Edit the Validator Class


The validator class is located in Setup, Apex Classes. The generated class contains the rule property and
the validation method. You can edit the validator class.

© 2022 Vlocity LLC, a Salesforce


company 84
Vlocity Government

The generated class contains the rule property and the validation method.

© 2022 Vlocity LLC, a Salesforce


company 85
Vlocity Government

To edit the validator class:

© 2022 Vlocity LLC, a Salesforce


company 86
Vlocity Government

1. From Setup, click Develop, and then click Apex Classes.


2. Next to the validator class, click Edit.

Generate a JSON Parser Class


Applications packaged with Vlocity Government capture data in a JSON blob. The Application Flow custom
setting defines which fields from the application are included in the blob. You can create a parser class to
pull the data out of the blob.

© 2022 Vlocity LLC, a Salesforce


company 87
Vlocity Government

To create a JSON Parser Class:

1. From the Screening Rule Group record detail page, in the JSON Parser Class field, enter the name of
the class.
2. Click Generate JSON Parser Class.

The new class is located in Setup, Apex Classes.

© 2022 Vlocity LLC, a Salesforce


company 88
Vlocity Government

Generate a Screening Class


The screening class receives data from either the JSON parser class or from other sources, such as fields
or forms. This data is then sent to the validator class for validation. You can generate a new screening
class.

Vlocity uses the Salesforce Tooling API to generate classes. The API does not allow reference to SFDC
objects when generating classes, so Vlocity provides a workaround by creating a template class with
instructions on how to comment out and include lines in the Apex class editor for the new screening class.
The template also includes example code.

© 2022 Vlocity LLC, a Salesforce


company 89
Vlocity Government

To generate a new screening class:

1. On the Screening Rule Group record detail page, in the Screening Class field, enter the screening
class name.
2. Click Generate Screening Class.

3. From Setup, click Develop, and then click Apex Classes.


4. Click DemoScreeningClass.
5. Follow the instructions in the class by commenting out some lines and including others.
6. Add the implementation for the class.
In the following image, we collect the list of Social Security numbers from the JSON parser and then
send that list to the validator class by setting the SSN rule property.

© 2022 Vlocity LLC, a Salesforce


company 90
Vlocity Government

7. Screen the application using the SSN validator. The results return true or false.

© 2022 Vlocity LLC, a Salesforce


company 91
Vlocity Government

Generic Implementation of Vlocity Custom Classes


Your organization can also generically implement Vlocity custom classes—InterfaceRuleValidator
and InterfaceApplicationScreening—when creating screening and validator classes.

global with sharing class IncomeValidator implements


vlocity_core.InterfaceRuleValidator

or

global with sharing class BenefitApplicationScreening implements


vlocity_core.InterfaceApplicationScreening

SmartySteets for Using External Systems for Screening


Vlocity Government has set up SmartyStreets as a way of testing address validation. Your agency may
choose to use SmartyStreets or other external address validation APIs, such as from the US Postal Service
or UPS, to validate addresses.

Please note, these are paid products and require that you license them directly from the provider. If you
sign up for a SmartyStreets account, you will only need to enter the Authorization ID and Authorization
Token to begin using it. Only administrators should have access to the page where this information is
entered.

© 2022 Vlocity LLC, a Salesforce


company 92
Vlocity Government

Additionally, your agency can implement other external callouts to validate any data elements collected
during Intake. SFDC recommends using a protected custom setting to store organization-wide credentials.
Contact Vlocity for more information.

Sign up for SmartyStreets


You must sign up to use SmartyStreets and obtain the Authentication ID and Token from your account.

1. Browse to www.smartystreets.com.
2. Register for a SmartyStreets account.
3. Copy your Authentication ID and Token (two separate values).
4. Return to Vlocity Government.

Add SmartyStreets Credentials to Vlocity Government


When you add SmartySteets Credentials, the informationis stored in a protected custom setting.

1. Go to the Callout Credentials Custom Setting tab.


2. Double click under the Name column and enter smartystreets.
3. Double click under the auth-id column and paste your SmartyStreets Authentication ID.
4. Double click under the auth-token column and paste your SmartyStreets Authentication Token.
5. Click Save.

Cases to Service Requests


The Benefit Cases tab in Vlocity Government displays a 360° view of a case, including client information,
contacts related to the client, activities related to the case, assessments, service plans, and service
requests. Benefit Cases are different from the standard Salesforce Case object, which track a customer's
feedback, problem, or question. To avoid confusion between Benefit Case and Case, Vlocity Government
recommends changing the Cases tab and all associated field labels to Service Requests. Vlocity also
recommends modifying the Service Request picklists to reflect the types of service requests that your
organization receives.

There are two parts to this procedure:

• Relabel Cases to Service Requests


• Modify the Service Request Picklists

Relabel Cases to Service Requests


You can relabel Cases to Service Requests in Setup.

1. From Setup, click Customize, and then click Tab Names and Labels, and then click Rename Tabs
and Labels.

© 2022 Vlocity LLC, a Salesforce


company 93
Vlocity Government

2. Click Edit next to Cases.


3. In the Singular field, enter Service Request.
4. In the Plural field, enter Service Requests.
5. Click Next.

6. Scroll through the renamed fields to make additional corrections, then click Save.

Modify the Service Request Picklists


You can modify the Type and Service Request Reason picklists in Setup.

1. From Setup, click Customize, and then click Cases, and then click Fields.
2. Click Type.
3. Delete Mechanical, Electrical, Electronic, and ;Structural. When prompted to find and replace
values, select None and click Save.
4. From the Case Type Picklist Values section, click New.

© 2022 Vlocity LLC, a Salesforce


company 94
Vlocity Government

5. Enter the types of service requests that your agency receives—for example, Citizen, Financial, Health,
Legal—and click Save.
6. Return to Case Fields.
7. Click Case Reason (appears as Service Request Reason on Service Request page).
8. Delete all of the listed picklist values. When prompted to find and replace values, select None and click
Save.
9. From the Case Reason Picklist Values section, click New.
10. Enter reasons for service requests that your agency receives—for example, Change of Circumstances,
Lost/Stolen EBT Card, Request New Caseworker—and click Save.
Now, when adding a new service request on a Benefit Case, a case worker can pick the correct type
and reason for the service request:

Set Up Benefit Case Types and Stages


You must configure the picklist fields contained in Vlocity Government custom objects to meet the
requirements of your agency. The values in Stage and Type must be the same across custom objects.
First, determine the type of benefit cases your agency offers—for example, Child Care. Next, determine the
stages in these cases—for example, Intake. Stage and Type picklists to configure include:

Type

© 2022 Vlocity LLC, a Salesforce


company 95
Vlocity Government

• Benefit Case
• Activity Template
• State Transition
• Application
• Application Template
• Screening Rule Group

Stage

• Benefit Case
• Activity Template

Adding Values to Type Picklists


To add values to Vlocity custom object Type picklists:

1. From Setup, click Create, and then click Objects.


2. Click Benefit Case.
3. Scroll to the Custom Fields & Relationships section and click Type.
4. Scroll to the Picklist Values section and click New to add a new value. Click Edit or Del next to an
existing value to modify or remove it.
5. Enter one or more values to the picklist and click Save.
6. Repeat Steps 1–5 for Activity Template, Assessment, State Transition, Application, Application
Template, and Screening Rule Group. Remember to add identical values across these picklists.

Add Values to Stage Picklists


To add values to Vlocity custom object Stage picklists:

1. From Setup, click Create, and then click Objects.


2. Click Benefit Case.
3. Scroll to the Custom Fields & Relationships section and click Stage.
4. Scroll to the Picklist Values section and click New to add a new value. Click Edit or Del next to an
existing value to modify or remove it.

5. Enter one or more values to the picklist and click Save.


6. Repeat Steps 1–5 for Activity Template.
Remember to add identical values to this picklist.

© 2022 Vlocity LLC, a Salesforce


company 96
Vlocity Government

Set Up State Transitions


State Transitions allow you to automate the progress of benefit cases from one stage to the next,
depending on the status of the task(s) associated with the benefit case. For example, an agency may
decide that to move from the Intake to Assessment stage on an unemployment application, all of the
tasks in the stage must either be complete and/or deferred. After these conditions are met, the stage
is moved to Assessment and all of the tasks associated with the Assessment stage (determined by the
Activity Template) appear on the Benefit Case record. Before setting up state transitions, you must first
configure the Type, From, and To picklists in the State Transition object. Optionally, you can set the field
dependencies between the From and To fields and modify the Status of Open Activities picklist, which
determines which status or statuses—in addition to Completed—the activities in the stage must be set to in
order to transition to the next stage.

• Add Stages to the From and To Picklists


• Set Field Dependencies Between the From and To Fields
• Modify the Status of Open Activities Picklist
• Create a New State Transition

Add Stages to the From and To Picklists


Add Stages to the From and To picklists. These must be identical to the stages in the Benefit Case Stage
picklist.

1. From Setup, click Create, and then click Objects.


2. Click State Transition.
3. Scroll down to the Custom Fields & Relationships section and click From.
4. Scroll to the Picklist Values section and click New to add a new value. Click Editor Del next to an
existing value to modify or remove it.
5. Enter new stages, leaving out the final stage, and click Save.
6. Return to the Custom Fields & Relationships section and click To.
7. Scroll down to the Picklist Values section and click New.
8. Enter the same new stages, leaving out the first stage, and click Save.

Set Field Dependencies Between the From and To Fields


Optionally, you can set the field dependencies between the From and To fields. Leave the last stage out of
the From picklist and leave the first stage out of the To picklist. When creating State Transitions, the Field
Dependency chart lets you control the selection of stages a user can progress to.

1. From Setup, click Create, and then click Objects.


2. Click State Transition.
3. Scroll down to the Custom Fields & Relationships section and click Field Dependencies.
4. Click Edit.
5. Under each value in the From row, select the stage that comes next. For example, under Intake, select
Assessment and under Assessment, select Planning. Use CTRL +click to select entries in each
column.
6. Click Include Values and click Save.

© 2022 Vlocity LLC, a Salesforce


company 97
Vlocity Government

Modify the Status of Open Activities Picklist


You can modify or add values to the Status of Open Activities picklist. Add any new or modified values to
the corresponding Status field in the Task Fields section of Activities.

1. From Setup, click Create, and then click Objects.


2. Click State Transition.
3. Scroll down to the Custom Fields & Relationships section and click Status of Open Activities.
4. Scroll down to the Picklist Values section and click New.
5. Enter one or more statuses—for example, Escalated— and click Save.
6. Return to Setup and click Customize, and then click Activities.
7. Click Task Fields.
8. Click Statusand click New.
9. Add the new values from the Status of Open Activities field and click Save.

Create a New State Transition


To create a new state transition:

1. From the State Transitions tab, click New State Transition.


2. In the Code field, enter an identifying code for the State Transition.
3. In the Type field, enter the type of benefit case for the State Transition.
4. In the From field, enter the stage that the state will transition from.
5. In the To field, enter the stage that the state will transition to.
6. In the Status of Open Activities list, select the statuses, in addition to Completed, that the tasks in
the From stage must be set to transition to the To stage.
7. In the Description field, enter a description of the state transition.
8. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 98
Vlocity Government

New State Transition Example


In this example—an Employment benefit case in the Intake stage—all tasks from the activity template
appear as open and not started:

When all of the tasks are marked as either Completed or Deferred, the state transition moves the stage
to Assessment, and displays the tasks from the corresponding Assessment activity template. Note that the
deferred task from the previous stage remains in the open activities list.

© 2022 Vlocity LLC, a Salesforce


company 99
Vlocity Government

Create a New Assessment Template


Vlocity Government make it easy to create complex assessments in which questions and answers can
each have specific weights. Assessments can also be conducted in the field using Vlocity Government for
Salesforce1 or Vlocity Mobile.

© 2022 Vlocity LLC, a Salesforce


company 100
Vlocity Government

To create a new Assessment Template:

1. On the Assessments tab, click New.


2. In the Name field, enter the name of the assessment.
3. In the Type field, select the type of benefit case that the assessment will be used for.
4. Click Is Template.
5. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 101
Vlocity Government

Creating a New Assessment Question


You can create a new question and then Add Answers to Assessment Questions to create Assessment
Answers. The assessment itself is initiated from a Benefit Case record when the user clicks Start
Assessment.

© 2022 Vlocity LLC, a Salesforce


company 102
Vlocity Government

To create a new Assessment Question:


1. On the Assessments tab, click the template that you want to add a question to.
2. Click New Assessment Question.
3. In the Order field, enter the correct order for the question. For example, if the previous question order
is Q007, the new question should be Q008.

NOTE
The Order field is alphanumeric. Vlocity recommends numbering questions using the
format Q001, Q002, Q003...Q999.

4. Select a Question Type.


5. In the Question field, enter the assessment question.
6. By default, questions are set to be scored and assigned a weight of 1.00. You can adjust the weight if
necessary. If the question should not be scored, clear Scorable.
The Total Score is calculated based on the sum of all scorable questions that have been answered,
where each score is multiplied by its corresponding weight: Total Score = Sum(QuestionScore*Weight)
7. Click Save.

Question Types Version 2.7


Question Type Description Example
Checkbox The answers are created automatically as "Selected" and "Not Selected" and are the
only possible answers. Checkbox questions appear on an assessment as the display
question text and a single checkbox.

Free-text Text field displayed under question allows case worker to enter free text answers and
assign a score, if necessary.

Instruction Used to add instructive text at the beginning of a new assessment section

© 2022 Vlocity LLC, a Salesforce


company 103
Vlocity Government

Question Type Description Example


Multi-Select Allow case workers to select one or more answers from a list.

Single Select Give case workers a list of answers and they select one. Can be dropdown or radio
button.

Date Select a Date and optionally assign a score.

Number Enter a number and optionally assign a score.

Question Table A list of questions with the same answer options. Case workers can select one answer
Single Select per question.

Question Table A list of questions with the same answer options. Case workers can select one or
MultiSelect more answers per question.

Question Types Version 2.5


There are four types of Assessment Questions:

• Checkbox questions are binary. The answers are created automatically as "Selected" and "Not Selected"
and are the only possible answers. Checkbox questions appear on an assessment as the display
question text and a single checkbox.
• Free Text questions allow caseworkers to enter free text answers.
• Select questions give caseworkers a list of answers and they select one.
• Multi-select questions allow users to select one or more answers from a list.
• The Instruction Question Type is used to add instructive text at the beginning of a new assessment
section—for example, "Below are examples of problems which people sometimes have. Please mark
whether each is NEVER true, SOMETIMES true, or OFTEN true of the client."

See Also
• Add Answers to Assessment Questions
• Create Question Tables

Add Answers to Assessment Questions


To add answers to assessment questions:

1. From within the Assessment Question, click New Assessment Answer.


2. In the Order field, enter the order that the answer appears under the question—for example, A01.

© 2022 Vlocity LLC, a Salesforce


company 104
Vlocity Government

NOTE
As with Assessment Questions, the Order field is alphanumeric

3. In the Score field, enter a score for the answer. The calculated score will be this value times the weight
of the question.
The Total Score is calculated based on the sum of all scorable questions that have been answered,
where each score is multiplied by its corresponding weight: Total Score = Sum(QuestionScore*Weight)
4. In the Answer field, enter the answer text.
5. Click Save or Save & New.
6. Repeat Steps 1-5 to add more answers.

Create Question Tables


A Question Table is a list of Assessment Questions paired with Assessment Answers. There are two types
of Question Tables: Single, which allows only answer per question, and MultiSelect, which allows multiple
answers.

To create a Single or MultiSelect Question Table:

1. Follow the instructions in Creating a New Assessment Question to create a new question and select
Question Table Single Select or MultiSelect. In the Question field, enter the first question.
2. Follow the instructions in Add Answers to Assessment Questions to create Assessment Answers.
Answers should only be created under the first question in the table. Each Assessment Answer
corresponds to a column in the Question Table.
3. For additional questions (rows) in the table, from the first question in the table, click New Assessment
Question and select Question Table Single Select or MultiSelect.

Question Table Example


In the following example, the first question in the table is Anxious. The answers are Morning, Afternoon,
Evening, Never, and All day and the additional questions are Frustrated and Depressed (Q013 and Q014).

© 2022 Vlocity LLC, a Salesforce


company 105
Vlocity Government

The table renders as:

Activity Templates
Activity Templates give you a way to set up a list of tasks for each stage of a Benefit Case or Incident.
These tasks are set in a unique Activity Template for the stage.

For example, an unemployment insurance case might have six stages—Intake, Assessment, Planning,
Service Delivery, Monitoring, and Closure. Each stage has a variety of tasks that case workers must
complete before the case moves to the next stage. Intake tasks might include scheduling a phone interview,
notifying the client of the date and time of the interview, conducting the interview, and other tasks. These
tasks are all added to the Activity Template for the Intake stage of the Employment type.

NOTE
A stage can only have one activity template for each type.

© 2022 Vlocity LLC, a Salesforce


company 106
Vlocity Government

Creating a New Activity Template


To create a new activity template:

1. On the Activity Templates tab, click New.


2. Enter a description for the template.
The description should describe the Benefit Case or Incident type as well as the stage.
3. Select the Stage and Type for the template.
4. Leave the Publish option cleared until you are ready to publish the template.
If another activity template exists for the same Type and Stage, you will be unable to publish the new
template until you unpublish the existing template.
5. Click Save.

Adding Tasks to the Activity Template


All activities, or tasks, in an activity templates must:

• Be created as Tasks. Events are not used in activity templates.


• Have the Status field set to Not Started.
• Be nonrecurring.
• Use Due (in days) and not Due Date. Tasks in a template will never be due on a specific day. Instead,
the due date will be calculated based on the date this activity template is added to a benefit case, by
adding the number of days, set in the Due in (days) field, to the current date.

To add tasks to the activity template:

• On an activity template record detail page, click New Task.

© 2022 Vlocity LLC, a Salesforce


company 107
Vlocity Government

1. In the Subject field, enter the task name.


2. Leave the Due Date field blank.
3. In the Due in (days) field, enter the number of days that the case worker has to complete the task.
4. Click Save or Save & New Task to add another task.

Publishing the Activity Template


After you have added all of the tasks for a stage, you can publish the template. If another activity template
exists for the same Type and Stage, you will be unable to publish the new template until you unpublish the
existing template.

From the Activity Template page, double-click Publish then select Save.

© 2022 Vlocity LLC, a Salesforce


company 108
Vlocity Government

Now, a Benefit Case or Incident that enters a new stage displays the tasks from the corresponding Activity
Template. Note that the tasks are ordered by due date.

Set Up Service Providers


A Service Provider record in Vlocity Government uses an Account record type and page layout that
includes metrics, benefit cases assigned to the provider, contracts, and credentials. Before deploying the
application, set up service providers.

© 2022 Vlocity LLC, a Salesforce


company 109
Vlocity Government

TIP
To configure how clients are matched with service providers, run the
ServiceProviderMatchingCriteria OmniScript.

• Configure the Service Provider Account Record


• Add Values to the Regions Served Picklist
• Turn Off Matching by Region
• Activate Service Provider for Matching
• Add Contracts to a Service Provider
• Add Sites and Site Offerings to a Service Provider
• Automate Service Provider Deactivation

Configure the Service Provider Account Record


The Type field on account records drives the record type. If you change the Type to Service Provider, the
record type and page layout for the record will switch to Service Provider. Add "Service Provider" to the
picklist to enable this functionality.

To configure the Type picklist on Account records:

1. From Setup, click Customize, and then click Accounts , and then click Fields.
2. Click Type.
3. From the Account Type Picklist Values section, click New.
4. Enter Service Provider and select the check boxes next to Default and Service Provider to add
these values to the record type picklists.
5. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 110
Vlocity Government

Add Values to the Regions Served Picklist


Regions Served defines one or more regions where services are provided to clients. During the service
provider matching process, regions in this field can be used to match providers with the client's region.
Values in the Regions Served field must be an exact match to the Region field on the client's Contact
record.

To add values to the Regions Served picklist:

1. From Setup, click Customize , and then click Accounts, and then click Fields.
2. Scroll to the Account Custom Fields & Relationships section and click Region Served.
3. From the Picklist Values section, click New.
4. Click Edit or Del next to an existing value to modify or remove it.
5. Add one or more regions and click the check boxes next to Service Provider.
6. Click Save.

Turn Off Matching by Region


By default, service provider matching happens if an active service provider is in the primary client's region
and the selected services are offered at one of the service provider's service locations (sites). Vlocity
provides a custom setting if you only want to match against services offered.

To turn off matching by region:

1. From Setup, click Develop, and then click Custom Settings.


2. Click Manage next to Service Provider Matching Criteria.
3. Click Edit next to Region.
4. Clear Include Check .
5. Click Save.

Activate Service Provider for Matching


Activate a Service Provider for matching if you want to use the provider for matching on a Service Plan:

1. From a Service provider record, double-click the Active field and click Yes.
2. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 111
Vlocity Government

Add Contracts to a Service Provider


While Service Provider matching uses Products in Service Locations (sites), those Products come from
Contracts in the parent Service Provider. Therefore, Services Providers must have activated contracts with
Products and Services. Use the simplified Price Schedule record type to add a basic Contract and Products
and Services. Learn more about Contracts in the Salesforce Help.

Add Sites and Site Offerings to a Service Provider


If a Service Provider has more than one location, you can add it to the Sites list on the Service Provider
record. After adding the Site, you can add Site Offerings, which are chosen from the list of products and
services on the Contracts of the Service Provider. In this way, clients can be matched to Service Provider
locations that offer the products and services that they require. Please add all Contracts and associated
products and services to a Service Provider before adding Site Offerings.

To add a Site and Site Offerings:

1. From the Service Provider record, click New Site.


2. Enter location information and click Save.
3. Click New Site Offering.
4. Enter a name for the Site Offering
5. In the Product field, click the lookup icon and select a product from one of the Service Provider's
contracts.
6. Click Save.
7. Repeat for additional Sites.
Vlocity checks nightly to ensure that contracts are Active. If a contract expires, the Site Offering will
remain associated with the Site, but will not be used in site matching until the contract is reactivated.

Automate Service Provider Deactivation


Vlocity provides a scheduler class (UpdateServiceProviderStatusSchedule) that switches the Active field
to No if a Service Provider's contracts have expired. Schedule this class to run if you want to set any
Service Provider with no active contracts to Inactive.

To schedule the class:

1. From Setup, click Develop, click Apex Classes, and then click Schedule Apex.
2. Enter a name for the job.
3. In the Apex Class field, click the lookup icon and select UpdateServiceProviderStatusSchedule.
4. Set the frequency settings for the job and click Save.

© 2022 Vlocity LLC, a Salesforce


company 112
Vlocity Government

Operating Hours
Using Operating Hours, you can create hours of operation once and associate them across multiple service
provider sites. You can also create exceptions—for example, Christmas and other holidays—and apply
them to sites. The hours appear on the Service Provider detail page:

Create Standard Operating Hours


To create standard hours for one or more sites:

1. From the Operating Hours tab, click New.


2. Enter a name for the Operating Hours template and click Save.
3. Click New Operating Hours and Exceptions.
4. Select Standard and click Continue.
5. Enter a name for this operating hours entry.
6. Modify the operating hours and select an Active Range. If a site is closed on a certain day, enter
closed for both opening and closing time.
7. Click Save.

Create Exceptions to Operating Hours


To create exceptions to the standard hours:

© 2022 Vlocity LLC, a Salesforce


company 113
Vlocity Government

1. From an existing Operating Hours template, click New Operating Hours and Exceptions.
2. Select Exception and click Continue.
3. Enter a name for the exception entry.
4. If the exception is a holiday, choose the date of the holiday.
5. If the exception is an hours exception—for example, closed for lunch from 12-1 every day—enter
the Closed From and Closed To. Enter Open From and Open To hours if the site is open special
hours—for example, the first Monday of each month the site is open until 6pm instead of 5pm.
6. Select a start and end date, and choose one or more days of the week.
7. Click Save.

Create an Operating Hours Template


To add a site to the Operating Hours template:

1. Navigate to the Sites related list on the Service Provider record and select a Site.
2. Double click the Operating Hours field and lookup the Operating Hours template.
3. Click Save.

Vlocity List Overview


With Vlocity Lists, you can create custom list views with any standard or custom object. For example, you
can automate the ordering of applicants waiting for housing and other programs. Vlocity Lists are flexible;
with the administration tool, an administrator can determine which columns to display and set prioritization
rules for ordering records on the list. Workflow rules make it easy to automatically add, inactivate, and
remove records from the list.

Define a Vlocity List


You can crate a new Vlocity List by creating a new record in the Query Builder tab.

When creating the record, fill out the following fields:

• Name
• Active: Select True when the list is ready to be published.
• Object Name: API name of the object from which the data is coming from. Make sure to include the
namespace for custom objects.
• Where Condition Formula: Defines the logic of the Where conditions in the query builder. Use the index
and logical operators (AND/OR) for this expression.
• Program: Look-up to Program object. Make sure this value matches the program on other objects (such
as the Program Enrollment).

© 2022 Vlocity LLC, a Salesforce


company 114
Vlocity Government

• Type: This is used to distinguish one type of list from another, such as Service Requests.
• Subtype This is used to distinguish one type of list from another such as Tenant.

NOTE
You can use any combination of Program, Type, and Subtype to distinguish one Vlocity
List from another. The system will look for an exact match between the Program/Type/
Subtype values defined in the Visualforce page and the Vlocity List record.

The following fields are optional and used for the waitlist use case.

• Sort Date Field: The date which will be used to sort applicants on a waitlist list (for example, application
created date, application approved date).
• Determination Cycle: The period in which an applicant will need to revalidate eligibility while on the
waitlist.

If using the Sort Date and Determination functionality, consider the following:

• The object used in the list should be Program Enrollment (vlocity_ps__ProgramEnrollment__c)


• Program/Type/Subtype of the Vlocity List must match the Program/Type/Subtype of the Program
Enrollment record.
• The Waitlist Sort Date field on each applicant’s program enrollment will be populated with the value in
the Sort Date Field when the applicant is placed on the waitlist. This value can be overwritten manually.

Deploy a Vlocity List


To deploy a waitlist, create a visualforce page with the code in the example below. After this is done, create
a custom tab to display the Vlocity List or embed the Vlocity List in a Salesforce record.

<apex:page sidebar="false" showHeader="false" docType="html-5.0">


<vlocity_ps:WaitlistComponentstrObjectName="vlocity_ps__MessageQueue__c"
strProgramName="Public Housing"strType="Message Center"strSubType="Tenant"
strImgsrc="{!
$Resource.vlocity_ps__cportalHeaderMessageCenter}"strHeading="Message Center"
strSubHeading="Working for citizens in Brampton, Caledon and Mississauga"
strIndexColumn="Position"boolSearch="true"
strHyperlinkField="vlocity_ps__PrimaryApplicantName__c"
sHyperlinkRedirectpage="{{p['pgmEnr']['Id']}}"boolIsWithSharing="false"
Longlistnosort="true"strPopupField="vlocity_ps__MessageText__c"strViewShow="Vie
w"/>
</apex:page>

Update the parameter values in the code according to the use case.

© 2022 Vlocity LLC, a Salesforce


company 115
Vlocity Government

Parameter Description Default Examples


Behavior
strObjectName API name of the object from which N/A Case, vlocity_ps__MessageQueue__c
the data is coming from. Make
sure to include the namespace for
custom objects. This must match
the Vlocity List record
strProgramName Program value which matches the null Public Housing
Program on the Vlocity List record.
strType Type value which matches the null Service Requests
Type on the Vlocity List record.
strSubType Subtype value which matches the null Tenant
Subtype on the Vlocity List record.
strImgsrc Reference to static resource file to N/A {!$Resource.vlocity_ps__cportalTenantDetailIcon}
use for header icon.
strHeading Primary heading text. N/A Social Housing Waitlist
strSubHeading Secondary heading text. N/A List of applicants on the waitlist
strIndexColumn If this parameter is included, a No index Position, Number, #
number column will appear to column
the left of the list. The value of appears.
this parameter will be the column
name.
boolSearch Boolean field. True will make the false true, false
search box appear.
strHyperlinkField API name of the field you would No vlocity_ps__PrimaryApplicantName__c
like to add a hyperlink to. hyperlink
field
appears
sHyperlinkRedirectpage URL that the Hyperlink Field No {{p['pgmEnr']['Id']}},http://www.google.com
will lead to. Note, you can use hyperlink
{{p['pgmEnr']['Id']}} to lead the user field
to the main record page. appears
boolIsWithSharing Setting this parameter to false true true, false
will display all records, regardless
of sharing settings. This can be
helpful for the waitlist use case
where the person managing the
waitlist may not have access to
the program enrollment records.

© 2022 Vlocity LLC, a Salesforce


company 116
Vlocity Government

Longlistnosort Due to Salesforce limitations, very false true, false


long lists (>3,000) cannot have
custom sort.

longlistnosort=true

Max # units supported - no limit


Max # filterable/searchable units
supported - no limit but the filter/
search will only apply to a subset
of records loaded (not all records)

Custom Sort supported - false

longlistnosort=false

Max # units supported - 3000


Max # filterable/searchable units
supported - 3000 Custom Sort
supported - true
strPopupField This is used for the Message No pop-up vlocity_ps__MessageText__c
Center. This parameter specifies field
which field should display in a appears
pop-up when clicked.
strViewShow This is used for the Message No view View, Full Message, Read
Center. This parameter adds a link
column to the right side of the appears
Vlocity List with a link that will
open a pop-up window. The value
of this parameter will be the
display text of the link

Use Select Clause to Define Columns in Vlocity List


You can define which columns appear in the Waitlist table using the Select clause.

1. Click Select.
2. Choose the field you would like to display from the Field Selection pop-up. All fields in the object you
selected in the Object Name field will be available, as well as fields on related objects.
3. Click Save.

Use WHERE Conditions to Determine Applicants Added to a Vlocity List


You can determine which applicants automatically are added to a Vlocity List, and which are filtered out,
using WHERE conditions.

1. In the Clause field, select WHERE.


2. Select the Field/Attribute on the Program Enrollment or other object selected in the Object Name
field.
3. Choose the logical operator (=, <, >, an so on).
4. Define the value, surrounded by a single quote, for example, 'Waitlisted'.
5. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 117
Vlocity Government

Define a Vlocity List Sort Order


To determine applicant prioritization, add ORDER BY conditions to the query builder. ORDER BY conditions
allow you to sort by multiple columns, for example, first by Priority Status, then by Waitlist Sort Date.

1. In the Clause field, select ORDER BY.


2. Select the Field/Attribute on the Program Enrollment, or other object selected in Object Name field,
by which you would like to sort.
3. Choose the order. If the field you chose was a picklist, you can drag the picklist values to determine the
order. Otherwise, select either ASC (Ascending) or DESC (Descending).
4. Click Save.

Add Filters to Vlocity Lists


With the Vlocity Attributes Categories related list, you can define filters which will appear on the waitlist
page. Filters will appear above the waitlist:

1. Click New Vlocity Attribute Category.


2. Fill out the following fields:
a. Name: Display name for the filter.
b. Code/JSONKey: API name of the field on the program enrollment you would like to filter by for
example, vlocity_ps__Stage__c.
c. Display sequence: The sequence in which you would like the filter to display for example, 2.
d. Filterable: Select true when you are ready for the filter to be published to the waitlist page.
e. Active: Select true when you are ready for the filter to be published to the waitlist page.
3. Save the Vlocity Attribute Category.
4. Click New Vlocity Attribute.
5. Fill out the following fields:
a. Name: Display name for the filter value.
b. Code: Unique code for the filter value.
c. Display sequence: The sequence in which you would like the filter value to display for example 2.
d. Value: The value which must match the picklist value of the field on which you are filtering.
e. Filterable: Select true when you are ready for the filter value to be published to the waitlist page.
f. Active: Select true when you are ready for the filter value to be published to the waitlist page.

Set the Number of Records Per Vlocity List Page


To choose how many records appear per page, update the Housing Setup custom setting .

© 2022 Vlocity LLC, a Salesforce


company 118
Vlocity Government

1. From Setup, click Develop, and then click Custom Settings.


2. Find the Housing Set Up custom setting and click Manage.
3. Find WaitlistPaginationSetting and click Edit.
4. In the value, select the number of records to appear on one page of the waitlist .
By default, 25 records appear per page.

Document Generation In Vlocity Government


You can use Vlocity Document Generation with Vlocity Government.

• Vlocity provides the capability to create client documents in Microsoft Word, HTML, and PDF using data
from Salesforce or other systems, using a tool that is 100% native to the Salesforce platform.
• Administrators can set up document templates with text formatting options and conditional logic to tailor
the document to a client’s circumstances.
• Employees can select from available templates when creating a document. Vlocity uses the appropriate
data from Salesforce to populate the template, creating a client-specific document in seconds.

NOTE
Vlocity Document Generation is a separate component that customers must purchase in
addition to Vlocity Government.

Vlocity Document Generation is also known as Vlocity Contract Life Cycle Management (CLM). For more
information, see Contract Lifecycle Management Overview.

Importing the Templates To Create Documents


To use Vlocity Document Generation in Vlocity Government, the system administrator must import the
templates for document creation into your org before you can create your own templates.

To import the template to create documents:

1. From the App Launcher, click Vlocity Templates.


2. Click the Additional Actions arrow in the upper right and choose Install
ObjectDocumentCreationUITemplates.
3. Ensure that all items are selected and then click Next.
4. Review the items to import and then click Next.
5. Click Activate Now.
6. Click Start Activation.
7. Click Done.

Creating a Document Template


When you have Vlocity Document Generation, you can create document templates. Specific instructions
vary based on the content of your template. However, this topic provides an overview of the process.

© 2022 Vlocity LLC, a Salesforce


company 119
Vlocity Government

To create a document template in Vlocity Government:

1. Create a new JSON-based template. For more information, see Creating a New JSON-Based
Template.

NOTE
Using Document Generation in Vlocity Government, you cannot use object-based
templates. You must use JSON-based templates. Object-based templates apply only
to specific objects, such as Contract, Opportunity, Order, and Quote.

2. Design the document template sections. For more information, see the following topics:
• Creating a Context Section in Document Template Designer
• Creating a Clause Section
• Creating a Signature Section
• Creating an Image Section
• Creating an Item Section
• Creating an Embedded Template Section
• Creating a Custom Section
• Creating a Repeating Content Section
3. Create the extract DataRaptor to fetch the data from Salesforce. For more information, see Creating a
DataRaptor Extract.Append the word "Extract" to the end of the DataRaptor.
4. Create the mapping DataRaptor to put the data in the document. Append the word "Mapping" to the
end of the DataRaptor.

Deploying a Document Template


After you complete the document template, you have several options to make it available to your end users
so they can generate client documents using the template. You can create a Vlocity Action to generate a
specific template, or use an OmniScript to allow an employee to select from multiple templates to generate
a client document. A sample OmniScript is available in the Vlocity Government Process Library . For more
information about Vlocity Actions, see Configuring Vlocity Actions.

Import Benefit Cases Using the Salesforce Data Import Wizard


You can import benefit cases in two ways:

• Salesforce Data Import Wizard


• Vlocity DataRaptor

1. To avoid Salesforce import limits, turn off the Task trigger before importing benefit cases using the
wizard:
a. From Setup, click Develop , and then click Custom Settings.
b. Click Manage next to Trigger Setup.
c. Click TaskTrigger.
d. Clear the Trigger On checkbox.

© 2022 Vlocity LLC, a Salesforce


company 120
Vlocity Government

e. Click Save.
2. Once the trigger is off, use the Data Import Wizard to import benefit cases:
a. From Setup, click Data Management, and then click Data Import Wizard.
b. Click Launch Wizard.
c. Click the Custom objects tab, then select Benefit Cases.
d. Configure your mapping, then import your data.
e. After importing, return to the Trigger Setup custom setting and turn the Task trigger back on by
selecting the Trigger On checkbox.

Restrict Users From Benefits and Incidents Cards


To restrict users from adding, deleting, or editing users on Benefit Case Cards and Incident Cards,
remove Create, Edit, and Delete on Benefit Case Party Relationship and Incident Party Relationship. After
removing these permissions users will no longer see these buttons on the Benefit Case:

or Incident:

Why Do I Receive the "Missing Organization Feature: WorkOrder"


Error When Installing Vlocity Government?
Problem
Error: Missing Organization Feature: WorkOrder

© 2022 Vlocity LLC, a Salesforce


company 121
Vlocity Government

Solution
1. From Setup, in the Quick Find box, enter Field Service Settings.
2. Click Field Service Settings.
3. Select Enable Work Orders.
4. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 122
Vlocity Government

Case Management

Case management includes management of client benefits and enrollments.

Benefit Cases
The Benefits Cases tab in Vlocity Government displays a 360° view of a case, including client information,
contacts related to the client, all tasks for the case, and service requests.

Benefit Case Tasks


The Open Activities section displays all open tasks for the case. When the status of open tasks for each
stage meet certain requirements (for example, they are completed or waiting on someone else), the case
transitions to the next stage, and new tasks appear under Open Activities.

For example, an employment benefit case that is in the Intake stage displays all tasks as open and Not
Started:

When all of the tasks are marked as either Completed or Deferred, the case moves to the Assessment
stage, and a new set of tasks appear. Note that the deferred task from the previous stage remains in the
open activities list.

© 2022 Vlocity LLC, a Salesforce


company 123
Vlocity Government

Benefit Case Task Assignment


When a case worker or manager changes the owner of a case, all open tasks are transferred to the new
owner. All closed tasks (in the Activity History section) remain owned by the original owner.

A case manager can move one or more tasks from a case to another case worker. To ensure confidentiality,
the user sees only the tasks assigned to them and no other case information. These tasks are included with
the user's other tasks in the My Tasks section on the Home tab:

© 2022 Vlocity LLC, a Salesforce


company 124
Vlocity Government

View Contacts On a Benefit Case


All contacts entered during the application intake process will appear in the Contacts section on the Benefit
Case page:

Update the Benefit Case Layout (Vlocity 2.7)


In Vlocity Government, the Primary Client field has been replaced with the Primary Contact field and a
new Visualforce page displaying related Contact and Household cards has been added to the layout.

To update the Benefit Case layout:

1. From Setup, click Create, and then click Objects, and then click Benefit Case.
2. From the Page Layouts section, click Edit next to PS Case Layout.
3. Remove the Primary Client field from the Information section of the layout and replace it with Primary
Contact.
4. Create a new 1-Column Section and drag the PSCaseParties Visualforce page into the section.
5. Click Save.

© 2022 Vlocity LLC, a Salesforce


company 125
Vlocity Government

Program Enrollments
The Program Enrollment is used to track the participation of an individual or household in a program. The
stage and status of a Program Enrollment can be used to track the party’s progress through the different
steps that are required, such as submitting paperwork, being interviewed by a caseworker, and so on, to
complete enrollment successfully. For example, after a client completes an application, Vlocity DataRaptor
can be set up to create a program enrollment automatically with a stage of Applied and a status of Not
Enrolled. Where applicable, the stage can be updated as the party passes through the different required
steps in the process. When the party successfully completes all activities that are required to enroll, their
status can be updated to Enrolled. Once the party is no longer participating, the Program Enrollment can be
maintained with a status value such as Inactive or Completed, to enable the agency to maintain a record of
who has participated in the program.

Program Enrollment Detail


The program enrollment detail section includes the name of the primary applicant and the program for
which they are applying, as well as additional details such as the stage and status of the program
enrollment.

The current eligibility determination section reflects the details of the most recent eligibility determination,
based on the created date field for that program enrollment.

Eligibility Determination
The eligibility determinations related list is used to track any eligibility determinations that are made during
the course of that party’s participation in the program.

Different types of eligibility determinations may include a preliminary determination, a final determination, or
a redetermination after a change of circumstances.

Program Enrollment Card


Available out-of-the-box, the Program Enrollment Card displays details about a citizen’s (contact) Program
Enrollment and executes related actions.

© 2022 Vlocity LLC, a Salesforce


company 126
Vlocity Government

When editing a card layout, it is best practice to clone the existing card layout first, then edit the cloned
version. For more information on cloning card layouts, see Cloning in the Cards Framework.

Requirements
• PS 104 release
• Report Change of Circumstances process downloadable from Vlocity Process Library
• Program Enrollment base card downloadable here

Card Layout
Card Layout Name Card Layout Template Cards Layout Preview
programEnrollmentCardLayout card-canvas-3x-slds Housing

Employment Assistance

Child Care

© 2022 Vlocity LLC, a Salesforce


company 127
Vlocity Government

Cards
Card Name Card Description and Settings Layout
Template Preview
Housing card- Displays Program Enrollment details for an Employment Assistance program and
active-slds executes related actions.

Fields

• Enrollment Name
• Program Name
• Status
• Stage
• Enrollment Eligibility

States

• Enrolled: Program Enrollment exists. Status = Enrolled


• Not Enrolled: Program Enrollment exists. Status = Not Enrolled
• Program: A Program Enrollment does not exist for the given program.

Actions

• Request Annual Review


• Change of Circumstances
• Unenroll Client (visible when Status = Not Enrolled)
• Enroll Client (visible when Status = Enrolled)
• Click to Apply for Program (if no Status exists)
Employment Displays Program Enrollment details for an Employment Assistance program and
Assistance executes related actions.

Fields

• Enrollment Name
• Program Name
• Status
• Stage
• Enrollment Eligibility

States

• Enrolled: Program Enrollment exists. Status = Enrolled


• Not Enrolled: Program Enrollment exists. Status = Not Enrolled
• Program: A Program Enrollment does not exist for the given program.

Actions

• Request Annual Review


• Change of Circumstances
• Unenroll Client (visible when Status = Not Enrolled)
• Enroll Client (visible when Status = Enrolled)
• Click to Apply for Program (if no Status exists)

© 2022 Vlocity LLC, a Salesforce


company 128
Vlocity Government

Card Name Card Description and Settings Layout


Template Preview
Child Care Displays Program Enrollment details for a Child Care program and executes related
actions.

Fields

• Enrollment Name
• Program Name
• Status
• Stage
• Enrollment Eligibility

States

• Enrolled: Program Enrollment exists. Status = Enrolled


• Not Enrolled - Program Enrollment exists. Status = Not Enrolled
• Program: A Program Enrollment does not exist for the given program.

Actions

• Request Annual Review


• Change of Circumstances
• Unenroll Client (visible when Status = Not Enrolled)
• Enroll Client (visible when Status = Enrolled)
• Click to Apply for Program (if no Status exists)

Enrollment Determinations
The enrollment determination is used to track decisions that are made by an agency about whether a party
such as an individual or household is eligible to enroll in a program, and when applicable, what amount of
benefit they are to receive.

Enrollment Determinations work with Applications and Program Enrollments to manage the full life-cycle of
a party’s application for assistance.

The enrollment determination detail section includes the related Program Enrollment, the date it was
created and last updated, and an indicator of whether it is active. The eligibility determination section
reflects whether the party who is the subject of the Program Enrollment is eligible, and where applicable,
the amount of benefit they qualify for.

© 2022 Vlocity LLC, a Salesforce


company 129
Vlocity Government

Enrollment Determinations can be of different types, such as Preliminary Determination, Final


Determination, Annual Re-determination, or Change of Circumstance.

Enrollment Determinations can be created manually by an employee after reviewing a client’s file.
Alternatively, you can use Vlocity DataRaptor to automatically create an Enrollment Determination upon
the completion of an Intake or a Change of Circumstances.

A Program Enrollment record can have only one Enrollment Determination. When a Enrollment
Determination is created, it is set as the Active Enrollment Determination, and all previous determinations
are set to Inactive.

Configure the Parties That Transfer From an Incident to a Benefit


Case
After an incident is investigated and substantiated, a Benefit Case can be created for the relevant parties.
Upon creation, all parties associated with the Incident are, by default, associated with the Benefit Case.
Additionally, you can configure which parties are to be transferred to the Benefit Case when it is created.

To configure parties:

1. From Setup, click Develop, and then click Custom Settings.


2. Click Manage next to Role Setup.
3. Click New.
4. In the Name field, enter a name for the setting.
5. In the Value field, enter the name of the Role to be omitted from the Benefit Case. This Role must
match the value in the Role picklist in the Incident Party Relationship custom object.
6. Click Save.
7. Repeat to add more Roles.

Case Management Case Finances Objects


Vlocity Government Winter '18 introduces new Case Management Case Finances objects and page
layouts. These new objects enable caseworkers and other Vlocity application users to view the financial
information associated with a benefit case or Client record. Using these objects, employees can:

• Track the balances of each client account.


• Store and view monthly client account statements.
• Record transactions, such as logging a payment or reversing a charge.
• Update or add payment methods using the Vlocity application, instead of accessing your financial system
directly.

© 2022 Vlocity LLC, a Salesforce


company 130
Vlocity Government

The Vlocity Case Finances module has been designed to facilitate integration with your back office
Financial Management System, not to replace all of the functions of the financial system. For more
information, about developing this integration, see Integration Procedures.

To track account balances, statements, and transactions for clients, you must create a Client Account
record for each contact or household. A client account is a Salesforce Account record. You can decide to
create a separate record type for client accounts. The Client Account becomes the parent record under
which all the financial information is stored.

Your administrator must add related lists or tabs for these objects to give users access to the case financial
information. Your administrator must also create the appropriate permissions to these objects, according
your organization’s requirements.

The new objects and associated page layouts are:

• Account Balance, see Account Balance Object and Page Layout


• Payment Method, see Payment Method Object and Page Layout
• Payment Transaction, see Payment Transaction Object and Page Layout
• Statement, see Statement Object and Page Layout
• Statement Line Item, Statement Line Item Object and Page Layout

Account Balance Object and Page Layout


The Account Balance object represents an historical snapshot of charges, credits, and resulting balance
for a client account at a point in time. Your organization's billing system typically populates the Account
Balance object. The Account Balance object API name is vlocity_ps__AccountBalance__c.

Field Label API Name Type Standard or Custom


Account Balance Name Name Text (80) Standard field
Balance vlocity_ps__Balance__c Currency (16, 2) Custom field
Charges vlocity_ps__Charges__c Currency (16, 2) Custom field
Client Account vlocity_ps__AccountId__c Master-Detail (Account) Custom field
Created By CreatedById Lookup (User) Standard field
Credits vlocity_ps__Credit__c Currency (16, 2) Custom field
Date vlocity_ps__Date__c Date Custom field
Inventory Item vlocity_ps__InventoryItem__c Lookup (Inventory Item) Custom field
Last Modified By LastModifiedById Lookup (User) Standard field
Program vlocity_ps__Program__c Lookup (Program) Custom field

© 2022 Vlocity LLC, a Salesforce


company 131
Vlocity Government

Figure 2. Account Balance Page Layout, Salesforce Lightning Experience

The Account Balance page layout includes the following:

• Account Balance Name


• Client Account
• Date
• Balance
• Details
• Charges
• Program
• Credits
• Inventory Item
• System Information
• Created By
• Last Modified By

Payment Method Object and Page Layout


The Payment Method objects stores credit card, bank account, or other payment processing information for
an account. The Payment Method object API name is vlocity_ps__PaymentMethod__c.

Field Label API Name Type Standard or Custom


Active vlocity_ps__IsActive__c Checkbox Custom field
Bank Account Number vlocity_ps__BankAccountNumber__c Text (Encrypted)(80) Custom field
Bank Account Type vlocity_ps__BankAccountType__c Picklist Custom field
Bank Routing Number vlocity_ps__BankRoutingNumber__c Text (80) Custom field
Card Holder Name vlocity_ps__CardHolderName__c Text (80) Custom field
Card Number vlocity_ps__CardNumber__c Text (Encrypted)(16) Custom field

© 2022 Vlocity LLC, a Salesforce


company 132
Vlocity Government

Field Label API Name Type Standard or Custom


Card Type vlocity_ps__CardType__c Picklist Custom field
Client Account vlocity_ps__AccountId__c Master-Detail(Account) Custom field
Created By CreatedById Lookup (User) Standard field
Expiration Month vlocity_ps__ExpirationMonth__c Text (80) Custom field
Expiration Year vlocity_ps__ExpirationYear__c Text (4) Custom field
Last Modified By LastModifiedById Lookup (User) Standard field
Last4Numbers vlocity_ps__Last4Numbers__c Text (20) Custom field
Nickname Name Text (80) Standard field
Payment Method Token vlocity_ps__PaymentMethodToken__c Text (80) Custom field
Payment Method Type vlocity_ps__MethodType__c Picklist Custom field
Primary vlocity_ps__IsPrimary__c Checkbox Custom field

Figure 3. Payment Method Object Page, Salesforce Lightning Experience

The Payment Method page layout includes the following:

• Nickname
• Payment Method Type

© 2022 Vlocity LLC, a Salesforce


company 133
Vlocity Government

• Client Account
• Details
• Active
• Payment Method Token
• Primary
• Credit Card Details
• Card Type
• Card Number
• Expiration Month
• Card Holder Name
• Expiration Year
• Last4Numbers
• Bank Account Details
• Bank Account Type
• Bank Routing Number
• Bank Account Number
• System Information
• Created By
• Last Modified By

Payment Transaction Object and Page Layout


The Payment Transaction object represents client payments or adjustments. Usually, an accounting system
populates this object, but the Payment Transaction object can be used to request an adjustment to a
customer's owed balance or to register a client's payment. The Payment Transaction object API name is
vlocity_ps__PaymentTransaction__c.

Field Label API Name Type Standard or Custom


Amount vlocity_ps__Amount__c Currency (16, 2) Custom field
Client Account vlocity_ps__AccountId__c Master-Detail(Account) Custom field
Created By CreatedById Lookup (User) Custom field
Inventory Item vlocity_ps__InventoryItemId__c Lookup (Inventory Item) Custom field
Last Modified By LastModifiedById Lookup (User) Standard field
Method of Payment vlocity_ps__TypeOfPayment__c Picklist Custom field
Notes vlocity_ps__Notes__c Rich Text Area (32,768) Custom field
Paid With vlocity_ps__PaidWithId__c Lookup (Payment Method) Custom field
Post Date vlocity_ps__PostDate__c Date Custom field
Statement vlocity_ps__StatementId__c Lookup (Statement) Custom field
Transaction Date vlocity_ps__TransactionDate__c Date Custom field
Transaction Number Name Text (80) Standard field
Type vlocity_ps__Type__c Picklist Custom field

© 2022 Vlocity LLC, a Salesforce


company 134
Vlocity Government

Figure 4. Payment Transaction Object Page, Salesforce Lightning Experience

The Payment Transaction page layout includes the following:

• Transaction Number
• Client Account
• Transaction Date
• Amount
• Details
• Type
• Post Date
• Method of Payment
• Statement
• Paid With
• Inventory Item
• Notes
• System Information
• Created By
• Last Modified By

© 2022 Vlocity LLC, a Salesforce


company 135
Vlocity Government

Statement Object and Page Layout


The Statement object can contain imported summaries from periodic statements that your organization's
billing software produces. The Statement object can retain historical statements as well. The API name for
the Statement object is vlocity_ps__Statement__c.

Field Label API Name Type Standard or Custom


Balance Due vlocity_ps__BalanceDue__c Currency (16, 2) Custom field
Client Account vlocity_ps__AccountId__c Master-Detail(Account) Custom field
Created By CreatedById Lookup (User) Standard field
Current Balance vlocity_ps__CurrentBalance__c Currency (16, 2) Custom field
Current Charges/Credits vlocity_ps__CurrentChargesCredits__c Currency (16, 2) Custom field
Due Date vlocity_ps__DueDate__c Date Custom field
Inventory Item vlocity_ps__InventoryItemId__c Lookup (Inventory Item) Custom field
Last Modified By LastModifiedById Lookup (User) Standard field
Program vlocity_ps__ProgramId__c Lookup (Program) Custom field
Statement Date vlocity_ps__StatementDate__c Date Custom field
Statement Description vlocity_ps__StatementDescription__c Text Area (255) Custom field
Statement Image URL vlocity_ps__StatementImageURL__c URL (255) Custom field
Statement Number Name Text (80) Custom field
Statement Period End Date vlocity_ps__StatementPeriodEndDate__c Date Custom field
Statement Period Start Date vlocity_ps__StatementPeriodStartDate__c Date Custom field
Status vlocity_ps__Status__c Picklist Custom field

© 2022 Vlocity LLC, a Salesforce


company 136
Vlocity Government

Figure 5. Statement Page Layout

The Statement page layout includes the following:

• Statement Name
• Client Account
• Due Date
• Current Balance
• Details
• Statement Period Start Date
• Statement Date
• Statement Period End Date
• Program

© 2022 Vlocity LLC, a Salesforce


company 137
Vlocity Government

• Statement Image URL


• Inventory Item
• Statement Description
• Installment Details
• Previous Balance
• Current Charges/Credits
• Balance Due
• System Information
• Created By
• Last Modified By

Statement Line Item Object and Page Layout


The Statement Line Item object retains individual line items constituting a client an account's statement,
which are imported from your organization's billing system. Line items may include payments your
organization makes on behalf of the client, as well as charges or fees that are the client’s responsibility.
Statement Line Item objects are children of the Statement object. The Statement Line Item object API name
is vlocity_ps__StatementLineItem__c.

Field Label API Name Type Standard or Custom


Amount vlocity_ps__Amount__c Currency (16, 2) Custom field
Charge Type vlocity_ps__ChargeType__c Picklist Custom field
Created By CreatedById Lookup (User) Custom field
Current Month to Date vlocity_ps__CurrentMonthToDate__c Checkbox Standard field
Description vlocity_ps__Description__c Text Area (255) Custom field
End Date vlocity_ps__EndDate__c Date Custom field
Frequency vlocity_ps__Frequency__c Picklist Custom field
Inventory Item vlocity_ps__InventoryItemId__c Lookup (Inventory Item) Custom field
Last Modified By LastModifiedById Lookup (User) Standard field
Product/Service vlocity_ps__ProductId__c Lookup (Product) Custom field
Program vlocity_ps__ProgramId__c Lookup (Program) Custom field
Quantity vlocity_ps__Quantity__c Number (18, 0) Custom field
Sequence vlocity_ps__Sequence__c Number (18, 0) Custom field
Service Type vlocity_ps__ServiceType__c Picklist Custom field
Start Date vlocity_ps__StartDate__c Date Custom field
Statement vlocity_ps__StatementId__c Master-Detail(Statement) Custom field
Statement Line Number Name Text (80) Custom field
Transaction Date vlocity_ps__TransactionDate__c Date Custom field
Type vlocity_ps__Type__c Picklist Custom field

© 2022 Vlocity LLC, a Salesforce


company 138
Vlocity Government

Figure 6. Statement Line Item Page Layout

The Statement Line Item page layout includes the following:

• Statement Line Number


• Statement
• Description
• Amount
• Details
• Type
• Sequence
• Frequency
• Program
• Transaction Date

© 2022 Vlocity LLC, a Salesforce


company 139
Vlocity Government

• Inventory Item
• Service Details
• Start Date
• Service Type
• End Date
• Product/Service
• Current Month to Date
• Quantity
• System Information
• Created By
• Last Modified By

Referral Card
Available out-of-the-box in Vlocity Government, the Referral Card enables caseworkers and case managers
to view details about a referral and perform related actions.

When editing a card layout, it is best practice to clone the existing card layout first, then edit the cloned
version. For more information on cloning card layouts, see Cloning in the Cards Framework.

Requirements
• PS 104 release
• Create a Referral process downloadable from Vlocity Process Library
• Referral Card Layout file downloadable here.

© 2022 Vlocity LLC, a Salesforce


company 140
Vlocity Government

Card Layout
Card Layout Name Card Layout Template Cards Layout Preview
Referral Card Layout card-canvas-3x-slds column-chart

Cards
Card Name Card Template Description and Settings
column-chart card-active-slds Displays details about Referral and executes related actions.

Fields

• Referral Name
• Referral Date
• Status
• Stage
• Service Provider Name
• Offering Name

States

• Closed Referral. Status = Closed


• Open Referral. Status = Open

Actions

• Request Update
• Duplicate Referral
• Reopen (visible if Status = Closed)

© 2022 Vlocity LLC, a Salesforce


company 141
Vlocity Government

Housing Program Administration

Housing program administration includes management of the buildings and the resident benefits.

Manage Buildings and Units


Vlocity Government enables agencies and providers to manage a directory of all available housing
inventory. Inventory is comprised of Buildings, which can have one or more Units. A Unit represents an
individual dwelling, such as an apartment, a secondary suite, or a single-family home.

Building Detail
Buildings are represented by the Premises object in the Vlocity data model. The building detail section
provides additional information about the Building, such as how many units it contains and information
about infrastructure like what type of heating and cooling systems it has.

Unit Features
Units are represented by the “Inventory Item” object in the Vlocity data model. The unit features section
provides a high-level view of which types of Units are available within a Building. These features are used
to indicate whether a Building has any units of this type, rather than indicating characteristics that apply to
all Units. For instance, in the example below this building has at least one wheelchair accessible Unit, but
does not offer any one bedroom apartments.

Address Information
The address information section includes the street address and additional address details for the Building.

© 2022 Vlocity LLC, a Salesforce


company 142
Vlocity Government

Address information is inherited by all Units that are related to a Building.

Units
The units related list displays all units associated with a building.

Upon drilling into a Unit record, additional details about a specific Unit are available.

Unit Detail
The unit detail section shows the name of the Unit and its associated Building, the current resident, and
whether the unit is occupied.

Housing Directory Administration


The housing directory administration section controls whether a Unit is published to the housing directory,
and for how long. The Status must be set to “Available” and the current date must be on or after the Publish
Start date and on or before the Publish End date for the Unit to be visible in the directory.

An administrator can change the Status value that publishes a unit to a listing.

1. From Setup, click Develop, and then click Custom Settings.


2. Find the Housing Set-up custom setting and click Manage.
3. Change the value of the InventoryStatus custom setting from Available to a different status .

Unit Information
The unit information section provides additional characteristics of the Unit, such as the rent and amount of
space, that can be viewed in the housing directory.

© 2022 Vlocity LLC, a Salesforce


company 143
Vlocity Government

Interested Parties
The Interested ApplicantsVisualforce page shows the provider which individuals have expressed an interest
in the Unit while it was published in the housing directory. From here, the provider can take the appropriate
action, such as contacting the top person on the list to arrange for them to view the Unit.

Unit Images
The “Unit Attachment” Visualforce page is used to attach any photographs that will be displayed in the
housing directory when the Unit is published. Images can either be uploaded from your local machine, or
added via an external URL. Attachments have a maximum size of 25 MB.

Application for Housing Benefits


Administrators can create applications for housing using OmniScript. The resulting forms can be deployed
in a Salesforce application or on an external website.

© 2022 Vlocity LLC, a Salesforce


company 144
Vlocity Government

For detailed instructions on how to set-up and deploy an OmniScript, see:

• Vlocity OmniScript Overview


• Reference Guide of OmniScript Elements
• Deploy an OmniScript
• Deploy an OmniScript to an External Website

Send Application Data to Salesforce


Data collected in the application forms can be posted to Salesforce.com using Vlocity DataRaptor. See the
following topics for detailed instructions on how to use DataRaptor:

• DataRaptor Overview
• Create or Update Records From an OmniScript Using DataRaptor

Vlocity recommends capturing data in the following objects, using an OmniScript DataRaptor Post Action.

• Program Enrollment: Details about the client’s participation in the housing program including status of the
enrollment and current eligibility determination.
• Contact: Information about the client, such as preferred method of contact. Associate the contact as the
“Primary Contact” on the Program Enrollment.
• Enrollment Determination: Details about the client’s eligibility determination for a specific program
enrollment.

© 2022 Vlocity LLC, a Salesforce


company 145
Vlocity Government

Remember to link the Contact and Enrollment Determination to the Program Enrollment. To learn more
about creating DataRaptor input mappings, see Mapping Data to Salesforce.

If you want to save a copy of the completed intake form, use an OmniScript to create an Application object.
For more information, see OmniScript Post to Object Action. The application ID is returned in the data
JSON so that you can associate it with the Program Enrollment record.

Integrate Eligibility Calculation


With Vlocity Calculations, you can perform eligibility calculations directly from an OmniScript and post
the results to Salesforce objects, such as the client’s Program Enrollment and Enrollment Determination
records. See the following topics for detailed instructions on how to use Vlocity Calculations:

• Calculation Procedures Overview


• Integrate OmniScript with Vlocity Calculations
• Create Formula Fields in an OmniScript

Housing Eligibility Entity Filters


Entity filters are used to specify the rules that determine whether a party is eligible for different types of
units. For example, in the entity filter, you can specify that a client can express interest in a unit only if the
Eligible Number of Bedrooms field on his or her Program Enrollment matches the Number of Bedrooms
field on the Unit.

To define an Entity Filter:

1. Navigate to the Vlocity Entity Filters tab and click New.


2. Fill out the following fields:
• Entity Filter Name: Specify a name for your entity filter.
• Active: Set to True when you are ready to use your Entity Filter.
• Filter on Object Name: Enter the API name of the object to filter based on Eligibility Rules, typically
Inventory Item (vlocity_ps__InventoryItem__c).
• Type: Select Evaluation.
• Valid From: Date when the Entity Filter goes into effect.
• Valid Until: Date when the Entity Filter becomes inactive.

Define Housing Eligibility Rules


To define housing Eligibility Rules:

1. Click Add to define a new Eligibility Rule.


2. From the Type picklist, select Field.
3. Click Select near the Field/Attribute Name field.
A dialog box opens, displaying the fields on the object that you specified in the Filter on Object Name
field.

© 2022 Vlocity LLC, a Salesforce


company 146
Vlocity Government

You can also choose fields from related objects (such as Premises):

4. Select the field that will drive eligibility, for example, # Bedrooms, and click Save.
5. Choose an operator, such as =, <, contains, in, and so on.
6. In the Value field, define the field on the Program Enrollment using the following format:
{!$Variable.EligibilityMap.Field} where Field is the API name of the field on the Program Enrollment.
7. Repeat steps 1–6 as many times as needed to define all Eligibility Rules.
8. Click Save.

Activate the Housing Eligibility Filter


To start using the Eligibility Entity Filter in your housing listing, set the Housing Set-up custom setting.

To activate the Housing Eligibility Filter:

1. Activate the entity filter by selecting Active on the record.

© 2022 Vlocity LLC, a Salesforce


company 147
Vlocity Government

2. Add the name of the Entity Filter to the Housing Set-up custom setting.
a. From Setup, click Develop, and then click Custom Settings.
b. Find the Housing Set-up custom setting.
c. Click Manage.
d. Find EligibilityCondition and click Edit.
e. Replace the value with the name you selected for your Entity Filter.

Housing Eligibility Filter Examples


Below are a few examples of Eligibility Entity Filters:

• For a client to express interest in a unit, the Number of Eligible Bedrooms field on his or her Program
Enrollment must equal the Number of Bedrooms of the unit.

• For a client to express interest in a unit, the Resident Type field on the unit must be included in the
Eligible Resident Type picklist on the Program Enrollment:

Program Enrollment Entity Filter


Program Enrollment Entity Filters are similar to Eligibility Entity Filters, except the eligibility determination is
based on fields from only one object, typically the Program Enrollment. For example, you might want any
client that does not have a status of Unit Ready to be ineligible to express interest in a unit.

There are a few key differences when setting up a Program Enrollment Entity Filter:

• The Filter on Object Name field should be set to vlocity_ps__ProgramEnrollment__c.


• In the Field/Attribute Name picklist, select the field on the Program Enrollment on which you want to
filter, for example vlocity_ps__Stage__c.
• In the Value field, specify the value on which you want to filter, for example, Unit Ready.
• Activate the Program Enrollment Entity Filter by replacing the name in the ProgramEnrollmentCondition
Housing Set-up custom setting.

Program Enrollment Entity Filter Examples


Below are a few examples of Program Enrollment Entity Filters:

• For a client to express interest in a unit, Stage must equal Unit Ready

• For a client to express interest in a unit, Program must equal Housing

© 2022 Vlocity LLC, a Salesforce


company 148
Vlocity Government

Requests for Housing and Placements


The Program Enrollment Item Request (PEIR) object tracks two phases of a client’s placement:

1. Request for Placement


2. Placement

While a client might have many open PEIRs in the Request Stage, he or she will likely have only one active
PEIR in Placement stage.

A PEIR record is typically created when a client user expresses interest in a unit from the housing portal:

Request for Placement


When a client user expresses interest in a unit, a PEIR is created and associated to 1) the user’s contact
record and 2) the unit record. When first created, the PEIR will have a Stage of “Request” and Status of
“Open Request.”

The following additional statuses are available by default for PEIRs in the Request stage:

• Request Aborted - can be used if a client aborts an expression of interest in a unit

© 2022 Vlocity LLC, a Salesforce


company 149
Vlocity Government

• Request Refused - can be used if a client refuses the unit after expressing interest
• Placed Elsewhere - can be used if the client commits to a different unit

Placement
When a client is committed to the unit, the PEIR Stage can become Placement.

The following additional statuses are available by default for PEIRs in the Placement stage:

• Placement Pending - can be used if the client commits to a unit but the Current Date < Lease Start Date.
• Placement Active - can be used if the client commits to a unit and the Lease Start Date >= Current Date.
• Placement Inactive - can be used if the placement time period has passed and Current Date > Lease
End Date.

© 2022 Vlocity LLC, a Salesforce


company 150
Vlocity Government

Configure Housing Listing Filters


To add filters to your housing listing, add Attribute Categories and Attributes. Attribute Categories will define
the filter (ex. Number of Bedrooms, Tenant Type) and Attributes will define the filter values (ex. 1 Bedroom,
2 Bedrooms, 3 Bedrooms).

Vlocity recommends creating Attribute Categories first, then adding Attributes. If you start with an Attribute,
there must be an existing Attribute Category to relate it to. If you start with categories, you will be able to
add Attributes there and that category relationship will be automatic.

Attribute Categories appear as filters in the housing listing:

© 2022 Vlocity LLC, a Salesforce


company 151
Vlocity Government

Building a Provider or Client Portal Using Vlocity on


Salesforce Communities

You can use Salesforce Communities to create a provider or client portal for self-service actions.

Set Up a Housing Community Overview


Setting up a housing community involves the following steps:

1. Import Layout and Cards for Housing Setup


2. Import Templates for Housing Setup
3. Create a Housing Listing Visualforce Page
4. Community Permissions
5. Set Up the Community
6. Add a Header for the Housing Listing
7. Add a Default Housing Unit Image
8. Enable Translations and Custom Labels
9. Set a Maximum Number of Expressions of Interest

Import Layout and Cards for Housing Setup


Layouts define the different types of cards that display in the Housing Listing. Vlocity Government provides
the following default Layouts you can use as a starting point to set-up your housing listing:

• Grid
• Housing-Flyout

To use the default cards, import the layouts using the Vlocity Cards Designer.

Import Templates for Housing Setup


Templates allow you to update the look and feel of the Housing Listing page. Vlocity Government provides
the following UI templates you can use as a starting point to set-up your housing listing:

• Variables: define variables used in other UI templates


• Mixin: define patterns of property value pairs, which can then be reused in other UI templates
• Card-Canvas-Housing: skeleton of the housing listing page
• Housing-Header: header image
• Housing-Facets: filters above housing listing
• House-Card: fields and layout of unit listing item card
• Housing-Flyout-Gallery: image carousel in the “additional information” flyout
• Housing-Flyout-Grid: skeleton of “additional information” flyout
• Housing-Flyout-Details: fields and layout in the “additional information” flyout

To use the default UI templates, import the templates using the Vlocity Template Designer.

© 2022 Vlocity LLC, a Salesforce


company 152
Vlocity Government

NOTE
import Variables and Mixin templates first, then bulk import the other templates.

Create a Housing Listing Visualforce Page


Once Layouts and Templates are set-up, create a Visualforce page for the housing listing. You can either
use the default one provided by Vlocity (HousingCards) or create your own.

Create a custom tab for the housing listing Visualforce page:

1. From Setup click Create, and then click Tabs.


2. Go to Visualforce Tabs and click New.
3. Select the visualforce page you created in the previous step.

Community Permissions
Set-up a community profile or permission set for client users. Vlocity has packaged a sample permission
set, called “Housing Community - Client User” - you can clone this permission set and use it as a starting
point.

Make sure client users have “API Enabled” (in the System Permissions) and “View All” access to Inventory
Items.

Set Up the Community


Create a community for your Housing Portal. Once created, go to Manage > Administration to start setting
up the housing listing.

• In Members: Add the internal and external profiles and permission sets that should have access to the
housing portal.
• In Tabs: Add the Visualforce Page tab you created for the housing listing.
• In Pages: Set the Home page.

Add a Header for the Housing Listing


To add a header to the housing listing, upload the header image as a static resource. Click View File and
copy the URL of the image.

Update the housing listing header template with the URL to the new header image.

1. Go to Vlocity Template Designer.


2. Find the housing-header template or your own custom template that references the header image.
3. Update the URL.

Add a Default Housing Unit Image


You can upload a default image to display if 1) No photo is associated to the listing or 2) The associated
photo is not available. Vlocity offers the following default image:

© 2022 Vlocity LLC, a Salesforce


company 153
Vlocity Government

To change the default image, upload the new default image as a static resource. Click View File and copy
the URL of the image.

Update the housing card template with the URL to the new default unit image.

1. Go to Vlocity Template Designer.


2. Find the housing-card template (or your own custom template that references the default unit image).
3. Update the URL in the following places:

<img ng-if="obj.images.length>0" ng-src="{{obj.images[0].url||'URLHERE'}}"


onerror="this.onerror=null;this.src='URL HERE'"/><div class="noimage"
ng-if="obj.images.length <= 0"><img ng-src="URL HERE"/></div>

Enable Translations and Custom Labels


Most labels in Vlocity can be translated. To change the default text of a label—for example, to change the
Express Interest button to read Add to Wishlist—perform the following steps.

1. If translations are not enabled in your org, enable translation workbench as follows.
a. From Setup, click Translation Workbench, then click Translation Settings.
b. Click Enable and fill out the information for the desired target languages. To change the default
messaging, enable the translation workbench for English.
2. To translate or update the default messaging of a label:
a. From Setup, click Create, then click Custom Labels.
b. Find your label by searching the Value column.

c. Click the custom label and create a New Local Translation.


d. Specify the translated text or custom messaging in the Translation Text field.

Set a Maximum Number of Expressions of Interest


By default, a client can express interest in 5 units. If you would like to change this maximum value.

© 2022 Vlocity LLC, a Salesforce


company 154
Vlocity Government

1. From Setup, click Develop, and then click Custom Settings.


2. Find the Housing Set-up custom setting and click Manage.
3. Find ExpressInterestMaxUnits and click Edit.
4. Update the value to your new maximum.

Create a Community User from an Application


The housing community will provide clients with a self-service portal to interact with the agency and
property management.

It is possible to automate the creation of an external Salesforce Community user after a prospective tenant
fills out the initial intake form, requesting assistance.

To create an external user when a form is submitted:

1. Add a remote action to the end of the application (OmniScript), in place of a Submit action.

Remote Class= ExternalUserSelfRegistrationService


Remote Method = selfRegistration
2. Create elements in the OmniScript for Username and Password. Alternatively, if an email address
is already an element in the form, you can set the email address as the username. If no password
element is added, a system-generated email will be sent to the user with instructions for setting up their
password for the portal.
3. Create a Pre-Transform DataRaptor Interface to add to the remote action. The purpose of the Pre-
Transform DataRaptor Interface is to map fields in the application (such as Name, Email, Password) to
the required inputs for registration.

Tenant Self-Service Actions Overview


The housing community provides tenants and prospective tenants with a secure, easy-to-use portal that
enables them to interact with the agency and any housing providers to accomplish any self-service tasks.

Import Layout & Cards


Layouts define the different types of cards that display in the Housing Listing. To learn how to create
Layouts & Cards, see Creating a New Card Layout.

© 2022 Vlocity LLC, a Salesforce


company 155
Vlocity Government

Use the following default layouts a starting point to set the community up:

• PORTAL-ACCOUNT-LAYOUT
• PORTAL-ANNOUNCEMENTS-LAYOUT
• PORTAL-CASE-LAYOUT
• PORTAL-FEEDBACK-LAYOUT
• PORTAL-HOME-LAYOUT
• PORTAL-MIMOC-LAYOUT
• PORTAL-SIDEBAR-LAYOUT

To use the default cards, import the layouts using the Vlocity Cards Designer.

Import Templates
Templates allow you to update the look and feel of the Housing Community. Vlocity Government provides
the following UI templates you can use as a starting point to set-up your portal:

• Variables: define variables used in other UI templates


• Mixin: define patterns of property value pairs, which can then be reused in other UI templates
• community-housing-grid
• community-housing-sidebar
• portal-announcements-canvas
• portal-case-template
• portal-feedback-canvas
• portal-home-canvas
• mimoc-canva
• portal-myinfo-canvas
• tenantDetail-canvas
• portal-welcome-canvas

To use the default UI templates, import the templates using the Vlocity Template Designer.

NOTE
Import Variables and Mixin templates first, then bulk import the other templates.

Visualforce Pages
The following pages are included in the Vlocity package:

• CommunityCanvas
• CommunityCanvasHousing
• CommunityUserInformation

© 2022 Vlocity LLC, a Salesforce


company 156
Vlocity Government

• CommunityUserServiceRequest
• CommunityCanvasHousingHomePage
• CommunityUserBuildingAnnouncements
• CommunityUserFeedback
• CommunityUserMoveInMoveOutCoordination
• CommunityUserTenantList

Housing Listing
Click here to learn how to add the housing listing to your Housing Community.

Message Center
With Message Center, agency and provider employees can communicate securely with clients. Message
Center is built using the capabilities of Salesforce Chatter. If you want to use Message Center, make sure
Chatter is enabled for community users and they are able to receive Private Messages.

Manage Profile
In the Update Profile section of the portal, clients can view their profile, update their circumstances, perform
scheduled validations of eligibility, and upload documentation.

Resident Manager
In the Resident Manager section of the portal, clients can schedule move-in or move-out, reserve common
rooms, make service requests, and submit feedback or grievances.

Resident Resources
In the Resident Resources section of the portal, clients can view updates and building announcements from
the Property Manager.

Set Up Message Center


With Message Center, agency and provider employees can communicate securely with clients. With simple
configuration, an administrator can also set-up automated notifications to alert clients of changes to their
record.

© 2022 Vlocity LLC, a Salesforce


company 157
Vlocity Government

Enable Message Center in Communities


To use Message Center, first enable Chatter in your community.

1. Go to Chatter and click Chatter Settings and then click Enable.


2. Go to Communities and click All Communities .
3. Find your community and click Manage.
4. Go to Administration and then click Preferences.
5. Select Enable private messages.

Send Private Messages


To send a private message to a user, perform these steps.

1. Log into the portal.


2. Go to either the standard Salesforce Chatter tab or the Message Center page.
3. Click New Message.
4. Type the community user’s name in the To field.
5. Add the body of the private message and click Send.
The message is sent to the community user’s message center.

Send Automatic Messages for Field Updates


You can create an automated message based on an update to the a field on the Program Enrollment object
or Program Enrollment Item Request object.

1. From Setup, click Develop, and then click Custom Settings.


2. Find the Chatter custom setting and click Manage.
3. Add a new entry in the following format:
a. Name - [ObjectName][Insert/Update][Entry #]
Examples: ProgramEnrollmentUpdate0, ProgramEnrollmentUpdate1
b. Key - Object API name
Example: Stage__c
c. Value - Field Value
Example: Unit Ready
d. Message - Private message text
Example: Good news - you are now "Unit Ready." Please check the housing listing regularly
for units that fit your needs.

© 2022 Vlocity LLC, a Salesforce


company 158
Vlocity Government

Here are some examples of notification templates:

Send Automatic Messages at Application Submission


You can create an automated message when an application has been submitted.

1. Set up the ability to create a community user through an application. For more information, see Create
a Community User from an Application.
2. Set the frequency of messages to be sent to users in the Chatter Custom Settings.
a. Create a custom setting entry for ChatterSchedulerRunTime.
b. Set the Value to the desired frequency in minutes.Vlocity recommends 20.
3. Run the scheduler script in the Developer Console. Click Debug and then click Open execute
anonymous window.

ChatterMessageSchedulerClass jb = new ChatterMessageSchedulerClass ();

jb.execute(null);
4. By default, the following message will be sent to the user upon submission of an application: “Your
application has been successfully submitted.” To update this messaging, create an English translation
for the custom label Submit Application Label.

Enable Clients to Send Messages


In the message center, the New Message button starts an OmniScript that allows the user to compose and
send a message to either the Agency or Property Management.

To enable clients to send messages:

1. Import the ChatterMessageOmni Omniscript. Go to the VlocityOmniScript tab and click Import
Omniscript .
2. Update Remote Actions:
• Remote Class = ScheduleAppointmentService

© 2022 Vlocity LLC, a Salesforce


company 159
Vlocity Government

• Remote Method = sendChatterMessage


3. Configure the OmniScript per your organization’s requirements:
• In the Send to Agency Remote Action, update UserId to the organization administrator’s ID.

Add a New Announcement Type


To add a new type to the announcements page in the housing portal:

1. Add the new type to the picklist on the Event Directory object.
2. Add Announcement Type to the Filter List in the Announcements Vlocity UI Template.
3. Upload your icon to Static Resources.
4. Add Announcement icon to the Icons in the Announcements Vlocity UI Template.
5. Make Updates 2–4 on Home Page Vlocity UI Template.

Add the New Type to the Picklist on the Event Directory Object
1. From Setup, click Create, and then click Objects.
2. Find the Event Directory custom object and click the Type field.
3. Add a new picklist value, for example, Parking Updates.

Add Announcement Type to the Filter List in the Announcements Vlocity UI


Template
1. Go to the Vlocity Templates tab and find the portal-announcements-canvas template.
2. Find the reference to announcement_filter in the html:

<select ng-model="announcement_filter">
<option value selected>-- All Event Types --</option>
<option value="Services">Services</option>
<option value="Social">Social</option>
<option value="Building News">Building News</option>
</select>

© 2022 Vlocity LLC, a Salesforce


company 160
Vlocity Government

3. Add another option value before the </select>. For example:

<select ng-model="announcement_filter">
<option value selected>-- All Event Types --</option>
<option value="Services">Services</option>
<optionvalue="Social">Social</option>
<option value="Building News">Building News</option>
<option value="Parking Updates">Parking Updates</option>
</select>

Make sure that the option value matches the picklist value you added to the Event Directory Type
picklist.

Upload Icon to Static Resources


1. From Setup, click Develop, and then click Static Resources.
2. Upload your icon. Make sure visibility is set to Public.
3. Click View File and grab the URL of the static resource. You only need the part after .com, for
example:

/resource/1461893906000/vlocity_ps__cportalParkingUpdates

Add Announcement Icon to the Icons in the Announcements Vlocity UI


Template
1. Go to the Vlocity Templates tab and find the portal-announcements-canvas template
2. Find the reference to iconList in the html:

ng-init='iconList=[

{ type:"Social", iconUrl:"/customer/resource/1454578138000/
vlocity_ps__cpotalHappyHours"},

{ type:"Building News", iconUrl:"/customer/resource/


1454578138000/vlocity_ps__cportalAnnTypeBuildingAnnouncement" },

{ type:"Services", iconUrl:"/customer/resource/1454578138000/
vlocity_ps__cportalServices"}]'
3. Add your reference to the new icon. If your community has a subdomain, make sure to include it before
the URL.

ng-init='iconList=[

{ type:"Social", iconUrl:"/customer/resource/1454578138000/

© 2022 Vlocity LLC, a Salesforce


company 161
Vlocity Government

vlocity_ps__cpotalHappyHours"},

{ type:"Building News", iconUrl:"/customer/resource/1454578138000/


vlocity_ps__cportalAnnTypeBuildingAnnouncement" },

{ type:"Services", iconUrl:"/customer/resource/1454578138000/
vlocity_ps__cportalServices"},

{type:"Parking Updates", iconUrl:"/customer/resource/1461893906000/


vlocity_ps__cportalParkingUpdates"} ]

Make Similar Updates on Home Page Vlocity UI Template


If you are displaying announcements on your Home Page, make sure to add your new Announcement Type
to the Type List and Icon List in the portal-home-canvas.

Configure and Use Trailing Documents Requirements


Enrich your org's data by giving Vlocity and Community users the ability to upload documents associated
with government, insurance, and health plan objects. For example, let underwriters for property insurance
upload required survey and inspection documentation. Let customers applying for life insurance upload
required medical test results.

Objects That Support Trailing Document Requirements


Vlocity Government • Account
• Application
• Case
• Contact
• Contract
• Incident
• Program Enrollment
• Program Enrollment Member
• Program
• Service Plan
Vlocity Insurance and Vlocity Health • Application
• Asset (policy)
• Case
• Claim
• Contract
• Quote

TIP
You can extend support of trailing documents to any custom object by adding a custom
lookup field to the Trailing Documents Placeholder Object.

© 2022 Vlocity LLC, a Salesforce


company 162
Vlocity Government

You can create placeholders and categories for trailing documents for any of the supported objects. If you
don’t set up categories, another administrator can create a default category name.

Trailing documents can be any format and up to 38 MB in size.

• Customize the Trailing Documents Placeholder Object


Configure the Trailing Document Placeholder object to suit your business needs. The object has several
custom fields and you can add more based on the types of information you track.
• Configure Support of Trailing Documents for Custom Objects
Give Vlocity and Community users the ability to upload documents associated with custom objects. In
General Settings, add a custom setting corresponding to each object.
• Create a Parent-Child Hierarchy for Trailing Documents
Organize documents associated with different objects within directories. To create the directories, use a
custom formula field named UniqueField in the Trailing Document Placeholder object.
• Add Trailing Documents Requirements to Pages
To meet internal or external compliance requirements, configure an object page to require a trailing
document.
• Set Up Trailing Documents Requirements in Communities
Increase customer engagement and speed up processing with trailing documents in Communities. Let
customers and brokers upload supporting documents associated with objects such as quotes, policies,
and claims.

© 2022 Vlocity LLC, a Salesforce


company 163
Vlocity Government

Vlocity Government Data Model

The Vlocity Government data model supports a range of social assistance programs, helping agencies
and non-profit organizations to effectively deliver service to people and households. It is a comprehensive
data model covering a range of services like housing program administration, health, human services case
management, foster care administration, and program performance management.

The Vlocity Government data model is a 100% additive extension of the standard Salesforce data model
that leverages all of the relevant Salesforce objects. Each ERD page in this section illustrates the important
entities and relationships as well as the Vlocity extension to the Salesforce object model of a topic area of
the Vlocity Government data model. A reference list of all the data, system, and integration objects for the
Vlocity Government data model is provided below. To understand the notation used in these diagrams, see
About Vlocity Entity Relationship Diagram Notation.

NOTE
Vlocity provides industry-specific data models, built on top of the Salesforce object model,
for each of the industries served by Vlocity. The logical entity relationship diagrams (ERDs)
provided in this section illustrate the important entities and relationships for a given topic.
The ERDs illustrate how Vlocity extends the standard Salesforce object model to tailor it
to the needs of each industry. Vlocity will, on request, provide a physical copy of a Vlocity
Industry Data Model Blueprint to customers and partners. This industry-specific 2 x 3-feet
logical ERD diagram documents the Vlocity data model for all the key business entities
in a given industry. To receive a copy, you'll need to sign an NDA Acknowledgement. If
you would like to request an industry data model blueprint, please contact Vlocity Support
at support@vlocity.com or log a case specifying which industry diagram you desire and
where you want it sent (mailing address).

NOTICE
The content on this page may only be viewed by customers or partners of Vlocity who are
authorized users of Vlocity cloud business applications pursuant to an agreement between
Vlocity and such customer or partner, or in the absence of any such agreement, the
terms at https://vlocity.com/terms (in either case, the "Main Agreement"). Employees and
contractors of Vlocity may also view the content. The content is the highly confidential and
proprietary information of Vlocity and is protected under the confidentiality obligations of
the Main Agreement. Accordingly, the content may be used only as necessary to complete
your responsibilities related to the Agreement. Copying and further distribution is prohibited
without prior written consent from Vlocity.

© 2022 Vlocity LLC, a Salesforce


company 164
Vlocity Government

Child Welfare ERD

© 2022 Vlocity LLC, a Salesforce


company 165
Vlocity Government

Program Enrollment ERD

Vlocity Government Object List


Government Object List

NOTE
This spreadsheet opens in a new tab and might take a few seconds to load.

© 2022 Vlocity LLC, a Salesforce


company 166
Vlocity Government

Vlocity Government Cards Reference

Quickly deploy common Government processes with the following prebuilt Vlocity Government Cards.

Cards Purpose Documentation


Program Enrollment Enables caseworkers and case managers to view Program Enrollment details Program Enrollment Card
and perform related actions.
Referral Enables caseworkers and case managers to view Referral details and perform Referral Card
related actions.

© 2022 Vlocity LLC, a Salesforce


company 167
Vlocity Government

Vlocity Government APIs

The Vlocity Government APIs have been defined for community users to view housing listings and express
interest in them. The API provides a layer of abstraction between the web application and the Salesforce
data model. Clients using the Housing application have the ability to view the details of a housing unit. They
can act on those units by expressing interest but are agnostic to the underlying data model.

The Vlocity Government APIs include the following:

Express Interest
The Express Interest feature enables an applicant to indicate that he or she is interested in the available
housing units and to rescind that interest later.

GET /v1/interest/?objId={ID}&objType=InventoryItem__c&type=ExpressInterest

Express Interest creates a ProgramEnrollmentItemRequest__c type record. This record represents


the applicant’s future interactions for the given housing unit. The record is populated with the applicant’s ID,
unit ID, stage as Request, and status as Open Request.

Package
Government (vlocity_ps)

Parameters
Parameter Description Optional Example
ID Inventory item ID to be used as context ID Required objId=a1e28000000DOizAAG

Resource Information
Response JSON
Format
Resource URL /services/apexrest/vlocity_ps/v1/interest/?
objId=a1e28000000DOizAAAG&objType=InventoryItem__c&type=ExpressInterest

Example request
GET
/services/apexrest/vlocity_ps/v1/interest/?
objId=a1e28000000DOizAAG&objType=InventoryItem__c&type=ExpressInterest

[empty]

Example Result
{
"success": true,

© 2022 Vlocity LLC, a Salesforce


company 168
Vlocity Government

"message": “You have expressed interest in 1 unit(s). You can only express
interest in 6 units.”
}

Inventory Item
The Inventory Item API fetches the inventory records and the user’s eligibility for the inventory according to
the filter criteria.

GET /v1/inventory/?reqBy={requester}&limit={limit}&offset={offset}

There can be two types of requestors depending on the type of the community. A requestor can be a citizen
or a provider for the citizen community and provider community. The limit and offset parameters limit
the number of inventory records fetched.

Package
Government (vlocity_ps)

Parameters
Parameter Description Optional Example
reqBy Provides the requestor type Required reqBy=citizen
limit Limit for the number of records. The default is 100. Optional limit=1
offset Offset for the next request. The default offset value is 0. Optional offset=1

Resource Information
Response Format JSON
Resource URL /services/apexrest/vlocity_ps/v1/inventory/?reqBy=citizen&limit=1&offset=1

Example Request
GET
/services/apexrest/vlocity_ps/v1/inventory/?reqBy=citizen&limit=1&offset=1

Example Response
{
"success": true,
"message": null,
"data": {
"searchLabel": "Search",
"resultsLabel": "Results",
"noUnitMatchFilterMsg": "There are currently no units that match your
filter criteria.",
"noUnitMatchElgblMsg": "There are currently no units that match your

© 2022 Vlocity LLC, a Salesforce


company 169
Vlocity Government

eligibility criteria.",
"noUnitAvailableMsg": "There are currently no available unit.",
"noBldgSelectionMadeMsg": "You have not made any building selections.
[Edit your Building Preferences] >> Add link to launch Omniscript",
"inventoryType": null,
"inventoryInfo": [{
"vTour": null,
"unitType": null,
"unitAdd": {
"zipcode": "70064",
"street": "St Maverick",
"stIntersection": "21",
"state": "ON",
"region": null,
"lng": null,
"lat": null,
"houseNo": "123",
"floorNo": "3",
"city": "NY"
},
"tenantType": "Senior",
"status": "Available",
"stairsReq": null,
"sqftLabel": "sqft",
"shownInt": 0,
"rent": 3000,
"publishStart": "2016-01-04",
"publishEnd": "2016-10-06",
"photosLabel": "Photos",
"ownerId": "00528000001T0kKAAS",
"name": "Perl 3",
"monthLabel": "month",
"marketRentLabel": "Market Rent",
"isPublished": true,
"inventoryType": null,
"inventoryItem": {
"attributes": {
"type": "<namespace>__InventoryItem__c",
"url": "/services/data/v35.0/sobjects/
<namespace>__InventoryItem__c/a1e28000000DOj9AAG"
},
"Id": "a1e28000000DOj9AAG",
"OwnerId": "00528000001T0kKAAS",
"IsDeleted": false,
"Name": "Perl 3",
"CreatedDate": "2015-10-30T05:51:54.000+0000",

© 2022 Vlocity LLC, a Salesforce


company 170
Vlocity Government

"CreatedById": "00528000001T0kKAAS",
"LastModifiedDate": "2016-01-05T07:36:04.000+0000",
"LastModifiedById": "00528000001T0kKAAS",
"SystemModstamp": "2016-01-05T07:36:04.000+0000",
"LastViewedDate": "2016-01-05T07:36:05.000+0000",
"LastReferencedDate": "2016-01-05T07:36:05.000+0000",
"<namespace>__AccessibilityFeatures__c": "Roll-In Shower",
"<namespace>__City__c": "NY",
"<namespace>__Cooling__c": "Central",
"<namespace>__ElevatorOrWalkup__c": "First Floor",
"<namespace>__Floor__c": "3",
"<namespace>__Furnished__c": false,
"<namespace>__ParkingIncluded__c": false,
"<namespace>__PostalCode__c": "70064",
"<namespace>__PremisesId__c": "a1I28000000ooNnEAI",
"<namespace>__PublishEnd__c": "2016-10-06",
"<namespace>__PublishStart__c": "2016-01-04",
"<namespace>__RentAmount__c": 3000,
"<namespace>__SquareFeet__c": 3000,
"<namespace>__State__c": "ON",
"<namespace>__Status__c": "Available",
"<namespace>__StreetAddress__c": "St Maverick",
"<namespace>__StreetIntersection__c": "21",
"<namespace>__TotalRooms__c": 3,
"<namespace>__UnitNumber__c": "123",
"<namespace>__HasBalcony__c": false,
"<namespace>__IsAccessible__c": false,
"<namespace>__IsFurnished__c": false,
"<namespace>__Laundry__c": "In Unit",
"<namespace>__NumberOfBathrooms__c": 3,
"<namespace>__NumberOfBedrooms__c": 3,
"<namespace>__PremisesId__r": {
"attributes": {
"type": "<namespace>__Premises__c",
"url": "/services/data/v35.0/sobjects/<namespace>__Premises__c/
a1I28000000ooNnEAI"
},
"Id": "a1I28000000ooNnEAI",
"OwnerId": "00528000001T0kKAAS",
"IsDeleted": false,
"Name": "Black Pearl",
"CreatedDate": "2015-10-29T10:08:34.000+0000",
"CreatedById": "00528000001T0kKAAS",
"LastModifiedDate": "2015-11-24T10:45:06.000+0000",
"LastModifiedById": "00528000001T0kKAAS",
"SystemModstamp": "2015-12-05T13:43:48.000+0000",

© 2022 Vlocity LLC, a Salesforce


company 171
Vlocity Government

"LastViewedDate": "2015-11-24T10:45:06.000+0000",
"LastReferencedDate": "2015-11-24T10:45:06.000+0000",
"<namespace>__AutoNumber__c": "1",
"<namespace>__City__c": "NY",
"<namespace>__Geolocation__c": null,
"<namespace>__PostalCode__c": "70064",
"<namespace>__PremisesType__c": "Condominium",
"<namespace>__State__c": "ON",
"<namespace>__Status__c": "Available",
"<namespace>__StreetAddress__c": "St Maverick",
"<namespace>__BedroomsAvailable__c": "2",
"<namespace>__Cooling__c": "Central",
"<namespace>__Elevator__c": true,
"<namespace>__Heating__c": "Gas",
"<namespace>__HousingType__c": "Non-Profit",
"<namespace>__Laundry__c": "In Unit",
"<namespace>__ParkingIncluded__c": true,
"<namespace>__PetsAllowed__c": false,
"<namespace>__Region__c": "Region 1",
"<namespace>__ResidentType__c": "Senior",
"<namespace>__StreetIntersection__c": "21",
"<namespace>__Units__c": 10,
"<namespace>__UtilitiesIncluded__c": "Included",
"<namespace>__BalconyIsAvailable__c": false,
"<namespace>__HasAccessibleUnits__c": false,
"<namespace>__HasElevator__c": false,
"<namespace>__IsActive__c": false,
"<namespace>__IsParkingIncluded__c": false
}
},
"interestLabel": "You've expressed interest",
"interested": false,
"ineligibilityMsg": "You are not eligible for this unit.",
"images": [],
"id": "a1e28000000DOj9AAG",
"housingType": "Non-Profit",
"expressInterestBtn": "Express Interest",
"eligible": false,
"description": null,
"contactAdminMsg": "Please contact system administrator.",
"clearInterestBtn": "Clear Interest",
"bldgType": "Condominium",
"bldgName": "Black Pearl",
"bldgId": "a1I28000000ooNnEAI",
"bldgAdd": {
"zipcode": "70064",

© 2022 Vlocity LLC, a Salesforce


company 172
Vlocity Government

"street": "St Maverick",


"stIntersection": null,
"state": "ON",
"region": "Region 1",
"lng": null,
"lat": null,
"houseNo": null,
"floorNo": null,
"city": "NY"
},
"bedrooms": 3,
"bathrooms": 3,
"attributes": {
"type": "<namespace>__InventoryItem__c"
},
"area": 3000,
"ammenities": [],
"accessibilty": "Roll-In Shower"
}],
"inventoryCount": 6,
"interestCountLimit": 2,
"interestCount": 0,
"filterInfo": [{
"options": [{
"value": "1",
"selected": false,
"premiseType": null,
"name": "1 Room",
"groupBy": null
}],
"name": "Rooms",
"groupBy": null,
"filterType": "multi-select",
"field": "bedrooms"
},{
"options": [{
"value": "This option is very long to be displayed in the menu",
"selected": false,
"premiseType": null,
"name": "This option is very long to be displayed in the menu",
"groupBy": null
}],
"name": "Social Housing Type",
"groupBy": null,
"filterType": "On-Off",
"field": "unitType"

© 2022 Vlocity LLC, a Salesforce


company 173
Vlocity Government

}],
"entityFilterInventory": false,
"entityFilter": false,
"emptyBidsMsg": "You have not yet expressed interest in any unit.",
"editBuildingPrefsLabel": "Edit Building Preferences",
"bldgPref": {
"options": [],
"name": null,
"groupBy": true,
"filterType": null,
"field": null
}
}

© 2022 Vlocity LLC, a Salesforce


company 174

You might also like