You are here:
Classic Cards (Managed Package)
For the managed package runtime, Classic Cards in the Vlocity Cards Framework are UI components rich in information and actions relevant to the customer's context. The Classic Card Designer is a declarative tool to create cards and card layouts, with minimal HTML, CSS, and AngularJS coding.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Beginning with Vlocity Health and Insurance Summer '19, Vlocity supports Salesforce's Lightning Web Components programming model with Vlocity Lightning Web Components. Vlocity Lightning Web Components include components, functionalities, and templates exclusive to LWC Cards. LWC Cards enables you to use standard JavaScript and HTML to modify and extend Vlocity products.
Cards
A Vlocity card is a block that contains a combination of pertinent information and links to processes within a specific context.
An account card, for example, includes unique account information, such as:
-
Status
-
Priority or service level agreement
-
Creation date
Actions on an account card might include:
-
Closing a case
-
Opening a new case
-
Creating a new task
Each action can launch an Omniscript to begin a guided process. An action can also open an external web address or application. With an LWC enabled card, you can fire a pubsub event from an action.
Card Flyouts
You can design a card to have an action that, when clicked, opens or "flies out" an additional card. A card flyout contains additional information and actions related to the parent card.
Card Layouts
A card layout contains one or more cards.
When you create a new card layout, you can:
-
Choose existing cards to include in the layout
-
Create new cards to include in the layout
Controlling the Look of Cards and Card Layouts
Each card and card layout is associated with a template that can use HTML and CSS/SCSS, and may use Javascript. Templates control the style and appearance of the card and the card layout, and they can be changed using the Template Designer.
The Template Designer is not supported when LWC is enabled.
Data Sources for Cards and Card Layouts
When you create a card or a card layout, you indicate where it retrieves data to display.
- Installing and Activating Vlocity Templates and Cards (Managed Package)
For the managed package runtime, after you install the latest Vlocity package, you must install and activate the base templates and cards. - Configuring Community Profiles for Vlocity Cards (Managed Package)
For the managed package runtime, ensure users see Vlocity Card Layouts on community pages by configuring user profile settings. Enable the appropriate interface, and configure custom object permissions, Visualforce page access, and Apex class access. - Lightning Web Component Cards (Managed Package)
For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model. - Apply Global Branding to Vlocity Cards (Managed Package)
For the managed package runtime, apply global style changes to all Vlocity Cards in your org by using the Newport Design System. The Newport Design System enables you to download, edit, and override the existing Newport CSS styles with your own styles. - Working with the Template Designer and Card Designer (Managed Package)
For the managed package runtime, customize the look of card layouts, card states, and flyouts by creating or editing templates in the Template Designer. - Cards Framework Versioning (Managed Package)
For the managed package runtime, the Vlocity Cards Framework supports versioning for all components. The name, author, and version combination must be unique for each component of a given type (layout, card, or template) in an org. - Using Actions with Cards (Managed Package)
For the managed package runtime, cards use Vlocity Actions, OS Actions, and Custom Actions to launch procedures. For example, a card can launch an Omniscript, run an Apex class, redirect to a URL endpoint, and so on. - Previewing a Layout (Managed Package)
For the managed package runtime, preview a card layout to see how your cards will look once published to a Lightning or Community page. - Adding a Card to a Layout (Managed Package)
For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model. - Adding a State to a Card (Managed Package)
For the managed package runtime, add card states to display data fields from the card or card layout data source, to present different interactions and layouts based on specified conditions, to add actions, and to add flyouts to display additional information about a record. For example, for cards displaying past due policy information, use a card state template, and display actions, fields, and flyouts different from those on cards displaying information for active policies in good standing. - Creating a Custom State Field (Managed Package)
For the managed package runtime, you can create a custom State Field in the template for your layouts or cards by entering'custom-type'into the supporting HTML for the template in the Template Designer, as follows: - 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. - Cards URL Syntax (Managed Package)
For the managed package runtime, the Vlocity Cards framework uses a generic Visualforce page to show layouts. This page requires at least one parameter pair to load a specific layout. For example: - Creating Zones (Managed Package)
For the managed package runtime, zones enable you to arrange the information on a card layout into sections. Create zones in the Template Designer, add the zones to a layout in the Card Designer, then add cards or nested layouts inside the zones. - Creating a Placeholder (Managed Package)
For the managed package runtime, create placeholders in the Template Designer to insert additional fields into card states in the Card Designer. For example, to add a unique title for escalated case cards, select thecard-active-placeholders-sldscard template, and enter Escalated for the value of the Title placeholder. - Creating a Flyout (Managed Package)
For the managed package runtime, create a flyout to display additional information about the record displayed on the card when you click the card. For example, a flyout can display information from long text strings that do not fit in the standard card field, or data from child records, such as open cases for an account, or additional actions. - Cloning a Card Layout (Managed Package)
For the managed package runtime, clone an existing card layout to copy layout, card state, and data source settings to a new card layout. - Creating a Version of a Template (Managed Package)
For the managed package runtime, to make minor edits and switch between active versions, create a version of a template. - Cloning a Template (Managed Package)
For the managed package runtime, edit a template without overriding existing code and settings by cloning an Omniscript element or Cards Framework component template with the Template Designer. - Adding Cards to a Lightning or Community Page (Managed Package)
For the managed package runtime, launch Vlocity Cards from Lightning and Community pages by adding Card Layouts with the Lightning App Builder and the Community Builder. - Reloading a Card After Updating an LWC Omniscript (Managed Package)
For the managed package runtime, update information on a card after making a change to an LWC Omniscript by passing an event to the Omniscript in the URL parameterc__vlocEventsof an OS Action. - Cards Context Variables (Managed Package)
For the managed package runtime, several variables are available across the framework to provide contexts to cards, data sources, flyouts, templates, and other components. - Exporting Vlocity Layouts and Cards (Managed Package)
For the managed package runtime, when deploying components in a new org, you must export any applicable Vlocity Cards framework components, particularly those that you modified. The Vlocity Cards Framework supports versioning for all components (layouts, cards and templates). Only active versions are exported. - Cards Framework Web Deployment Options (Managed Package)
For the managed package runtime, you can deploy Omnistudio for Managed Packages components, including Omniscripts and Cards Framework components, outside of Salesforce. This type of deployment is also called off-platform. You can use these components in an external server with or without an active connection to a Salesforce org. You can deploy components to a Heroku web server or to Adobe Enterprise Manager. - Base UI and Card Templates (Managed Package)
For the managed package runtime, the following tables list the base templates that are available for use with Vlocity Cards. When editing a template, it’s best practice to clone the existing template first and to edit the cloned version. - Cards Framework Required Resources (Managed Package)
For the managed package runtime, for Angular components, when implementing theCardFrameworkin your custom page, you must include these resources, in the order given. - Creating a Custom Cards Apex Page (Managed Package)
For the managed package runtime, to create a custom Cards Apex page, create a Visualforce Apex page, add your Angular app to the page, add some common scripts, and add your layout name.
