Upgrading IBM Automation Document Processing

If you installed a previous version of IBM Automation Document Processing, you can now move to a newer version.

About this task

When you upgrade Automation Document Processing, you must also upgrade the IBM FileNet® Content Manager components that you use with document processing.

Plan your upgrade to accommodate all of the related components. The following diagrams highlight the components that are always installed when you install a document_processing pattern, along with the optional components. Your upgrade steps might be different depending on whether you are upgrading an authoring environment or a runtime environment.

document_processing pattern visual
Note: The custom resource configuration sections for these components use the following names:
  • Business Automation Navigator: navigator_configuration
  • FileNet Content Manager: ecm_configuration
  • Document Processing: document_processing
  • Application Engine: application_engine_configuration
  • Business Automation Insights: bai_configuration
  • Resource Registry: resource_registry_configuration
  • Business Automation Studio: bastudio_configuration
document_processing pattern visual
Note: The custom resource configuration sections for these components use the following names:
  • Business Automation Navigator: navigator_configuration
  • FileNet Content Manager: ecm_configuration
  • Document Processing: document_processing
  • Application Engine: application_engine_configuration
  • Resource Registry: resource_registry_configuration
Check the upgrade instructions for prerequisite capabilities in case upgrading them requires additional actions.

After you complete the upgrade, you must update any deployed document processing applications to the latest version and re-import them in Business Automation Navigator.

Important:
  • After an upgrade from the previous version, make sure to retrain your extraction model for your existing projects, and then redeploy the projects to the runtime environment.
  • To avoid any loss of project data when upgrading, you must force your latest changes to be saved to the remote Git server by sharing the project. Before you start the upgrade process, open each Document Processing project and from the Designer main page, click Share.

Procedure

To upgrade from the previous release to the current release:

  1. If your Cloud Pak for Business Automation deployment uses EDB Postgres (Option 1: Upgrading a CP4BA deployment that uses EDB Postgres or Option 3: Upgrading a CP4BA deployment that uses an external database that is not PostgreSQL), then check the following datasource_configuration parameters under the Document Processing and the Document Processing engine (DPE) section in the CR:
    1. Check that the dc_use_postgres parameters for Document Processing and the Document Processing engine are set to true.
    2. Check the rest of the datasource_configuration parameters that are listed in Table 1 and Table 2 in IBM Automation Document Processing parameters.

      Verify that the value for each parameter is set as described in these tables when dc_use_postgres is set to true.

  2. If your Cloud Pak for Business Automation deployment uses an external PostgreSQL database (Option 2: Upgrading a CP4BA deployment that uses an external PostgreSQL), then check the following datasource_configuration parameters under the Document Processing section in the CR:
    1. Check that the dc_use_postgres parameters for Document Processing and the Document Processing engine are set to false.
    2. Check the rest of the datasource_configuration parameters that are listed in Table 1 and Table 2 in IBM Automation Document Processingparameters.

      Verify the values that you entered in the upgrade script correspond to the ones in your external PostgreSQL database.

What to do next

  1. Continue to configure the other capabilities that are in your CR file, and make sure that you complete the last step Validating the YAML in your custom resource file before you apply the CR to the operator.
  2. Apply the modified custom resource file as described in Applying the upgraded custom resource for the upgrade to take place.
  3. Go to Completing the IBM Automation Document Processing upgrade to complete the post-upgrade steps.