Flexcards Data Source Properties (Managed Package)

For the managed package runtime, Flexcard Data Source properties are configurable for each data source type in the Setup panel of the Flexcard Designer. Retrieve data from a Salesforce object or an external database.

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

Common Data Source Properties

These properties are shared by all data sources. See Configure a Data Source on a Flexcard (Managed Package).

Delay(ms) available beginning Summer '21.

Property

Description

Data Source Type

Select the data source type.

Delay(ms)

To prevent bundling this data source call with other server requests and to emphasize its priority, enter a delay time in milliseconds.

Fetch Timeout(ms)

Set an appropriate timeout value to enable the application and users to react accordingly to long wait times. The timeout value controls the time that the framework waits for the designated data source to return a response.

Input Map

When required, pass variables from the Flexcard to the data source.

Key

Enter the variable to pass. For example, pass the contextId AccountId.

Value

Enter the value for the variable. For example, enter a merge field, such as {recordId} or a static value, such as the alpha-numeric Account Id found in the URL of an Account record page.

Order By

Order the records by a specified field.

Refresh Interval(ms)

Enter the frequency for refreshing data. At each refresh, if the data source records changed, the Flexcard and its child components reload.

Result JSON Path

To drill down to a specific dataset enter a JSON path, such as ['Cases']. If your entire JSON is an array, such as [{ "Cases": [{...},{...}]}], enter the index with the path. For example, enter [0]['Cases'].

Reverse Order

Reverse the order of the returned records.

Test Parameters

Preview a Flexcard using real data by adding test variables that the query can use to return live data.

Apex Remote Data Source Properties

These properties are unique to the Apex Remote data source. See Configure an Apex Remote Data Source on a Flexcard (Managed Package).

Property

Description

Asynchronous

Calls the Apex class asynchronously using the long-polling method.

Options Map

Send additional key/value pairs to the Input Map passed to the remote method. Enter a key in the first field, and its value in the second field. The value supports merge field syntax such as {Name}.

Poll Interval

Specifies the polling interval in milliseconds to check the response status.

Remote Class

The Apex remote class to invoke.

Remote Method

The Apex method to call.

Apex REST Data Source Properties

These properties are unique to the Apex REST data source. See Configure an Apex REST Data Source on a Flexcard (Managed Package).

Property

Description

Apex Endpoint

The URL of the Apex REST endpoint.

JSON Payload

Enter the JSON formatted response.

Method

Specifies what type of call to make: GET or POST.

Omnistudio Data Mapper Data Source Properties

These properties are unique to the Data Mapper data source. See Configure an Omnistudio Data Mapper Data Source on a Flexcard (Managed Package).

Property

Description

Interface Name

Select the Data Mapper to fetch the data from.

Integration Procedure Data Source Properties

These properties are unique to the Integration Procedure data source. See Configure an Integration Procedure Data Source on a Flex Card.

Property

Description

Name

Select the Integration Procedure to fetch the data from.

REST Data Source Properties

These properties are unique to the REST data source. See Configure a REST Web Data Source on a Flexcard (Managed Package). See Configure a REST Data Source Using Named Credentials on a Flexcard (Managed Package).

Property

Description

Endpoint

Enter the relative path to get what you need from the API, such as My_Payroll_System/paystubs?format=json.

Headers

Pass additional information from an HTTP request or response with an HTTP header.

JSON Payload

Enter the JSON formatted response.

Method

Select a GET or POST method.

Named Credential

Select a Named Credential created from Setup > Named Credential in your org.

REST type

Select the type of REST endpoint to access.

SDK Properties

These properties are unique to the SDK data source. The SDK data source is available beginning Summer '21. See Flexcard SDK Data Source (Managed Package).

Property

Description

Edit as JSON

Add or modify Input Parameters as JSON.

SDK Method

Select the SDK function to provide data for the Flexcard.

SDK

Select from the list of available SDKs to fetch data from.

SOQL Query Properties

These properties are unique to the SOQL Query data source. See Configure a SOQL Query Data Source on a Flexcard (Managed Package).

Property

Description

Query

Enter an SOQL expression to search for specific information from an org's Salesforce database. For example, SELECT Id, FirstName, LastName Email, Phone, Title FROM Contact WHERE Phone != Null.

SOSL Search Data Source Properties

These properties are unique to the SOSL Search data source. See Configure a SOSL Search Data Source on a Flexcard (Managed Package).

Property

Description

In

Select which fields to search in.

Limit to

Limit the maximum number of rows to return.

Returning sObject & Fields

Select at least one sObject and field to search.

Search For

Enter the search term to search for.

Streaming API Data Source Properties

These properties are unique to the Streaming API data source. See Vlocity Streaming API Data Sources (Managed Package).

Property

Description

Channel

Enter the URL of the app you created.

Get All Messages

Select whether to get all messages from the last 24 hours or get the latest data update.

Operations

Select the type of operation to perform. Select Replace to overwrite the Flexcard with new data or Append to add new data to the Flexcard.

Type

Select a Streaming API type.