You are here:
Configure Object-Based Widget Properties for the Interaction Launcher
Create one or more search widgets to add to an Interaction Launcher component to enable an agent to launch a search that starts a customer interaction. Configure an object-based widget for your Interaction launcher to retrieve a search request and search response from specified fields of an sObject, such as Account.
Create the Interaction Launcher. See Create a Vlocity Interaction Launcher.
- Select Object Based as Record Type.
-
In the Type dropdown field, select the layout for the
search results:
-
Related Party: To display a three-column layout where Party Name is listed in the first column, Source Role is listed in the second column and action buttons, such as Verify, are listed in the third column, select this option.

-
Caller Identification: To display a two-column layout where search results fields are listed in the first column and action buttons, such as Verify, are listed in the second column, select this option.

-
- In the Search Object Name field, enter the name of the object to search. For example, Asset, Contact, or %NS%__PolicyPartyRelationship__c, where %NS% is dynamically replaced with your Vlocity namespace prefix.
- In the Search Field, enter the data fields necessary to perform the search. Separate multiple entries by a comma. Make sure there are no spaces between the entries. For example, FirstName,LastName,%NS%__ProducerNumber__c.
-
In the Results Fields, enter the fields to display in the search result. Separate
multiple entries by a comma. Make sure there are no spaces between the entries.
Note
The search results page paginates when more than ten results are returned.
- In the Result Verification Fields, enter the fields to verify before the interaction continues. Separate multiple entries by a comma. Make sure there are no spaces between the entries.
-
To filter out duplicate entries, in the Result Unique
Field, enter the name of the object to use as a filter.
For example, a search for an asset party relationship based on a party name might return duplicates because the same party has many relationships to the same policy with different roles. However, entering Asset.AccountId in the Result Unique Field returns search results with distinct policy holder IDs.
- If this search widget is a secondary search, enter the Previous Search Context Id Field of the previous search widget, such as %NS%_AccountId.
- To return hidden fields queried from the search object, enter field names in the Additional Result Fields input field. Use these hidden search fields to pass information down to the interaction object. Separate multiple entries by a comma. Make sure there are no spaces between the entries.
- To filter search results, in the Filter input field, enter a formula where a field is checked against a value by an operator. For example, %NS%__Role__c!='Carrier'.
-
To launch role-based actions, enter the name of an object in the
Reference Object Name field.
For example, enter Asset for a Policy search. If the policy is not related to any party, a set of role-based actions display. The reference object gets a list of role-based actions and passes the policy Id to the actions.
-
Enter additional verification fields in the Optional Verification
Fields input field. Separate multiple entries by a comma. Make sure
there are no spaces between the entries. This property works with the Min
# of Optional Verification Fields property.
For example, if there are two optional verification fields such as Name,Email, and the minimum number of optional verification fields is 1, then the customer interaction agent needs to verify Name or Email, not both.
- (Optional) To update the layout of the Interaction Launcher component, see Update the Layout of an Interaction Launcher.
To add your Interaction Launcher to a Console app, see Add the Vlocity Interaction Launcher to a Console App.

