Second-Generation Managed Packaging Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Components Available in Second-Generation Managed Packages
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.
| Component Can Be Updated During Package Upgrade |
If yes: The component can be updated during a package upgrade. The
component is first deployed to the subscriber org during the initial package
installation, and subsequent package upgrades update the installed component. If no: The component can’t be updated during package upgrades. Instead, it’s only deployed to the subscriber org during the initial package installation, and subsequent package upgrades don’t update the component. Components in this category can typically be modified by the admin in the subscriber org. |
| Subscriber Can Delete Component |
If yes: The subscriber or installer of the managed package can delete the
packaged component from their org. Deleted components aren’t reinstalled during a
package upgrade. If no: The subscriber or installer of the managed package can’t delete the packaged component from their org. |
| Package Developer Can Remove Component |
If yes: After the package that contains the component is promoted and
released, the package developer can choose to remove the component in a future package
version. In most cases, removing components from a package version marks the component as deprecated, and doesn’t hard delete the component from the subscriber org. These deprecated components can be deleted by the admin of the subscriber org. For details about which managed 2GP components are deprecated, see Remove Metadata Components from Second-Generation Managed Packages. To request access to this feature, log a support case in the Salesforce Partner Community. If no: After the package that contains the component is promoted and released, the package developer can’t remove the component in a future package version. |
| Component Has IP Protection |
If yes: To protect the intellectual property of the developer, the
component’s metadata, such as Apex code or Custom Metadata record information, is
hidden in the installed org. If no: The component is visible in the subscriber’s org. |
Editable Properties After Package Promotion or Installation
Certain properties on metadata components are editable after the managed package is installed.
- Only Package Developer Can Edit: The package developer can edit specific component properties. These properties are locked in the subscriber’s org. During package upgrade, the changes made by the package developer are applied in the subscriber org. For example, when you update the code in an Apex class or the custom permissions in a permission set, subscribers receive those updates during their package upgrade.
- Both Subscriber and Package Developer Can Edit: Both the subscriber and package developer can edit these component properties, but developer changes are only applied to new subscriber installs. This approach prevents a package upgrade from overwriting changes made by the subscriber. For example, the help text on a custom field, and the page layout of a custom object are editable by both the subscriber and package developer. The subscriber can modify the page layout or help text, and trust that their changes won’t be overwritten by a future package upgrade.
- Neither Subscriber or Package Developer Can Edit: After a package is promoted and released, these component properties are locked and can’t be edited by the package developer or the subscriber. For example, the API names of packaged components are locked and can’t be edited after the package version is promoted and released.
Supported Components in Second-Generation Managed Packages
Action Link Group 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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes. Supported in both 1GP and 2GP packages. |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
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
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.
| Packageable In: | First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
More Information
- Feature Name
- Metadata Name: ActionPlanTemplate
- Documentation
- Salesforce Help: Action Plans
Actionable List 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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes. Supported in both 1GP and 2GP packages. |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | Yes |
| Package Developer Can Remove Component From Package | Yes, Supported in both 1GP and 2GP packages. |
| Component Has IP Protection | No |
To confirm whether this component is available in managed 1GP, managed 2GP, or both package types, see Metadata Coverage Report.
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 After Package Promotion or Installation
- All attributes
- All attributes
- None
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
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.
| Packageable In: | First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- DataConnector
- Description
- LogoUrl
- MasterLabel
- OutputFormat
- RefreshMode
- Type
- Enabled (only subscriber editable)
- IncludeSegmentNames (only subscriber editable)
- ID
- OutputGrouping
- PeriodicRefreshFrequency
- RefreshFrequency
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 AppExchange 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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- Type
- Status
- ExternalId
- MlExternalId
- Name
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- AIApplicationId
- Rank
-
IsInsightReasonEnabled
- IsInsightReasonEnabled
- AIScoringMode
- ExternalId
- Name
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- All the AIUsecaseDefinition fields
- None
- None
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
Component Manageability Rules
Analytics components include analytics applications, dashboards, dataflows, datasets, lenses, recipes, and user XMD.
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes (Analytics Dataflow only). All other analytics components can’t be updated. |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes (Analytic snapshot only). Supported in managed 2GP packages only. All other analytics components can’t be removed. |
| Component Has IP Protection | No |
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
- To include analytics components in a managed 2GP package, include EinsteinAnalyticsPlus in your scratch org definition file.
- To enable analytics in a 1GP packaging org, see Basic CRM Analytics Platform Setup in Salesforce Help.
- For more details, see CRM Analytics Packaging Considerations.
Apex Class
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes (if not set to global access).
Supported in both 1GP and 2GP packages. |
| Component Has IP Protection | Yes |
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 After Package Promotion or Installation
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 AppExchange, 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 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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- Reason Label
- None
- Reason Name
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 Sharing Recalculation
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | No |
| Subscriber Can Delete Component From Org | Yes |
| Package Developer Can Remove Component From Package | Yes. Supported in 1GP packages only. |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
Apex Trigger
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes. Supported in both 1GP and 2GP packages. |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
More Information
- Feature Name
- Metadata Name: ApexTrigger
- Component Type in 1GP Package Manager UI: Apex Trigger
- Documentation
- Apex Developer Guide: Triggers
Application Subtype 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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | No |
| Subscriber Can Delete Component From Org | Yes |
| Package Developer Can Remove Component From Package | Yes |
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 After Package Promotion or Installation
- None
- Label
- Developer Name
- Description
- Application Usage Type
- None
More Information
- Feature Name
- Metadata Name: ApplicationSubtypeDefinition
AssessmentConfiguration
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes. Supported in managed 1GP packages only. |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- All but DeveloperName
- None
- DeveloperName
More Information
- Feature Name
- Metadata Name: AssessmentConfiguration
- Component Type in 1GP Package Manager UI: AssessmentConfiguration
- Documentation
- Health Cloud Developer Guide: AssessmentConfiguration
AssessmentQuestion
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- All except DeveloperName
- None
- DeveloperName
More Information
- Feature Name
- Metadata Name: AssessmentQuestion
- Documentation
- Industries Common Resources Developer Guide: AssessmentQuestion
AssessmentQuestionSet
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- All except DeveloperName
- None
- DeveloperName
More Information
- Feature Name
- Metadata Name: AssessmentQuestionSet
- Documentation
- Industries Common Resources Developer Guide: AssessmentQuestionSet
Aura 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.
You can build Lightning components using two programming models: the Lightning Web Components model, and the original Aura Components model.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes. Supported in both 1GP and 2GP packages. |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- API Version
- Description
- Label
- Markup
- None
- Name
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | Yes, except templates |
Editable Properties After Package Promotion or Installation
- Entire Data Processing Engine definition
- Label
- Description
- Status
- API Name
- URL
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | Yes, except templates |
Editable Properties After Package Promotion or Installation
- Entire Batch Management job
- Label
- Description
- Status
- API Name
- URL
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | Yes, except templates |
Editable Properties After Package Promotion or Installation
- Entire Benefit Action record
- Label
- Description
- Status
- API Name
- URL
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | Yes |
| Package Developer Can Remove Component From Package | Yes |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- Bot Dialog Groups
- Bot Dialogs
- Conversation Context Variables
- Conversation Languages
- Conversation Definition Goals
- Conversation System Dialogs
- Conversation Variables
- Description
- Entry Dialog
- Icon
- Main Menu Dialog
- Label
- MlDomain
- Rich Content Enabled
- None
- None
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- brandingSetProperty
- description
- masterLabel
- type
- None
- None
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- Entire briefcase
- Active
- Full Name
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.
- 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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- Both Package Developer and Subscriber Can EditAll attributes
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- All Business Process Group fields including Business Process Definition and Business Process Feedback.
- None
- Developer Name
- Customer Satisfaction Metric
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | No |
| Subscriber Can Delete Component From Org | Yes |
| Package Developer Can Remove Component From Package | Yes |
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 After Package Promotion or Installation
- None
- Label
- Developer Name
- Description
- Application Usage Type
- None
More Information
- Feature Name
- Metadata Name: BusinessProcessTypeDefinition
Care Benefit Verify 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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- MasterLabel
- ServiceApexClass
- ServiceNamedCredential
- UriPath
- isDefault
- GeneralPlanServiceTypeCode
- ServiceTypeSourceSystem
- OrganizationName
- DefaultNpi
- CodeSetType
- None
- Name
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- LimitType
- MetricType
- MasterLabel
- None
- Name
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- MasterLabel
- CareRequestType
- CareRequestRecordType
- CareRequestRecords
- IsDefaultRecordType
- IsActive
- Name
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- External ID Field
- Is Active
- Label
- Source System
- Target Object
- None
- Name
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
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.
| Packageable In: | First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
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.
- 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
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.
| Packageable In: | First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | Yes |
Editable Properties After Package Promotion or Installation
- Description
- Header Text
- Hover Text
- Icon
- Name
- None
- Composition CMP
- Render CMP
- Type
More Information
- Feature Name
- Metadata Name: ChatterExtension
- Documentation
- Metadata API Developer Guide: ChatterExtension
- Object Reference for the Salesforce Platform: ChatterExtension
Claim Financial 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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
- Label
- Claim Coverage Pending Authority Status
- Claim Coverage Payment Detail Pending Authority Status
- Claim Pending Authority Status
- None
More Information
- Feature Name
- Metadata Name: ClaimFinancialSettings
- Documentation
- Salesforce Help: Claim Financial Settings
Community Template 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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | No |
| Component Has IP Protection | No |
Editable Properties After Package Promotion or Installation
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
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes. Supported in 2GP packages only. |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
More Information
- Feature Name
- Metadata Name: CompactLayout
- Component Type in 1GP Package Manager UI: Compact Layout
- Documentation
- Metadata API Developer Guide: CompactLayout
Connected App
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.
| Packageable In: | Second-Generation Managed Packages (2GP), First-Generation Managed Packages (1GP) |
| Component Is Updated During Package Upgrade | Yes |
| Subscriber Can Delete Component From Org | No |
| Package Developer Can Remove Component From Package | Yes. Supported in 1GP packages only. |
| Component Has IP Protection | No |
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 After Package Promotion or Installation
- Access Method
- Canvas App URL
- Callback URL
- Connected App Name
- Contact Email
- Contact Phone
- Description
- Icon URL
- Info URL
- Trusted IP Range
- Locations
- Logo Image URL
- OAuth Scopes
- ACS URL
- Entity ID
- IP Relaxation
- Mobile Start URL
- Permitted Users
- Refresh Token Policy
- SAML Attributes
- Service Provider Certificate
- Start URL
- Subject Type
- API Name
- Created Date/By
- Consumer Key
- Consumer Secret
- Installed By
- Installed Date
- Last Modified Date/By
- Version