omnistudio-flexcard-generate
OmniStudio FlexCard creation and validation with 130-point scoring. Use when building at-a-glance UI cards, configuring data source bindings to Integration Procedures, or reviewing existing FlexCard definitions for accessibility and performance. TRIGGER when: user creates FlexCards, configures data
By forcedotcom · 4,635 installs
npx skills add forcedotcom/sf-skills --skill omnistudio-flexcard-generate
Source repository · Upstream listing
omnistudio flexcard generate: OmniStudio FlexCard Creation and Validation
Expert OmniStudio engineer specializing in FlexCard UI components for Salesforce Industries. Generate production ready FlexCard definitions that display at a glance information with declarative data binding, Integration Procedure data sources, conditional rendering, and proper SLDS (Salesforce Lightning Design System) styling. All FlexCards are validated against a 130 point scoring rubric across 7 categories.
Scope
In scope : Creating and validating OmniStudio FlexCard definitions ( OmniUiCard ); configuring Integration Procedure data sources; designing card layouts, states, and action buttons; scoring against the 130 point rubric; deployment and activation
Out of scope : Building OmniScripts (use omnistudio omniscript generate ), creating Integration Procedures (use omnistudio integration procedure generate ), mapping full dependency trees (use omnistudio dependencies analyze ), deploying metadata to org (use platform metadata deploy )
Core Responsibilities
1. FlexCard Authoring : Design and build FlexCard definitions with proper layout, states, and field mappings
2. Data Source Binding : Configure Integration Procedure data sources with correct field mapping and error handling
3. Test Generation : Validate cards against multiple data states (populated, empty, error, multi record)
4. Documentation : Produce deployment ready documentation with data source lineage and action mappings
Document Map
Need Document Description
Best practices [references/best practices.md](references/best practices.md) Layout patterns, SLDS, accessibility, performance
Data binding [references/data binding guide.md](references/data binding guide.md) IP sources, field mapping, conditional rendering
CRITICAL: Orchestration Order
FlexCards sit at the presentation layer of the OmniStudio stack. Ensure upstream components exist before building a FlexCard that depends on them.
FlexCards consume data from Integration Procedures and can launch OmniScripts. Build the data layer first, then the presentation layer.
Key Insights
Insight Detail
Configuration fields OmniUiCard uses DataSourceConfig for data source bindings and PropertySetConfig for card layout, states, and actions. There is NO Definition field on OmniUiCard in Core namespace.
Data source binding Data sources bind to Integration Procedures for live data; the IP must be active and deployed before the FlexCard can retrieve data
Child card embedding FlexCards can embed other FlexCards as child cards, enabling composite layouts with shared or independent data sources
OmniScript launching FlexCards can launch OmniScripts via action buttons, passing context data from the card's data source into the OmniScript's input
Designer virtual object The FlexCard Designer uses OmniFlexCardView as a virtual list object ( /lightning/o/OmniFlexCardView/home ), separate from the OmniUiCard sObject where card records are stored. Cards created via API may not appear in "Recently Viewed" until opened in the Designer.
Workflow (5 Phase Pattern)
Phase 1: Requirements Gathering
Before building, clarify these with the stakeholder:
Question Why It Matters
What is the card's purpose? Determines layout type and data density
Which data sources are needed? Identifies required Integration Procedures
What object context does it run in? Determines record level vs. list level display
What actions should the card expose? Drives button/link configuration and OmniScript integration
What layout best fits the use case? Single card, list, tabbed, or flyout
Are there conditional display rules? Fields or sections that appear/hide based on data values
Phase 2: Design & Layout
Read references/best practices.md for layout patterns, SLDS compliance, accessibility requirements, and performance guidance before designing.
Card Layout Options
Layout Type Use Case Description
Single Card Record summary One card displaying fields from a single record
Card List Related records Repeating cards bound to an array data source
Tabbed Card Multi context Multiple states displayed as tabs within one card
Flyout Card Detail on demand Expandable detail panel triggered from a summary card
Data Source Configuration
Each FlexCard data source connects to an Integration Procedure (or other source type) and maps response fields to display elements.
Map IP response fields to card display elements using {datasource.fieldName} merge syntax
Configure input parameters to pass record context (e.g., {recordId} ) to the IP
Set data source order when multiple sources feed the same card
Action Button Design
Action Type Purpose Configuration
Launch OmniScript Start a guided process OmniScript Type + SubType, pass context params
Navigate Go to record or URL Record ID or URL template with merge fields
Custom Action Platform event, LWC, etc. Custom action handler with payload mapping
Conditional Visibility
Show/hide fields based on data values using visibility conditions
Show/hide entire card states based on data source results
Display empty state messaging when data source returns no records
Phase 3: Generation & Validation
Read references/data binding guide.md for merge field syntax, data source types, and multi source coordination before generating.
Read references/scoring rubric.md for the full point by point breakdown when running the 130 point validation.
1. Generate the FlexCard definition JSON
2. Validate all data source references resolve to active Integration Procedures
3. Run the 130 point scoring rubric (see Scoring section below)
4. Verify merge field syntax matches IP response structure
5. Check accessibility attributes on all interactive elements
Phase 4: Deployment
1. Ensure all upstream Integration Procedures are deployed and active
2. Run a dry run check: use the platform metadata deploy skill with dry run before committing
3. Deploy the FlexCard metadata ( OmniUiCard ) — sf project deploy start is safe to re run; it upserts existing records
4. Activate the FlexCard in the target org
5. Embed the FlexCard in the target Lightning page, OmniScript, or parent FlexCard
6. If deploy fails : check error output for specific cause — common issues: upstream IP not deployed ( Cannot find OmniIntegrationProcedure ), missing namespace prefix ( Entity not found ), or FlexCard still in Draft status (activate before retrieving)
Phase 5: Testing
Test each FlexCard against multiple data scenarios:
Scenario What to Verify
Populated data All fields render correctly, merge fields resolve
Empty data Empty state message displays, no broken merge fields
Error state Graceful handling when IP returns an error or times out
Multi record Card list renders correct number of items, pagination works
Action buttons OmniScript launches with correct pre populated data
Conditional fields Visibility rules toggle correctly based on data values
Mobile Card layout adapts to smaller viewport widths
Generation Guardrails
Avoid these patterns when generating FlexCard definitions:
Anti Pattern Why It's Wrong Correct Approach
Referencing non existent IP data sources Card fails to load data at runtime Verify IP exists and is active before binding
Hardcoded colors in styles Breaks SLDS theming and dark mode Use SLDS design tokens and CSS custom properties
Missing accessibility attributes Fails WCAG compliance Add aria label , role , and keyboard handlers
Excessive nested child cards Performance degrades with deep nesting Limit to 2 levels of nesting; flatten where possible
Ignoring empty states Broken UI when data source returns no records Configure explicit empty state messaging
Hardcoded record IDs Card breaks across environments Use merge fields and context driven parameters
Scoring Rubric (130 Points)
All FlexCards are validated against 7 categories. Thresholds : [PASS] 90+ (Deploy) [VERIFY] 67 89 (Review) [BLOCK] <67 (Block fix required)
Category Points Criteria
Design & Layout 25 Appropriate layout type, logical field grouping, responsive design, consistent spacing, clear visual hierarchy
Data Binding 20 Correct IP references, proper merge field syntax, input parameter mapping, multi source coordination
Actions & Navigation 20 Action buttons configured correctly, OmniScript launch params mapped, navigation targets valid, action labels descriptive
Styling 20 SLDS tokens used (no hardcoded colors), consistent typography, proper use of card/tile patterns, dark mode compatible
Accessibility 15 aria label on interactive elements, keyboard navigable actions, sufficient color contrast, screen reader friendly field labels
Testing 15 Verified with populated data, empty state, error state, multi record scenario, and mobile viewport
Performance 15 Data source calls minimized, child card nesting limited (max 2 levels), no redundant IP calls, lazy loading for non visible states
Read references/scoring rubric.md for the full per criterion breakdown of all 7 categories.
CLI Commands
Read scripts/flexcard commands.sh for all FlexCard CLI commands (query, retrieve, deploy). Replace <org with your org alias and <Name with the FlexCard API name.
Data Source Binding
FlexCard Data Source Configuration
The DataSourceConfig field on OmniUiCard contains the data source bindings as JSON. The PropertySetConfig field contains the card layout, states, and field definitions.
IMPORTANT : There is NO Definition field on OmniUiCard in Core namespace. Use DataSourceConfig for data sources and PropertySetConfig for layout.
Read assets/omni ui card.json for the complete OmniUiCard record template including the DataSourceConfig JSON structure.
Data Source Types
Type dataSource.type When to Use
Integration Procedure IntegrationProcedures (plural, capital P) Primary pattern; calls an IP for live data
SOQL SOQL Direct query (use sparingly; prefer IP for abstraction)
Apex Remote ApexRemote Custom Apex class invocation
REST REST External API call via Named Credential
Custom Custom Custom data provider (pass JSON body directly)
Field Mapping from IP Response
Map IP response fields to card display elements using merge field syntax:
Input Parameter Mapping
Pass context from the hosting page into the IP data source:
Context Variable Source Example
{recordId} Current record page Pass to IP to query related data
{userId} Running user Filter data by current user
{param.customKey} URL parameter or parent card Pass from parent FlexCard or URL
Cross Skill Integration
Skill Relationship to omnistudio flexcard generate
omnistudio integration procedure generate Build the IP data sources that FlexCards consume
omnistudio omniscript generate Build the OmniScripts that FlexCard action buttons launch
omnistudio datamapper generate Build DataRaptors/DataMappers that IPs use under the hood
omnistudio dependencies analyze Analyze dependency chains across FlexCards, IPs, and OmniScripts
platform metadata deploy Deploy FlexCard metadata along with upstream dependencies
experience lwc generate Build custom LWC components embedded within FlexCards
Gotchas
Scenario Handling
Empty data Configure an explicit empty state with a user friendly message; do not show raw "No data" or blank card
Error states Di