To move metadata with metadata sharing, use the Metadata Sharing Export Utility application to generate a .zip file containing your metadata, and the Metadata Sharing Import Utility to upload that metadata in a branch lifecycle in different environment. From there, it can be merged to the tenant default lifecycle, or to base. Learn the specific requirements and steps in Metadata sharing configuration.

Considerations

Metadata sharing is an advanced migration tool and should not be used for standard migrations. Customers can learn more about how to migrate their metadata in Move your data between environments. Solution development partners should reference the Deliver your metadata to customers topic.

Relationships

Metadata sharing moves the relationships between roles in the Role Hierarchy Definitions application and between topics in the Content Builder application. Each relationship connects a parent and a child, such as a parent topic and a topic placed under it. Relationships aren't listed in the bundle. They're added automatically based on the roles and topics the bundle contains.

A relationship is exported only when both its parent and its child are in the bundle, no matter how they were added. If only one of them is in the bundle, the relationship is left out. This prevents partial relationships that could cause errors in the target environment.

When the bundle is imported, relationships follow the roles and topics they connect in the following ways:

  • If a role or topic is renamed during the import, its relationships use the new name.
  • If a role or topic is skipped, its relationships are skipped too.
  • If a matching relationship already exists in the target environment, it's skipped and left unchanged.
  • Importing never removes relationships from the target environment. To remove one, delete it in the target environment directly.

Metadata sharing configuration

Use the Metadata Sharing Export Utility, Metadata Sharing Import Utility, Branch Lifecycle Management, and Merge Requests applications to move metadata between environments using metadata sharing.

Your source environment contains the metadata you need to export. Your target environment is the environment where you need to import the metadata.

Metadata Sharing Export Utility

In the Metadata Sharing Export Utility application, 

On the Bundle Creation Entries page, specify the metadata you want to export. There are multiple ways to include metadata objects in the bundle:

  • Add Bundle Creation Entries button—Manually add each individual object you want exported in the bundle. Dependent objects are not automatically included. For example, if you want to export a table, you must specify the table as well as each individual data item. To include a relationship from the Role Hierarchy Definitions or Content Builder application, add both its parent and its child to the bundle. 
  • Merge Requests—Specify a single merge request to load all of the metadata included in the merge request. The merge request must be in a Merged state.
  • Branch Lifecycle Import—Specify a single branch lifecycle to load all of the metadata checked into that lifecycle into the bundle.
  • Metadata Manifest—Create your manifest in the Metadata Manifest Utility application with Agentic Projects as the Data Source Type, then add it in the Manifests subtable. 

Save the record and select the Create Bundle form action. Download the attached .zip file from the associated record on the Bundle Creation Records page.

Branch Lifecycle Management

Sign in to your target environment. In the Branch Lifecycle Management application, you must create a new branch lifecycle. 

Objects are imported into this branch, where they can then be merged to the Merge Request Target Lifecycle, which is usually the tenant default lifecycle. Solution development partners can merge to the base lifecycle, or a different branch lifecycle of their choosing.

Metadata Sharing Import Utility

In the Metadata Sharing Import Utility application, in your target environment, you must:

  • Create a new import record, and specify the branch lifecycle you created in the Import Lifecycle field.
  • Enter your tenant default lifecycle in the Merge Request Target Lifecycle field. Your tenant default lifecycle is defined in the Tenant Environment Setup application.
  • Use the Attachments form action to upload the .zip file that you downloaded, and then save the record.
  • Select the Extract Bundle form action to load the objects from the attachment into the detail form.
  • Review the Status Message field for each object. If any objects have errors, fix them and select the Resolve Bundle form action.
  • Select the Commit Bundle form action to import the objects to the environment, in the branch lifecycle you created.

Branch Lifecycle Management

In the Branch Lifecycle Management application, in your target environment you must:

  • Use the Lifecycle menu in the Main Menu bar to switch to the branch lifecycle you created.
  • Navigate to the branch lifecycle record in the application.
  • Select the Create Merge Request form action to navigate to a new record in the Merge Requests application.

Merge Requests

In the Merge Requests application, in your target environment, you must:

  • Select Metadata Sharing in the Type field.
  • Enter your tenant default lifecycle in the Target Lifecycle field, and save the record. 
    • Solution development partners can specify the base lifecycle, or any other branch lifecycle they choose.
  • Select the Approve Merge Request form action, and save the record again.
  • Select the Validate form action.
  • Select the Merge form action to merge the metadata objects into your tenant default lifecycle, making them available to the users in the environment.

Metadata Sharing Export Utility application

Use the Metadata Sharing Export Utility application to create bundles of Owned and Customized metadata objects to export, or to export a metadata manifest containing agentic projects. This enables you to export metadata from one environment and import it into another environment. 

Each metadata sharing export record can have multiple metadata manifests or bundles configured and saved. Exported bundles are saved as a .zip file on the record, and can be uploaded in a new tenant in the Metadata Sharing Import Utility application. Bundles can contain Owned and Customized objects, but cannot have base objects. If you export a table which contains base objects, the new tenant provides those objects when the table is imported in. 

To export a metadata manifest, use the Manifests subtable. 

Bundle Creation Entries

Define the objects you want exported in the bundle. Save and create the bundle in order to export the objects. 

Bundle Creation Records

View and open previously created bundles. 

Metadata Sharing Import Utility application

Use the Metadata Sharing Import Utility application to import customized and owned metadata object bundles which were exported from the Metadata Sharing Export Utility application into different environments.

Bundles are exported and imported as a .zip file, and contain only Owned and Customized objects. Base objects are not imported as part of the bundle. 

Once the objects have been uploaded to the application, you can review the Status Message field for conflicts. Once conflicts have been resolved, you can commit the objects to the new tenant. 

Files are automatically renamed with the appropriate namespace for the environment. 

Learn more in the Metadata sharing topic.