Components Available in First-Generation Managed Packages

Each metadata component that you include in a first-generation managed package has certain rules that determine its behavior in a subscriber org. Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and installed.

Before you review the details about the metadata components that can be included in a managed package, be sure you understand the meaning of each manageability rule.

Each component also lists which properties the package developer and subscriber can edit after the package is promoted or installed. For definitions of those categories, see Editable Properties After Package Promotion or Installation.

• Account Plan Objective Measure Calculation Definition

  Represents the definition of a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure.

• Account Relationship Share Rule

  Determines which object records are shared, how they’re shared, the account relationship type that shares the records, and the level of access granted to the records.

• Action Link Group Template

  Represents the action link group template. Action link templates let you reuse action link definitions and package and distribute action links.

• Action Plan Template

  Represents an instance of an action plan template.

• Actionable List Definition

  Represents the data source definition details associated with an actionable list.

• Actionable List Key Performance Indicator Definition

  Represents the custom key performance indicators that are defined for a specific field in an object.

• Activation Platform

  Represents the ActivationPlatform configuration, such as platform name, delivery schedule, output format, and destination folder.

• AffinityScoreDefinition

  Represents the affinity information used in calculations to analyze and categorize contacts for marketing purposes.

• Agent Action

  Represents an action, for use in Agentforce.

• Agent Topic

  Represents a topic, for use in Agentforce.

• AI Application

  Represents an instance of an AI application. For example, Einstein Prediction Builder.

• AI Application Config

  Represents additional prediction information related to an AI application.

• AIUsecaseDefinition

  Represents a collection of fields in a Salesforce org used to define a machine learning use case and get real-time predictions.

• Analytics

  Analytics components include analytics applications, dashboards, dataflows, datasets, lenses, recipes, and user XMD.

• Analytics Dashboard

  Represents a Tableau Next dashboard.

• Analytics Visualization

  Represents a Tableau Next visualization.

• Analytics Workspace

  Represents a Tableau Next workspace.

• Apex Class

  Represents an Apex Class. An Apex class is a template or blueprint from which Apex objects are created. Classes consist of other classes, user-defined methods, variables, exception types, and static initialization code.

• Apex Sharing Reason

  Represents an Apex sharing reason, which is used to indicate why sharing was implemented for a custom object.

• Apex Trigger

  Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur, such as before object records are inserted into the database, or after records have been deleted.

• App Framework Template Bundle

  Represents the app framework template bundle. Use these templates for Data Cloud and Tableau Next assets.

• Application Subtype Definition

  Represents a subtype of an application within an application domain.

• AssessmentConfiguration

  Represents a configuration for Assessment component. An AssessmentConfiguration entry indicates configuration for user flows such as sending out emails or reminder actions on assessments initiated by the patient.

• AssessmentQuestion

  Represents the container object that stores the questions required for an assessment.

• AssessmentQuestionSet

  Represents the container object for Assessment Questions.

• Aura Component

  Represents an Aura definition bundle. A bundle contains an Aura definition, such as an Aura component, and its related resources, such as a JavaScript controller. The definition can be a component, application, event, interface, or a tokens collection.

• Batch Calc Job Definition

  Represents a Data Processing Engine definition.

• Batch Process Job Definition

  Represents the details of a Batch Management job definition.

• Benefit Action

  Represents details of an action that can be triggered for a benefit.

• Bot Template

  Represents the configuration details for a specific Einstein Bot template, including dialogs and variables.

• Branding Set

  Represents the definition of a set of branding properties for an Experience Builder site, as defined in the Theme panel in Experience Builder.

• Briefcase Definition

  Represents a briefcase definition. A briefcase makes selected records available for specific users and groups to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android.

• Building Energy Intensity Record Type Configuration

  Represents the setup object that contains the mapping between the Building Energy Intensity Record record type and internal enums. You can primarily use this object for calculations across different record types.

• Business Process

  The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.

• Business Process Group

  Represents the surveys used to track customers’ experiences across different stages in their lifecycle.

• Business Process Type Definition

  Define the types of business processes that are applied to a rule.

• Care Benefit Verify Settings

  Represents the configuration settings for benefit verification requests.

• Care Limit Type

  Defines the characteristics of limits on benefit provision.

• Care Request Configuration

  Represents the details for a record type such as service request, drug request, or admission request. One or more record types can be associated with a care request.

• Care System Field Mapping

  Represents a mapping from source system fields to Salesforce target entities and attributes.

• Channel Layout

  Represents the metadata associated with a communication channel layout.

• Chatter Extension

  Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher.

• Claim Financial Settings

  Represents the configuration settings for Insurance Claim Financial Services.

• CommunicationChannelType

  Represents the type of communication channel, such as WhatsApp and SMS, to use for referral promotions.

• Community Template Definition

  Represents the definition of an Experience Builder site template.

• Community Theme Definition

  Represents the definition of a theme for an Experience Builder site.

• Compact Layout

  Represents the metadata associated with a compact layout.

• Conditional Formatting Ruleset

  Represents a set of rules that define the style and visibility of conditional field formatting on Dynamic Forms-enabled Lightning page field instances.

• Connected App

  Represents a connected app configuration. A connected app enables an external application to integrate with Salesforce using APIs and standard protocols, such as SAML, OAuth, and OpenID Connect.

• Context Definition

  A context definition defines the relationship between the nodes and the attributes within each node. For efficient data access, users can use nodes and attributes to easily access the relevant data from the mapped data source. Various Salesforce products offer predefined context definitions based on their use case.

• Contract Type

  A contract type is used to group contracts so that they exhibit similar characteristics. For example, the lifecycle states, the people who access, the templates and clauses used.

• Conversation Channel Definition

  Represents the conversation channel definition that’s implemented for Interaction Service for Bring Your Own Channel and Bring Your Own Channel for CCaaS messaging channels.

• Conversation Vendor Info

  This setup object connects the partner vendor system to the Service Cloud feature.

• CORS Allowlist

  Represents an origin in the CORS allowlist.

• CSP Trusted Site

  Represents a trusted URL. For each CspTrustedSite component, you can specify Content Security Policy (CSP) directives and permissions policy directives.

• Custom Application

  Represents a custom application.

• Custom Button or Link

  Represents a custom link defined in a home page component.

• Custom Console Components

  Represents a custom console component (Visualforce page) assigned to a CustomApplication that is marked as a Salesforce console. Custom console components extend the capabilities of Salesforce console apps.

• Custom Field on Standard or Custom Object

  Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard or custom objects.

• Custom Field on Custom Metadata Type

  Represents a custom fields on the custom metadata type.

• Custom Field Display

  Represents the CustomFieldDisplay view type assigned to product attribute custom fields.

• Custom Help Menu Section

  Represents the section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources for the org. The custom section contains help resources added by the admin.

• Custom Index

  Represents an index used to increase the speed of queries.

• Custom Label

  The CustomLabels metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies.

• Custom Metadata Type Records

  Represents a record of a custom metadata type.

• Custom Metadata Type

  Represents a record of a custom metadata type.

• Custom Notification Type

  Represents the metadata associated with a custom notification type.

• Custom Object

  Represents a custom object that stores data unique to an org or an external object that maps to data stored outside an org.

• Custom Object Translation

  This metadata type allows you to translate custom objects for a variety of languages.

• Custom Permission

  Represents a permission that grants access to a custom feature.

• Custom Tab

  Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce.

• Dashboard

  Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.

• DataCalcInsightTemplate

  Represents the object template for data calculations and insights of Data Cloud objects in DataCalcInsightTemplate. These objects are added inside the data kit.

• DataCleanRoomProvider

  Represents a clean room provider configuration that defines the clean room collaboration details, including templates and the platform used for secure data collaboration in Data 360.

• DataConnector

  Represents the white-labeled metadata configuration for an external connector in Data 360.

• Data Connector Ingest API

  Represents the connection information specific to Ingestion API.

• Data Connector S3

  Represents the connection information specific to Amazon S3.

• Data Kit Object Dependency

  Represent the object dependencies and relationships between different objects in Data Kit Object Dependency. These objects are added inside the data kit.

• Data Kit Object Template

  Represents the object in Data Kit Object Template. This object template is added inside the data kit.

• DataObjectBuildOrgTemplate

  Represents the output objects of the components the user includes in a data kit.

• Data Package Kit Definition

  Represents the top-level Data Kit container definition. Content objects can be added after the Data Kit is defined.

• Data Package Kit Object

  Represents the object in Data Kit Content Object. These objects are added inside the data kit.

• Data Source

  Used to represent the system where the data was sourced.

• Data Source Bundle Definition

  Represents the bundle of streams that a user adds to a data kit.

• Data Source Object

  Represents the object from where the data was sourced.

• Data Src Data Model Field Map

  Represents the entity that’s used to store the design-time bundle-level mappings for the data source fields and data model fields.

• Data Stream Definition

  Contains Data Ingestion information such as Connection, API and File retrieval settings.

• Data Stream Template

  Represents the data stream that a user adds to a data kit.

• DataWeaveResource

  Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. DataWeave scripts can be directly invoked from Apex.

• Decision Matrix Definition

  Represents a definition of a decision matrix.

• Decision Matrix Definition Version

  Represents a definition of a decision matrix version.

• Decision Table

  Represents the information about a decision table.

• Decision Table Dataset Link

  Represents the information about a dataset link associated with a decision table. In a dataset link, select an object for whose records, the decision table must provide an outcome.

• Digital Experience

  Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items.

• Digital Experience Bundle

  Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items.

• Disclosure Definition

  Represents information that defines a disclosure type, such as details of the publisher or vendor who created or implemented the report.

• Disclosure Definition Version

  Represents the version information about the disclosure definition.

• Disclosure Type

  Represents the types of disclosures that are done by an individual or an organization and the associated metadata.

• Discovery AI Model

  Represents the metadata associated with a model used in Einstein Discovery.

• Discovery Goal

  Represents the metadata associated with an Einstein Discovery prediction definition.

• Discovery Story

  Represents the metadata associated with a story used in Einstein Discovery.

• Document

  Represents a Document. All documents must be in a document folder, such as sampleFolder/TestDocument.

• Document Generation Setting

  Represents an org's settings for automatic document generation from templates.

• Eclair GeoData

  Represents an Analytics custom map chart. Custom maps are user-defined maps that are uploaded to Analytics and are used just as standard maps are. Custom maps are accessed in Analytics from the list of maps available with the map chart type.

• Email Template (Classic)

  Use email templates to increase productivity and ensure consistent messaging. Email templates with merge fields let you quickly send emails that include field data from Salesforce records.

• Email Template (Lightning)

  Represents a template for an email, mass email, list email, or Sales Engagement email.

• Embedded Service Config

  Represents a setup node for creating an Embedded Service for Web deployment.

• Embedded Service Menu Settings

  Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business.

• Enablement Measure Definition

  Represents an Enablement measure, which specifies the job-related activity that a user performs to complete a milestone or outcome in an Enablement program. A measure identifies a source object and optional related objects, with optional field filters and filter logic, for tracking the activity.

• Enablement Program Definition

  Represents an Enablement program, which includes exercises and measurable milestones to help users such as sales reps achieve specific outcomes related to your company’s revenue goals.

• Enablement Program Task Subcategory

  Represents a custom exercise type that an Enablement admin adds to an Enablement program in Program Builder. A custom exercise type also requires a corresponding EnblProgramTaskDefinition record for Program Builder and corresponding LearningItem and LearningItemType records for when users take the exercise in the Guidance Center.

• Entitlement Template

  Represents an entitlement template. Entitlement templates are predefined terms of customer support that you can quickly add to products.

• ESignature Config

  Using the Electronic Signature Configuration setup, the system admin must define the required configurations to support the e-signature APIs and UI.

• ESignature Envelope Config

  Using the Electronic Signature Envelope Config the system admin can define the default reminders and expiry for the envelopes submitted for eSignature.

• Event Relay

  Represents an event relay that you can use to send platform events and change data capture events from Salesforce to Amazon EventBridge.

• Explainability Action Definition

  Define where the metadata for your Decision Explainer business rules are stored in Public Sector Solutions.

• Explainability Action Version

  Define and store versions of the explainability actions used by your Decision Explainer business rules in Public Sector Solutions.

• Explainability Message Template

  Represents information about the template that contains the decision explanation message for a specified expression set step type.

• Expression Set Definition

  Represents an expression set definition.

• Expression Set Definition Version

  Represents a definition of an expression set version.

• Expression Set Object Alias

  Represents information about the alias of the source object that’s used in an expression set.

• Expression Set Message Token

  Represents a token that's used in an explainability message template. The token can be replaced with an expression set version resource that the template is used in. This object is available in API version 59.0 and later.

• External Auth Identity Provider

  Represents the external auth identity provider that obtains OAuth tokens for callouts that use named credentials.

• External Client App Header

  Represents the header file for an external client application configuration.

• External Client App Notification Settings

  Represents the settings configuration for the external client app’s notifications plugin.

• External Client App OAuth Settings

  Represents the settings configuration for the external client app’s OAuth plugin.

• External Client App Push Settings

  Represents the settings configuration for the external client app’s push notification plugin.

• External Credential

  Represents the details of how Salesforce authenticates to the external system.

• External Data Connector

  Used to represent the object where the data was sourced.

• External Data Source

  Represents the metadata associated with an external data source. Create external data sources to manage connection details for integration with data and content that are stored outside your Salesforce org.

• External Data Transport Field Template

  Represents the definition of a Data Cloud schema field.

• External Data Transport Field

  Use ExternalDataTranField to add a field to the ExternalDataTranObject in your managed packages. ExternalDataTranObject is a Data Cloud schema object.

• External Data Transport Object Template

  Represents the definition of a Data Cloud schema object.

• External Data Transport Object

  To include a Data Cloud schema object in your managed packages, add ExternalDataTranObject.

• External Document Storage Configuration

  Represents configuration, which admin makes in setup to specify the drive, path, and named credential to be used for storing documents on external drives.

• External Services

  Represents the External Service configuration for an org.

• Feature Parameter Boolean

  Represents a boolean feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package.

• Feature Parameter Date

  Represents a date feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package.

• Feature Parameter Integer

  Represents an integer feature parameter in the Feature Management App (FMA). Feature parameters let you drive app behavior and track activation metrics in subscriber orgs that install your package.

• Field Set

  Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's first name, middle name, last name, and business title.

• Field Source Target Relationship

  Stores the relationships between a data model object (DMO) and its fields. For example, the Individual.Id field has a one-to-many relationship (1:M) with the ContactPointEmail.PartyId field.

• Flow

  Represents the metadata associated with a flow. With Flow, you can create an application that navigates users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.

• Flow Category

  Represents a list of flows that are grouped by category.

• Flow Definition

  Represents the flow definition’s description and active flow version number.

• Flow Test

  Represents the metadata associated with a flow test. Before you activate a record-triggered flow, you can test it to verify its expected results and identify flow run-time failures.

• Folder

  Represents a folder.

• Fuel Type

  Represents a custom fuel type in an org.

• Fuel Type Sustainability Unit of Measure

  Represents a mapping between the custom fuel types and their corresponding unit of measure (UOM) values defined by a customer in an org.

• Fundraising Config

  Represents a collection of settings to configure the fundraising product.

• Gateway Provider Payment Method Type

  Represents an entity that allows integrators and payment providers to choose an active payment to receive an order's payment data rather than allowing the Salesforce Order Management platform to select a default payment method.

• Gen Ai Planner Bundle

  Represents a planner for an agent or agent template. It’s a container for all the topics and actions used to interact with a large language model (LLM).

• Generative AI Prompt Template

  Represents a generative AI prompt template, for use in Agentforce.

• Global Picklist

  Represents the metadata for a global picklist value set, which is the set of shared values that custom picklist fields can use. A global value set isn’t a field itself. In contrast, the custom picklist fields that are based on a global picklist are of type ValueSet.

• Home Page Component

  Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.

• Home Page Layout

  Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.

• Identity Verification Proc Def

  Represents the definition of the identity verification process.

• Inbound Network Connection

  Represents a private connection between a third-party data service and a Salesforce org. The connection is inbound because the callouts are coming into Salesforce.

• IntegrationProviderDef

  Represents an integration definition associated with a service process. Stores data for the Industries: Send Apex Async Request and Industries: Send External Async Request invocable actions.

• LearningAchievementConfig

  Represents the mapping details between a Learning Achievement type and a Learning Achievement record type.

• Learning Item Type

  Represents a custom exercise type that an Enablement user takes in an Enablement program in the Guidance Center. A custom exercise type also requires a corresponding LearningItem record for the Guidance Center and corresponding EnblProgramTaskDefinition and EnblProgramTaskSubCategory records for when admins create a program in Program Builder.

• Letterhead

  Represents formatting options for the letterhead in an email template. A letterhead defines the logo, page color, and text settings for your HTML email templates. Use letterheads to ensure a consistent look and feel in your company’s emails.

• Life Science Config Category

  Represents the category that a Life Sciences configuration record is organized into.

• Life Science Config Record

  Represents a configuration record for Life Sciences. This object is a child of Life Science Config Category.

• Lightning Bolt

  Represents the definition of a Lightning Bolt Solution, which can include custom apps, flow categories, and Experience Builder templates.

• Lightning Message Channel

  Represents the metadata associated with a Lightning Message Channel. A Lightning Message Channel represents a secure channel to communicate across UI technologies, such as Lightning Web Components, Aura Components, and Visualforce.

• Lightning Page

  Represents the metadata associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.

• Lightning Type

  Represents a custom Lightning type. Use this type to override the default user interface to create a customized appearance based on your business requirements. Deploy this bundle to your organization to implement the overrides.

• Lightning Web Component

  Represents a Lightning web component bundle. A bundle contains Lightning web component resources.

• List View

  ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects.

• Live Chat Sensitive Data Rule

  Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex). Use this object to mask or delete data of specified patterns, such as credit card, social security, or phone and account numbers.

• Loyalty Program Setup

  Represents the configuration of a loyalty program process including its parameters and rules. Program processes determine how new transaction journals are processed. When new transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals.

• Managed Content Type

  Represents the definition of custom content types for use with Salesforce CMS. Custom content types are displayed as forms with defined fields.

• Marketing App Extension

  Represents an integration with a third-party app or service that generates prospect external activity.

• Marketing App Extension Activity

  Represents an Activity Type, which is a prospect activity that occurs in a third-party app and can be used in Account Engagement automations.

• Market Segment Definition

  Represents the field values for MarketSegmentDefinition. MarketSegmentDefinition is used to store the exportable metadata of a segment, such as segment criteria and other attributes. Developers can create segment definition packages, pass segment definition in the form of data build tool (DBT), and publish it on AgentExchange for subscriber organizations to install and instantiate these segments.

• MktCalculatedInsightsObjectDef

  Represents Calculated Insight definition such as expression.

• MktDataConnection

  Represents the connection information of an external connector that can ingest data to Data Cloud, read data from the source, or write data to the source in Data Cloud.

• MktDataTranObject

  An entity that is used to deliver (aka transport) information from the source to a target (target will be called a landing entity).This can be the schema of a file, API, Event, or other means of transporting data, such as SubscriberFile1.csv, or SubscriberCDCEvent.

• Named Credential

  Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts.

• Object Source Target Map

  Contains the object-level mappings between the source and the target objects. The source and target objects can be an MktDataLakeObject or an MktDataModelObject. For example, an Email source object can be mapped to the ContactPointEmail object.

• Object Integration Provider Definition Mapping

  Maps structured, logical data nodes in a context definition to actual Salesforce object fields or external data sources

• OcrSampleDocument

  Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form.

• OcrTemplate

  Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader.

• Outbound Network Connection

  Represents a private connection between a Salesforce org and a third-party data service. The connection is outbound because the callouts are going out of Salesforce.

• Page Layout

  Represents the metadata associated with a page layout.

• Path Assistant

  Represents Path records.

• Payment Gateway Provider

  Represents the metadata associated with a payment gateway provider.

• Permission Set

  Represents a set of permissions that's used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access.

• Permission Set Groups

  Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed.

• Platform Cache

  Represents a partition in the Platform Cache.

• Platform Event Channel

  Represents a channel that you can subscribe to in order to receive a stream of events.

• Platform Event Channel Member

  Represents an entity selected for Change Data Capture notifications on a standard or custom channel, or a platform event selected on a custom channel.

• Platform Event Subscriber Configuration

  Represents configuration settings for a platform event Apex trigger, including the batch size, the trigger’s running user, and parallel subscription settings.

• Pricing Action Parameters

  Represents a pricing action associated to a context definition and a pricing procedure.

• Pricing Recipe

  Represents one out of various data models or sets of entities of a particular cloud that'll be consumed by the pricing data store during design and run time.

• Procedure Output Resolution

  Represents the pricing resolution for an pricing element determined using strategy name and formula.

• Process

  Use Flow instead.

• Process Flow Migration

  Represents a process's migrated criteria and the resulting migrated flow.

• Product Attribute Set

  Represents the ProductAttribute information being used as and attribute such as color_c, size_c .

• Product Specification Type

  Represents the type of product specification provided by the user to make the product terminology unique to an industry. A product specification type is associated with a product specification record type.

• Product Specification Record Type

  Represents the relationship between industry-specific product specifications and the product record type.

• Prompts (In-App Guidance)

  Represents the metadata related to in-app guidance, which includes prompts and walkthroughs.

• Quick Action

  Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher.

• Recommendation Strategy

  Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations.

• Record Action Deployment

  Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components.

• Record Alert Data Source Expression Set Definition

  Represents information about the data source for a record alert and the association with an expression set definition.

• Record Type

  Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page layouts to different users. Use this metadata type to create, update, or delete record type definitions for a custom object.

• RedirectWhitelistUrl

  Represents a trusted URL that’s excluded from redirection restrictions when the redirectionWarning or redirectBlockModeEnabled field on the SessionSettings Metadata type is set to true.

• Referenced Dashboard

  Represents the ReferencedDashboard object in CRM Analytics. A referenced dashboard stores information about an externally referenced dashboard.

• Registered External Service

  Represents a registered external service, which provides an extension or integration.

• RelationshipGraphDefinition

  Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works.

• Remote Site Setting

  Represents a remote site setting.

• Report

  Represents a custom report.

• Report Type

  Represents the metadata associated with a custom report type. Custom report types allow you to build a framework from which users can create and customize reports.

• ServiceProcess

  Represents a process created in Service Process Studio and its associated attributes.

• Slack App (Beta)

  Represents a Slack app.

• Service Catalog Category

  Represents the grouping of individual catalog items in Service Catalog.

• Service Catalog Filter Criteria

  Represents an eligibility rule that determines if a Service Catalog user has access to a catalog item.

• Service Catalog Item Definition

  Represents the entity associated with a specific, individual service available in the Service Catalog.

• Service Catalog Fulfillment Flow

  Represents the flow associated with a specific catalog item in the Service Catalog.

• Stationary Asset Environmental Source Record Type Configuration

  Represents the setup object that contains the mapping between the Stationary Asset Environmental Source record type and internal enums. You can primarily use this object for calculations across different record types.

• Static Resource

  Represents a static resource file, often a code library in a ZIP file.

• Streaming App Data Connector

  Represents the connection information specific to Web and Mobile Connectors.

• Sustainability UOM

  Represents information about the additional unit of measure values defined by a customer.

• Sustainability UOM Conversion

  Represents information about the unit of measure conversion for the additional fuel types defined by a customer.

• Timeline Object Definition

  Represents the container that stores the details of a timeline configuration. You can use this resource with Salesforce objects to see their records' related events in a linear time-sorted view.

• Timesheet Template

  Represents a template for creating time sheets in Field Service.

• Translation

  Add translations to your managed packages.

• UI Object Relation Config

  Represents the admin-created configuration of the object relation UI component.

• User Access Policy

  Represents a user access policy.

• Validation Rule

  Represents a validation rule, which is used to verify that the data a user enters in a record is valid and can be saved.

• Vehicle Asset Emissions Source Record Type Configuration

  Represents the setup object that contains the mapping between the Vehicle Asset Emissions Source record type and internal enums. You can primarily use this object for calculations across different record types.

• View Definition (Beta)

  Represents a view definition on a Slack app.

• Virtual Visit Config

  Represents an external video provider configuration, which relays events from Salesforce to the provider.

• Visualforce Component

  Represents a Visualforce component.

• Visualforce Page

  Represents a Visualforce page.

• Wave Analytic Asset Collection

  A collection of CRM Analytics assets.

• Wave Application

  A CRM Analytics application.

• Wave Component

  A CRM Analytics dashboard component.

• Wave Dataflow

  A CRM Analytics data prep dataflow.

• Wave Dashboard

  A CRM Analytics dashboard.

• Wave Dataset

  A CRM Analytics dataset.

• Wave Lens

  A CRM Analytics lens.

• Wave Recipe

  A CRM Analytics data prep recipe.

• Wave Template Bundle

  A CRM Analytics template bundle.

• Wave Xmd

  The extended metadata for CRM Analytics dataset fields and their formatting for dashboards and lenses.

• Web Store Template

  Represents a configuration for creating commerce stores.

• Workflow Alert

  WorkflowAlert represents an email alert associated with a workflow rule.

• Workflow Field Update

  WorkflowFieldUpdate represents a workflow field update.

• Workflow Knowledge Publish

  WorkflowKnowledgePublish represents Salesforce Knowledge article publishing actions and information.

• Workflow Outbound Message

  WorkflowOutboundMessage represents an outbound message associated with a workflow rule.

• Workflow Rule

  This metadata type represents a workflow rule.

• Workflow Task

  This metadata type references an assigned workflow task.

Account Plan Objective Measure Calculation Definition

Represents the definition of a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AccountPlanObjMeasCalcDef; Component Type in 1GP Package Manager UI: Account Plan Objective Measure Calculation Definition

Documentation: Sales Account Plan Objectives, Measures, and Calculation Definitions

Account Relationship Share Rule

Determines which object records are shared, how they’re shared, the account relationship type that shares the records, and the level of access granted to the records.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AccountRelationshipShareRule

Use Case: To share data between external accounts.

License Requirements: Orgs with Digital Experiences enabled can use this package.

Documentation: Salesforce Help: Account Relationships and Account Relationship Data Sharing Rules

Action Link Group Template

Represents the action link group template. Action link templates let you reuse action link definitions and package and distribute action links.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ActionLinkGroupTemplate; Component Type in 1GP Package Manager UI: Action Link Group Template

Documentation: Salesforce Help: Action Link Templates

Action Plan Template

Represents an instance of an action plan template.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ActionPlanTemplate

Documentation: Salesforce Help: Action Plans

Actionable List Definition

Represents the data source definition details associated with an actionable list.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ActionableListDefinition; Component Type in 1GP Package Manager UI: ActionableListDefinition

Documentation: Salesforce Help: Actionable Segmentation

Actionable List Key Performance Indicator Definition

Represents the custom key performance indicators that are defined for a specific field in an object.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

To confirm whether this component is available in managed 1GP, managed 2GP, or both package types, see Metadata Coverage Report.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ActnblListKeyPrfmIndDef; Component Type in 1GP Package Manager UI: ActnblListKeyPrfmIndDef

License Requirements: Actionable Segmentation

Documentation: Salesforce Help: Create Custom Key Performance Indicators; Salesforce Help: ActnblListKeyPrfmIndDef

Activation Platform

Represents the ActivationPlatform configuration, such as platform name, delivery schedule, output format, and destination folder.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ActivationPlatform; Component Type in 1GP Package Manager UI: ActivationPlatform

Use Case: Allows ISVs to specify capabilities of their Activation Platform integrations and publish it on AgentExchange for subscriber organizations to install and instantiate instances of the platform as a disparate activation target.

Considerations When Packaging

Some upgrade scenarios are not support:

• Adding a new required field
• Removing a previously supported ID type
• Removing a previously supported optional field or required field
• Changing a previously supported field property from optional to required

Some update scenarios are supported and don't automatically cascade to Activation Target or Activations created before the upgrade installations:

• Adding a new ID type
• Adding of a new optional field
• Adding a new hidden field
• Value change on a previously supported hidden field

To apply updates to future Activation run jobs, the user must edit and resave all Activation Targets created before the upgrade. Developers provide post-install instructions informing the subscriber of this required action anytime a change is made in a new version release.

License Requirements: Data Cloud enabled orgs can access this package.

Post Install Steps: An admin from the subscriber org enables the activation platform to start using this platform in Activation creations.

Documentation: Metadata API Developer Guide: ActivationPlatform

AffinityScoreDefinition

Represents the affinity information used in calculations to analyze and categorize contacts for marketing purposes.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AffinityScoreDefinition

Documentation

Agent Action

Represents an action, for use in Agentforce.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

Action Input Fields:

• CopilotAction.IsUserInput
• Description
• IsPII
• Properties (Inherited from invocationTarget like flows or Apex code.)
• Title (Inherited from invocationTarget like flows or Apex code.)
• Required
• Lightning.Type

Action Output Fields:

• Description
• CopilotAction.IsDisplayable
• IsPII
• CopilotAction.IsUsedByPlanner
• Properties (Inherited from invocationTarget like flows or Apex code.)
• Title (Inherited from invocationTarget like flows or Apex code.)

More Information

Feature Name: Metadata Name: GenAiFunction; Component Type in 1GP Package Manager UI: Generative AI Function Definition

Use Case: Provide actions that customers can add to their own topics and agents.

Considerations When Packaging

When creating an Agent Action of type Apex, the Apex class, invocable Apex method, and any invocable Apex variables must all be marked as global. If any of these are public or private, the Apex method won't appear in the list of options to add to the Agent Action, and won't be invoked by an Agent at runtime.

Documentation: Salesforce Help: Agentforce Agents; Salesforce Help: Agentforce Actions; Metadata API Developer Guide: GenAiFunction

Agent Topic

Represents a topic, for use in Agentforce.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: GenAiPlugin; Component Type in 1GP Package Manager UI: Generative AI Plugin Definition

Use Case

Provide topics that customers can add to their own agents. Actions can be added to topics.

Considerations When Packaging

Subscribers can't edit which actions are associated with a managed-installed topic. Instead, subscribers must manually create a copy of the topic and then assign actions to their copy of the topic. We're working to improve this experience.

Documentation: Salesforce Help: Agentforce Agents; Salesforce Help: Agentforce Topics

AI Application

Represents an instance of an AI application. For example, Einstein Prediction Builder.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AIApplication

Considerations When Packaging

AIApplication is the parent entity for all Einstein configuration entities. Packaging of Einstein features must always begin with the selection of one or more AIApplications. To create a package with ML Prediction Definition, select the parent AIApplication (Type = PredictionBuilder). To create a package with ML Recommendation Definition, select the parent AIApplication (Type = RecommendationBuilder). Packaging automatically analyzes the relationships and includes the associated MLPredictionDefinitions, MLRecommendationDefinitions, and MLDataDefinitions necessary to fully define the Einstein configuration.

Documentation: Metadata API Developer Guide: AIApplication; Salesforce Help: Einstein Prediction Builder; Salesforce Help: Einstein Recommendation Builder

AI Application Config

Represents additional prediction information related to an AI application.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AIApplicationConfig

Considerations When Packaging

AIApplicationConfig is always associated with an AIApplication. Packaging of Einstein features must always begin with the selection of one or more AIApplications. To create a package with AI Application Config, select the parent AIApplication. Packaging automatically analyzes the relationships and includes the associated MLApplicationConfig, MLPredictionDefinition, MLRecommendationDefinitions, and MLDataDefinitions necessary to fully define the Einstein configuration.

Documentation: Metadata API Developer Guide: AIApplicationConfig; Salesforce Help: Einstein Prediction Builder; Salesforce Help: Einstein Recommendation Builder

AIUsecaseDefinition

Represents a collection of fields in a Salesforce org used to define a machine learning use case and get real-time predictions.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AIUsecaseDefinition; Component Type in 1GP Package Manager UI: AIUsecaseDefinition

Use Case

AI Usecase Definition lets you ship data that can be used to set up use cases for which you want to generate real-time predictions. This data includes machine learning models and feature extractors required to generate the real-time predictions.

License Requirements: This feature is available with the CRM Plus license and the use case-related product’s CRM license.

Documentation: Industries Common Resources Developer Guide: AI Accelerator; Salesforce Help: AI Accelerator

Analytics

Analytics components include analytics applications, dashboards, dataflows, datasets, lenses, recipes, and user XMD.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

More Information

Analytics Dashboard

Represents a Tableau Next dashboard.

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AnalyticsDashboard; Component Type in 1GP Package Manager UI: Analytics Dashboard

License Requirements: Tableau Next Admin or Tableau Next Analyst permission sets

Documentation: For more information on Tableau Next dashboards, see Create Effective Dashboards With Tableau Next in in Salesforce Help..

Analytics Visualization

Represents a Tableau Next visualization.

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AnalyticsVisualization; Component Type in 1GP Package Manager UI: Analytics Visualization

License Requirements: Tableau Next Admin or Tableau Next Analyst permission sets

Documentation: For more information on Tableau Next visualizations, see Build Insightful Visualizations in Tableau Next in in Salesforce Help..

Analytics Workspace

Represents a Tableau Next workspace.

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AnalyticsWorkspace; Component Type in 1GP Package Manager UI: Analytics Workspace

License Requirements: Tableau Next Admin or Tableau Next Analyst permission sets

Documentation: For more information on Tableau Next workspaces, see Tableau Next Workspaces in in Salesforce Help..

Apex Class

Represents an Apex Class. An Apex class is a template or blueprint from which Apex objects are created. Classes consist of other classes, user-defined methods, variables, exception types, and static initialization code.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ApexClass; Component Type in 1GP Package Manager UI: Apex Class

Considerations When Packaging

• Any Apex that is included as part of a package must have at least 75% cumulative test coverage. Each trigger must also have some test coverage. When you upload your package to AgentExchange, all tests are run to ensure that they run without errors. In addition, all tests are run when the package is installed in the installer’s org. If any test fails, the installer can decide whether to install the package.

• Managed packages receive a unique namespace. This namespace is prepended to your class names, methods, variables, and so on, which helps prevent duplicate names in the installer’s org.

• In a single transaction, you can only reference 10 unique namespaces. For example, suppose that you have an object that executes a class in a managed package when the object is updated. Then that class updates a second object, which in turn executes a different class in a different package. Even though the first package didn’t access the second package directly, the access occurs in the same transaction. It’s therefore included in the number of namespaces accessed in a single transaction.

• If you’re exposing any methods as Web services, include detailed documentation so that subscribers can write external code that calls your Web service.

• If an Apex class references a custom label and that label has translations, explicitly package the individual languages desired to include those translations in the package.

• If you reference a custom object’s sharing object (such as MyCustomObject__share) in Apex, you add a sharing model dependency to your package. Set the default org-wide access level for the custom object to Private so other orgs can install your package successfully.

• The code contained in an Apex class, trigger, or Visualforce component that’s part of a managed package is obfuscated and can’t be viewed in an installing org. The only exceptions are methods declared as global. You can view global method signatures in an installing org. In addition, License Management Org users with the View and Debug Managed Apex permission can view their packages’ obfuscated Apex classes when logged in to subscriber orgs via the Subscriber Support Console.

• You can use the deprecated annotation in Apex to identify global methods, classes, exceptions, enums, interfaces, and variables that can’t be referenced in later releases of a managed package. So you can refactor code in managed packages as the requirements evolve. After you create another package version as Managed - Released, new subscribers that install the latest package version can’t see the deprecated elements, while the elements continue to function for existing subscribers and API integrations.

• Apex code that refers to Data Categories can’t be uploaded.

• Before deleting Visualforce pages or global Visualforce components from your package, remove all references to public Apex classes and public Visualforce components. After removing the references, upgrade your subscribers to an interim package version before you delete the page or global component.

Usage Limits

The maximum number of class and trigger code units in a deployment of Apex is 7500. For more information, see

Execution Governors and Limits in the

in the

Apex Developer Guide.

.

Documentation: Second-Generation Managed Packaging Developer Guide: Namespace-Based Visibility for Apex Classes in Second-Generation Managed Packages; First-Generation Managed Packaging Developer Guide: About API and Dynamic Apex Access in Packages; First-Generation Managed Packaging Developer Guide:Using Apex in Group and Professional Editions

Apex Sharing Reason

Represents an Apex sharing reason, which is used to indicate why sharing was implemented for a custom object.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: SharingReason; Component Type in 1GP Package Manager UI: Apex Sharing Reason

Considerations When Packaging: Apex sharing reasons can be added directly to a package, but are only available for custom objects.

Documentation: Metadata API Developer Guide: SharingReason

Apex Trigger

Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur, such as before object records are inserted into the database, or after records have been deleted.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ApexTrigger; Component Type in 1GP Package Manager UI: Apex Trigger

Documentation: Apex Developer Guide: Triggers

App Framework Template Bundle

Represents the app framework template bundle. Use these templates for Data Cloud and Tableau Next assets.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AppFrameworkTemplateBundle; Component Type in 1GP Package Manager UI: App Framework Template Bundle

Considerations When Packaging

Data Cloud and Tableau Next assets are installed in subscriber orgs via templates using the AppFrameworkTemplateBundle. The template framework supports the data sync and orchestration needed for visualization assets, along with customizations for each org.

License Requirements: Tableau Included App Manager permission set

Application Subtype Definition

Represents a subtype of an application within an application domain.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ApplicationSubtypeDefinition

Documentation: Industries Common Resources Developer Guide: AssessmentSubtypeDefinition

AssessmentConfiguration

Represents a configuration for Assessment component. An AssessmentConfiguration entry indicates configuration for user flows such as sending out emails or reminder actions on assessments initiated by the patient.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AssessmentConfiguration; Component Type in 1GP Package Manager UI: AssessmentConfiguration

Documentation: Health Cloud Developer Guide: AssessmentConfiguration

AssessmentQuestion

Represents the container object that stores the questions required for an assessment.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AssessmentQuestion

Documentation: Industries Common Resources Developer Guide: AssessmentQuestion

AssessmentQuestionSet

Represents the container object for Assessment Questions.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: AssessmentQuestionSet

Documentation: Industries Common Resources Developer Guide: AssessmentQuestionSet

Aura Component

Represents an Aura definition bundle. A bundle contains an Aura definition, such as an Aura component, and its related resources, such as a JavaScript controller. The definition can be a component, application, event, interface, or a tokens collection.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

You can build Lightning components using two programming models: the Lightning Web Components model, and the original Aura Components model.

When a package developer removes an Aura or Lightning web component from a package, the component remains in a subscriber’s org after they install the upgraded package. The administrator of the subscriber’s org can delete the component, if desired. This behavior is the same for a Lightning web component or an Aura component with a public or global access value.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Aura Component: Metadata Name: AuraDefinitionBundle; Component Type in 1GP Package Manager UI: Aura Component Bundle

Documentation: Lightning Aura Components Developer Guide

Batch Calc Job Definition

Represents a Data Processing Engine definition.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BatchCalcJobDefinition; Component Type in 1GP Package Manager UI: Batch Calculation Job Definition

Use Case

Data Processing Engine helps you transform data that's available in your Salesforce org and write back the transformation results as new or updated records. You can transform the data for standard and custom objects using Data Processing Engine definitions.

License Requirements: Either Financial Services Cloud, Manufacturing Cloud, Loyalty Management, Net Zero Cloud, or Rebate Management; Data Pipelines

Documentation: Salesforce Help: Data Processing Engine

Batch Process Job Definition

Represents the details of a Batch Management job definition.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BatchProcessJobDefinition; Component Type in 1GP Package Manager UI: Batch Process Job Definition

Use Case

Automate the processing of records in scheduled flows with Batch Management. With Batch Management, you can process a high volume of standard and custom object records.

License Requirements: Either Loyalty Management, Manufacturing Cloud, or Rebate Management; System Administrator Profile

Documentation: Salesforce Help: Batch Management

Benefit Action

Represents details of an action that can be triggered for a benefit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BenefitAction; Component Type in 1GP Package Manager UI: Benefit Action

Use Case: Benefit Actions are actions that can be triggered for a loyalty program benefit.

License Requirements: Loyalty Management permission set license

Documentation: Salesforce Help: Benefit Action

Bot Template

Represents the configuration details for a specific Einstein Bot template, including dialogs and variables.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BotTemplate; Component Type in 1GP Package Manager UI: Bot Template

Documentation: Salesforce Help: Create an Einstein Bot Template; Salesforce Help: Create a Template from an Einstein Bot; Salesforce Help: Package an Einstein Bot Template; Metadata API Developer Guide: BotTemplate

Branding Set

Represents the definition of a set of branding properties for an Experience Builder site, as defined in the Theme panel in Experience Builder.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

note: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

More Information

Feature Name: Metadata Name: BrandingSet

Relationship to Other Components

BrandingSet can’t be added to a package by itself. BrandingSet is included automatically in a package if it’s referenced by another object in the package, such as CommunityThemeDefinition, LightningExperienceTheme, or EmbeddedServiceMenuSettings.

Documentation: Salesforce Help: Use Branding Sets in Experience Builder

Briefcase Definition

Represents a briefcase definition. A briefcase makes selected records available for specific users and groups to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BriefcaseDefinition; Component Type in 1GP Package Manager UI: Briefcase Definition

Considerations When Packaging

As a best practice, package Briefcase Definition with IsActive set to false. If you package Briefcase Definition with IsActive set to true, the package installation fails if installing the package exceeds any limits.

Usage Limits

All

Briefcase Builder limits apply to a Briefcase Definition package.

apply to a Briefcase Definition package.

Relationship to Other Components

After you install the package, assign the briefcase to the application that the briefcase's data is for.

Documentation: Salesforce Help: Briefcase Builder

Building Energy Intensity Record Type Configuration

Represents the setup object that contains the mapping between the Building Energy Intensity Record record type and internal enums. You can primarily use this object for calculations across different record types.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BldgEnrgyIntensityCnfg; Component Type in 1GP Package Manager UI: Building Energy Intensity Record Type Configuration

Use Case: You can use this component to build on top of the current Net Zero Cloud data model and carbon accounting capability to create new stationary asset types for end users.

License Requirements

• Net Zero Cloud Growth license or Net Zero Cloud Starter license
• Net Zero Cloud Manager permissions set

Post Install Steps

Enable these org settings:

• Net Zero Cloud
• Manage Carbon Accounting
• Manage Building Energy Intensity

Documentation

• Salesforce Help: Set Up Record Types for Net Zero Cloud
• Salesforce Help: Benchmark Building Energy Intensity Data

Business Process

The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BusinessProcess

Use Case: You can use this component to define different picklist values that you associate with record types.

Relationship to Other Components: Record types of corresponding entities.

Documentation: Salesforce Help: Tailor Business Processes to Different Users Using Record Types

Business Process Group

Represents the surveys used to track customers’ experiences across different stages in their lifecycle.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BusinessProcessGroup; Component Type in 1GP Package Manager UI: Business Process Group

Use Case

Business Process Group lets you ship groupings relevant to survey metrics that are captured as part of any purchase or product lifecycle. For a specific business process group, you can define different stages and associate relevant questions from one or more surveys for reporting purposes.

License Requirements: This feature is available with the Feedback Management - Growth license.

Relationship to Other Components: This feature can be used in conjunction with Surveys and Survey Invitation Rules Flow types, and their corresponding dependencies.

Documentation: Metadata API Developer Guide: BusinessProcessGroup; Salesforce Help: Track Satisfaction Across a Customer's Lifecycle

Business Process Type Definition

Define the types of business processes that are applied to a rule.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: BusinessProcessTypeDefinition

Care Benefit Verify Settings

Represents the configuration settings for benefit verification requests.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CareBenefitVerifySettings; Component Type in 1GP Package Manager UI: Care Benefit Verification Settings

Use Case: Provides out-of-the-box configuration settings for benefit verification requests in Health Cloud.

License Requirements: Industries Health Cloud

Relationship to Other Components: CareBenefitVerifySettings can contain ApexClass as well as NamedCredentials.

Documentation: Health Cloud Developer Guide: CareBenefitVerifySettings

Care Limit Type

Defines the characteristics of limits on benefit provision.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CareLimitType; Component Type in 1GP Package Manager UI: Care Limit Type

Use Case: Provide the characteristics of limits on benefit provision in Health Cloud.

License Requirements: Industries Health Cloud Add On or an org with a Health Cloud Financial Data Platform license

Documentation: Health Cloud Developer Guide: CareLimitType

Care Request Configuration

Represents the details for a record type such as service request, drug request, or admission request. One or more record types can be associated with a care request.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CareRequestConfiguration; Component Type in 1GP Package Manager UI: Care Request Configuration

Use Case: Provides the details for a record type such as a service request, drug request, or admission request in Health Cloud.

License Requirements: Industries Health Cloud Add On an org with a Health Cloud Utilization Mgmt Platform license

Relationship to Other Components

Ensure that the record type specified in the Case Record Type field in CareRequestConfiguration is available in the subscriber org. Otherwise, the package must include the record type.

Documentation: Health Cloud Developer Guide: CareRequestConfiguration

Care System Field Mapping

Represents a mapping from source system fields to Salesforce target entities and attributes.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CareSystemFieldMapping; Component Type in 1GP Package Manager UI: Care System Field Mapping

Use Case: Provides an out-of-the-box mapping for an external system to Salesforce for the Care Program Enrollment or Remote Monitoring features in Health Cloud.

License Requirements: Industries Health Cloud

Documentation: Health Cloud Developer Guide: CareSystemFieldMapping

Channel Layout

Represents the metadata associated with a communication channel layout.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ChannelLayout; Component Type in 1GP Package Manager UI: Communication Channel Layout

Considerations When Packaging: ChannelLayout can only be installed in Salesforce Classic orgs with Knowledge enabled.; ChannelLayout includes the article type *__kav, which is not supported by Lightning Knowledge., which is not supported by Lightning Knowledge.; If you try to install ChannelLayout into an org with Lightning Knowledge enabled, this message is displayed: “When Lightning Knowledge is enabled, you can’t add an article type”.

License Requirements: Enable Knowledge in Salesforce Classic orgs.

Documentation: Salesforce Knowledge Developer Guide: ChannelLayout

Chatter Extension

Represents the metadata used to describe a Rich Publisher App that’s integrated with the Chatter publisher.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ChatterExtension

Documentation: Metadata API Developer Guide: ChatterExtension; Object Reference for the Salesforce Platform: ChatterExtension

Claim Financial Settings

Represents the configuration settings for Insurance Claim Financial Services.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ClaimFinancialSettings

Documentation: Salesforce Help: Claim Financial Settings

CommunicationChannelType

Represents the type of communication channel, such as WhatsApp and SMS, to use for referral promotions.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CommunicationChannelType

Use Case: Use WhatsApp as a communication channel for referral promotions.

License Requirements: Referral Marketing permission set license

Documentation: Salesforce Help: Communication Assets

Community Template Definition

Represents the definition of an Experience Builder site template.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CommunityTemplateDefinition; Component Type in 1GP Package Manager UI: Lightning Community Template

Use Case: Share or distribute your Experience Builder site templates.

License Requirements: Customize Application user permission; Create and Set Up Experiences user permission; View Setup and Configuration user permission

Relationship to Other Components: If you add CommunityTemplateDefinition to a package, you must also add CommunityThemeDefinition to the package.

Documentation: Salesforce Help: Export a Customized Experience Builder Template for a Lightning Bolt Solution; Salesforce Help: Package and Distribute a Lightning Bolt Solution

Community Theme Definition

Represents the definition of a theme for an Experience Builder site.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CommunityThemeDefinition; Component Type in 1GP Package Manager UI: Lightning Community Theme

Use Case: Share or distribute your Experience Builder site themes.

License Requirements: Customize Application user permission; Create and Set Up Experiences user permission; View Setup and Configuration user permission

Relationship to Other Components: CommunityThemeDefinition must contain a BrandingSet.; CommunityThemeDefinition can be added to a package without a CommunityTemplateDefinition, but CommunityTemplateDefinition must contain a CommunityThemeDefinition to be added to a package.

Documentation: Salesforce Help: Export a Customized Experience Builder Theme for a Lightning Bolt Solution; Salesforce Help: Package and Distribute a Lightning Bolt Solution

Compact Layout

Represents the metadata associated with a compact layout.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CompactLayout; Component Type in 1GP Package Manager UI: Compact Layout

Documentation: Metadata API Developer Guide: CompactLayout

Conditional Formatting Ruleset

Represents a set of rules that define the style and visibility of conditional field formatting on Dynamic Forms-enabled Lightning page field instances.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: UiFormatSpecificationSet; Component Type in 1GP Package Manager UI: UI Format Specification Set

Relationship to Other Components: You can only assign a conditional formatting ruleset to a field on a Dynamic Forms-enabled Lightning page..

Documentation: Salesforce Help: Conditional Field Formatting in Lightning App Builder; Metadata API Developer Guide: UiFormatSpecificationSet

Connected App

Represents a connected app configuration. A connected app enables an external application to integrate with Salesforce using APIs and standard protocols, such as SAML, OAuth, and OpenID Connect.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Context Definition

A context definition defines the relationship between the nodes and the attributes within each node. For efficient data access, users can use nodes and attributes to easily access the relevant data from the mapped data source. Various Salesforce products offer predefined context definitions based on their use case.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ContextDefinition; Component Type in 1GP Package Manager UI: Context Definition

Documentation: Industries Common Resources Developer Guide: Context Definition; Salesforce Help: Context Service

Contract Type

A contract type is used to group contracts so that they exhibit similar characteristics. For example, the lifecycle states, the people who access, the templates and clauses used.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ContractType

Use Case: Allows admin users to modify Contract Type properties.

License Requirements: CLM Admin Permission Set (CLM User PSL).

Documentation: Salesforce Contracts Developer Guide: ContractType

Conversation Channel Definition

Represents the conversation channel definition that’s implemented for Interaction Service for Bring Your Own Channel and Bring Your Own Channel for CCaaS messaging channels.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ConversationChannelDefinition; Component Type in 1GP Package Manager UI: ConversationChannelDefinition

Use Case: To enable and set up Bring Your Own Channel, integrating third-party messaging services with Salesforce.; To enable and set up Bring Your Own Channel for Contact Center as a Service (CCaaS), integrating a third party CCaaS provider with Salesforce.

License Requirements: Service Cloud license with Digital Engagement add-on license

Post Install Steps: Set up and enable Bring Your Own Channel or Bring Your Own Channel for CCaaS.

Relationship to Other Components: Linked to ConversationVendorInfo.

Documentation: Salesforce Developer Documentation: Bring Your Own Channel; Salesforce Developer Documentation: Bring Your Own Channel for CCaaS; Salesforce Help: Set Up Bring Your Own Channel; Salesforce Help: Set Up Bring Your Own Channel for CCaaS

Conversation Vendor Info

This setup object connects the partner vendor system to the Service Cloud feature.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ConversationVendorInfo; Component Type in 1GP Package Manager UI: ConversationVendorInfo

Use Case: Include information about a Service Cloud Voice implementation.

License Requirements: Enable Service Cloud Voice in your org.

Documentation: Service Cloud Voice for Partner Telephony Developer Guide: ConversationVendorInfo; Object Reference for the Salesforce Platform: ConversationVendorInfo

CORS Allowlist

Represents an origin in the CORS allowlist.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CorsWhitelistOrigin; Component Type in 1GP Package Manager UI: CORS Allowed Origin List

Use Case

Customers can add a URL pattern that includes an HTTPS protocol and a domain name. Including a port number is optional. The wildcard character (*) is supported only for the second-level domain name, for example,

https://*.example.com.

.

Documentation: Salesforce Help: Enable CORS for OAuth Endpoints; Salesforce Help: Configure Salesforce CORS Allowlist

CSP Trusted Site

Represents a trusted URL. For each CspTrustedSite component, you can specify Content Security Policy (CSP) directives and permissions policy directives.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CspTrustedSite; Component Type in 1GP Package Manager UI: CspTrustedSite

Use Case

The Lightning Component framework uses Content Security Policy (

CSP) to impose restrictions on content. The main objective of CSP is to help prevent cross-site scripting (

) to impose restrictions on content. The main objective of CSP is to help prevent cross-site scripting (

XSS) and other code injection attacks. If your package includes sites or pages that load content from an external (non-Salesforce) server or via a WebSocket connection, add the external server as a CSP trusted site. Each CSP trusted site can apply to Experience Cloud sites, Lightning Experience pages, custom Visualforce pages, or all three.

) and other code injection attacks. If your package includes sites or pages that load content from an external (non-Salesforce) server or via a WebSocket connection, add the external server as a CSP trusted site. Each CSP trusted site can apply to Experience Cloud sites, Lightning Experience pages, custom Visualforce pages, or all three.

Considerations When Packaging

When you include the CspTrustedSite component in a package, the permissions for the third-party APIs and Websocket connections apply to sites and pages across the org. Because this component modifies security, we don’t recommend including CspTrustedSite components in packages. Instead, we recommend that you instruct customers to use the CSP Trusted Sites Setup page or the CSPTrustedSites metadata API type to add the URLs to their allowlist as part of activating your package. If you choose to include CspTrustedSite components in your package, disclose this change prominently in your package documentation to ensure that your customers are aware of the security modification.

You can’t load JavaScript resources from a third-party site, even if it’s a CSP Trusted Site. To use a JavaScript library from a third-party site, add it to a static resource, and then add the static resource to your component. After the library is loaded from the static resource, you can use it as normal.

CSP isn’t enforced by all browsers. For a list of browsers that enforce CSP, see

caniuse.com.

.

Usage Limits

CspTrustedSite components are available in API version 39.0 and later. Multiple properties and enumeration values are available in later API versions. For details, see CspTrustedSite in the

Metadata API Developer Guide.

.

For Experience Builder sites, if the HTTP header size is greater than 8 KB, the directives are moved from the CSP header to the

<meta> tag. To avoid errors from infrastructure limits, ensure that the HTTP header size doesn’t exceed 3 KB per context.

tag. To avoid errors from infrastructure limits, ensure that the HTTP header size doesn’t exceed 3 KB per context.

Relationship to Other Components: This component can be used only in conjunction with an Aura or Lightning Web Runtime (LWR) page for an Experience Cloud site, a Lightning Page, or a , or a Visualforce page..

Documentation: Salesforce Help: Manage CSP Trusted Sites; Metadata API Developer Guide: CspTrustedSites

Custom Application

Represents a custom application.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomApplication

Documentation: Metadata API Developer Guide: CustomApplication

Custom Button or Link

Represents a custom link defined in a home page component.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: WebLink, CustomPageWebLink

Documentation: Salesforce Help: Custom Buttons and Links

Custom Console Components

Represents a custom console component (Visualforce page) assigned to a CustomApplication that is marked as a Salesforce console. Custom console components extend the capabilities of Salesforce console apps.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

A package that has a custom console component can only be installed in an org with the Service Cloud license or Sales Console permission enabled.

To confirm whether this component is available in managed 1GP, managed 2GP, or both package types, see Metadata Coverage Report.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomApplicationComponent; Component Type in 1GP Package Manager UI: Custom Console Component

Documentation: Metadata API Developer Guide: CustomApplicationComponent; Salesforce Help: Create Console Components in Salesforce Classic

Custom Field on Standard or Custom Object

Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard or custom objects.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

• Developers can add required and universally required custom fields to managed packages as long as they have default values.
• Auto-number type fields and required fields can’t be added after the object is included in a Managed - Released package.
• Subscriber orgs can’t install roll-up summary fields that summarize detail fields set to protected.

Custom Field on Custom Metadata Type

Represents a custom fields on the custom metadata type.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Custom Field Display

Represents the CustomFieldDisplay view type assigned to product attribute custom fields.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomFieldDisplay

License Requirements: A B2B Commerce or D2C Commerce license and access to Commerce objects is required.

Documentation: Salesforce Help: Create Attributes for Product Variations in Commerce Cloud

Custom Help Menu Section

Represents the section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources for the org. The custom section contains help resources added by the admin.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

More Information

Feature Name: Metadata Name: CustomHelpMenuSection

Documentation: Metadata API Developer Guide: CustomHelpMenuSection

Custom Index

Represents an index used to increase the speed of queries.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

More Information

Feature Name: Metadata Name: CustomIndex; Component Type in 1GP Package Manager UI: Custom Index

Considerations When Packaging: Subscribers can remove the custom index using Metadata API only.

Documentation: Best Practices for Deployments with Large Data Volumes: Indexes

Custom Label

The CustomLabels metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomLabels

Considerations When Packaging

If a label is translated, the language must be explicitly included in the package for the translations to be included in the package. Subscribers can override the default translation for a custom label.

This component can be marked as protected. For more details, see

Protected Components in the

in the

First-Generation Managed Packaging Developer Guide.

.

Documentation: Metadata API Developer Guide: CustomLabels

Custom Metadata Type Records

Represents a record of a custom metadata type.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

More Information

Feature Name: Metadata Name: CustomObject

This component can be marked as protected. For more details, see Protected Components in the First-Generation Managed Packaging Developer Guide.

Usage Limits

Deprecated custom metadata type records count against the subscriber’s org limit. When removing custom metadata type records from a second-generation managed package, encourage subscribers to delete the deprecated records from their org. If the subscriber org reaches their org limit for custom metadata type records, package upgrades that include new custom metadata type records fail. For details see

Custom Metadata and Allocations and Usage Calculations in

in

Salesforce Help.

.

Documentation: Salesforce Help: Package Custom Metadata Types and Records

Custom Metadata Type

Represents a record of a custom metadata type.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

More Information

Second-generation managed packages (2GP) include the fields and records for custom metadata types that you add. You can’t add fields directly to an existing package after the package version is promoted. If you create multiple packages that share a namespace, then layouts and records can be in separate packages. Custom fields on the custom metadata type must be in the same package.

You can add fields to a custom metadata type by publishing an extension to the existing package, creating an entity relationship field, and mapping the field to the custom metadata type in your extension. See Add Custom Metadata Type Fields to Existing Packages.

This component can be marked as protected. For more details, see Protected Components in the First-Generation Managed Packaging Developer Guide.

Custom Notification Type

Represents the metadata associated with a custom notification type.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomNotificationType; Component Type in 1GP Package Manager UI: Custom Notification Type

License Requirements: Database.com editions don’t have permission to access this component.

Usage Limits

You can package up to 500 custom notification types, but keep in mind that subscriber orgs are limited to a total of 500 custom notification types. The subscriber org limit is shared across namespaces.

A subscriber org can execute up to 10,000 notification actions per hour.

Documentation: Salesforce Help: Create and Send Custom Desktop or Mobile Notifications; Salesforce Help: Considerations for Processes that Send Custom Notifications

Custom Object

Represents a custom object that stores data unique to an org or an external object that maps to data stored outside an org.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomObject; Component Type in 1GP Package Manager UI: Custom Object

Considerations When Packaging

If a developer enables the Allow Reports or Allow Activities attributes on a packaged custom object, the subscriber’s org also has these features enabled during a package upgrade. After it’s enabled in a Managed - Released package, the developer and the subscriber can’t disable these attributes.

Standard button and link overrides are also packageable.

In your extension package, if you want to access history information for custom objects contained in the base package, work with the base package owner to:

1. Enable history tracking in the release org of the base package.
2. Create a new version of the base package.
3. Install the new version of the base package in the release org of the extension package to access the history tracking info.

As a best practice, don’t enable history tracking for custom objects contained in the base package directly in the extension package’s release org. Doing so can result in an error when you install the package and when you create patch orgs for the extension package.

This component can be marked as protected. For more details, see

This component can be marked as protected. For more details, see

Protected Components and

and

Hide Custom Objects and Custom Permissions in Your Subscribers’ Orgs in the

in the

First-Generation Managed Packaging Developer Guide.

.

Documentation: Metadata API Developer Guide: CustomObject

Custom Object Translation

This metadata type allows you to translate custom objects for a variety of languages.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomObjectTranslation

Relationship to Other Components

When you create a first-generation managed package and add the

Translation component, the Custom Object Translation component is automatically added to your package.

component, the Custom Object Translation component is automatically added to your package.

When you create a second-generation managed package, you must add Custom Object Translation to your package, even if you've already added the Translation component.

Documentation: Metadata API Developer Guide: CustomObjectTranslation

Custom Permission

Represents a permission that grants access to a custom feature.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomPermission; Component Type in 1GP Package Manager UI: Custom Permission

Considerations When Packaging

If you deploy a change set with a custom permission that includes a connected app, the connected app must already be installed in the destination org.

This component can be marked as protected. For more details, see

Protected Components and

and

Hide Custom Objects and Custom Permissions in Your Subscribers’ Orgs in the

in the

First-Generation Managed Packaging Developer Guide.

.

Documentation: Metadata API Developer Guide: CustomPermission

Custom Tab

Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: CustomTab

Considerations When Packaging

• The tab style for a custom tab must be unique within your app. However, it doesn’t have to be unique within the org where it’s installed. A custom tab style doesn’t conflict with an existing custom tab in the installer’s environment.
• To provide custom tab names in different languages, from Setup, in the Quick Find box, enter Rename Tabs and Labels, then select Rename Tabs and Labels.

Documentation: Metadata API Developer Guide: CustomTab

Dashboard

Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: Dashboard; Type in 1GP Package Manager UI: Dashboard

Considerations When Packaging

Developers of managed packages must consider the implications of introducing dashboard components that reference reports released in a previous version of the package. If the subscriber deleted the report or moved the report to a personal folder, the dashboard component referencing the report is dropped during the installation. Also, if the subscriber has modified the report, the report results can impact what displays in the dashboard component. As a best practice, release a dashboard and the related reports in the same version.

Documentation: Metadata API Developer Guide: Dashboard

DataCalcInsightTemplate

Represents the object template for data calculations and insights of Data Cloud objects in DataCalcInsightTemplate. These objects are added inside the data kit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataCalcInsightTemplate; Component Type in 1GP Package Manager UI: Calculated Insight Template

Use Case: DataCalcInsightTemplate represents the data calculations and insights for objects of a Data Cloud schema field the user includes in a data kit.

Considerations When Packaging

A Data Cloud feature is always packaged via a data kit. A calculated insight template is added to a package when you add a data calculation and insight into a data kit, and package that data kit. You can’t directly add this component to a package.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy the features from the installed data kit.

Documentation: Metadata API Developer Guide: Calculated Insight Template; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

DataCleanRoomProvider

Represents a clean room provider configuration that defines the clean room collaboration details, including templates and the platform used for secure data collaboration in Data 360.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataCleanRoomProvider; Component Type in 2GP Package Manager UI: Data Kit Package Definition

Use Case

Clean room providers (Partners and ISVs) include DataCleanRoomProvider in a DataKit which can be added to a managed package to offer clean room collaboration templates to consumers via AgentExchange. Consumers install the package to initiate a collaboration with the provider using pre-defined use case templates.

Considerations When Packaging

• Providers need a Data Cloud Developer edition org to create and publish a clean room package.
• The package name must be unique. The UI may not display a clear error for duplicate package names. If you encounter an issue, check your browser’s Network tab for the specific conflict error.
• The provider logo URL must be a publicly accessible URL in an appropriate image format (such as .png). If the URL is not accessible externally, the UI falls back to a standard icon on the Collaboration Summary screen for consumers.
• Data 360 clean rooms don't support cross-geo collaboration (for example, AMER to APAC or EMEA is not supported). Cross-region collaboration within the same geo is supported.
• This feature is not available in Government Cloud.

License Requirements

Clean room providers need a Data Cloud license and a Developer edition to create the package. Clean room consumers require a Data Cloud license to install and deploy the package.

Post Install Steps

After installing a package that contains DataCleanRoomProvider, the consumer must manually deploy the data kit components in Data Cloud Setup. See

Deploy a Clean Room from an AgentExchange Package.

.

Relationship to Other Components

To include DataCleanRoomProvider in a managed package, you must add the component to a data kit (DataPackageKitDefinition). Then, add the DataPackageKitDefinition to the managed package. DataCleanRoomProvider requires Data Cloud to Data Cloud (DC to DC) sharing. Providers and consumers using Data 360 must have DC to DC sharing configured.

Documentation: Salesforce Help: Clean Rooms; Salesforce Help: How a Data 360 Clean Room Works; Salesforce Help: Create a Clean Room Package; Salesforce Help: Publish a Clean Room Package to AgentExchange; Salesforce Help: Deploy a Clean Room from an AgentExchange Package

DataConnector

Represents the white-labeled metadata configuration for an external connector in Data 360.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: IntegArtifactDef; Component Type in 1GP Package Manager UI: MktDataConnection is the Connector parent type

Use Case

ISV partners can build, package, and distribute custom Data 360 connectors, which extend existing native Data 360 Connector Framework (DCF) connectors via AgentExchange. Partners configure the connector metadata, icon, and localization, then package it as a data kit in a 2GP or 1GP managed package. Customers see the connector in the Data 360 new stream page with a "partner built" indicator.

Considerations When Packaging

• No automatic spidering in 2GP; ISVs must manually include all related components.
• One version per connector name per package. Minor or patch versions are upgrades in-place.
• Major version changes require a new connector name (e.g., AsanaV2).
• Connection credentials are excluded (subscriber must supply post-install).
• PACKAGING_DISABLED capability exists. isGlobal=true must be set.

License Requirements: Data 360 must be provisioned in the subscriber org.

Usage Limits: The number of connections per connector type can be up to 200.

Post Install Steps

Connection will be INACTIVE post-install. To activate, the subscriber admin must supply the credentials or authenticate, and then manually activate the connection.

Relationship to Other Components

Not a requirement but DataConnector should be used with data stream and activation components. A connector package is typically bundled inside a data kit. If packaging with a flow or data stream, all dependent metadata (for example, the connection or Named Credentials) must be explicitly included.

Documentation: Developer Guide: Data 360 Connectors and Integrations

Data Connector Ingest API

Represents the connection information specific to Ingestion API.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataConnectorIngestApi; Component Type in 1GP Package Manager UI: Adding DataStreamDefinition brings in DataConnectorIngestApi for Ingestion API DataStreams.

Use Case: This component is part of the Ingestion API Data stream metadata that is packaged and installed in subscriber.

License Requirements: You need Customer 360 Audiences Corporate (cdpPsl) licenses on both package developer org and subscriber org.

Post Install Steps: User has to create DataStream via ui-api or using the Data Cloud App.

Documentation: Salesforce Help: Ingestion API

Data Connector S3

Represents the connection information specific to Amazon S3.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataConnectorS3

Use Case: This includes the bucket details for the S3 connector in Data Cloud.

Considerations When Packaging

To package this component, first add it to a data kit. For more information about data kits, see

Data Kits in

in

Salesforce Help.

.

Credentials are encrypted and need “IsDevInternal” permission for the encryption service.

License Requirements: You need Customer 360 Audiences Corporate (cdpPsl) licenses on both package developer org and subscriber org.

Post Install Steps: User has to create DataStream via ui-api or using the Data Cloud App.

Documentation: Salesforce Help:Data Connector S3

Data Kit Object Dependency

Represent the object dependencies and relationships between different objects in Data Kit Object Dependency. These objects are added inside the data kit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataKitObjectDependency; Component Type in 1GP Package Manager UI: Data Kit Object Dependency

Use Case: DataKitObjectDependency represents the relationship of objects of a Data Cloud schema field the user includes in a data kit.

Considerations When Packaging

A Data Cloud feature is always packaged via a data kit. You add the external data transport field template to a data kit and then add that data kit to a package. You can’t directly add this component to a package.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy the features from the installed data kit.

Documentation: Metadata API Developer Guide: Data Kit Object Dependency; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

Data Kit Object Template

Represents the object in Data Kit Object Template. This object template is added inside the data kit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataKitObjectTemplate; Component Type in 1GP Package Manager UI: Data Kit Object Dependency

Use Case: DataKitObjectTemplate represents the objects the user includes in a data kit.

Considerations When Packaging

A Data Cloud feature is always packaged via a data kit. You add the external data transport field template to a data kit, and then add that data kit to a package. You can’t directly add this component to a package.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy the features from the installed data kit.

Documentation: Metadata API Developer Guide: Data Kit Object Template; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

DataObjectBuildOrgTemplate

Represents the output objects of the components the user includes in a data kit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataObjectBuildOrgTemplate; Component Type in 1GP Package Manager UI: DataObjectBuildOrgTemplate

Use Case

Supports extension packages that reference the output of any object.

Considerations When Packaging

A Data Cloud feature is always packaged via a data kit. You add the data object build org template to a data kit, and then add that data kit to a package. You can’t directly add this component to a package.

License Requirements

For more information, see Data Cloud Standard Permission Sets in Salesforce Help.

Post Install Steps

After you install a package that contains a data kit, you must manually deploy the features from the installed data kit.

Documentation: Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

Data Package Kit Definition

Represents the top-level Data Kit container definition. Content objects can be added after the Data Kit is defined.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataPackageKitDefinition; Component Type in 1GP Package Manager UI: Data Package Kit Definition

Use Case

Represents the top-level data kit container definition. Content objects can be added after the data kit is defined.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy features from the installed data kit.

Documentation: Metadata API Developer Guide: DataPackageKitDefinition; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

Data Package Kit Object

Represents the object in Data Kit Content Object. These objects are added inside the data kit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataPackageKitObject; Component Type in 1GP Package Manager UI: Data Package Kit Object

Use Case: Represents an object in a data kit.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy features from the installed data kit.

Documentation: Metadata API Developer Guide: DataPackageKitObject; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

Data Source

Used to represent the system where the data was sourced.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataSource

Use Case: DataSource gives the lineage information of the datastream.

License Requirements: You need Customer 360 Audiences Corporate (cdpPsl) licenses on both package developer org and subscriber org.

Post Install Steps: Create DataStream using ui-api or the Data Cloud App.

Relationship to Other Components

This isn't a top-level entity. AddDataStreamDefinition or DataKitDefinition to pick up DataSource.

Documentation: Salesforce Help: Connection Tasks in Data Cloud

Data Source Bundle Definition

Represents the bundle of streams that a user adds to a data kit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataSourceBundleDefinition; Component Type in 1GP Package Manager UI: Data Source Bundle Definition

Use Case: Represents the data stream data sources that a user adds to a data kit.

Considerations When Packaging

Any Data Cloud feature is always packaged via a data kit. A data source bundle definition is added to a package when you add a data stream to a data kit and package that data kit. You can’t directly add this component to a package.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy features from the installed data kit.

Documentation: Metadata API Developer Guide: DataSourceBundleDefinition; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

Data Source Object

Represents the object from where the data was sourced.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataSourceObject

Use Case: DataSourceObject contains specific information about the source of the data like filename, table names.

Considerations When Packaging: DataSourceObject pulls in child DataSourceField entity records when packaged with DataKitDefinition.

License Requirements: Customer 360 Audiences Corporate (cdpPsl) licenses must be available on both package developer org and subscriber org.

Post Install Steps: Create a DataStream via ui-api or using the Data Cloud App.

Relationship to Other Components

This isn’t a top-level entity. Add DataStreamDefinition or DataKitDefinition to pick up DataSourceObject.

Documentation: Salesforce Help: Connection Tasks in Data Cloud

Data Src Data Model Field Map

Represents the entity that’s used to store the design-time bundle-level mappings for the data source fields and data model fields.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataSrcDataModelFieldMap; Component Type in 1GP Package Manager UI: Data Source Data Model Field Mapping

Use Case: Represents the entity that contains design-time bundle-level mappings for the data source fields and data model fields.

Considerations When Packaging

Any Data Cloud feature is always packaged via a data kit. Data model field mappings are added to a package when you add a data stream and any associated mappings to a data kit and package that data kit. You can’t directly add this component to a package.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy features from the installed data kit.

Documentation: Metadata API Developer Guide: DataSrcDataModelFieldMap; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

Data Stream Definition

Contains Data Ingestion information such as Connection, API and File retrieval settings.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataStreamDefinition; Component Type in 1GP Package Manager UI: DataStreamDefinition

Use Case

DataStreamDefinition is the starting point for packaging a Datastream and its mappings.

Considerations When Packaging

Data Cloud admin user can install or upgrade the package. Admin User or Data Aware Specialist User can create Datastreams out of the installed package.

License Requirements

Customer 360 Audiences Corporate (cdpPsl) licenses must be available on both package developer org and subscriber org. CDP Admin User can install,upgrade, or uninstall the package.

Post Install Steps

Create the DataStream via ui-api or using the Data Cloud App.

Documentation: Metadata API Developer Guide: DataStreamDefinition

Data Stream Template

Represents the data stream that a user adds to a data kit.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataStreamTemplate; Component Type in 1GP Package Manager UI: Data Stream Template

Use Case: Represents the data stream that a user adds to a data kit.

Considerations When Packaging

Any Data Cloud feature is always packaged via a data kit. A data stream template is added to a package when you add a data stream to a data kit and package that data kit. You can’t directly add this component to a package.

License Requirements

For more information, see

Data Cloud Standard Permission Sets in Salesforce Help.

in Salesforce Help.

Post Install Steps: After you install a package that contains a data kit, you must manually deploy features from the installed data kit.

Documentation: Metadata API Developer Guide: DataStreamTemplate; Data Cloud Developer Guide: Packages and Data Kits; Salesforce Help: Packaging in Data Cloud

DataWeaveResource

Represents the DataWeaveScriptResource class that is generated for all DataWeave scripts. DataWeave scripts can be directly invoked from Apex.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DataWeaveResource; Component Type in 1GP Package Manager UI: DataWeaveResource

Use Case: Include MuleSoft DataWeave scripts to read and parse data from one format, transform it, and export it in a different format directly from Apex.

Considerations When Packaging: There’s a maximum of 50 DataWeave scripts per org.

Documentation: Apex Developer Guide: DataWeave in Apex..

Decision Matrix Definition

Represents a definition of a decision matrix.

note: 2GP support for Business Rules Engine Components is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DecisionMatrixDefinition; Component Type in 1GP Package Manager UI: Decision Matrix Definition

Use Case

Decision matrices are lookup tables that match input values to a matrix row and return the row’s output values. Expression sets and various digital procedures can call decision matrices. Decision matrices accept JSON input from, and return JSON output to the digital processes that call the matrices. Decision matrices are useful for implementing complex rules in a systematic, readable manner.

Documentation: Industries Common Resources Developer Guide: Decision Matrix Definition; Salesforce Help: Decision Matrices; Salesforce Help: Decision Matrix Migration Considerations

Decision Matrix Definition Version

Represents a definition of a decision matrix version.

note: 2GP support for Business Rules Engine Components is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DecisionMatrixDefinitionVersion; Component Type in 1GP Package Manager UI: Decision Matrix Definition Version

Post Install Steps

After migrating a decision matrix version, upload the row data to the active version manually. The row data isn’t migrated as part of the migration.

Relationship to Other Components: A DecisionMatrixDefinitionVersion is a child of DecisionMatrixDefinition, and can’t exist without the parent DecisionMatrixDefinition.

Documentation: Industries Common Resources Developer Guide: Decision Matrix Definition; Salesforce Help: Decision Matrices; Salesforce Help: Decision Matrix Migration Considerations

Decision Table

Represents the information about a decision table.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DecisionTable; Component Type in 1GP Package Manager UI: Decision Table

Use Case: Decision tables read business rules and decide the outcome for records in your Salesforce org or for the values that you specify.

License Requirements: Either Loyalty Management or Rebate Management

Documentation: Salesforce Help: Decision Tables

Decision Table Dataset Link

Represents the information about a dataset link associated with a decision table. In a dataset link, select an object for whose records, the decision table must provide an outcome.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DecisionTableDatasetLink

Use Case: In a dataset link, you can map the decision table’s input fields with fields of different standard or custom objects.

License Requirements: Either Loyalty Management or Rebate Management

Documentation: Salesforce Help: Add Dataset Links to a Decision Table

Digital Experience

Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DigitalExperience

Use Case: To move Digital Experience metadata Content from one org to another

Post Install Steps: After the package is installed, publish the site to make it available to customers.

Documentation: Salesforce Help: CMS Content

Digital Experience Bundle

Represents a text-based code structure of your organization’s workspaces, organized by workspace type, and each workspace’s content items.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DigitalExperienceBundle

Use Case

Share or distribute the content of an enhanced workspace in Salesforce CMS, including images, documents, and news articles. In Marketing Cloud, you can package the content of general and marketing workspaces, including landing pages, forms, and emails (and their associated images and branding).

Considerations When Packaging

Enhanced LWR sites are unsupported.

In marketing workspaces, the default data graph, personalization recommenders, personalization points, and decisions aren't included in the bundle. If the workspace includes emails with personalized content that’s based on these objects, then:

• Any merge field or repeater that uses the default data graph or a personalization recommender from the source org is broken in the target org.
• Any dynamic content variations of email components are removed and only the default variations appear in the email.

Post Install Steps: After the package is installed, publish the workspace content to make it available to customers.

Documentation: Salesforce Help: Salesforce CMS; Salesforce Help: Marketing Cloud; Metadata API Developer Guide: DigitalExperienceBundle

Disclosure Definition

Represents information that defines a disclosure type, such as details of the publisher or vendor who created or implemented the report.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DisclosureDefinition; Component Type in 1GP Package Manager UI: Disclosure Definition

Use Case: You can use this component to define a disclosure type, such as details of the publisher or vendor who created or implemented the report.

License Requirements

• Net Zero Cloud Growth license
• Disclosure and Compliance Hub permission set license
• Disclosure and Compliance Hub User permission set

Post Install Steps

Enable these org settings:

• Manage Disclosure and Compliance Hub

Documentation

• Salesforce Help: Disclosure and Compliance Hub
• Salesforce Help: Generate Disclosures Using Disclosure and Compliance Hub
• Metadata API Developer Guide:DisclosureDefinition

Disclosure Definition Version

Represents the version information about the disclosure definition.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DisclosureDefinitionVersion; Component Type in 1GP Package Manager UI: Disclosure Definition Version

Use Case: You can use this component to define the version information about the disclosure definition.

License Requirements

• Net Zero Cloud Growth license
• Disclosure and Compliance Hub permission set license
• Disclosure and Compliance Hub User permission set

Post Install Steps

Enable these org settings:

• Manage Disclosure and Compliance Hub

Documentation

• Salesforce Help: Disclosure and Compliance Hub
• Salesforce Help: Generate Disclosures Using Disclosure and Compliance Hub
• Metadata API Developer Guide:DisclosureDefinitionVersion

Disclosure Type

Represents the types of disclosures that are done by an individual or an organization and the associated metadata.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DisclosureType; Component Type in 1GP Package Manager UI: Disclosure Type

Use Case: You can use this component to create types of disclosures that are done by an individual or an organization.

License Requirements

• Net Zero Cloud Growth license
• Disclosure and Compliance Hub permission set license
• Disclosure and Compliance Hub User permission set

Post Install Steps

Enable these org settings:

• Manage Disclosure and Compliance Hub

Documentation

• Salesforce Help: Disclosure and Compliance Hub
• Salesforce Help: Generate Disclosures Using Disclosure and Compliance Hub
• Metadata API Developer Guide:DisclosureType

Discovery AI Model

Represents the metadata associated with a model used in Einstein Discovery.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DiscoveryAIModel

Documentation: Metadata API Developer Guide: DiscoveryAIModel

Discovery Goal

Represents the metadata associated with an Einstein Discovery prediction definition.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DiscoveryGoal

Documentation: Metadata API Developer Guide: DiscoveryGoal

Discovery Story

Represents the metadata associated with a story used in Einstein Discovery.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DiscoveryStory

Documentation: Metadata API Developer Guide: DiscoveryStory

Document

Represents a Document. All documents must be in a document folder, such as sampleFolder/TestDocument.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

For more details on 2GP component removal, see Remove Metadata Components from Second-Generation Managed Packages.

More Information

Feature Name: Metadata Name: Document; Component Type in 1GP Package Manager UI: Document

Documentation: Metadata API Developer Guide: Document

Document Generation Setting

Represents an org's settings for automatic document generation from templates.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: DocumentGenerationSetting

Use Case: Allows admin users to modify document generation properties.

License Requirements: DocGen Designer (Permission Set License)

Documentation: Metadata API Developer Guide: DocumentGenerationSetting

Eclair GeoData

Represents an Analytics custom map chart. Custom maps are user-defined maps that are uploaded to Analytics and are used just as standard maps are. Custom maps are accessed in Analytics from the list of maps available with the map chart type.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EclairGeoData

Documentation: Metadata API Developer Guide: EclairGeoData

Email Template (Classic)

Use email templates to increase productivity and ensure consistent messaging. Email templates with merge fields let you quickly send emails that include field data from Salesforce records.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

Email Template (Lightning)

Represents a template for an email, mass email, list email, or Sales Engagement email.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

These packaging considerations apply to Lightning email templates, including email templates created in Email Template Builder.

• For email templates created in Email Template Builder before the Spring ’21 release, attachments aren’t automatically added to the package. Open and resave these templates to turn the attachments into content assets, which are then automatically added to the package.

• Enhanced email template folders have these behaviors:

  • If a package includes an enhanced email template folder, the target organization must have enhanced folders enabled for the deploy to succeed.
  • If an email template is in a subfolder, adding the root folder to a package doesn’t automatically add the email template to the package. If the email template is in the root folder, it’s automatically added to the package.
  • You can’t package an email template in the default public and private folders.

• For merge fields based on custom fields that are used in the Recipients prefix (for leads and contacts), we add references to those merge fields. If the custom field is renamed, the reference in the template isn’t updated. Edit the custom merge field to use the new field name and update the reference.

note: An email template created in Email Template Builder can’t be edited after it’s downloaded. To edit the template, clone it.

When upgrading a package that has Email Template Builder email templates, only the associated FlexiPage is updated. After downloading the new version of the template, clone it to see the changes.

Embedded Service Config

Represents a setup node for creating an Embedded Service for Web deployment.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EmbeddedServiceConfig

Documentation: Metadata API Developer Guide: EmbeddedServiceConfig; Salesforce Help: Embedded Chat

Embedded Service Menu Settings

Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EmbeddedServiceMenuSettings

Documentation: Metadata API Developer Guide: EmbeddedServiceMenuSettings; Salesforce Help: Channel Menu Setup

Enablement Measure Definition

Represents an Enablement measure, which specifies the job-related activity that a user performs to complete a milestone or outcome in an Enablement program. A measure identifies a source object and optional related objects, with optional field filters and filter logic, for tracking the activity.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EnablementMeasureDefinition

Use Case

Include this component in a package with a program if the program has outcomes or milestones.

Considerations When Packaging: See Considerations for Packaging Enablement Programs and Dependencies..

License Requirements

Enablement add-on license and the Enablement permission set license are required. For Partner Enablement programs in supported Experience Cloud sites, a

supported Partner Relationship Management (PRM) add-on license is also required.

is also required.

Usage Limits: See Enablement Limits..

Relationship to Other Components

An Enablement measure is used within an Enablement program. Package the Enablement Measure Definition component with the Enablement Program Definition component. Or, package the Enablement Measure Definition component separately. Each measure references a source object and optional related objects.

Documentation

• Salesforce Help: Sales Programs and Partner Tracks with Enablement
• Metadata API Developer Guide: EnablementMeasureDefinition
• Sales Programs and Partner Tracks with Enablement Developer Guide: Create a Managed Package for Enablement Programs, Measures, and Content

Enablement Program Definition

Represents an Enablement program, which includes exercises and measurable milestones to help users such as sales reps achieve specific outcomes related to your company’s revenue goals.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EnablementProgramDefinition

Use Case

Include this component in a package when you want to move a program from one org to another.

Considerations When Packaging: See Considerations for Packaging Enablement Programs and Dependencies..

License Requirements

Enablement add-on license and the Enablement permission set license are required. For Partner Enablement programs in supported Experience Cloud sites, a

supported Partner Relationship Management (PRM) add-on license is also required.

is also required.

Usage Limits: See Enablement Limits..

Relationship to Other Components

An Enablement program can contain other items that are related to other packageable components. Package the Enablement Program Definition component with other appropriate components.

• Exercises that reference Digital Experiences content. Package the Digital Experience component.
• Exercises that reference assessment surveys. Package the Flow component.
• Custom exercise types that reference user-defined content. Package the Learning Item Type and Enablement Program Task Subcategory components.
• Measures that track job-related activity using specific objects. Package the Enablement Measure Definition component.

Documentation

• Salesforce Help: Sales Programs and Partner Tracks with Enablement
• Metadata API Developer Guide: EnablementMeasureDefinition
• Sales Programs and Partner Tracks with Enablement Developer Guide: Create a Managed Package for Enablement Programs, Measures, and Content

Enablement Program Task Subcategory

Represents a custom exercise type that an Enablement admin adds to an Enablement program in Program Builder. A custom exercise type also requires a corresponding EnblProgramTaskDefinition record for Program Builder and corresponding LearningItem and LearningItemType records for when users take the exercise in the Guidance Center.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EnblProgramTaskSubCategory

Use Case

Include this component in a package with a program if the program has a custom exercise type.

Considerations When Packaging: See Considerations for Packaging Enablement Programs and Dependencies..

License Requirements

Enablement add-on license and the Enablement permission set license are required.

important: Custom exercises aren’t compatible with Partner Enablement programs.

Usage Limits: See Enablement Limits..

Relationship to Other Components

The Enablement Program Task Subcategory component requires a corresponding Learning Item Type component. Both components are used with custom exercise types in Enablement programs. Package both of these components with an Enablement Program Definition component.

Documentation

• Salesforce Help: Sales Programs and Partner Tracks with Enablement
• Metadata API Developer Guide: EnblProgramTaskSubCategory
• Metadata API Developer Guide: LearningItemType
• Object Reference for the Salesforce Platform: EnblProgramTaskDefinition
• Object Reference for the Salesforce Platform: LearningItem
• Sales Programs and Partner Tracks with Enablement Developer Guide: Create a Managed Package for Enablement Programs, Measures, and Content
• Sales Programs and Partner Tracks with Enablement Developer Guide: Implement Custom Exercise Types for Enablement Programs

Entitlement Template

Represents an entitlement template. Entitlement templates are predefined terms of customer support that you can quickly add to products.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EntitlementTemplate

Documentation: Metadata API Developer Guide: EntitlementTemplate; Salesforce Help: Set Up an Entitlement Template

ESignature Config

Using the Electronic Signature Configuration setup, the system admin must define the required configurations to support the e-signature APIs and UI.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ESignatureConfig

Use Case: Allows users to get the electronic signatures on their documents.

License Requirements: DocGen Designer (Permission Set License)

ESignature Envelope Config

Using the Electronic Signature Envelope Config the system admin can define the default reminders and expiry for the envelopes submitted for eSignature.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ESignatureEnvelopeConfig

Use Case: Allows users to get the electronic signatures and notifications on their documents.

License Requirements: DocGen Designer (Permission Set License)

Documentation: Metadata API Developer Guide: ESignatureEnvelopeConfig

Event Relay

Represents an event relay that you can use to send platform events and change data capture events from Salesforce to Amazon EventBridge.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: EventRelayConfig; Component Type in 1GP Package Manager UI: Event Relay

Documentation: Metadata API Developer Guide: EventRelayConfig

Explainability Action Definition

Define where the metadata for your Decision Explainer business rules are stored in Public Sector Solutions.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.

More Information

Feature Name: Metadata Name: ExplainabilityActionDefinition

Explainability Action Version

Define and store versions of the explainability actions used by your Decision Explainer business rules in Public Sector Solutions.

Component Manageability Rules

Manageability rules determine whether you, or the subscriber, can edit or remove components after the package version is created and promoted to the released state.

note: When a package developer removes this component from a package, the component remains in a subscriber’s org after they install the upgraded package. The admin of the subscriber’s org can then delete the component, if desired.

Removing components from managed 1GP or 2GP packages requires approval from Salesforce. To request access to the component removal feature, log a support case in the Salesforce Partner Community.

Editable Properties

Certain properties on metadata components are editable after the managed package is installed.