Define Metadata Values from the Flexcard Designer

Define the metadata values for the generated Flexcard LWC from the Flexcard Designer. When your Flexcard is active, use the Publish Options feature to configure API Version, Targets, Description, and other metadata values from a GUI or code editor.

Before You Begin

To view the Publish Options feature, activate your Flexcard. See Activate a Flexcard.

  1. From the Flexcards tab, click a version of a Flexcard to open the Flexcard Designer.
  2. From the Flexcard Designer submenu, click the down arrow next to Activate, and click Publish Options.
  3. Enter or update values for these properties:

    Property

    Description

    Master Label

    Update the visible name of the generated LWC as you want it to appear in the Lightning App Builder and Experience Builder. The default is the Name you used to create the Flexcard and, which is visible in the Setup panel.

    Description

    Enter a description for your generated LWC.

    API Version

    Defines the API version of your generated LWC. The default is the API version used when creating the Flexcard. When you create a Flexcard, the default value is the current API version.

    Runtime Namespace

    (Read-Only) Defines the Vlocity package namespace.

    Is Exposed

    When enabled, your card component is public. By default, this feature is enabled.

    Targets

    Select where your generated LWC is accessible. By default, Home Page, Record Page, and App Page are selected to enable use on a custom home page, a record page, and an app home page.

    To enable the use of your LWC on an Experience Builder site, select Community Page. To enable the use of your generated LWC on an Experience Builder site with configurable properties, select Community Default.

  4. (Optional) Beginning Winter '22, define an attribute that creates a public property from the Exposed Attributes feature in the Setup panel.
  5. To manually update metadata, click Editor to view the XML.

    See Supported XML Configuration for Publishing Flexcards.

    Important
    Important

    Don’t manually modify a public property created as an Exposed Attribute (Step 4).

    <targetConfig targets="lightning__AppPage"> 
        //default property  
        <property name="debug" type="Boolean" /> 
        //default property         
        <property name="recordId" type="String" />       
    </targetConfig>
    <targetConfig targets="lightning__RecordPage">
        //default property
        <property name="debug" type="Boolean"/>
        //do not modify property created as an Exposed Attributes                      
        <property name="recLimit" type="Boolean" label="Record Limit" />               
    </targetConfig>
    

What’s next: Add a custom component SVG icon to your generated Flexcard LWC. See Add a Custom Component SVG Icon to a Flexcard.