---
schema_version: "1"
id: 3d514293eb13a7f98a3e1886f16559eaed36c4a8fd532a034384aae0dfaaaa04
title: Card and Card Layout Naming Conventions (Managed Package)
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_card_and_card_layout_naming_conventions.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_card_and_card_layout_naming_conventions.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 2ca44ccdf176a8390046838778ba7dd7917a67b6d6be3ed9180ff6131dbf2649
description: For the managed package runtime, follow Vlocity's requirements and best practices when naming cards and card layouts.
products:
  - Omnistudio
release: "264"
---
# 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](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/resources-global/_corporate/images/managedpackageicon.png) This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see [Omnistudio Help](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_standard.htm&language=en_US).

## Beginning with Vlocity Insurance and Health Spring '20

## Layout and Card Naming Conventions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e56">
              <p style="margin-bottom:0;">Requirements</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e62">
              <p style="margin-bottom:0;">Examples</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e56 ">
              <p style="margin-bottom:0;">The combination of the card <strong class="uicontrol">Name</strong> and <strong class="uicontrol">Author</strong> must be unique in your Org. If the Name is the same and Author is different, the card or layout is versioned. See <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_cards_framework_versioning.htm&amp;release=264.0.0&amp;type=5" title="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.">Cards Framework Versioning (Managed Package)</a>.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e62 ">
              <p>Name: <kbd>account_layout</kbd>
              </p>
              <p>Author: <strong class="uicontrol">CustomerSales</strong>
              </p>
              <p>Name: <strong class="uicontrol">account_closed_layout</strong>
              </p>
              <p style="margin-bottom:0;">Author: <strong class="uicontrol">CustomerSales</strong>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e56 ">
              <p style="margin-bottom:0;">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.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e62 ">
              <p style="margin-bottom:0;">Not acceptable: <strong class="uicontrol">account$card!</strong>, <strong class="uicontrol">1account__card</strong>, <strong class="uicontrol">$account__card_</strong>, <strong class="uicontrol">account card</strong>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e56 ">
              <p style="margin-bottom:0;">Only one version of a card or layout can be active at the same time.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e62 ">
              <p style="margin-bottom:0;">N/A</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e56 ">
              <p style="margin-bottom:0;">Card and layout names cannot be changed.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e62 ">
              <p style="margin-bottom:0;">N/A</p>
            </td>

          </tr>
        </tbody>
      </table>

## Layout Naming Conventions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e197">
              <p style="margin-bottom:0;">Best Practices</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e203">
              <p style="margin-bottom:0;">Examples</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Best Practices" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e197 ">
              <ul>
                <li>
                  <p>Use lowercase separated by an underscore (_) for feature or sub feature.</p>
                </li>

              </ul>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e203 ">
              <ul>
                <li>
                  <p>
                    <kbd>myapp_home_product</kbd>
                  </p>
                </li>

                <li>
                  <p>
                    <kbd>trng_account_console</kbd>
                  </p>
                </li>

              </ul>
            </td>

          </tr>
        </tbody>
      </table>

## Card Naming Conventions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e271">
              <p style="margin-bottom:0;">Best Practices</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e277">
              <p style="margin-bottom:0;">Examples</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Best Practices" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e271 ">
              <ul>
                <li>
                  <p>Use descriptive name in Title Case and an optional prefix.</p>
                </li>

              </ul>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e277 ">
              <ul>
                <li>
                  <p>vpl_Product_Details</p>
                </li>

                <li>
                  <p>rep_Account_Cases</p>
                </li>

              </ul>
            </td>

          </tr>
        </tbody>
      </table>

## Prior to Vlocity Insurance and Health Spring '20

## Layout and Card Naming Conventions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e346">
              <p style="margin-bottom:0;">Requirements</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e352">
              <p style="margin-bottom:0;">Examples</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e346 ">
              <p style="margin-bottom:0;">The combination of the card <strong class="uicontrol">Name</strong> and <strong class="uicontrol">Author</strong> must be unique in your Org. If the Name is the same and Author is different, the card or layout is versioned. See <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_cards_framework_versioning.htm&amp;release=264.0.0&amp;type=5" title="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.">Cards Framework Versioning (Managed Package)</a>.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e352 ">
              <p>Name: <kbd>account-layout</kbd>
              </p>
              <p>Author: <strong class="uicontrol">CustomerSales</strong>
              </p>
              <p>Name: <strong class="uicontrol">account-closed-layout</strong>
              </p>
              <p style="margin-bottom:0;">Author: <strong class="uicontrol">CustomerSales</strong>
              </p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e346 ">
              <p style="margin-bottom:0;">Use ASCII characters.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e352 ">
              <p style="margin-bottom:0;">See <a href="https://ascii.cl/" target="_blank">ascii.cl</a>.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e346 ">
              <p style="margin-bottom:0;">Only one version of a card or layout can be active at the same time.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e352 ">
              <p style="margin-bottom:0;">N/A</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Requirements" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e346 ">
              <p style="margin-bottom:0;">Card and layout names cannot be changed.</p>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e352 ">
              <p style="margin-bottom:0;">N/A</p>
            </td>

          </tr>
        </tbody>
      </table>

## Layout Naming Conventions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e479">
              <p style="margin-bottom:0;">Best Practices</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e485">
              <p style="margin-bottom:0;">Examples</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Best Practices" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e479 ">
              <ul>
                <li>
                  <p>Use lowercase separated by a dash (-) for feature or sub feature.</p>
                </li>

              </ul>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e485 ">
              <ul>
                <li>
                  <p>
                    <kbd>myapp-home-product</kbd>
                  </p>
                </li>

                <li>
                  <p>
                    <kbd>trng-account-console</kbd>
                  </p>
                </li>

              </ul>
            </td>

          </tr>
        </tbody>
      </table>

## Card Naming Conventions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e553">
              <p style="margin-bottom:0;">Best Practices</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d245074e559">
              <p style="margin-bottom:0;">Examples</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Best Practices" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e553 ">
              <ul>
                <li>
                  <p>Use descriptive name in Title Case and an optional prefix.</p>
                </li>

              </ul>
            </td>

            <td data-label="Examples" class="slds-cell-wrap" style="vertical-align:top;" headers="d245074e559 ">
              <ul>
                <li>
                  <p>vpl Product Details</p>
                </li>

                <li>
                  <p>rep Account Cases</p>
                </li>

              </ul>
            </td>

          </tr>
        </tbody>
      </table>