Card and Card Layout Naming Conventions (Managed Package)

For the managed package runtime, follow Vlocity's requirements and best practices when naming cards and card layouts.

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

Beginning with Vlocity Insurance and Health Spring '20

Layout and Card Naming Conventions

Requirements

Examples

The combination of the card Name and Author must be unique in your Org. If the Name is the same and Author is different, the card or layout is versioned. See Cards Framework Versioning (Managed Package).

Name: account_layout

Author: CustomerSales

Name: account_closed_layout

Author: CustomerSales

Beginning with Vlocity Insurance and Health Spring '20, when creating a card or layout, the name and author must only contain underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Existing layout names and card names are automatically updated to make them compliant. New cards and layouts can not be saved without following these naming requirements.

Not acceptable: account$card!, 1account__card, $$account__card_, account card

Only one version of a card or layout can be active at the same time.

N/A

Card and layout names cannot be changed.

N/A

Layout Naming Conventions

Best Practices

Examples

  • Use lowercase separated by an underscore (_) for feature or sub feature.

  • myapp_home_product

  • trng_account_console

Card Naming Conventions

Best Practices

Examples

  • Use descriptive name in Title Case and an optional prefix.

  • vpl_Product_Details

  • rep_Account_Cases

Prior to Vlocity Insurance and Health Spring '20

Layout and Card Naming Conventions

Requirements

Examples

The combination of the card Name and Author must be unique in your Org. If the Name is the same and Author is different, the card or layout is versioned. See Cards Framework Versioning (Managed Package).

Name: account-layout

Author: CustomerSales

Name: account-closed-layout

Author: CustomerSales

Use ASCII characters.

See ascii.cl.

Only one version of a card or layout can be active at the same time.

N/A

Card and layout names cannot be changed.

N/A

Layout Naming Conventions

Best Practices

Examples

  • Use lowercase separated by a dash (-) for feature or sub feature.

  • myapp-home-product

  • trng-account-console

Card Naming Conventions

Best Practices

Examples

  • Use descriptive name in Title Case and an optional prefix.

  • vpl Product Details

  • rep Account Cases