Moving case instances by backing up and restoring the on-premises databases

Make sure that you have all the prerequisites before you start.

After you assess your readiness, prepare the case instances for the move from traditional Business Automation Workflow to Cloud Pak for Business Automation. Make sure that the required databases are restored to the databases that Cloud Pak for Business Automation uses.

1. Use the migration planning sheet to gather the traditional environment configuration data that is required for migration. After you generate the custom resource, check that all the values that are listed in the migration planning sheet are entered.
   See Migration planning sheet .
2. Take a backup of the custom widgets.
3. Disable any custom plug-ins on IBM Content Navigator.

You can now generate and run a custom resource (CR) file by using a script that helps you move case instances. This script supports moving multiple target object stores.

1. In the cert-kubernetes/scripts folder, run the ./case-migrate-cp4a-prerequisites.sh script. Running the prerequisites script gives you the instructions to follow.

   Usage: case-migrate-cp4a-prerequisites.sh -m [modetype] - n [namespace]
   
   Options:
     -h  Display help
     -m  The valid mode type: [property] or [generate] or [validate] or [generate-cr]
         STEP1: Run the script in [property] mode to create the user property files (DB/LDAP property files) with default values (database name/user).
         STEP2: Modify the DB/LDAP/User property files with your values.
         STEP3: Run the script in [generate] mode to generate the DB SQL statement files and YAML template for the secrets, based on the values in the property files.    
         STEP4: Create the databases and secrets manually based on the modified DB SQL statement file and YAML templates for the secret.    
         STEP5: Run the script in [validate] mode to check that the databases and secrets are created before you deploy Business Automation Workflow. 
         STEP6: Run the script in [generate-cr] mode to generate the Business Automation Workflow custom resource based on the property files.    
   

2. Run the script in property mode to generate the properties files:

   ./case-migrate-cp4a-prerequisites.sh -m property -n <project_name>

   This mode displays the different capabilities.

   Select the Cloud Pak for Business Automation capability to install:
   1) FileNet Content Manager
   2) Operational Decision Manager
   3) Automation Decision Services
   4) Business Automation Application
   5) Business Automation Workflow (Selected)
      (a) Workflow Authoring
      (b) Workflow Runtime (Selected)
   6) Automation Workstream Services
   7) IBM Automation Document Processing
      (a) Development Environment
      (b) Runtime Environment
   8) Workflow Process Service Authoring
   
   Info: Note that Business Automation Workflow Authoring (5a) cannot be installed together with Automation Workstream Services (6). However, Business Automation Workflow Runtime (5b) can be installed together with Automation Workstream Services (6).
   
   Info: Business Automation Navigator will be automatically installed in the environment as it is part of the Cloud Pak for Business Automation foundation platform. 
   
   Tips:  After you make your first selection you will be able to make additional selections since you can combine multiple selections.
   
   ATTENTION: IBM Automation Document Processing (7a/7b) does NOT support a cluster running a Linux on Z (s390x)/Power architecture.
   
   Tips: Press [ENTER] when you are done
   Enter a valid option [1 to 4, 5a, 5b, 6, 7a, 7b, 8]:

   Enter 5b to move to the Business Automation Workflow Runtime environment.
3. If you want to use Business Automation Insights, choose the optional components.

   Pattern "(b) Workflow Runtime": Select optional components:
   1) Business Automation Insights
   2) Exposed Kafka Services
   3) Exposed Elasticsearch
   
   Tips: Press [ENTER] if you do not want any optional components or when you are finished selecting your optional components
   Enter a valid option [1 to 3 or ENTER]:

4. Select the LDAP that you use in the traditional environment.
5. Enter the storage class name or names that you want to use.
   For more information, see Storage considerations.
6. Select the deployment profile: small, medium, or large.
   For more information, see System requirements.
7. Select the database type: Db2®, Oracle, or SQL Server.
8. Enter an alias name or names for the database server or servers to be used by Cloud Pak for Business Automation.
9. Enter the name of an existing project (namespace) where you want to deploy.
10. Answer the prompt that asks whether you want to restrict access to the Cloud Pak for Business Automation deployment.
11. Answer the prompts about PostgreSQL.
12. Answer whether you want to use an external certificate (root CA) for the OpenSearch Kafka deployment.
13. View your results.
    The database and LDAP property files for Cloud Pak for Business Automation are created, followed by the property file for each database name and user, followed by the Cloud Pak for Business Automation property files.
    In cert-kubernetes/scripts/cp4ba-prerequisites/project/<CP4BA_NAMESPACE>/propertyfile, the following files are created:

    • cp4ba_case_migration.property
    • cp4ba_db_name_user.property
    • cp4ba_db_server.property
    • cp4ba_LDAP.property
    • cp4ba_user_profile.property
14. To configure multiple target object stores (TOS), enter a value greater than 1 for the number of target object stores.
15. Update the property files.
    1. Update the cp4ba_case_migration.property file with the values from the traditional Case Manager server and the multiple target object store information from the traditional environment
    2. Update the cp4ba_db_name_user.property file with the usernames and passwords of the GCD database, DOCS database, DOS database, TOS database, IBM Content Navigator (ICN) database, and BPMDB database. All the databases are backed up from traditional Business Automation Workflow and restored to Cloud Pak for Business Automation database. Backup and Restore of databases is supported for Db2, MSSQL, and Oracle. For more information on how to backup and restore database users and databases, see these documentations:
       • For DB2: Backing up and restoring Db2 .
       • For Oracle: Backup and Recovery User's Guide .
       • For SQL: Quickstart: Backup and restore a SQL Server database with SSMS .
    3. Update the cp4ba_db_server.property file with the details of the databases where the on-premises databases are restored.
    4. Update the cp4ba_LDAP.property file with the same LDAP details as in the traditional Case Manager.
    5. Update the cp4ba_user_profile.property file with the license, admin user (as in the traditional Case Manager), and keystore passwords.
16. Run the ./case-migrate-cp4a-prerequisites.sh script in generate mode by using the following command:

    ./case-migrate-cp4a-prerequisites.sh -m generate -n <project_name>

    This command generates the database SQL statements files that are required by the Cloud Pak for Business Automation deployment based on the property files.
17. Apply the secrets by running the create_secret.sh file in the ./cp4ba-prerequisites/project/<CP4BA_NAMESPACE>/ folder.

    create_secret.sh

    The required secrets for LDAP, FileNet, Navigator, and Workflow are created.
18. To validate the configuration before you deploy, run the script again.

    ./case-migrate-cp4a-prerequistes.sh -m  validate -n <project_name>

    This command checks that everything was created: Slow/Medium/Fast/Block storage classes, required Kubernetes secrets, LDAP connection, and database connections for all required databases.
19. Generate the CR. From the /scripts folder, run the ./case-migrate-cp4a-deployment.sh command.
    Answer the on-screen prompts and check the input as you go.
    The CR file cert-kubernetes/scripts/generated-cr/project/<CP4BA_NAMESPACE>/ibm_cp4a_cr_final.yaml is generated.
20. Validate your CR file before you apply it or save it in the YAML view. It is likely that you edited the file multiple times, and possibly introduced errors or missed values during your customizations. For more information, see Validating the YAML in your custom resource file.
21. You can now deploy Cloud Pak for Business Automation by applying the CR to the operator. For more information, see Applying the updated custom resource.

To move case instances to Cloud Pak for Business Automation, you must perform post-migration steps if you work with file storage target object stores. You can also update the Daeja Viewer log file path, work with custom plug-ins and extensions, enable case analyzer and case history, configure the case event emitter, and index case instances.

1. If you use file storage target object stores, do the following steps.
   1. Log in to the administrative console for Content Platform Engine (ACCE).
   2. For each file storage target object store, update the path in the TOSStorage, Properties tab of the file storage device to point to the location in the Content Platform Engine physical volume.
      The file storage backup is now copied to the Content Platform Engine physical volume.
2. If you use Daeja Viewer, update the log file path and cache directory to the Cloud Pak for Business Automation container path.
   The default log file in the traditional environment before upgrade is install_dir/ibm/viewerconfig/logs/daeja.log, where install_dir is the directory where Navigator is installed. Update the path to reflect your container deployment location, for example /opt/ibm/viewerconfig/logs/daeja.log.
3. If you have custom plug-ins and custom extensions in the production environment, you must copy the plug-ins to /<icn pv directory>/<icn-pluginstore>. Add lines similar to the following example lines in the CR file under case configuration and deploy the CR file:

   custom_package_names: "ICMCustomWidgets.zip" 
   custom_extension_names: "CustomEditors.zip"

   For more details about custom packages and custom extensions, see Configuring custom case widgets for a container environment.
4. Enable the case analyzer and case history stores in the Administrative Console for Content Platform Engine (ACCE).
   1. In the ACCE, go to FileNet P8 domain > Workflow Subsystem.
   2. Select Case History enabled and Case Analyzer enabled.
   3. Restart the Content Platform Engine pod to reflect the changes.
5. Configure the case event emitter. See Case event emitters parameters.
6. Index case instances. The case management tools provide support for indexing case instances in the Elasticsearch index. Full reindexing and live index updates are supported. For more information, see Indexing case instances.
   Note: The FileNet P8 Process Engine REST APIs that are packaged with Business Automation Workflow Case Manager application are not available in Cloud Pak for Business Automation.

   Back to top