Migrating packages

Migrate configurations such as custom fields, extended integrations, credentials, and global settings from the source instance to the target instance.

Content

1. About migrating packages
2. Creating the package
3. Adding migration items to the package
4. Adding configuration changes to a package
5. Testing the migration
6. Completing the migration

About migrating packages

You choose package migrations when you want to migrate multiple configurations simultaneously. Typically, as part of a new use case or project that was implemented in your development environment . You can create packages that contain the following types of configuration:

• Business objects
• Credentials
• Custom objects
• Dashboards
• Global settings
• Integrations
• Mobile screen designs
• Roles
• Saved searches  
• Web screen designs
• Workflows

Unlike standalone migrations, package integrations migrate multiple configurations together.

Note
In standalone migrations, you must migrate the credentials, dashboards, saved searches, and workflows separately and in a certain order because of dependencies between the types of objects.

To migrate the integrations successfully, you complete the following actions:

• You create the package 
• You test the migration
• You complete the migration

Creating the package

You must enter the name of the package and select a status, such as beta. The status of the package doesn't affect the migration of the package from your development to your production instance.

1. Log into the source instance.
2. Click Configuration > Migrations > Packages.
3. Click ADD.
4. Add information about the package migration. You must select a status value.
5. Click CREATE.

Adding migration items to the package

1. On the Configuration > Migrations > Packages page, click the package.
2. Click MIGRATIONS.
3. Click Add New Migration Item +.
4. From the Scope list, click the type of configuration that you want to include in the package.
5. For each item that you select, fill out the remaining fields. For example, when you add a Business Object migration, select the object such as Assets and all of the fields that you want to migrate as part of the package.
6. Click NEXT and then click ADD. 

Tips
To edit the list of fields, click . To delete all of the migration items, click .
If you want to add images, click MEDIA, and drag and drop the file onto the canvas or click the canvas to upload files.  

Adding configuration changes to a package

To seamlessly migrate configuration changes to production, you can automatically associate the configuration changes that you make to a package.

For example, you can add new or modify custom fields, saved reports, credentials, integrations, workflows, dashboards, and widgets. And, they're automatically added to the package. If you archive an item, such as a custom field or workflow, they are automatically removed from the package.

1. Log in as Super Administrator and click Select a package on the header bar.
2. Select the package. The changes that you make will be recorded and automatically associated with the package.
3. Make your changes.

   Tip
   Before you finish making your changes, complete these actions:
   1. Click Configuration > Migrations > Packages.
   2. Click the package and then click MIGRATION.
   The items that you added are listed. To get more details, click Edit  .

4. When you are finished, click Select a package on the header bar and select None from the list. 

Testing the migration

When you run the migration in test mode, the migration is validated and you’re notified whether the migration can be completed or can’t be completed, for example, because of dependency violations or mismatching field IDs.

The results of the migration test are recorded in the Migration Log. 

Complete the following steps:

1. In the source instance, click Configuration > Migrations > Migrate.
2. Click PERFORM MIGRATION.
3. As migration type, you can select Package or Standalone.

   Information
   If you select Standalone, you can migrate each configuration separately.

4. Click the packages to select them. 
5. Click NEXT, and then click TEST. 

Important
To check the status of the items that are being migrated, click Configuration > Migrations > Migration Log. To get more information, click the migration item.

Completing the migration

Resolve the issues that were detected, and then repeat the migration procedure for the packages that you tested.

1. Click PERFORM MIGRATION.
2. As migration type, select Package.
3. Select the packages that you tested.
4. Click NEXT and then click MIGRATE.

Related articles

Planning the migration

Migration objects

Migrating standalone objects

Migration overview