For the managed package runtime, Action element properties are configurable from the Properties panel in the Flexcard Designer when you select an Action element. With the Action element, create an action to launch an Omniscript, navigate to a web page or application, display a flyout, fire an event, and more.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
The Action element supports concatenated strings. Combine plain text and supported merge fields, such as {Parent.prodType} > {Name}, in these fields:
-
Action > Label
-
Card Action > Set Values > Value
-
Event Action > Input Parameters > Value
Common Action Type Properties
These properties are shared by all Action Types.
|
Property |
Description |
Reference |
|---|---|---|
|
Action Label |
Enter a name to distinguish the action from other actions in a sequence. Visible within the Flexcard designer only |
n/a |
|
Action Type |
Select the type of action to execute. |
|
|
Block Interactions While Waiting |
Block users from interacting with the Flexcard until actions that require waiting for a response, such as a Data action, are resolved. |
n/a |
|
Conditions |
Add a condition that must be met for the element to display. |
|
|
Display As Button |
Check to display the action as a button. |
n/a |
|
Element Name |
The name of the element as seen on the canvas. Used to distinguish one element from another as you build your Flexcard in the designer. Is used only within the designer. |
|
|
Enable Tracking |
Enable click-based event tracking through OmniAnalytics. Track the UI Action event. |
|
|
Hide Icon |
Check to hide the icon and only show the label. |
n/a |
|
Icon |
Enter the name of the icon, such as utility:down, or click into the field to search for an icon. |
n/a |
|
Label |
Enter a visible label for the element. |
n/a |
|
Show Only Icon |
Select to show an icon without a label. |
n/a |
|
Variant |
Select from predefined SLDS styles to change the appearance of the element. |
n/a |
Card Action
These properties are unique to the Card Action.
|
Property |
Description |
|---|---|
|
Selectable Field |
Select a data field with a boolean (true or false) value, that when true, preselects the card record. |
|
Selectable Mode |
Select whether a user can select a Single record or Multiple records. |
|
Selected Cards List Name |
Enter the name of the array to add or remove selected cards from. |
|
Type |
Select the type of action to launch. |
Card Action Types
This table lists descriptions for the available Card Action Types.
|
Type |
Description |
|---|---|
|
Reload |
Reloads the Flexcard. |
|
Remove |
Removes a card from the Flexcard component. For example, use for notifications and alerts. |
|
Select Cards |
Enables users to update an Omniscript from a list of selectable items on a Flexcard. When the user clicks a Select Cards action, it fires the selectcards_ event and the selected card is added or removed from an array. |
|
Set Values |
Updates field values. |
|
Update Data Source |
Changes the data source, or updates parameters of an existing data source. |
Data Action
Call a data source from an action with the Data action type. See Call a Data Source from an Action on a Flexcard (Managed Package).
These properties are unique to the Data Action. For properties specific to the selected Data Source Type, see Flexcards Data Source Reference (Managed Package).
|
Property |
Description |
|---|---|
|
Ignore Response |
Enable when you don't need a response from the server, such as in a simple notification. |
|
Response Node |
Specify where in the data JSON you want to save the returned data. |
Event Action
These properties are unique to the Event Action. See Trigger a Custom Event from an Action on a Flexcard (Managed Package). See Trigger a Pubsub Event from an Action on a Flexcard (Managed Package).
|
Property |
Description |
|---|---|
|
Bubbles |
Check to enable the event to bubble up through the DOM. |
|
Channel Name |
Enter a channel name for the pubsub event. |
|
Composed |
Check to enable the event to pass through the shadow boundary. |
|
Event Name |
Enter the name of the custom event. |
|
Event Type |
Select an event type. |
|
Input Parameters |
Enter parameters to pass contextual data to the event as key/value pairs. |
Flyout Action
These properties are unique to the Flyout Action. See Launch a Flyout from an Action on a Flexcard (Managed Package).
|
Property |
Description |
|---|---|
|
Attributes |
Set attributes available from the flyout's component. For example, if an Omniscript requires a ContextId be set, enter ContextId as Key and {recordId} as Value. |
|
Data Node |
To pass parent data to the Child Flexcard, select a data node. |
|
Flyout Type |
Select the type of component to display. |
|
Flyout |
Select the component to display in the flyout. |
|
Layout Type |
Select a theme for the flyout. |
|
Open Flyout In |
Select the flyout's container type. When enabling a flyout as a clickable event on an element such as a Block or Menu element, this feature defaults to modal. In this case, the feature is disabled because popover positioning can't be controlled. |
|
Preload Flyout Component |
Enable the Flyout component to load before it's clicked. Preloading a flyout with an embedded component can cause visual anomalies, such as incorrect sizing of embedded components in the modal. Sizing problems can occur because the modal isn't visible yet. If you experience such problems, disable this property. |
|
Reset Component On Close |
Resets the component to its on-load state when the flyout closes. |
Omniscript Action
These properties are unique to the Omniscript Action. See Launch an Omniscript from a Flexcard (Managed Package).
|
Property |
Description |
|---|---|
|
Input Parameters |
Enter parameters to pass contextual data to the action as key/value pairs. |
|
Context ID |
Select a data field to use as the ContextId, such as {'AccountId'}. |
|
Layout Type |
Select a theme for the layout. |
|
Omniscript |
Select the Omniscript to launch. |
|
Open Target In |
Select whether to open the target page in the current window or in a new tab or window. |
|
Visualforce Page |
Override the default Visualforce Page that displays the Omniscript. |
Update Omniscript Action
These properties are unique to the Update Omniscript Action. See Update an Omniscript from a Flexcard (Managed Package).
|
Property |
Description |
|---|---|
|
Input Parameters |
Enter the Omniscript data fields to update. |
|
Parent Node |
Point to a specific data node in the Omniscript JSON to update. Select from the merge fields available from the data source or enter a data node manually. |
Vlocity Action
These properties are unique to the Vlocity Action. See Add a Vlocity Action to a Flexcard (Managed Package).
|
Property |
Description |
|---|---|
|
Context ID |
Select a data field to use as the ContextId, such as {'AccountId'}. |
|
Fetch Action Name From Datasource |
Select the action name from a data source field. |
|
Input Parameters |
Enter parameters to pass contextual data to the action as key/value pairs. |
|
Object |
Select the sObject. |
|
Open Target In |
(Disabled by default) Opens the target in the current window or in a new tab or window. |