ÃÛ¶¹ÊÓƵ

Share packages across organizations using Sandbox Tooling

Improve configuration accuracy across sandboxes and seamlessly export and import sandbox configurations between sandboxes across different organizations with the sandbox tooling feature. This document covers how to use sandbox tooling in ÃÛ¶¹ÊÓƵ Experience Platform to share packages across different organizations. There are two types of shared packages:

  • Private package

Private packages can only be shared with organizations that have approved the sharing request from the source organization.

  • Public package

Public packages are available to import without any additional approval. These packages can be shared on a partner’s website, blog, or platform. The package payload allows packages to be copied and pasted from these channels to the target organization.

Private packages private-packages

NOTE
To initiate and approve a sharing request and share packages across organizations, you will need to have package-share role-based access control permission.

Use the Sandbox Tooling feature to create partnerships, track partnership request stats, manage existing partnerships, and share packages with partner organizations.

Create an organization partnership request

To create an organization partnership request, navigate to the Sandboxes Partner orgs tab. Next, select Manage partner orgs.

The sandboxes UI, with the Partner orgs tab and Manage partner orgs highlighted.

In the Package partner management dialog, enter the organization ID into Enter Org ID and press enter (Windows) or return (Mac). The organization ID is shown in the Selected Org IDs section below. After adding the IDs, select Confirm.

TIP
Multiple organization IDs can be entered at a time using comma-separated lists or by entering each organization ID followed by enter.

The Package Partner orgs dialog with Enter Org ID, Selected Org IDs, and Confirm highlighted.

The sharing request is successfully sent to the partner organization, and you are returned to the Sandboxes Partner orgs tab, which displays the Outgoing request.

The Partner orgs tab with Outgoing request highlighted.

Authorize a partnership request authorize-request

To authorize an organization partnership request, navigate to the Sandboxes Partner orgs tab. Next, select Incoming request.

The sandboxes UI with the Partner orgs tab and Incoming request highlighted.

The current Status for the request, at this stage, is Pending. To approve the request, select the ellipsis (...) next to the selected request, then select Approve from the dropdown.

List of incoming requests showing the dropdown menu with Approve highlighted.

The Review partner org request dialog displays details about the organization partnership request. Enter a Reason for approval, then select Approve.

Review partner org request dialog with Reason and Approve highlighted.

You are returned to the Incoming request page, and the request’s status has been updated to Approved.

List of incoming requests with Approved highlighted.

Use this workflow/process to share packages between your organization and the source organization.

Share packages to partner organizations share-package

NOTE
Only packages with the status Published can be shared.

To share a package to an approved partner organization, navigate to the Sandboxes Packages tab. Next, select the ellipsis (...) next to the package, and then select Share package from the dropdown menu.

List of packages showing the dropdown menu with Share package highlighted.

In the Share package dialog, select the package to share from the Share settings dropdown, then select Confirm.

TIP
It is possible to select more than one organization. Selected organizations will show up beneath the Share settings dropdown.

Share package dialog with Share settings and Confirm highlighted.

Public packages public-packages

Use the Sandbox Tooling feature to create shareable public packages that don’t require any additional approval and are easily imported with the use of the package’s payload.

Update package availability to public update-package

To update a package’s availability type, navigate to the Sandboxes Packages tab. Next, select the ellipsis (...) next to the package, and then select Update to public package from the dropdown menu.

The Sandboxes UI with the packages tab and the dropdown option menu with Update to public package highlighted.

In the Change package availability to public dialog, verify the package name is correct and select Confirm.

IMPORTANT
Once a package has been made public, it cannot be changed back to private.

Change package availability to public dialog with Confirm highlighted.

Share packages using the package payload

To share the public package, select the ellipses (...) next to the package, and then select Copy package payload.

The Sandboxes UI showing a individual packages dropdown menu with Copy package payload highlighted.

The Copy package payload dialog displays the package name and payload. Select Copy package payload to copy the payload associated with the package.

Copy package payload dialog box showing the JSON payload with Copy package payload highlighted.

Create a new package using a package payload

To create a package using a package payload, navigate to the Sandboxes Packages tab. Next, select Create package.

The Sandboxes UI showing Create package highlighted.

In the Create package dialog, select the option to Paste package payload, then select Select.

Create package dialog with paste package payload selected and Select highlighted.

Paste the copied package payload into the text field and select Create.

Create package dialog with the empty text field and Create highlighted.

To view the current status of your share request, navigate to the Sharing status. The current status of the request is shown in the Sharing status column.

The Sharing status tab showing a pending payload request.

Next steps next-steps

This document demonstrated how to use the Sandbox tooling feature to share packages across different organizations. For additional information, refer to the sandbox tooling guide.

To learn how to perform different operations using the Sandbox API, see the sandbox developer guide. For a high-level overview of sandboxes in Experience Platform, refer to the overview documentation.

recommendation-more-help
e243ad8f-a318-46b3-9930-159a80f82b42