You are here:
Customer Story Configuration (Managed Package)
For the managed package runtime, the following tables describe the settings you can configure for customer story objects.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Field |
Description |
Sample Values |
|---|---|---|
Name |
A unique name for the configuration. We recommend ParentObject_StoryObject. |
|
To import standard customer story configuration settings from Static Resources in your org, see Import Customer Story Configuration Settings (Managed Package).
Parent Object
Field |
Description |
Sample Values |
|---|---|---|
Parent Object Name |
The Object on which the Customer Story will be displayed. This is the object where you’ll add the Customer Story component to the page layout. |
|
Parent Object Field |
Default is Id. Enter a different Id field from the Parent Object if you want to query story objects using something other than Id. |
AccountId |
Story Object
Field |
Description |
Sample Values |
|---|---|---|
Story Object Name |
The Object that will be displayed as an item within the Customer Story. |
|
Story Object Filter |
The Story Object Filter is an optional filter. For example, you can filter events on the story object so that no child events appear on the story. |
isChild=false |
Story Object Lookup Field |
The foreign key within the Story Object that points to the Parent Object. If a Junction Object exists, this is the foreign key in Junction Object pointing to the Parent Object. |
|
Story Object Sort Field (required) |
The field in the Story Object that determines where to place the item on the chronological timeline. Must be a Date or DateTime field. |
|
Sort Field Is Date |
By default, we assume the Story Object Sort field is DateTime. If the field is not DateTime, check this box to indicate it’s a Date field. |
|
Story Object Reference Id |
Only used for Order. |
|
Has Owner |
If the Story Object has a record owner and you would like it displayed on the card, check “Has Owner”. |
|
Reference Object
Field |
Description |
Sample Values |
|---|---|---|
Reference Object Name |
If the required story is not the object specified in Story Object Name, specify the required story object in this field. Use the Reference Object Id to link this object and the object in Story Object Name. For example, if the story object name is CampaignMember, but you want to return Campaigns, use Campaign for the Reference Object Name and CampaignId for the Reference Object Id. |
Campaign |
Reference Object Id |
The object Id in story object pointing to reference object |
CampaignId |
Junction Object
Field |
Description |
Sample Values |
|---|---|---|
Junction Object |
The relationship between the parent object and story object is many to many through the junction object. A nested query is formed using the Junction Object. |
EventRelation |
Junction Lookup Field |
The foreign key in the Junction Object pointing to the story object. |
EventId |
Junction Object Filter |
The Junction Object Filter is an optional filter. For example, you can filter events on the story object so that only events where a contact did not decline appear on the story. |
Status!='Declined' |
Card Details
Field |
Description |
Sample Values |
|---|---|---|
Summary Fields |
The fields on the Story object to display on the card, separated by commas. Title: Title_Highlight: Subtitle: |
Title:Subject,TitleHighlight:Type,Subtitle:Status |
Detail Fields |
The field displayed at the bottom of the card, under the title and subtitles. Can accommodate long text fields. |
Description Body |
Navigation Field Name |
Contains a URL. If this field is not null, clicking on the story card launches the URL. |
ResumeLink__c |
Icon (mobile only)
Field |
Description |
Sample Values |
|---|---|---|
Indicators |
The formula field for the Story Object to determine which icon is displayed on the card. By default, Vlocity uses the same icons for the following Story objects:
When you use one of the following Story Objects, you should specify a formula to indicate which icon to use - as the Objects have different icons for different statuses.
|
Status:StatusImageName__c,Priority:PriorityImageName__c |
