IBM Support

Mustgather - IBM Business Automation Document Processing (ADP)

Question & Answer


What is the information that is to be collected and provided when you are requesting support assistance for IBM Business Automation Document Processing (ADP)?


ADP is deployed as part of Cloud Pak for Business Automation (CP4BA).  This document provides guidance on information to collect and provide for issues specific to ADP.


  1. Collect for all issues
  2. Collect as needed
  3. Pod reference
  4. What to do next

1. Collect for all issues
This section lists the basic information needed for all issues.
  • CP4BA version and interim fix level -  In the OCP console, go to Installed Operators, IBM Cloud Pak for Business Automation and note the displayed version.  The console drops the second digit, so for example shows as 21.2.2.
  • OCP version information
    oc version > version.txt
  • Platform - Specify the platform being used.  Red Hat, AWS, Azure, ROKS, and so on.
  • CR yaml file - Provide the CR (Custom Resource) yaml file used for deployment.  The default name and path for CP4BA is /scripts/generated-cr/ibm-cp4ba/ibm_cp4a_cr_final.yaml.  Some deployments don't generate a physical file.  The yaml can also be obtained from the OCP Console Installed Operators, IBM Cloud Pak for Business Automation, CP4BA Deployment tab, select the ICP4ACluster, YAML tab.
  • Exact problem - This information can be a screen capture of the error or the file containing the error.  Provide the complete file or listing, rather than just extracting the error.  Complete data allows Support to better understand the context under which the error occurred.
  • Exact repro steps - Provide the exact actions leading to the problem to include buttons clicked and data entered. 
  • Scope - Did the issue start happening on a previously running system, or is it associated with a new deployment, upgrade, or configuration change of some kind?  Does it happen for all documents, users, or workstations, or is the issue specific to just one or a few documents, users, or workstations?
  • Operator deployment status - Provide the operator log.
    • If this issue is associated with a new deployment
      kubectl logs deployment/ibm-cp4a-operator -c operator > operator.log
    • If this issue is associated with an existing deployment, replace <namespace> and <local_logpath>.
      deployment_name=$(kubectl get icp4acluster | awk '{print $1}' | grep -v "NAME")
      operator_pod_name=$(kubectl get pod|grep ibm-cp4a-operator | awk '{print $1}')
      kubectl cp $operator_pod_name:/logs/$operator_pod_name/ansible-operator/runner/<namespace>/$deployment_name/artifacts /<local_logpath>

    2. Collect as needed
    If relevant to the issue being reported collect the following items.  Most commands must be run within the deployment namespace either by first changing to that workspace, or by adding -n <namespace> to the command.
    •  Collect node information.
      kubectl get nodes -o wide > nodes.txt
      kubectl top nodes > nodeusage.txt
    • Collect pod information.
      kubectl get pods > pods.txt
    • Collect routing information.
      oc get route > routes.txt
    •  Collect the defined secrets.
      kubectl get secrets > secrets.txt
    • Collect the defined persistent volume claims.
      kubectl get pvc > pvcs.txt
    • Collect the description and log of any pod you are having issues with.  See the Pod reference section for a list of pods.
      kubectl describe pod <pod-name> > describe-<podname>.txt
      kubectl logs <podname> > log-<podname>.log
    • For issues processing a document, either at design time, run time, or through the api, collect the Content Analyzer logs.  Navigate to the ACA/configuration-ha/utils folder and run this command.
    • ./
    The script gathers all the logs in to tar files, located in the /tmp/aca folder.
    • For user interface issues in a browser, collect the browser console information.  For Chrome, press F12, select the Console tab, reproduce the issue, and copy the generated contents.

    3. Pod reference
    ADP is tightly integrated with a number of other components within CP4BA.  For questions regarding which pods might be associated with an issue, use this reference.
    • cdra-deploy - Content Designer resources
    • cds-deploy - Content Designer services
    • cpds-deploy - Content Designer deployment
    • bastudio-authoring, bastudio-deployment - Toolkits and templates
    • cpe-deploy - content-processing-services event handlers
    • navigator-deploy - BAStudio applications
    • pbk-ae-deployment - runs the development environment applications
    • workspace-aae-ae-deployment - runs the runtime environment applications
    • viewone-deploy - Daeja ViewONE viewer
    • callerapi, classifyprocess-classify, deep-learning, natural-language-extractor, ocr-extraction, pdfprocess, postprocessing, processing-extraction, rabbitmq-ha, redis-ha-server, setup, spbackend, updatefiledetail, utf8process - Content Analyzer (collect logs with aca_logs_collection script)

  1. Review the log files entries generated at the time of the problem to try to determine the cause.
  2. Check these locations for known issues:
  3. Once you complete gathering all the needed information and diagnostics, you can add them to your case or upload files to ECURep.  More information on ECURep is available at Enhanced Customer Data Repository (ECuRep) - Overview.

[{"Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS2JQC","label":"IBM Cloud Pak for Automation"},"ARM Category":[{"code":"a8m3p000000hAKFAA2","label":"Automation Document Processing-\u003EADP App Management"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)"}]

Document Information

Modified date:
09 November 2021