Install an environment promotion package

Last update: December 17, 2024

Topics:
System Setup and Administration

CREATED FOR:

Admin

After you have created a package, you can install it in a different environment.

You must install a package in the environment that you want to copy objects to. For example, if you are configuring a project in your Custom Refresh Sandbox environment and promoting it to your Production environment, you must install the package in your Production environment.

IMPORTANT

If your Custom Refresh Sandbox is refreshed while you are configuring object for environment promotion, that configuration will be lost in the refresh. We recommend that you do not refresh your Custom Refresh Sandbox unless all outstanding environment promotion objects and packages have been successfully promoted.
Objects created in the target environment as part of package installation do not have the same ID as the object in the original environment. This is due to the fact that IDs are assigned by the system when objects are created.

Access requirements

You must have the following:

Adobe Workfront plan	Prime or Ultimate (New plans only)
Adobe Workfront licenses	Standard
Access level configurations	You must be a Workfront administrator.

For more detail about the information in this table, see Access requirements in Workfront documentation.

Prerequisites

An environment promotion package must be created before it can be installed.

For instructions, see Create or edit an environment promotion package.

Package status for installation

A package must be in ACTIVE status to be installed in your production environment.

We recommend moving the package to TESTING status and installing in another sandbox to test the package. If this test is successful, with no errors, move the package to ACTIVE to install it in your production environment.

To edit a package’s status:

Select the package as described in Edit or assemble an existing package in the article Create and edit environment promotion packages.
Click Edit Package.
Click Status.
Select the desired status from the drop-down menu.

For more information on statuses, see Environment Promotion Statuses in the article Overview of moving objects between Workfront environments.

Install a package

NOTE

To install a package, you must be logged in to the environment where you want to install the package. This is the environment that you are copying objects to.

Go to the environment where you want to install the package.
Click the Main Menu icon in the upper-right corner of Adobe Workfront, or (if available), click the Main Menu icon in the upper-left corner, then click Setup .
Select System in the left navigation, then select Environment Promotion.
Select the package from the displayed list.
For each object that has a collision, select how to resolve the collision.

To resolve a collision, click the drop-down arrow next to the object type, and select the action that you want to take.

For more information, see Collisions in this article
To deploy the package into the new environment, click Deploy at the upper-right of the screen.

Collisions

A collision is an object found in the target environment of an installation that matches one of the objects being installed from the source environment. Collisions are detected by comparing the names and IDs of the source objects against objects in the target environment. Collisions are also detected by comparing source objects against records of previously installed objects.

When a collision occurs, you can select how to resolve the collision. Collisions are resolved on the object level.

You can view collisions by clicking on the drop-down next to each object type. Collisions are displayed in the Collision column.

NOTE

Detected collisions may not be the objects that you want to override or use in your installation. We reccomend validating detected collisions to ensure that the installation targets are correct.

To resolve a collision, select an action in the Deployment Action column, or use the default action that is already displayed.

Create with new name: Create a new object in the target environment. If the object exists in the target environment, you can create a new object with a new name. If it does not exist in the target environment, you can create the object with a new name or with the name that the object has in the package.
Use existing: The object in the package is not installed, and the object that already existed in the target environment is unchanged.
Overwrite: The object in the package replaces the existing object in the target environment.

You can also choose objects to overwrite even if a collision is not detected.

For details on how overwriting affects parent and child objects, see Overwriting parent and child objects in this article.

Default values are Create new if the object does not exist in the target environment, and Use existing if the object does exist in the target environment. You can revert to the default mapping by clicking Reset to default mapping.

Overwriting parent and child objects

Some objects in your promotion package may have child objects. For example, a project (parent) has tasks (children). When overwriting a parent object, child objects are handled as follows:

Child objects that exist in both the package and the target will be updated in the target to match the package.
Child objects that exist in the package but not the target will be created.
Child objects that exist in the target but not the package will remain unchanged.

This functionality affects the following parent and child objects:

Parent object

Child objects

Project

Task
QueueDef (Queue Definition)
RoutingRule

Template

TemplateTask
QueueDef (Queue Definition)
RoutingRule

Parameter (Custom form field)

ParameterOption (Custom form field option)

CalendarInfo

CalendarSection

QueueDef (Queue Definition)

QueueTopicGroup
QueueTopic

recommendation-more-help