Skip to content
platform-custom-tab-generate logo

CustomTab Metadata Specification

platform-custom-tab-generate

Use this skill when users need to create or configure Salesforce Custom Tabs. Trigger when users mention tabs, navigation tabs, object tabs, web tabs, Visualforce tabs, Lightning component tabs, app page tabs, or tab configuration. Also use when users want to add navigation to custom objects, create tabs for external content, or set up Lightning page tabs. Always use this skill for any custom tab work.

forcedotcom/sf-skills5.7Kinstalls1.1Kstars

SKILL.md

Full skill instructions

When to Use This Skill

Use this skill when you need to:

  • Create tabs for objects, web pages, or Visualforce pages
  • Add navigation tabs to applications
  • Configure tab visibility and access
  • Troubleshoot deployment errors related to custom tabs

Specification

CustomTab Metadata Specification

Overview

Custom tabs for navigating to objects, web content, or Visualforce pages within Salesforce applications.

Purpose

  • Provide navigation to custom objects
  • Link to external web content
  • Access Visualforce pages
  • Organize application navigation

Required Properties

Core Tab Properties

  • customObject: true for custom object tabs, false for all others.
  • motif: Tab icon style — choose a motif that semantically matches the object's purpose. Do NOT reuse the same motif for every tab.
  • label: Display name (required for non-object tabs ONLY; object tabs inherit label from the object)
  • url: Web URL (for web tabs)
  • page: Visualforce page name (for Visualforce tabs)

STRICT ELEMENT ALLOWLIST — READ THIS FIRST

The root element MUST always be <CustomTab> (NOT <Tab>). The XML namespace must be xmlns="http://soap.sforce.com/​2006/​04/​metadata".

Only the elements listed below are valid. Any element not on this list WILL cause a deployment error.

Tab TypeONLY these elements are allowed (nothing else)
Object tabs<customObject> (required, set to true), <motif> (required), <description> (optional)
Web tabs<customObject> (required, set to false), <label> (required), <motif> (required), <url> (required), <urlEncodingKey> (required, set to UTF-8), <description> (optional), <frameHeight> (optional)
Visualforce tabs<customObject> (required, set to false), <label> (required), <motif> (required), <page> (required), <description> (optional)

FORBIDDEN ELEMENTS (every one of these causes a deployment error)

<sobjectName>, <name>, <fullName>, <apiVersion>, <isHidden>, <tabVisibility>, <type>, <mobileReady>, <urlFrameHeight>, <urlType>, <urlRedirect>, <encodingKey>, <height>, <auraComponent>

Also forbidden:

  • <label> on object tabs (object tabs inherit their label from the custom object)
  • <page> on web tabs (only for Visualforce tabs)
  • Empty elements like <page></​page> or <description></​description>
  • Any element not in the allowlist table above

Tab Types

Object Tabs

  • Purpose: Navigate to custom or standard objects
  • File name determines the object: {ObjectApiName}.tab-meta.xml (e.g., Space_Station__c.tab-meta.xml)
  • Required elements: <customObject>true</​customObject> and <motif>
  • Correct example (for a Space_Station__c.tab-meta.xml):
<?xml version="1.0" encoding="UTF-8"?>
<CustomTab xmlns="http://soap.sforce.com/​2006/​04/​metadata">
    <customObject>true</​customObject>
    <motif>Custom39: Telescope</​motif>
</​CustomTab>
  • Correct example (for a Supply__c.tab-meta.xml — note different motif):
<?xml version="1.0" encoding="UTF-8"?>
<CustomTab xmlns="http://soap.sforce.com/​2006/​04/​metadata">
    <customObject>true</​customObject>
    <motif>Custom98: Truck</​motif>
</​CustomTab>
  • WRONG — do NOT add <sobjectName>, <name>, <fullName>, or <label>:
<CustomTab xmlns="http://soap.sforce.com/​2006/​04/​metadata">
    <sobjectName>Space_Station__c</​sobjectName>  <!-- DEPLOYMENT ERROR -->
    <label>Space Station</​label>                  <!-- DEPLOYMENT ERROR on object tabs -->
    <customObject>true</​customObject>
    <motif>Custom57: Desert</​motif>
</​CustomTab>

Web Tabs

  • Purpose: Link to external websites or web applications
  • File name: Use a descriptive name: {TabName}.tab-meta.xml (e.g., Knowledge_Base.tab-meta.xml)
  • COPY THIS EXACT TEMPLATE — only replace the placeholder values. Do NOT add, remove, or rename any XML elements:
<?xml version="1.0" encoding="UTF-8"?>
<CustomTab xmlns="http://soap.sforce.com/​2006/​04/​metadata">
    <customObject>false</​customObject>
    <description>REPLACE_WITH_DESCRIPTION</​description>
    <frameHeight>600</​frameHeight>
    <label>REPLACE_WITH_LABEL</​label>
    <motif>REPLACE_WITH_MOTIF</​motif>
    <url>REPLACE_WITH_URL</​url>
    <urlEncodingKey>UTF-8</​urlEncodingKey>
</​CustomTab>
  • These 7 elements above are the ONLY elements allowed in a web tab file. Do not add ANY other elements.
  • The <description> element is optional — you may remove it if not needed, but do not add anything else.

Visualforce Tabs

  • Purpose: Access custom Visualforce pages
  • File name: {TabName}.tab-meta.xml (e.g., Custom_Page_Tab.tab-meta.xml)
  • Required elements: <customObject>false</​customObject>, <label>, <motif>, <page>
  • Correct example:
<?xml version="1.0" encoding="UTF-8"?>
<CustomTab xmlns="http://soap.sforce.com/​2006/​04/​metadata">
    <customObject>false</​customObject>
    <label>Custom Page</​label>
    <motif>Custom46: Computer</​motif>
    <page>CustomPage</​page>
</​CustomTab>

Tab Configuration

Tab Style

  • Default: Use standard tab styling
  • Custom: Can specify custom tab styles if needed

Tab Visibility

  • Default: Visible to all users with access
  • Custom: Can be configured for specific user profiles

Supported Applications

  • Standard Apps: Available in standard Salesforce applications
  • Custom Apps: Can be included in custom applications
  • Community Apps: Available in community applications

Integration Points

  • Object Relationships: Links to related object records
  • Web Content: External website integration
  • Visualforce Pages: Custom page functionality
  • Lightning Components: Modern component integration

Best Practices

  • Use clear, descriptive tab labels
  • Choose appropriate tab types for functionality
  • Select a unique, contextually relevant motif for each tab — do not default every tab to the same icon
  • Consider user experience and navigation flow
  • Test tab functionality across different applications
  • Ensure proper permissions and visibility settings
  • Follow consistent naming conventions
  • Object tab files MUST only contain <customObject>true</​customObject> and <motif> — nothing else
  • Web tab files MUST only contain: <customObject>false</​customObject>, <label>, <motif>, <url>, <urlEncodingKey>, and optionally <description>, <frameHeight> — nothing else
  • Never include <isHidden>, <tabVisibility>, <type>, <mobileReady>, or empty elements

More skills from forcedotcom

platform-apex-logs-debug logo
forcedotcom/sf-skills

platform-apex-logs-debug

Salesforce debug log analysis and troubleshooting with 100-point scoring. TRIGGER when: user analyzes debug logs, hits governor limits, reads stack traces, or touches .log files from Salesforce orgs. DO NOT TRIGGER when: running Apex tests (use platform-apex-test-run), generating or fixing Apex code (use platform-apex-generate), or Agentforce session tracing (use agentforce-observe).

1.1K 6.4K
View
platform-soql-query logo
forcedotcom/sf-skills

platform-soql-query

SOQL query generation, optimization, and analysis with 100-point scoring. Use this skill when the user needs SOQL/SOSL authoring or optimization: natural-language-to-query generation, relationship queries, aggregates, query-plan analysis, and performance or safety improvements for Salesforce queries. TRIGGER when: user writes, optimizes, or debugs SOQL/SOSL queries, touches .soql files, or asks about relationship queries, aggregates, or query performance. DO NOT TRIGGER when: bulk data operations (use platform-data-manage), Apex DML logic (use platform-apex-generate), or report/dashboard queries.

1.1K 6.3K
View
platform-metadata-deploy logo
forcedotcom/sf-skills

platform-metadata-deploy

Salesforce DevOps automation using sf CLI v2. TRIGGER when: user deploys metadata, creates/manages scratch orgs or sandboxes, sets up CI/CD pipelines, or troubleshoots deployment errors with sf project deploy. DO NOT TRIGGER when: writing Apex code (use platform-apex-generate), building LWC components (use experience-lwc-generate), creating metadata definitions (use platform-custom-object-generate or platform-custom-field-generate), or querying org data (use platform-data-manage).

1.1K 6.3K
View
platform-metadata-retrieve logo
forcedotcom/sf-skills

platform-metadata-retrieve

ALWAYS USE THIS SKILL to retrieve metadata from an org to your local project using the sf project retrieve start command. Supports multiple retrieval modes: retrieve all remote changes, retrieve by source directory, retrieve by metadata type with wildcards, retrieve by manifest (package.xml), or retrieve by package name. Use when the user asks to retrieve, pull, sync, or download metadata, Apex classes, custom objects, or org changes. Supports source format (default) or metadata format (ZIP). DO NOT TRIGGER for deploying metadata (use platform-metadata-deploy skill), listing metadata, or generating package.xml. NEVER use MCP tools - always use this skill and the Bash tool with sf project retrieve start.

1.1K 6.3K
View
platform-custom-field-generate logo
forcedotcom/sf-skills

platform-custom-field-generate

Use this skill when users need to create, generate, or validate Salesforce Custom Field metadata. Trigger when users mention custom fields, field types, Roll-up Summary fields, Master-Detail relationships, Lookup relationships, formula fields, picklists, dependent (controlling) picklists, referencing a value set from a field, or scoping/limiting picklist values for a specific record type. Also use when users encounter field deployment errors, especially around Roll-up Summary format, Master-Detail constraints, formula issues, or a record type that won't deploy without a business process. Use this skill for custom field metadata work, field generation, and field troubleshooting. DO NOT TRIGGER for creating or customizing the value set itself — defining a new GlobalValueSet, or modifying a StandardValueSet catalog like Industry or Lead Source — use platform-value-set-generate instead; this skill covers the field that references a value set, not the value set definition.

1.1K 6.2K
View

Generates correct, deployable Salesforce permission set metadata (PermissionSet XML) with object, field, user, and app permissions. Use this skill when creating or editing permission set metadata, object permissions, field-level security (FLS), tab visibility, or deploying permission sets.

1.1K 6.1K
View
dx-code-analyzer-run logo
forcedotcom/sf-skills

dx-code-analyzer-run

Run Salesforce Code Analyzer to scan code for security, performance, best practice, and code style violations. Supports all engines (PMD, ESLint, CPD, RetireJS, Flow, SFGE, ApexGuru), targets (files, folders, git diff), categories, and severities. Also handles post-scan exploration: filtering results by engine/severity/category/file, and explaining what rules mean. TRIGGER when: user says 'scan my code', 'check security issues', 'run PMD/ESLint', 'find duplicates', 'analyze Flows', 'check vulnerable libraries', 'AppExchange review', 'lint my LWC', 'static analysis', 'code quality', 'show security violations', 'what is this rule', 'explain ApexCRUDViolation', 'filter results', or mentions engines/file types (.cls, .trigger, .js, .flow-meta.xml). Use this skill for scanning, exploring results, and listing rules. DO NOT TRIGGER when: user asks only about installation/configuration (use dx-code-analyzer-configure), or wants to create a custom rule (use dx-code-analyzer-custom-rule-create).

1.1K 6.1K
View
automation-flow-generate logo
forcedotcom/sf-skills

automation-flow-generate

Generate Salesforce Flows using the MCP tool execute_metadata_action. Use when the user asks to create, build, or generate a flow — including Screen, Autolaunched, Record-Triggered (before/after-save), Scheduled. Also trigger for flow-like requests such as "when a record is created", "trigger daily at", "send an email when", "update the field when", "automate", "workflow", or "flow XML/metadata". This is the only skill for Salesforce Flow generation.

1.1K 6K
View
platform-custom-object-generate logo
forcedotcom/sf-skills

platform-custom-object-generate

Use this skill when users need to create, generate, or validate Salesforce Custom Object metadata. Trigger when users mention custom objects, creating objects, object metadata, .object files, sharing models, name fields, or validation rules on objects. Also use when users say things like "create a custom object", "generate object metadata", "set up an object for...", or when they're troubleshooting object deployment errors especially around sharing models and Master-Detail relationships. Always use this skill for any custom object metadata work, including enriching and keeping the object's description current whenever its fields or validation rules change. Do NOT use this skill for non-Custom-Object metadata (Apex, Flows, LWC, Permission Sets, Custom Metadata Types) or for standard Salesforce objects.

1.1K 6K
View
platform-data-manage logo
forcedotcom/sf-skills

platform-data-manage

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use platform-soql-query), Apex test execution (use platform-apex-test-run), or metadata deployment (use platform-metadata-deploy).

1.1K 5.9K
View
experience-lwc-generate logo
forcedotcom/sf-skills

experience-lwc-generate

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc/**/*.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use platform-apex-generate), Aura components, or Visualforce.

1.1K 5.9K
View
design-systems-slds-apply logo
forcedotcom/sf-skills

design-systems-slds-apply

Apply SLDS-compliant UI using the correct blueprints, styling hooks, utility classes, and icons. Use when building any UI that needs SLDS, choosing between Lightning Base Components and SLDS Blueprints, applying styling hooks for theming, using utility classes for layout and spacing, or selecting icons. Triggers include "build a modal", "create a form", "data table", "SLDS styling", "style with hooks", "add an icon".

1.1K 5.8K
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View