Salesforce Docs Portal

Configuring Data Sources for Cards Components (Managed Package)

For the managed package runtime, configure a data source on a card, layout, or flyout to retrieve data from a Salesforce object or an external database. Display the returned data on cards in a layout or flyout.

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

Cards can have data sources independent of the layout or flyout data source. Administrators can enable or disable data sources for an org, profile, and user level.

image

Data Source Types

Data sources available for card, layouts, and flyouts include:

Data Source Type

Description

Availability

Integration Procedures

Uses an Integration Procedure to return data. Integration Procedures are declarative, server-side processes that execute multiple actions in a single server call.

Using an Integration Procedure as a data source is recommended for optimal flexibility and easier implementation.

Cards and Layouts

Apex Remote

Uses an Apex Remote class and method to return data. An Apex Remote class is a standard Apex class that implements the VlocityOpenInterface.

Cards and Layouts

Apex REST

Uses a REST endpoint of an Apex class to return data from a server or post data to a server.

Cards and Layouts

Data Mapper

Uses an Omnistudio Data Mapper Extract interface to return data. Field-level security is fully supported.

Cards and Layouts

Dual

Combines Apex Remote and Apex REST technologies to support hybrid applications available for both web and mobile usage. For example, the Salesforce web environment uses Apex Remote technology while its parallel mobile App uses the Apex REST API, requiring configuration for multiple environments.

Cards and Layouts

Parent

On the card or card layout of a flyout, the Parent data source uses data from the parent card or card layout that a flyout is assigned.

Flyouts

REST

Uses the standard REST API call to return data. The Vlocity Rest types include:

  • Web : Standard request from the URL of a callout endpoint.

  • Named Credentials: Specifies the URL of a callout endpoint and its required authentication parameters in one definition.

Note
Note

Use +Add Header Variables to add any request headers. Most third-party APIs expect various headers such as tokens, public keys, and content-type.

Cards and Layouts

SOQL Query

Uses a Salesforce Object Query Language (SOQL) to search an org's Salesforce data for specific information. For example, SELECT Name, Id FROM Account LIMIT 5.

Note
Note

If security is a concern, use a Data Mapper instead of a SOQL query, because Data Mappers fully support field-level security.

Cards and Layouts

SOSL Query

Uses a Salesforce Object Search Language (SOSL) to construct text-based search queries against the search index.

Cards and Layouts

Sample

Uses sample JSON to set up a card with a temporary data source, which will eventually be replaced with another data source. This allows you to embed the custom JSON directly into the layout without depending on external data.

Cards and Layouts

Streaming API

Uses the Salesforce Streaming API to push notifications from the server to the client based on criteria that you define. The Vlocity Streaming API types include:

  • Streaming Channel: Sends notifications of general events that are not tied to Salesforce data changes.

  • PushTopic: Uses an SOQL query to return a result that notifies listeners of changes to records in a Salesforce organization.

  • Platform Event: Uses Salesforce's Platform Events enterprise messaging platform, which combines PushTopic and Streaming Channel to enable apps to communicate inside and outside of Salesforce.

Cards and Layouts