Solution migration and deployment

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
After you migrate a solution to a development environment, you can edit, deploy, and test the solution. After you migrate a solution to the production environment, you can deploy the solution to make it available to your case workers.

When you migrate a solution, you move the solution definition data and its related assets to a different environment. When you deploy a solution, you make the solution operational in the target environment. You can migrate a solution from one development environment to another development environment, a test environment, or a production environment.

Several types of assets must be exported from the development environment and imported into the target environment. Some assets, such as class definitions and property templates, are usable immediately after migration. Other assets, like workflow definitions, must be deployed to become usable. After migration, the various assets are combined to re-create the solution in the target environment.

Different tools are required to migrate and deploy different assets.
IBM® Business Automation Workflow assets
For case solution projects that are created on or promoted to Business Automation Studio, use Business Automation Studio to migrate the workflow solution project assets from one environment to another. These assets include artifacts that were created in Case Builder when the solution was designed, such as the solution definition, Content Platform Engine configuration, and solution pages.
IBM Business Automation Workflow project assets
If your solution package contains external workflow project assets created outside of Case Builder, such as the IBM Business Automation Workflow Process artifacts, use Business Automation Studio to migrate the assets from one environment to another. In the old environment. these assets would be workflow automations or toolkits.
Legacy Case Manager Solution assets
If you solution package contains legacy Case Builder assets created with the Case Builder application use the Case administration client to migrated the solution package file.
Other IBM Content Cortex assets
If your solution package contains assets that were created with other Content Cortex tools, use FileNet® Deployment Manager and Process Configuration Console to migrate the assets from one environment to another. These assets include classes, properties, workflow definitions, workflow system component queues, and content-based objects such as search templates.
Other IBM and external assets
If your solution package includes assets that were developed outside of IBM Business Automation Workflow and Content Cortex tools, consult with your solution developer for migration assistance. These assets might include assets that are managed by other IBM products and tools or assets that are managed by external products and tools. Examples include analytics, rules, data services, custom widgets, and custom deployable code.

Migration and deployment task flow

The following steps depict the general task flow for migrating and deploying a solution:
  1. Before you migrate a solution, you must test the solution and ensure that the solution works correctly in the development environment.
    • Legacy case solution package: Export the case solution package from the development environment using the Case Administration Client.
    • Workflow case solution project: Export the project snapshot file from the development environment using the Business Automation Studio.
  3. If the solution includes solution application assets that were created with other Content Cortex tools, use FileNet Deployment Manager and Process Configuration Console to export the assets from the development environment. For more information, see Installing FileNet Deployment Manager.
  4. If the solution includes assets that are managed by other IBM products or tools or external products or tools, use tools and processes that are native to those products and tools to migrate the assets from the development environment.
    • Legacy case solution package: Use the Case administration client to import the previously exported solution package to the staging object store of the test or production environment. (If you migrate a solution from one development environment to another, import the solution package to the design object store of the target development environment.)
    • Workflow case solution project: Use Business Automation Studio, Swagger, or the offline REST API to import the solution.
  6. If you exported solution application assets that are managed by other Content Cortex tools, use FileNet Deployment Manager and Process Configuration Console to import the assets to the test or production environment. Importing these assets also deploys the assets in the target environment.
  7. Legacy case solution: Use the Case administration client to deploy the migrated solution in the test or production environment.
  8. If you exported assets that are managed by other IBM products or tools or external products or tools, use tools and processes that are native to those products and tools to make the assets operational in the test or production environment.
  9. Depending on the solution application, you might need to configure the environment after you deploy the solution. For example, you might need to import security settings and audit settings. If the solution is translated, you must migrate the translated user interface elements.
  10. Test the solution to ensure that it works correctly before you release the solution to your case workers.