Professional Documents
Culture Documents
Vlo City Government Legacy
Vlo City Government Legacy
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
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
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.
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
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:
Package Index
Vlocity Government Package Links
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.
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.
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.
The terminology change does not affect how your products work. Nothing at the data level, such as
DataPacks or objects, has changed.
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.
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
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
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
How: When Date is selected for Field Type, check the Use Absolute Date checkbox.
What's Next
Add a Field to a FlexCard
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
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
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
Classic Cards
Limit user access to Classic Cards (Vlocity Cards) and Apex classes.
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
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
OmniScripts
Run OmniScripts through Adobe Experience Manager, and enable users to restart an OmniScript.
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.
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
See Also
• Navigate Action
• Navigate Action Properties
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
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.
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).
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.
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.
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
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
Relationship Graphs
Refresh Relationship Graphs programmatically, use additional filter operators, and include one-to-many
relationships in Timeline graphs.
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
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
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.
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
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.
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.
• 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.
• You can use the PDF generation option called VlocityClientSide for Web templates. For details about
PDF generation, see Understanding PDF Conversion in CLM.
• 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.
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.
• 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.
• 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.
New Properties
New LWC OmniScript properties appear in the LWC OmniScript Designer only. See LWC OmniScript
Designer Changes and Enhancements.
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.
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.
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.
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.
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.
• 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.
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
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.
Deleted Resources
• ps_assets
• angular
• BootstrapCSS
• JQuery_1_5_1
• jquery_2_2_4
• JQUERY211
• JQUERYJS
• tinymceIce
• vstrap14
• textangular
• AngularSanitizeJS
• vkBeautify
• external
• 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:
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.
• 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.
• 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 ???.
• 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.
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.
• 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.
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.
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.
New Functionalities
These new functionalities are exclusive to LWC OmniScripts:
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.
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.
• 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.
• 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.
• 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.
• 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.
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.
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.
• 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.
• 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
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
• You can filter nodes based on field values in the configuration or the published graph. See Use the
Relationship Graph Admin Config Tool.
• 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.
Vlocity Cards and Vlocity OmniScript both support 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.
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.
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.
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.
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.
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.
• 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.
• 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.
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.
• Billing detail page link has been removed from the Account Object.
• A Stored XSS security issue related to the DocumentPdf component has been fixed.
• Content that was not displayed due to a too-long custom setting name is now correctly displayed.
• The HousingCards VisualForce page now loads correctly.
• 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.
• 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.
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.
• 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.
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.
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.
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.
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.
To create more visually appealing radio buttons, you can now use images in place of text for the selectable
options!
Figure 1. Example: Woodgreen uses images for selectable options instead of text.
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.
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.
With DataRaptor Workbench, administrators can easily test their DataRaptor mappings without using
external tools.
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.
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:
For more information about Vlocity Government Spring '17, see our webinar, Introducing Vlocity
Government Spring '17.
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.
• 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.
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.
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.
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.
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.
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.
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.
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
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.
• Query Builder tables and Housing Portal templates have been enhanced to match Salesforce Lightning
Design System look and feel.
• 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.
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.
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.
• Waitlists
For more information, see Waitlist Overview.
• Tenant self-service actions
For more information, see Tenant Self-Service Actions Overview.
Known Issues
None.
IMPORTANT
If you purchased Public Sector Solutions, see Salesforce Public Sector Solutions
Administration Guide.
Vlocity provides a standard profile called Vlocity Basic Access that provides the following:
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.
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.
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.
• 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.
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.
NOTE
To install in a sandbox rather than a production org, alter the download URL by
changing "login" to "test". For example:
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.
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.
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.
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
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.
IMPORTANT
If you purchased Public Sector Solutions, see Salesforce Public Sector Solutions
Administration Guide.
The following table lists the values to add. See Adding Picklist Values for the steps.
Neglect
Incident Status Sent for Approval
Rejected
Returned
New
Approved-Closed
Rejected-Closed
Incident Category Family 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
Home Visit
Out-of-Home
Foster Care
Permanency
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.
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.
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.
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.
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.
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.
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.
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:
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.
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.
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:
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.
NOTE
Define all rule properties before generating a validator class interface.
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. 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.
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.
5. Click Save.
Any errors in the validation method will be displayed in a pop-up window.
The generated class contains the rule property and the validation method.
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.
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.
1. On the Screening Rule Group record detail page, in the Screening Class field, enter the screening
class name.
2. Click Generate Screening Class.
7. Screen the application using the SSN validator. The results return true or false.
or
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.
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.
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.
1. From Setup, click Customize, and then click Tab Names and Labels, and then click Rename Tabs
and Labels.
6. Scroll through the renamed fields to make additional corrections, then click Save.
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.
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:
Type
• Benefit Case
• Activity Template
• State Transition
• Application
• Application Template
• Screening Rule Group
Stage
• Benefit Case
• Activity Template
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.
NOTE
The Order field is alphanumeric. Vlocity recommends numbering questions using the
format Q001, Q002, Q003...Q999.
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
Single Select Give case workers a list of answers and they select one. Can be dropdown or radio
button.
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.
• 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
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.
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.
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.
From the Activity Template page, double-click Publish then select Save.
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.
TIP
To configure how clients are matched with service providers, run the
ServiceProviderMatchingCriteria OmniScript.
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.
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.
1. From a Service provider record, double-click the Active field and click Yes.
2. Click Save.
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.
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:
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.
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.
• 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).
• 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:
Update the parameter values in the code according to the use case.
longlistnosort=true
longlistnosort=false
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.
• 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.
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.
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.
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.
or Incident:
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.
Case Management
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.
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.
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:
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.
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.
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.
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
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
Actions
Fields
• Enrollment Name
• Program Name
• Status
• Stage
• Enrollment Eligibility
States
Actions
Fields
• Enrollment Name
• Program Name
• Status
• Stage
• Enrollment Eligibility
States
Actions
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.
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.
To configure parties:
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.
• Nickname
• Payment Method Type
• 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
• 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
• Statement Name
• Client Account
• Due Date
• Current Balance
• Details
• Statement Period Start Date
• Statement Date
• Statement Period End Date
• Program
• 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.
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
Actions
• Request Update
• Duplicate Referral
• Reopen (visible if Status = Closed)
Housing program administration includes management of the buildings and the resident benefits.
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.
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.
An administrator can change the Status value that publishes a unit to a listing.
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.
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.
• 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.
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.
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.
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.
• 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:
There are a few key differences when setting up a Program Enrollment Entity Filter:
• For a client to express interest in a unit, Stage must equal Unit Ready
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:
The following additional statuses are available by default for PEIRs in the Request stage:
• 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.
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.
You can use Salesforce Communities to create a provider or client portal for self-service actions.
• Grid
• Housing-Flyout
To use the default cards, import the layouts using the Vlocity Cards Designer.
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.
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.
• 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.
Update the housing listing header template with the URL to the new header image.
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. 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.
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.
1. Add a remote action to the end of the application (OmniScript), in place of a Submit action.
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:
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
• 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.
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.
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.
1. Import the ChatterMessageOmni Omniscript. Go to the VlocityOmniScript tab and click Import
Omniscript .
2. Update Remote Actions:
• Remote Class = ScheduleAppointmentService
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.
<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>
<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.
/resource/1461893906000/vlocity_ps__cportalParkingUpdates
ng-init='iconList=[
{ type:"Social", iconUrl:"/customer/resource/1454578138000/
vlocity_ps__cpotalHappyHours"},
{ 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/
vlocity_ps__cpotalHappyHours"},
{ type:"Services", iconUrl:"/customer/resource/1454578138000/
vlocity_ps__cportalServices"},
TIP
You can extend support of trailing documents to any custom object by adding a custom
lookup field to the Trailing Documents Placeholder Object.
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.
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.
NOTE
This spreadsheet opens in a new tab and might take a few seconds to load.
Quickly deploy common Government processes with the following prebuilt Vlocity Government Cards.
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.
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
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,
"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
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",
"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",
"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",
}],
"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
}
}