Migrate Your Configurations

Use a migration set to move your configurations from the source environment to the target environment. You can import your configurations into a sandbox in the target environment before you apply them to the mainline.

If you register your target environment in your source environment, you can do these additional migration tasks:

  • Migrate your changes from the source environment to the target environment without manually downloading and uploading the migration set file.

  • Move only new changes from the source environment to the target environment. This type of migration is called delta migration. However, only sandbox-aware modules support delta migration. All other modules move all changes every time they're migrated, even in delta migrations.

Note: The topic focuses on moving your configurations from the source environment to the target environment using the Migration page in Oracle Fusion Cloud Applications. For information about moving your application extensions made using Visual Builder Studio to the target environment, see Set Up the Project to Deploy to Production and Migrate Oracle Cloud Applications Configurations.

When You Can Do Delta Migration

A delta migration moves only those changes that were made to an environment after the last migration was done. On the other hand, a full migration moves all changes made to an environment.

You can do a delta migration if you meet these two conditions:

  • You have registered your target environment in your source environment.
  • Both of your environments are synchronized.

Here are some scenarios when you can perform delta migration:

  • Let's say your source environment is Alpha, and your target environment is Beta. You create object X in the Alpha environment, and do a migration. Then, you create object Y in the Alpha environment and do another migration. If the second migration is a delta migration, only the object Y is moved. However, if it's a full migration, both the objects X and Y are moved.
  • Let’s consider a setup of three environments, namely, development (source), test (target), and production (target).

    Between development and test environments:

    • Application change C1 is made in a sandbox in the development environment, and then published and moved using delta migration to the test environment.
    • Application change C2 is made in a sandbox in the development environment, and then published and moved using delta migration to the test environment.

    Between development and production environments:

    • Previously published application changes C1 and C2 in the development environment get moved using delta migration to the production environment.

Before You Start

Before creating a migration set, consider these points:

  • Make sure that the source and target environments are of the same release, with the same standard and one-off patches applied to both environments.

  • You should delete or publish any sandboxes in the target environment that have Application Composer enabled before you begin your migration.

  • Make sure that all Page Composer configurations made in sandboxes are complete and published.

  • Make sure that all configurations and extensions made using the Structure page, the Manage Standard Lookups task, and the Security Console are complete.

  • If you don't need to migrate flexfield configurations related to business intelligence, set the Business Intelligence Extender in Configuration Set Migration Disabled (FND_CSM_BI_EXTENDER_DISABLE) profile option to Yes. Setting this profile option to Yes makes the migration process faster. The default value for this profile option is No. You can find this profile option in the Manage Administrator Profile Values task in the Setup and Maintenance work area.

    Note: If you don't enable this profile option in the target environment, flexfield configurations related to business intelligence are included in your migration set. In such cases, the migration process takes longer to complete.
  • To move content created using Oracle Transactional Business Intelligence, set the Business Intelligence in Configuration Set Migration Disabled profile option to No in both the source and target environments. You can find this profile option in the Manage Administrator Profile Values task in the Setup and Maintenance work area.

  • You must have the following privileges to access the Migration page:

    • Manage Outgoing Configuration Set

    • Manage Incoming Configuration Set

    Contact your security administrator for details.

  • You should never make changes in the target or production environment while applying configurations.

    Note: If you make changes to the production environment in emergencies, you must make the same changes to the test environment. Making the changes to the test environment ensures that these changes are included in the next migration. However, in Application Composer, you should not create an object in the production environment because if you do so, you need to ask your help desk to log a service request for a production-to-test data refresh to resolve any migration issues.
  • Don't make any changes in the source environment during the export process.

  • Delete any temporary files on the server from previous migrations. If there are temporary files on the server, click the Delete button next to your previous import and export records.

  • If you have made any security changes in the source environment outside of Application Composer, make sure that you manually re-enter these security changes in the target environment before importing your migration set. For example, if you have set up a custom security role in the source environment, you must manually add this role in the target environment.

Note: For recommended best practices, see Best Practices for Migration.

Register the Target Environment

  1. In your source environment, in the Setup and Maintenance work area, go to the Manage Configuration Set Migration Target Security Policy task.

  2. Enter the URL of your target environment. Use the full URL, including the host and protocol information.

  3. Enter the application administrator role user credentials. Single sign-on isn't supported. So, enter your local user name and password.

  4. Click Save and Close to apply the changes.

Verify the Target Environment

  1. In the source environment, click Navigator > Configuration > Migration.

  2. Click the Environment Info infotile.

  3. Verify that the page displays the same URL as the target instance.

If you don't see the correct target instance, try registering it again.

Create Migration Set

  1. In the source environment, click Navigator > Configuration > Migration.

  2. Click Create Migration Set from the Outgoing infotile. If you want to migrate all configurations, click Move All Changes for a full migration.If you want to migrate only new configurations instead of all changes, click Move New Changes for a delta migration.

  3. Provide a name for the migration set.

  4. Provide the email ID of the person you want to notify after the migration set is created. You can provide multiple email IDs separated by commas. When the migration set is created, email notifications are sent to these specified people.

  5. Optionally, type a description of the set.

  6. Select the content you want to migrate.

    Note: The Industry solution extensions module is for Oracle's internal use only and has no impact on migration.
  7. Click Save and Close.

  8. Click the Refresh icon periodically to see the current status of the set creation. You can click the Log icon to review the process log, which provides more details about the configurations that are being compressed. If an error or exception occurs during this process, the log gives you information about the configurations that failed to compress. The process runs asynchronously, so you can close the page and return to it later.

  9. Eventually, the status changes to Ready for Download, which means that the migration set is complete. You can click Content Read Me to download the Readme file listing all the configurations you exported.

  10. If you have registered the target environment, you don't need to download your migration set. In such cases, you can directly apply the migration set.

  11. If you didn't register the target environment, do these tasks:

    • Click the Download icon to download your migration set. Ensure that the downloaded file is a JAR file.

    • After you download the file on your local file system, click Delete to remove the temporary files from the server.

Apply Migration Set

After you apply configurations, end users must sign out and sign back in to see the changes. So, apply configurations when fewer people are signed in to the environment.

To apply configurations to the target environment, follow these steps:

  1. Open the Migration page in the target environment.

  2. Click the Incoming infotile.

  3. Click the Upload Migration Set link. Then, browse for your migration set file, and click OK.

    Note: If you have registered the target environment, you don't need to upload the migration set to the target environment. That's because your migration set is automatically sent to the target environment for import. But, if you didn't register the target environment, or if the target was unreachable during export, you must upload your migration set.
  4. Provide the email ID of the person you want to notify after the migration set is imported. You can provide multiple email IDs separated by commas. When the migration set is imported, email notifications are sent to these specified people.

  5. Review the roles in your migration set that are missing from your target environment, and create them if required. Remember, you don't have to manually remove the same excluded roles from your migration set every time you import data from your source to target environments. That's because while importing if you exclude any roles from your migration set, those roles are automatically excluded from subsequent imports.

    To review and create roles, do these steps:

    1. Click the Details icon.

    2. In the Review Configuration work area, click the Missing Roles tab. New roles are displayed by default.

    3. From the Show Roles list, select new, excluded, or all roles to display them:

      • New Roles: Displays roles that are available in the source environment but are missing in your target environment.

      • Excluded Roles: Displays roles that are neither created in the target environment nor imported.

      • All Roles: Displays roles that are a combination of new roles and excluded roles.

    4. Select the roles you want to create in the target environment.

    5. Click Create Role. You get a warning message. Click Yes to proceed.

    6. After the roles are created, click OK to confirm.

    7. Select the Allow import process to continue even if new roles don't exist in the environment check box to add the remaining new roles to the excluded list.

    8. Click Save and Close.

  6. To compare the configurations made using Application Composer in the source and the target environments, download and review the configuration reports. You can then troubleshoot issues that occur in one environment but not in another.

    To download and review configuration reports, follow these steps:

    1. Click the Details icon.
    2. In the Review Configuration work area, click the Reports tab. The configuration Delta Summary is displayed by default.
    3. From the Download Report list, select the report you want to download:
      • Configuration Delta Report: Displays the configuration differences between the source and the target environments.
        Note: You can retain up to 10 configuration delta reports at a time.
      • Source Configuration Report: Displays the configuration made to artifacts in the source environment.
      • Target Configuration Report: Displays the configuration made to artifacts in the target environment.
    4. Click Save and Close.
  7. You can validate your migration sets and check for missing roles before importing them to the target environment. Based on the validation results, you can choose to proceed with the import as is or take corrective actions before importing.

    To validate your migration sets, do these steps:

    1. Click Validate.

    2. Click Yes to confirm.

  8. Click Import to import your migration set into a sandbox instance in the target environment.

    Note: Make sure that you have the Application Administrator (ORA_FND_APPLICATION_ADMINISTRATOR_JOB) role to successfully import the migration set to the target environment.
  9. Wait for the status to change to Successfully Imported.

  10. Click Preview to view your configurations in the sandbox preview mode. You can also edit web service connections and mashup URLs in preview mode.

    Note: You can preview your application extensions using Visual Builder Studio. To move these changes to the production environment of Oracle Fusion Cloud Applications, you need to first create an environment in Visual Builder Studio. Then you need to package and deploy the application extensions for the production sandbox of Oracle Fusion Cloud Applications. While creating the production sandbox packaging job, make sure that the parameter name matches with the sandbox name in Oracle Fusion Cloud Applications.
  11. Provide the email ID of the person you want to notify after the migration set is applied. You can provide multiple email IDs separated by commas. When the migration set is applied, email notifications are sent to these specified people.

  12. Click Apply when you're ready to apply your configurations to the target environment.

  13. Periodically, click the Refresh icon to view the current status of the apply action. The migration set is successfully applied to the target environment when the status changes to Applied and Deleted. You can review the process log, if required.

    The process runs asynchronously, so you can close the page and return to it. If problems occur during an Apply action, ask your help desk to log a service request.

Post Migration Tasks

Do these tasks after you apply your migration set to the target environment:

  1. Access the target environment and look for any deletions that you must make manually.

  2. Delete and recreate any web service connections in the target environment, using the target environment URL and credentials.

  3. Deploy all flexfields that display a Patched status.

  4. Do the following steps to send the new and updated social network definitions to the social network server:
    1. In the Setup and Maintenance work area, open the Manage Oracle Social Network Objects task.
    2. As part of the applying configurations process, some objects are created or updated. If the Enabled value of such an object is anything other than No, trigger the process of sending its definition to the social network server. You can do this by disabling the object and enabling it again with its original status. For example, if the Enabled value is Manual, then you can do this:
      1. Disable the object.
      2. Enable the object, and select the value, Manual.
      3. Click OK and save the changes.
    3. On the Manage Oracle Social Network Objects page, click Synchronize to synchronize a selected object. You can also click Synchronize All to synchronize all objects at the same time.
  5. Manually migrate all business processes created in the source environment to the target environment.

  6. If a new theme was created and applied in the source environment, and you want to use that theme in the target environment, then go to the Appearance work area and manually apply that theme.

  7. After applying configurations, do functional testing to verify the changes. Suppose testing exposes problems with the configurations, such as importing more than what you intended, or the changes weren't what you expected. In such cases, restore your environment to its state before the migration set was applied.

    1. Open the migration set in the Incoming infotile of the Migration page.

    2. Provide the email ID of the person you want to notify after the environment is restored to its state before the migration set was applied. You can provide multiple email IDs separated by commas. When the configuration is restored, email notifications are sent to these specified people.

    3. Click Restore to revert to the state before the migration set was applied.

  8. Finally, broadcast information to the users that they must sign out and sign in to view the most recent changes.