InteractionWrapper Lightning Web Component ReadMe (Managed Package)

For the managed package runtime, this page contains the InteractionWrapper LWC ReadMe for each Vlocity release.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Vlocity Insurance and Health Summer '20

The InteractionWrapper Lightning Web Component is a wrapper component for the customer interaction and power launcher. Use inside a record page to see all the interactions for that customer and trigger any related actions. The InteractionWrapper LWC supports custom labels.

Available c-interaction-wrapper Attributes

Attribute	Value	Type	Required	Description
recordId		string		Automatically fetches from record page
theme	slds, nds (Default: slds)	string		Sets the theme to use. NDS theme not implemented yet

Available c-interaction-wrapper Design Time Attributes

Attribute	Value	Type	Required	Description
Create Interaction	true, false (Default:false)	Boolean		When set to true uses the configured Create Interaction Integration Procedure and create interaction object
Create Interaction IP		string	yes	If Create Interaction is set to true, this field if required to configure the Integration Procedure to create the interaction
Create Topic IP		string		Cretaes interaction topic when triggerd. Triggering mechanism explained below.

Create Interaction IP

When Create Interaction flag is set to true, on page load, the wrapper automatically calls the IP configured on the Create Interaction IP with the input data below.

{
  recordId: this.recordId, //recordId of the sObject
  verificationdate: Date.now(),
  verifiedby: username //logged in username
}

Pubsub Listener

When the Create Interaction flag is set to true, on page load, the wrapper automatically creates a unique channel addInteractionTopic:<recordId> with eventName trackInteraction which other components on the page can trigger this event to track the interaction and create interaction topic.

Example on How to Trigger trackInteraction

This can be configured using the Action Component on Flex Card Designer

pubsub.fire('addInteractionTopic:<recordId>', 'trackInteraction', {
  name : "", // Name of the sObject
  label: "", //label of the field
  value: "", //value of the field
  contextId : "" //Id of the sObject
});

Create Topic IP

When Create Interaction flag is set to true, on page load the wrapper automatically adds a pubsub listener and when we trigger if Create Topic IP is pointer to an Integration Procedure. It gets called with input data below.

OOTB Integration Procedure: Interaction_handleInteractionFieldClick

Default required fields. All the fields sent through the Pubsub Event are passed to the Create Topic IP.

Create Interaction IP depends on the Create Interaction Flag and also Create Topic IP depends on both Create Interaction Flag and the pubsub listener.

{
  accountId: this.recordId, //recordId of the page, mostly account
  name: data.name, //Name that was send through the pubsub event
  contextId: data.contextId, //Id that was send through the pubsub event
  interactionId: this.interactionId // The created interaction Id
}

Available Custom Labels

Label	ApiName	Description
Call	cmpCall	Assistive text for the call icon.
Refresh	cmpRefresh	Assistive text for the refresh icon visible after clicking the call icon.
Viewed	cmpViewed	Assistive text for icons in the `Tasks Performed` list.
Viewed as	cmpViewedAs	Label for tasks viewed in the `Tasks Performed` list.
Tasks Performed	cmpTasksPerf	Label for the lists of tasks performed.
Action	cmpAction	Label for action type tasks in the `Tasks Performed` list.
Cancel	Cancel	Label for button to cancel interaction.
Summary (Optional)	cmpSummary	Label for the interaction summary textarea field.
Submit & End Call	SubmitAndEndCall	Label for the interaction submit button.
Resume Interaction	ResumeInteraction	Label for the interaction resume button.

Vlocity Insurance and Health Spring '20

The InteractionWrapper Lightning Web Component is a wrapper component for the customer interaction and power launcher. Use inside a customer interaction record page to see all the interactions for that customer and trigger any related actions. The InteractionWrapper LWC supports custom labels.

Available c-interaction-wrapper Attributes

Attribute	Value	Type	Required	Description
recordId		string	yes	Specifes the Id of the record.
theme	slds, nds (Default: slds)	string		Sets the theme to use.

Example c-interaction-wrapper Component

<c-interaction-wrapper
  record-id="001f400000Odl3cAAB"
  theme="slds"
>
</c-interaction-wrapper>

Available Custom Labels

Label	ApiName	Description
Call	cmpCall	Assistive text for the call icon.
Refresh	cmpRefresh	Assistive text for the refresh icon visible after clicking the call icon.
Viewed	cmpViewed	Assistive text for icons in the `Tasks Performed` list.
Viewed as	cmpViewedAs	Label for tasks viewed in the `Tasks Performed` list.
Tasks Performed	cmpTasksPerf	Label for the lists of tasks performed.
Action	cmpAction	Label for action type tasks in the `Tasks Performed` list.
Cancel	Cancel	Label for button to cancel interaction.
Summary (Optional)	cmpSummary	Label for the interaction summary textarea field.

Vlocity Insurance and Health Winter '20 and Vlocity CME Spring '20

The InteractionWrapper Lightning Web Component is a wrapper component for a customer interaction and the Power Launcher. The component is used inside a customer interaction records page to see all interactions with a customer and perform any actions related to the interaction.

Available c-interaction-wrapper Attributes

Attribute	Value	Type	Required	Description
recordId		number	yes	Sets the ID of the record.
theme	slds, nds (Default: slds)	string		Sets the theme for the layout of the component.

Example c-interaction-wrapper Component

<c-interaction-wrapper
  recordId=1
  theme="slds"
>
</c-interaction-wrapper>