SSYHZ8_26.0.0 - Documentation Index
Table of Contents
IBM Cloud Pak for Business Automation
Release notes
What's new in 26.0.0
Licenses and entitlements
Traditional license entitlements
Known limitations
Deprecated and removed features
Support lifecycle policy
Privacy and compliance
Guidelines for GDPR readiness
FIPS compliance
Overview
What is IBM Cloud Pak for Business Automation
Which business operations can be optimized
Automation capabilities
Business applications
Business insights
Common tools
Content services
Decision management
Document processing
Process Mining
Robotic Process Automation
Workflow automation
Artificial Intelligence toolkit
Cloud Pak user experiences
Getting started
Cloud Pak personas
Getting started with Red Hat OpenShift
Understanding custom resources and patterns
The Cloud Pak operators
Capability patterns
Custom resource pattern structure
Custom resource pattern templates
Types of deployment and installation steps
Installation steps in HMTL and PDF
Moving to the cloud
Business Automation Workflow
Moving inflight process instances
Moving process instances between environments
Testing process instance move in a test environment
Detailed procedure
Supported database combinations
Troubleshooting process instance move
Moving case instances
By reusing existing on-prem databases
By backing up and restoring the on-premises databases
Moving federation
Case Manager
Content Cortex
Assessing your readiness
Preparing your source Content Cortex environment for the move
Arranging your storage
Gathering the values for your custom resource definition
Backing up the IBM Content Navigator configuration directory
Preparing the target environment for Content Cortex
Deploying in the Cloud Pak
Modernizing Content Cortex
Enabling SSL between components
Configuring Content Platform Engine
Configuring Content Search Services
Configuring Business Automation Navigator
Configuring other components
Content Collector for SAP Applications
Enterprise Records
Operational Decision Manager
Planning
Planning for a production deployment
Planning for a CP4BA multi-pattern production deployment
Capability patterns for production deployments
System requirements
Storage considerations
Persistent volumes and storage classes
Persistent volumes and volume claims
Storage classes
Working around SELinux relabeling when a PV has a high file count
Storage options
Capability storage requirements
Availability of stored data
Comparison between two storage providers
Security considerations
Authentication and authorization considerations
Cluster role permissions
Logging considerations
High availability considerations
Digests versus image tags
External secret management
IBM Instana Observability integration
Monitoring Application Engine that uses Redis
Monitoring Resource Registry (etcd)
Understanding the IBM Content Cortex domain structure in a container environment
Understanding a geographically dispersed Content Cortex domain
Planning for a CP4BA Content Cortex production deployment
Components for a Content Cortex production deployment
System requirements
Storage considerations
Security considerations
Cluster role permissions
Logging considerations
High availability considerations
Digests versus image tags
Understanding the IBM Content Cortex domain structure in a container environment
Understanding a geographically dispersed Content Cortex domain
Planning for a CP4BA Workflow Process Service production deployment
Planning for a Workflow Process Service Runtime deployment
Planning for a CP4BA Process Federation Server production deployment
Installing
Review your deployment options
Installing CP4BA production deployments
Installing a CP4BA multi-pattern production deployment
Quick reference Q&A for online deployments
Quick reference Q&A for offline deployments
Getting access to images from the public IBM entitled registry
Option 1: Preparing your cluster for an online deployment
Preparing a client to connect to the cluster
Preparing your cluster
Preparing a namespace for the operator
Setting up the cluster
(Recommended) Option 1: Setting up the cluster by running a script
Option 2: Setting up the cluster in the OpenShift console
Option 3: Setting up the cluster and use a local image registry
Option 4: Setting up the cluster in silent mode
Option 2: Preparing your cluster for an air-gapped (offline) deployment
Setting up a host to mirror images to a private registry
Setting up a private registry
Option 1: Mirroring the Cloud Pak catalogs to a private registry manually
Downloading the CASE files and cert-kubernetes
Option 1a: Mirroring catalogs to a private registry with a bastion server
Option 1b: Mirroring catalogs to a private registry with a portable compute or a storage device
Option 2: Mirroring the Cloud Pak catalogs to a private registry by running a script
Installing the Cloud Pak catalog and operator instances
Option 1: Installing the Cloud Pak catalog and operator instances by using the cluster admin script (Recommended)
Option 2: Installing the Cloud Pak catalog and operator instances by using ibm-pak
Setting up a repeatable air-gap process
Optional: Mirroring and installing your own curated catalog
Preparing your chosen capabilities
Recommended: Preparing databases and secrets for your chosen capabilities by running a script
Running the cp4a-prerequisites.sh script in property mode
Running the cp4a-prerequisites.sh script in generate mode
Optional: Running the cp4a-prerequisites.sh script in validate mode
Preparing for external secret management
Custom resource parameters for secrets stored in an external vault
Creating custom secrets in vault for Business Automation Workflow
Creating custom secrets in vault for Workflow Process Service runtime
Creating custom secrets in vault for Process Federation Server
Creating custom secrets in vault for Business Automation Insights
Optional: Preparing to monitor your containers
Optional: Preparing customized versions of JDBC drivers and ICCSAP libraries
Business Automation Application
Business Automation Workflow Authoring
Preparing users and groups
Preparing storage
Preparing to install Business Automation Insights
Preparing your environment for customizations
Optional: Enabling the Timeline Visualizer widget to display Business Automation Workflow process activity flow
Business Automation Workflow Runtime and Automation Workstream Services
Preparing users and groups
Creating required databases and secrets without running the provided scripts
Creating required databases in Db2
Creating required databases in Oracle
Creating required databases in PostgreSQL
Creating required databases in SQL Server
Creating secrets to protect sensitive configuration data
Preparing storage
Installing Business Automation Insights
Preparing your environment for customizations
Configuring custom case widgets for a container environment
Configuring custom case extensions for a container environment
Optional: Enabling the Timeline Visualizer widget to display Business Automation Workflow process activity flow
Integrating Workflow automations with ECM content
Content Cortex
Understanding users and groups
Preparing users and groups
Creating the Content Cortex databases and secrets without running the provided scripts
Preparing the databases
Tuning a PostgreSQL database for Content Platform Engine
Tuning a PostgreSQL database for IBM Business Automation Workflow
Using PostgreSQL max_connections and max_prepared_transactions
Creating secrets to protect sensitive IBM Content Cortex configuration data
Creating secrets to protect sensitive Db2 SSL configuration data
Creating secrets to protect sensitive Oracle SSL configuration data
Creating secrets to protect sensitive PostgreSQL SSL configuration data
Creating secrets to protect sensitive Microsoft SQL Server SSL configuration data
Exporting and importing LTPA keys
Exporting and importing Content Platform Engine clientID or clientSecret values for IM
Configuring SSL-enabled LDAP
Configuring storage for the content services environment
Preparing storage for Content Cortex file storage areas and index areas
Creating volumes and folders for deployment on Kubernetes
Preparing volumes and folders for the Content Services GraphQL API container
Preparing to install Content Collector for SAP Applications
Option 1: Creating the persistent volumes (PV) and the persistent volume claims (PVC)
Option 2: Creating the persistent volume claims (PVC) using storage classes
Creating secrets to protect sensitive Content Collector for SAP Applications configuration data
Preparing to enable IBM Content Collector Content Cortex Content Search Services Support
Providing information to create the IBM Content Collector Content Cortex Content Search Services Support configmap
Creating a secret to hold IBM Content Cortex credentials
Creating a secret to hold encryption key information from IBM Content Collector
Preparing to install Enterprise Records
Option 1: Creating the persistent volume (PV) and the persistent volume claim (PVC) manually
Option 2: Creating the persistent volume claim (PVC) using storage classes
Creating secrets to protect sensitive Enterprise Records configuration data
Creating a Cognos data source
Tuning the components in your container environment
Tuning Content Cortex components using automatic horizontal scaling
Tuning IBM WebSphere Liberty for Content Cortex components
Decision Intelligence Client Managed Software
Creating the Decision Intelligence database and secrets without running the provided scripts
Configuring PostgreSQL storage
Configuring Decision Designer
Configuring the decision runtime
Configuring the event emitter for an external Apache Kafka instance
Document Processing
Creating load balancer resources
Creating the Document Processing databases and secrets without running the provided scripts
Creating the databases for Document Processing
Preparing the databases for Document Processing engine
Preparing the Db2 databases
Preparing the PostgreSQL databases
Creating secrets to protect sensitive Document Processing configuration data
Preparing users and groups for Document Processing
Creating volumes and folders for deployment
Preparing the Git connection
Preparing for other components
Operational Decision Manager
Creating the databases without running the provided scripts
Configuring an external database
Configuring a Db2 HA external database
Targeting separate external databases
Configuring a custom external database
Configuring the Decision Center Business console
Workflow Process Service Authoring
Cloud Pak for Business Automation foundation
Application Engine
Optional: Configuring Application Engine with data persistence
Optional: Creating the database and secrets without running the provided scripts
Creating a Db2 database
Creating an Oracle database
Creating a PostgreSQL database
Creating an SQL Server database
Creating secrets to protect sensitive configuration data
Optional: Implementing storage
Optional: Configuring Application Engine with Redis
Optional: Configuring Application Engine with toolkit contributions
Configuring Application Engine with IBM Business Automation Workflow on premise
Business Automation Insights
Customizing persistent storage
Setting up dynamic provisioning for Flink
Setting up manual provisioning for Flink
Customizing persistent storage for Kafka and OpenSearch
Business Automation Navigator
Preparing users and groups
Creating the databases without running the provided scripts
Creating secrets to protect sensitive Db2 SSL configuration data
Creating secrets to protect sensitive Oracle SSL configuration data
Creating secrets to protect sensitive PostgreSQL SSL configuration data
Creating secrets to protect sensitive Navigator configuration data
Creating volumes and folders for deployment on Kubernetes
Business Automation Studio
Optional: Creating databases and secrets without running the provided scripts
Creating Db2 databases
Creating Oracle databases
Creating PostgreSQL databases
Creating SQL Server databases
Creating secrets to protect sensitive configuration data
Optional: Implementing storage
Optional: Configuring Application Engine playback server with Redis
Optional: Configuring IBM Business Automation Studio with other editors
Optional: Configuring IBM Business Automation Studio with toolkit contributions
Preparing to configure Application Designer with Business Automation Workflow with toolkit contributions on premise
Configuring IBM Business Automation Application Designer with toolkit contributions from a container environment
Creating a production deployment
Option 1: (Recommended) Generating the custom resource with the deployment script
Option 2: Installing a production deployment in the OpenShift console
Checking and completing your custom resource
Checking the cluster configuration
Configuring Business Automation Application
Configuring Business Automation Workflow Runtime and Workstream Services
Completing configuration for Machine Learning Server
Configuring Intelligent Task Prioritization
Configuring Workforce Insights
Optional: Configuring multiple instances of Business Automation Workflow and Workstream Services
Configuring Business Automation Workflow Authoring
Configuring Content Cortex
Configuring Content Collector for SAP Applications
Configuring Enterprise Records
Configuring Decision Intelligence Client Managed Software
Configuring Document Processing
Importing the Zen route certificate to the runtime environment
Configuring Operational Decision Manager
Configuring Workflow Process Service Authoring
Configuring Cloud Pak for Business Automation foundation
Configuring Application Engine
Configuring Navigator
Configuring Business Automation Insights
Configuring Business Automation Studio
Validating the YAML in your custom resource file
If required: Deploying the custom resource you created with the deployment script
Optional: Installing network policies
Recommended: Validating your production deployment
Completing post-installation tasks
Business Automation Application
Business Automation Workflow Authoring, Runtime, and Workstream Services
Verifying Business Automation Workflow Runtime
Verifying Business Automation Workflow Authoring
Verifying Workstream Services
Decision Intelligence Client Managed Software
Managing user permissions
Determining Decision Designer server URL
Tuning the logging level
Configuring a generative AI secret
Document Processing
Setting up a remote Git organization
Verifying the installation of the containers
Creating more external databases
Creating external databases
Updating the database secret
Tuning the components in your container environment
Tuning the Horizontal Pod Autoscaler (HPA)
Tuning the memory
Tuning the timeout
Tuning the concurrency level
Tuning the logging level
Tuning PostgreSQL max_connections for Document Processing engine
Content Cortex
Manually initializing and verifying your content services environment
Optional: Manually initializing and verifying your content services environment with SCIM
Configuring the redirect URL with the Identity Provider
(Red Hat OpenShift) Determining routes for service access
Optional: Enabling EMC Elastic Cloud Storage
Optional: Using Content Platform Engine tools
Configuring Content Platform Engine for Content Search Services
Configuring the Content Services GraphQL API
(Optional) Configuring cross origin resource sharing (CORS)
Enabling the Content Services GraphQL API trace log
Verifying the Content Services GraphQL API deployment
Preparing Task Manager datasource connections
Creating storage policy and associate the Advanced Storage Area created during the deployment
Optional: Configuring the Content Cortex for Microsoft Office
Optional: Installing an add-in in Outlook
Optional: Improving security for session cookies
Optional: Creating load balancer resources for content services containers
Optional: Additional configuring and tuning for Content Search Services
Optional: Setting up custom tasks in Task Manager
Optional: Adding object stores post-deployment
Optional: Deleting object stores post-deployment
Troubleshooting Content Cortex initialization
Configuring Content Collector for SAP Applications
Configuring IBM Content Navigator for connecting to Content Collector for SAP Applications
Creating a Content Collector for SAP Applications instance
Connecting to SAP
Configuring IBM Enterprise Records
(Red Hat OpenShift) Determining routes for service access for Enterprise Records
Determining the CPE route and adding the SSL certificate to the IER truststore
Content Cortex AI services
Configuring Content Cortex AI Services to support external MCP clients
Operational Decision Manager
Identifying the services
Installing Rule Designer
Importing a security certificate in Rule Designer
Configuring proxy servers in Rule Designer
Configuring user access
Managing user permissions
Using a Zen API key for authentication
Optional user access configurations
Synchronizing users and groups in Decision Center
Configuring the network policy
Optimizing the execution unit (XU)
Customizing the Decision Center Business console
Customizing Decision Server
Customizing new Decision Server components
Customizing existing Decision Server components
Decision Server parameter properties
Customizing Decision Center
Customizing Decision Runner
Defining scripts for container starts and stops
Configuring multi-zone support
Configuring logging
Customizing JVM options
Workflow Process Service Authoring
ROKS on IBM Cloud
Cloud Pak for Business Automation foundation
Application Engine
Configuring Application Engine for third-party authentication
Business Automation Insights
Importing sample data
Setting up permissions for data access in Business Performance Center
Business Automation Navigator
(Red Hat OpenShift) Determining routes for service access
Configuring SSO logout between Business Automation Navigator and Platform UI (Zen) on OCP
Configuring SSO logout between Business Automation Navigator and Platform UI (Zen) on ROKS
Optional: Configuring Send Mail for Navigator
Optional: Customizing your Navigator firewall settings
Optional: Configuring IBM Business Automation Navigator for session persistence
Troubleshooting Navigator initialization
Business Automation Studio
Optional: Customizing Business Automation Studio properties
Optional: Configuring Application Designer with Business Automation Workflow with toolkit contributions on premise
Troubleshooting Business Automation Studio initialization
Cloud Pak foundational services
Adding or removing capabilities to an existing CP4BA production deployment
Enabling vault integration post-installation
Changing an OLM-based CP4BA deployment to a non-OLM deployment
Updating Workflow to add Workstreams, or Workstreams to add Workflow
Updating Workflow to add Workstream Services
Updating Workstream Services to add Workflow
Updating Workflow Process Service Authoring with other capabilities
Uninstalling capabilities
Option 1: Uninstalling capabilities from the OCP console
Option 2: Uninstalling capabilities from the command line
Cleaning up data
Cleaning up or deleting the Document Processing databases
Cleaning up Content Cortex
Redeploying Cloud Pak for Business Automation deployments
Reinitializing a CP4BA deployment with Business Automation Application
Reinitializing a CP4BA deployment with Business Automation Workflow
Reinitializing a CP4BA deployment with Business Automation Workflow Authoring
Reinitializing a CP4BA deployment with Enterprise Records
Reinitializing a CP4BA deployment with Decision Intelligence Client Managed Software
Reinitializing a CP4BA deployment with Business Automation Insights
Reinitializing a CP4BA deployment with Workflow Process Service Authoring
Redeploying Content Cortex
Redeploying Content Cortex from the OCP console
Redeploying Content Cortex from the command line
Reinitializing Content Cortex
Redeploying a Process Federation Server (PFS) deployment
Redeploying a Workflow Process Service Runtime deployment
Installing multiple versions of CP4BA on the same OpenShift cluster
Installing a CP4BA Content Cortex production deployment
Preparing for a production deployment
Preparing a client to connect to the cluster
Preparing your cluster
Preparing a namespace for the operator
Getting access to images from the public IBM Entitled Registry
Option 2: Setting up the cluster in the OpenShift console
Optional: Preparing customized versions of JDBC drivers and ICCSAP libraries
Preparing Content Cortex operator components
Content Cortex
Understanding users and groups
Preparing users and groups
Creating the Content Cortex databases and secrets without running the provided scripts
Preparing the databases
Tuning a PostgreSQL database for Content Platform Engine
Tuning a PostgreSQL database for IBM Business Automation Workflow
Using PostgreSQL max_connections and max_prepared_transactions
Creating secrets to protect sensitive IBM Content Cortex configuration data
Creating secrets to protect sensitive Db2 SSL configuration data
Creating secrets to protect sensitive Oracle SSL configuration data
Creating secrets to protect sensitive PostgreSQL SSL configuration data
Creating secrets to protect sensitive Microsoft SQL Server SSL configuration data
Exporting and importing LTPA keys
Exporting and importing Content Platform Engine clientID or clientSecret values for IM
Configuring SSL-enabled LDAP
Configuring storage for the content services environment
Preparing storage for Content Cortex file storage areas and index areas
Creating volumes and folders for deployment on Kubernetes
Preparing volumes and folders for the Content Services GraphQL API container
Preparing to install Content Collector for SAP Applications
Option 1: Creating the persistent volumes (PV) and the persistent volume claims (PVC)
Option 2: Creating the persistent volume claims (PVC) using storage classes
Creating secrets to protect sensitive Content Collector for SAP Applications configuration data
Preparing to enable IBM Content Collector Content Cortex Content Search Services Support
Providing information to create the IBM Content Collector Content Cortex Content Search Services Support configmap
Creating a secret to hold IBM Content Cortex credentials
Creating a secret to hold encryption key information from IBM Content Collector
Preparing to install Enterprise Records
Option 1: Creating the persistent volume (PV) and the persistent volume claim (PVC) manually
Option 2: Creating the persistent volume claim (PVC) using storage classes
Creating secrets to protect sensitive Enterprise Records configuration data
Creating a Cognos data source
Tuning the components in your container environment
Tuning Content Cortex components using automatic horizontal scaling
Tuning IBM WebSphere Liberty for Content Cortex components
Preparing to install Cloud Pak for Business Automation foundation
Business Automation Insights
Customizing persistent storage
Setting up dynamic provisioning for Flink
Setting up manual provisioning for Flink
Customizing persistent storage for Kafka and OpenSearch
Business Automation Navigator
Preparing users and groups
Creating the databases without running the provided scripts
Creating secrets to protect sensitive Db2 SSL configuration data
Creating secrets to protect sensitive Oracle SSL configuration data
Creating secrets to protect sensitive PostgreSQL SSL configuration data
Creating secrets to protect sensitive Navigator configuration data
Creating volumes and folders for deployment on Kubernetes
Creating a production deployment
Installing a CP4BA Content Cortex production deployment in the OpenShift console
Configuring Content Cortex
Configuring Content Collector for SAP Applications
Configuring Enterprise Records
Configuring Cloud Pak for Business Automation foundation
Configuring Business Automation Insights
Configuring Navigator
Optional: Installing network policies
Completing post-installation tasks
Content Cortex
Manually initializing and verifying your content services environment
Configuring the redirect URL with the Identity Provider
(Red Hat OpenShift) Determining routes for service access
Optional: Enabling EMC Elastic Cloud Storage
Optional: Using Content Platform Engine tools
Configuring Content Platform Engine for Content Search Services
Configuring the Content Services GraphQL API
(Optional) Configuring cross origin resource sharing (CORS)
Enabling the Content Services GraphQL API trace log
Verifying the Content Services GraphQL API deployment
Preparing Task Manager datasource connections
Creating storage policy and associate the Advanced Storage Area created during the deployment
Optional: Configuring the Content Cortex for Microsoft Office
Optional: Installing an add-in in Outlook
Optional: Improving security for session cookies
Optional: Creating load balancer resources for content services containers
Optional: Additional configuring and tuning for Content Search Services
Optional: Setting up custom tasks in Task Manager
Optional: Adding object stores post-deployment
Optional: Deleting object stores post-deployment
Troubleshooting Content Cortex initialization
Configuring Content Collector for SAP Applications
Configuring IBM Content Navigator for connecting to Content Collector for SAP Applications
Creating a Content Collector for SAP Applications instance
Connecting to SAP
Configuring IBM Enterprise Records
(Red Hat OpenShift) Determining routes for service access for Enterprise Records
Determining the CPE route and adding the SSL certificate to the IER truststore
Completing post-installation tasks for Cloud Pak for Business Automation foundation
Business Automation Insights
Importing sample data
Setting up permissions for data access in Business Performance Center
Business Automation Navigator
(Red Hat OpenShift) Determining routes for service access
Configuring SSO logout between Business Automation Navigator and Platform UI (Zen) on OCP
Optional: Configuring Send Mail for Navigator
Optional: Customizing your Navigator firewall settings
Optional: Configuring IBM Business Automation Navigator for session persistence
Troubleshooting Navigator initialization
Cloud Pak foundational services
ROKS on IBM Cloud
Uninstalling CP4BA Content Cortex from the OCP console
Installing a CP4BA multi-pattern or Content Cortex production deployment with Okta or Microsoft Entra ID integration
Installing a CP4BA Workflow Process Service Runtime production deployment
Customizing Workflow Process Service Runtime
Optional: Configuring Workflow Process Service Runtime to work with Workflow Process Service Authoring
Uninstalling Workflow Process Service Runtime
Installing a CP4BA Process Federation Server production deployment
Federating Business Automation Workflow in CP4BA
Optional: Enabling Common UI
Federated system parameters
Installing a stand-alone Business Automation Insights deployment
Installing IBM watsonx.ai lightweight engine
Installing IBM Model Gateway
Installing multiple Cloud Paks on the same OpenShift cluster
Troubleshooting
Using PDF guides to install a single capability pattern
Upgrading
Upgrading Red Hat OpenShift Container Platform
Preparing for an upgrade
Upgrading deployments in stages
Backing up your environments
Backing up your custom resources
Getting access to the new container images
Upgrading from 25.0.1
Upgrading CP4BA multi-pattern from 25.0.1
Option 1: Upgrading 25.0.1 by running the scripts
Upgrading the CP4BA operators from 25.0.1
Upgrading your IBM Cloud Pak deployment from 25.0.1
Upgrading your CP4BA deployment version from 25.0.1
Updating the custom resource for each capability in your deployment
Upgrading IBM Automation Document Processing
Upgrading IBM Automation Decision Services
Upgrading IBM Automation Workstream Services
Upgrading IBM Business Automation Application
Upgrading IBM Business Automation Workflow Authoring
Upgrading IBM Business Automation Workflow Runtime
Upgrading IBM FileNet Content Manager
Upgrading IBM Content Collector for SAP Applications
Upgrading IBM Enterprise Records
Upgrading IBM Operational Decision Manager
Upgrading IBM Workflow Process Service Authoring
Upgrading IBM Cloud Pak for Business Automation foundation
Upgrading Business Automation Insights
Upgrading IBM Business Automation Navigator
Upgrading IBM Business Automation Studio
Validating the YAML in your custom resource file
Applying the updated custom resource
Installing new or updating network policies
Completing post-upgrade tasks
Completing the IBM Automation Document Processing upgrade
Upgrading document processing applications
Completing the IBM Automation Workstream Services upgrade
Completing the IBM Business Automation Workflow Authoring upgrade
Completing the IBM Business Automation Workflow Runtime upgrade
Completing the IBM Content Cortex upgrade
Verifying the Content Collector for SAP Applications upgrade
Verifying the Enterprise Records upgrade
Enabling event emitters
Completing the IBM Decision Intelligence Client Managed Software upgrade
Completing the IBM Operational Decision Manager upgrade
Completing the IBM Workflow Process Service Authoring upgrade
Completing the IBM Business Automation Navigator upgrade
Rolling back an upgrade
Option 2: Upgrading 25.0.1 by using the CP4BA Automated Upgrade container
Deploying CP4BA Automated Upgrade container
Option 2a: Upgrading by using REST APIs
Upgrading the CP4BA operators
Upgrading your CP4BA deployment
Option 2b: Upgrading in silent mode
Monitoring upgrade tasks
Upgrading CP4BA FileNet Content Manager from 25.0.1
Upgrading CP4BA Process Federation Server from 25.0.1
Upgrading CP4BA Workflow Process Service Runtime from 25.0.1
Upgrading from 25.0.0
Upgrading CP4BA multi-pattern from 25.0.0
Option 1: Upgrading 25.0.0 by running the scripts
Upgrading the CP4BA operators from 25.0.0
Upgrading your IBM Cloud Pak deployment from 25.0.0
Upgrading your CP4BA deployment version from 25.0.0
Updating the custom resource for each capability in your deployment
Upgrading IBM Automation Document Processing
Upgrading IBM Automation Decision Services
Upgrading IBM Automation Workstream Services
Upgrading IBM Business Automation Application
Upgrading IBM Business Automation Workflow Authoring
Upgrading IBM Business Automation Workflow Runtime
Upgrading IBM FileNet Content Manager
Upgrading IBM Content Collector for SAP Applications
Upgrading IBM Enterprise Records
Upgrading IBM Operational Decision Manager
Upgrading IBM Workflow Process Service Authoring
Upgrading IBM Cloud Pak for Business Automation foundation
Upgrading IBM Business Automation Insights
Upgrading IBM Business Automation Navigator
Upgrading IBM Business Automation Studio
Validating the YAML in your custom resource file
Applying the updated custom resource
Installing new or updating network policies
Completing post-upgrade tasks
Completing the IBM Automation Document Processing upgrade
Upgrading document processing applications
Completing the IBM Automation Workstream Services upgrade
Completing the IBM Business Automation Workflow Authoring upgrade
Completing the IBM Business Automation Workflow Runtime upgrade
Completing the IBM Content Cortex upgrade
Verifying the Content Collector for SAP Applications upgrade
Verifying the Enterprise Records upgrade
Enabling event emitters
Completing the IBM Decision Intelligence Client Managed Software upgrade
Completing the IBM Operational Decision Manager upgrade
Completing the IBM Workflow Process Service Authoring upgrade
Completing the IBM Business Automation Navigator upgrade
Rolling back an upgrade
Option 2: Upgrading 25.0.0 by using the CP4BA Automated Upgrade container
Deploying CP4BA Automated Upgrade container
Option 2a: Upgrading by using REST APIs
Upgrading the CP4BA operators
Upgrading your CP4BA deployment
Option 2b: Upgrading in silent mode
Monitoring upgrade tasks
Upgrading CP4BA Workflow Process Service Runtime from 25.0.0
Upgrading CP4BA Process Federation Server from 25.0.0
Upgrading CP4BA FileNet Content Manager from 25.0.0
Upgrading from 24.0.0
Upgrading CP4BA multi-pattern from 24.0.0
Option 1: Upgrading 24.0.0 by running the scripts
Upgrading the CP4BA operators from 24.0.0
Upgrading your IBM Cloud Pak deployment from 24.0.0
Option 1: Upgrading a CP4BA deployment that uses an external PostgreSQL
Option 2: Upgrading a CP4BA deployment that uses an external database that is not PostgreSQL
Updating the custom resource for each capability in your deployment
Upgrading IBM Automation Document Processing
Upgrading IBM Automation Decision Services
Upgrading IBM Automation Workstream Services
Upgrading IBM Business Automation Application
Upgrading IBM Business Automation Workflow Authoring
Upgrading IBM Business Automation Workflow Runtime
Upgrading IBM FileNet Content Manager
Upgrading IBM Content Collector for SAP Applications
Upgrading IBM Enterprise Records
Upgrading IBM Operational Decision Manager
Upgrading IBM Workflow Process Service Authoring
Upgrading IBM Cloud Pak for Business Automation foundation
Upgrading IBM Business Automation Insights
Upgrading IBM Business Automation Navigator
Upgrading IBM Business Automation Studio
Validating the YAML in your custom resource file
Applying the updated custom resource
Installing new or updating network policies
Completing post-upgrade tasks
Optional: Deleting the old OpenSearch instance
Completing the IBM Automation Document Processing upgrade
Upgrading document processing applications
Completing the IBM Automation Workstream Services upgrade
Completing the IBM Business Automation Workflow Authoring upgrade
Completing the IBM Business Automation Workflow Runtime upgrade
Completing the IBM Decision Intelligence Client Managed Software upgrade
Completing the IBM Content Cortex upgrade
Verifying the Content Collector for SAP Applications upgrade
Verifying the Enterprise Records upgrade
Enabling event emitters
Completing the IBM Operational Decision Manager upgrade
Completing the IBM Workflow Process Service Authoring upgrade
Completing the IBM Business Automation Navigator upgrade
Rolling back an upgrade
Option 2: Upgrading 24.0.0 by using the CP4BA Automated Upgrade container
Deploying CP4BA Automated Upgrade container
Option 2a: Upgrading by using REST APIs
Upgrading the CP4BA operators
Option 1: Upgrading a CP4BA deployment that uses an external PostgreSQL
Option 2: Upgrading a CP4BA deployment that uses an external database that is not PostgreSQL
Applying the updated custom resource
Option 2b: Upgrading in silent mode
Monitoring upgrade tasks
Upgrading CP4BA FileNet Content Manager from 24.0.0
Upgrading CP4BA Workflow Process Service Runtime from 24.0.0
Upgrading CP4BA Process Federation Server from 24.0.0
Optional: Enabling vault integration post-upgrade
Optional: Enabling Content Cortex AI services post-upgrade
Uninstalling the CP4BA API Helm chart
Troubleshooting script-based upgrade
Troubleshooting REST API-based upgrade
Migrating stored data from versions that do not support a direct upgrade
Migrating data from Operational Decision Manager
Integrating MCP servers with AI Agents
IBM Model Gateway
Samples
Administering
Accessing the CP4BA capability user interfaces
Adding LDAP configurations
Authorizing HTTP requests by using the Zen API key
Configuring security
Customizing the Cloud Pak entry point
Customizing the Cloud Pak Identity Management (IM) service
Managing certificates
Allowing external services to connect with endpoints over TLS
Changing the default root CA signer certificate
Creating secure endpoints for external services
Connecting endpoints to external services over TLS
Extracting the root CA for external services
Importing the certificate of an external service
Customizing Kafka route certificates
Debugging TLS connections
Configuring cluster security
Changing the directory service bind credentials
Restricting resource consumption
Verifying container image integrity
High availability in Cloud Pak for Business Automation
Configuring components for disaster recovery
Disaster recovery in Cloud Pak for Business Automation
Preparing your environment for disaster recovery
Enabling Resource Registry for disaster recovery
Preparing Workflow Process Service for disaster recovery
Backing up your environment
Backing up Decision Intelligence Client Managed Software
Backing up Automation Document Processing
Persistent volume claims to be backed up
Restoring your environment
Restoring Decision Intelligence Client Managed Software
Restoring Automation Document Processing
Applying a rolling update strategy
Placing pods on particular nodes
Configuring application probes
Managing your license entitlements
Collecting and sending metrics to IBM Software Central
Reporting usage metrics with IBM Usage Metering Service
Uploading usage metrics to IBM Software Central
Uploading License Service metrics to IBM Software Central
Viewing license metrics with ILMT
Calculating your capacity usage
Managing CP4BA deployment compute resources
Accessing files for applications and configurations
Setting the session idle time limits for Platform UI (Zen)
Configuring OpenSearch to increase resource requirements
Updating JDBC drivers
Checking the status of your cluster and CP4BA deployments
Generating logs for auditing purposes
Collecting performance data for IBM System Dashboard
Monitoring CP4BA deployments in IBM Instana Observability
Monitoring CP4BA deployments in Prometheus and Grafana
Optimizing resource usage with IBM Turbonomic
Tuning performance
Visualization tool for CP4BA resources
Capabilities
Business applications and external automation services
Overview
User interface elements
View properties
Creating an application
Creating actions
Creating reusable views
Providing information about views
Categorizing views
Defining view behavior
Accessing a child view
Configuring the design-time appearance of views
Adding variables to views
Defining the contents of views
Setting the visibility of views
Calling actions from views
Generating URLs of managed assets
Calling services
Published automation services
External REST services
OpenAPI support
Previewing applications
Requesting that a version be published
Publishing and administering applications
Publishing applications
Adding applications
Managing applications
Configuring imported applications for third-party authentication
Cleaning up stale applications in Application Engine
Translating applications
Creating localization resources
Translating user interfaces
Translating configuration options for views
Translating your app name
Reference
Included toolkits
Downloadable toolkits
JavaScript APIs for actions
JavaScript APIs that can be used in views
REST APIs for DevOps
Configurators
Setting environment variables
Data persistence
Securing business application data
Embedding apps in external web pages
Business insights
Discovering IBM Business Automation Insights
Overview
Architecture and workflow
Supported topologies
Processing events
Fixed-format event emission
Events from custom sources
Processing Application
Getting started with your first Processing Application
Creating a Processing Application
Testing the Processing Application
Testing multiple events
Implementing event processing
Defining the ingress
Defining the egresses
Filtering events
Transforming events
Anonymizing data
Defining stateful event processing
Duration operations
Custom operations
Handling uncompleted operations
Managing events order within operations
Handling errors
Processing configuration
Managing a Processing Application
Decision management event processing walkthrough
How to get the Kafka connection information to configure a custom event emitter
Walkthrough overview
Default configuration
Updating the processing configuration
Monitoring source for ODM
Examples
What the examples help you do
Example 1: Separating business data from common data
Example 2: Writing time series to dedicated indices
Example 3: Filtering out data
Example 4: Obfuscating data
Using the management CLI
Content event processing
Default configuration
Migration considerations
Visualizing data
Business Performance Center overview
Definitions
Measurements, aggregations, and group by in charts
Measurements
Aggregations
Group by
Tutorial: Monitoring the hiring process
Step 1: Define a goal
Step 2. Create a dashboard
Step 3: Using a dashboard
Summary
User roles
Setting up data permissions
Authoring permission management
Associating teams and sources
Creating and customizing dashboards and charts
Creating dashboards
Creating charts
Selecting data to display in charts
Refining data for charts
Displaying data in charts
Customizing charts
Making a custom color palette for a chart
Displaying values in charts
Displaying legends in charts
Defining KPI thresholds
Creating drill-down charts
Setting time display format for durations
Enabling predictions
Enabling Workforce Insights
Setting goals
Creating your own monitoring sources
Working collaboratively with dashboards and charts
Exporting the content of a chart
Sharing dashboards and charts
Exporting and importing dashboards
User-owned dashboard - Use cases
Working with templates
Setting template permissions
Built-in dashboard templates
Workflow dashboards
Case dashboards
Content dashboard
Navigator dashboard
Content Cortex Workflow dashboards
Decisions dashboard
Decision Intelligence Client Managed Software dashboards
BPMN process dashboard
User-owned dashboard templates
Using the REST API
Interacting with dashboards
Setting alerts
Defining targets
Suggestions
Finding goals and dashboards
Filtering the dashboard list by monitoring source
Changing the monitoring source in several charts
Creating dashboard filters on charts
Displaying dashboards and charts in an external web application
Troubleshooting
Storing data
OpenSearch data storage
Naming conventions for indices and aliases
Predefined OpenSearch aliases and indices
Custom events
Creating rollover indices
Rolling over indices: General procedure
Rolling over indices that store active summaries
Cleaning up indices
Troubleshooting
Administering
Checking the status of your cluster and Business Automation Insights deployments
Pods within a Kubernetes cluster
Accessing Business Automation Insights services
Configuring for custom events
Configuring event emitters
Work context correlation
Retrieving information for connection to Kafka
Option 1: Retrieving information for connection to Kafka using commands
Option 2: Retrieving information for connection to Kafka using ConfigMap
Workflow event emitters configuration
Content event emitter configuration
ODM event emitter configuration
Decision Intelligence Client Managed Software event emitter configuration
Navigator event emitter configuration
Prerequisites
Configure Navigator event emitter for Navigator container deployment
Configure Navigator event emitter for On-prem Navigator installation
Customizing the configuration file
Initial event emitter configuration
Securing communications from event emitters to Kafka
From the BPM event emitter
Using your own keystore
Generating a truststore for the BPM event emitter
From the Case event emitter
Generating a truststore for the Case event emitter
Updating your Business Automation Insights custom resource
Configuring custom secrets
Creating custom-bai-secret
Creating custom-bpc-workforce-secret
Configuring Business Performance Center
Advanced updates
Backing up and restoring your deployment
Customizing Kafka resource
Moving to production
Prerequisites
Sizing your environment
Scaling an Business Automation Insights system
Job parallelism
Kafka partitions
Kafka retention period
Configuration for HA and fault tolerance
Adjusting parameter values
Operating Business Automation Insights
Operating an Apache Flink cluster
Cluster components
Specific configurations
For RocksDB properties
For Kafka properties
For Apache Flink job logging
Enabling Flink Job Manager high availability
Operating OpenSearch
OpenSearch capabilities for Business Automation Insights
Taking and restoring snapshots of OpenSearch data
Enabling snapshots repository
Taking snapshots by using _snapshot API
Restoring snapshots by using _snapshot API
OpenSearch security plug-in
Preparing your cluster for fault tolerance
Preparing against failure
Checkpoints and savepoints
Restarting from a checkpoint or savepoint
Securing communications and data
Securing communications to Kafka
Retrieving the Kafka truststore
Retrieving the Kafka username and password
Monitoring deployments in IBM Instana Observability
Troubleshooting
Troubleshooting the Workflow event emitter
Troubleshooting the Content event emitter
Troubleshooting Case dashboards
Troubleshooting Apache Flink jobs
Troubleshooting Setup
Reference
IBM Business Automation Insights architecture
Reference for BAW events
Reference for Content events
Reference for ODM events
Operational Decision Manager time series formats
Raw decision event formats
Reference for DICMS events
Common tools
Business Automation Navigator
Administering Business Automation Navigator
Troubleshooting Business Automation Navigator
Business Automation Studio
Projects
Business automations
Automation services
Granting access
Deploying
External automation services
Publishing
Deploying
Managing
Security considerations
Content services
Overview
Business object management
Application development and business objects
Properties
Events and subscriptions
Lifecycles
Property and full-text search capabilities
Bulk processing
Versioning
Classification
Entry templates
Managing XML content
Content storage
Content caching
Import and export
Retention and holds
Enabling Business Automation Insights
Decision management
Decision Intelligence Client Managed Software
Overview
Modeling and authoring business decisions
Collaborating on decision services
Integrating generative AI in decisions
Infusing business decisions with machine learning
Deploying and executing decision services
Administering
Configuring credentials for a Maven repository manager
Configuring global machine learning providers
Connecting to a remote repository automatically
Setting up your build environment
Using Decision Designer as a Maven repository
Using an external Maven repository
Installing the Decision Intelligence Client Managed Software command-line tool
Configuring Horizontal Pod Autoscaler
Learning resources
Getting started
Before you start
Task 1: Making a decision service
Task 2: Exposing and sharing your decision service
Task 3: Adding nodes
Task 4: Creating a data model
Task 5: Using the interaction policy
Task 6: Deploying and running a decision
Best practices tutorials
Best practices for modeling decisions
Task 1: Making an individual decision
Task 2: Making decisions for a population of cases
Task 3: Making decisions for families of cases
Task 4: Making intermediate decisions
Task 5: Creating composite types
Task 6: Applying a decision logic to many values
Task 7: Applying decision models to multi-valued variables
Task 8: Adding a final decision node
Best practices for defining the decision logic
Task 1: Making decisions with single rules
Task 2: Ensuring completeness
Task 3: Understanding undefined decisions
Task 4: Selecting or aggregating values from multiple rules
Task 5: Implementing sequential rule-based decision modeling
Predictive modeling tutorials
Using machine learning to make better decisions
Task 1: Defining and deploying a machine learning model in Watson Machine Learning
Task 2: Defining a machine learning provider in Decision Designer
Task 3: Defining and using a predictive model
Task 4: Deploying and executing the decision service
Quick guide: Integrating Watson Machine Learning with decision services
Task 1: Creating an empty deployment space in Watson Studio
Task 2: Defining a machine learning provider in Decision Designer
Task 3: Uploading a PMML file and connecting a predictive model
Task 4: Running a predictive model and a decision model
Quick guide: Using the embedded machine learning provider
Task 1: Defining a machine learning provider in Decision Designer
Task 2: Uploading a PMML file and connecting a predictive model
Task 3: Running a predictive model and a decision model
Using machine learning to reduce customer churn
Task 1: Setting up the sample
Task 2: Reviewing the sample details
Importing a PMML file to create a transparent predictive model
Task 1: Importing a sample decision service and exploring resources
Task 2: Creating and configuring a predictive model
Task 3: Integrating the predictive model into a decision model
Using generative AI within decisions
Task 1: Configuring a generative AI provider
Task 2: Importing and exploring a sample decision service
Task 3: Creating a generative AI model and integrating it into a decision model
Using a definition file to create a data model
Importing a data model definition file
Samples and tutorials in GitHub
Building decision services in Decision Designer
Building decision services
Defining data
Creating data models
Creating data types
Introduction to data types
Creating composite types
Creating enumeration types
Entering values manually
Extracting values from an external data source
Importing an Excel file
Mapping values to an enumeration type
Updating values
Creating business functions
Creating functions
Creating actions
Importing a data model definition file
Definition file annotations
Defining default values
Using data models in other decision artifacts
Default verbalization
Default verbalization in Brazilian Portuguese
Default verbalization in Chinese
Default verbalization in English
Default verbalization in French
Default verbalization in German
Default verbalization in Italian
Default verbalization in Japanese
Default verbalization in Spanish
Working with external libraries
Building an external library
Creating a POM file for an external library
Generating the external library files
Editing the generated files
Editing the vocabulary
Vocabulary
Vocabulary elements
Placeholders
Default verbalization in English
Vocabulary properties
Vocabulary errors and warnings
Editing terms
Documenting terms
Adding annotations
Annotations
Collections
Pure functions
Impure functions
Constructors
Value types
External annotation files
Adding custom BOM types and members
Defining custom members and their implementation
Understanding BOM-to-XOM mapping
Method restrictions
Importing an external library into Decision Designer
Using an external library in a decision service
Changing the version of an external library
Updating external libraries
Creating decision models
Designing a decision
Creating a decision diagram
Defining input
Creating an input data node
Defining a default value
Adding decisions
Creating a decision node
Adding the decision logic
Creating a business rule
Creating a decision table
Defining a default value
Choosing an interaction policy
Calling other models
Creating task models
Orchestrating rules
Creating task model artifacts
Creating a folder
Creating a business rule
Creating a decision table
Creating a variable set
Creating a ruleflow
Building a ruleflow
Defining the ruleflow structure
Adding task nodes
Adding a rule task node
Adding an action task node
Adding a function task node
Adding a subflow task node
Connecting nodes
Using a generative AI output in a ruleflow
Choosing an execution mode
Choosing a language
Creating functions
Creating generative AI models
Creating prompts
Creating predictive models
Managing local machine learning providers
Creating a predictive model
Configuring a predictive model
Invoking a machine learning model hosted remotely
Importing a transparent machine learning model
Mapping input data types
Editing the invocation rule
Mapping output data types
Updating a predictive model
Integrating a predictive model
Authoring the decision logic
Working with business rules
How business rules work
Rule variables
Types of rule variables
Rule conditions
Conditions that compare business terms and values
Conditions that test for existence
Conditions that test for set membership
Combinations of conditions
Combination negation
Rule actions
Rule actions for lists of business terms
Dependency of rule actions on rule variables
Using the rule editor
Creating rule parts with the completion menu
Using punctuation to avoid ambiguity
Setting completion menu options
Basic syntax checks
Using shortcuts
Working with decision tables
Columns
Using the column menu
Defining columns
Sorting and filtering columns
Rows
Using the row menu
Adding a partially completed row
Grouping and splitting rows
Cells
Using the cell menu
Specifying values
Changing the default operator for a cell
Preconditions
Using decision table locking facilities
Decision tables errors and warnings
Exporting and importing decision tables with Excel
Conducting completeness analysis
Reusing decision artifacts
Publishing decision artifacts
Managing dependencies
Creating decision operations
Creating versions
Comparing revisions of decision artifacts
Automatic refactoring
Finding references
Interacting with Decision Designer through an MCP server
Configuring IBM Bob to connect to the MCP server
Using the MCP server
Working collaboratively on decision services
Loading changes
Resolving conflicts
Sharing changes
Reverting changes
Restoring changes
Managing decisions
Managing access to decision automations
Connecting to a remote repository manually
Managing decision services
Managing branches
Creating branches
Merging branches
Protecting branches
Editing group IDs
Testing decision services
Running models with test data
Unit testing
Adding JSON scenarios
Deploying decision services
Building and deploying from Decision Designer
Publishing decision services in Business Automation Studio
Building and deploying from a CI/CD stack
Publishing decision services with ASRA API
User permissions and authentication modes
Publishing a decision service
Swagger UI for ASRA
Deploying to decision runtime with REST API
Deployment spaces
Promoting deployed decision services
Promoting automation services
Executing decision services
Decision services from the run service
Decision services from a CI/CD stack
Decision service metadata
Executing decision services with decision runtime
Prometheus metrics endpoint for decision service executions
User permissions and authentication modes
Selecting decision services for execution
Executing the last deployed version
Executing the last semantic version
Executing the last sorted version
Executing a specific version
Calling decision services
Execution trace for decision runtime
Runtime snapshots
Swagger UI for decision runtime API
Emitting decision execution events
Executing decision services with execution Java API
Metering and tracking usage for execution Java API
Application packaging
Executing a decision operation
Input and output format
Machine learning services
Execution trace for execution Java API
Integrating decision services into AI applications
Reference
Decision Intelligence Client Managed Software command-line tool reference
Annotations Java API reference
Error codes in predictive model output
Languages reference
Rule language
Rule structure
Understanding the structure of business rules
Condition part
Preconditions
for each (object) called (variable), in (list)
definitions
set (variable) to (definition)
from (object)
in (list)
(attribute) of (list)
where (test)
Conditions
all (type) in (list)
all of the following conditions are true
any of the following conditions is true
in (list)
it is not true that (a condition)
(attribute) of (list)
none of the following conditions are true
the number of (type)
there are (number) (type)
there are at least (number) (type)
there are at most (number) (type)
there are less than (number) (type)
there are more than (number) (type)
there is at least one (type)
there is at most one (type)
there is no (type)
there is one (type)
Action part
add (object) to (variable)
define (variable) as (value)
for each (object) in (list)
(attribute) of (list)
print (string)
remove (object) from (variable)
set (variable) to (value)
Data types and functions
Numbers
Mathematical operators and functions
Number comparison functions
Boolean
Logical operators
Dates and times
Time point functions
Time period functions
Calendar duration functions
Strings
String functions
String conversion functions
String patterns
String interpolation
String affiliation
Lists
List functions
Aggregation functions
Stream operators
Object functions
Punctuation in rules
Advanced Rule Language (ARL)
ARL syntax
Variables
Data types
Operators
Type conversion
Expressions
Statements
Keywords
ARL task model examples
Business Function Language
Expressions
Statements
Actions
String affiliation
declare
if/then/else
while
for each
result
Unit testing Java API reference
Decision runtime REST API reference
Execution Java API reference
Automation service registration REST API reference
Business Automation Insights reference
Technical and business event format
Raw event format
Known limitations
Troubleshooting
Decision returns null
A rule is not executed
An exception is thrown
An ads-runtime pod is evicted because the EmptyDir volume for archive-cache-dir exceeds the limit
Decision Designer fails to connect to services during startup
Runtime container does not start after the database migration or update failed
Glossary
Operational Decision Manager
Getting Started
Using Decision Server
Using Decision Center
Accessing Decision Center remotely from a Java client
Calling Decision Center Ant tasks
Automating project builds with the Build Command
Creating dedicated runtime pods for specific rulesets
Configuring dedicated runtime pods
Ruleset path format
Accessing a dedicated runtime service
Implementation details
Custom configuration references
Best practices and troubleshooting
Setting up custom data providers
Scaling deployments
Manual scaling
Autoscaling
Customizing log levels
Changing the time zone
Troubleshooting
Authentication limitation
Document processing
What is IBM Automation Document Processing?
Collaborating on document processing projects
Type of deployments
Deployment architecture
Document Processing security and roles
Business Teams permissions
Adding collaborators to a project
Best practices on OCR with IBM Automation Document Processing
Best practices on table extraction
Supported languages
Creating a document processing project
Configuring a Git repository for a project
Configuring your project settings
Document Processing event webhooks
Exporting training files
Exporting training files
Creating a document classification model
Establishing document types
Training and testing the classification model
Creating a data extraction model
Reviewing document samples
Adding fields
Creating a table field
Creating composite fields
Adding enrichments to a field
Annotating sample documents
Annotating table fields
Annotating composite fields
Reviewing the trained model
Testing the extraction model
Using feedback documents from applications to improve training
Enabling feedback from Runtime environment
Defining field types and enrichments
Creating a composite field type
Importing a library
Field types for Document Processing
Extractors
Converters
Formatters
Validators
Example: Creating a custom enrichment manually
Understanding model accuracy
Standardizing your data
Setting document retention
Saving a document processing project
Deleting a document processing project
Deploying and publishing a document processing project
Deployment overview
Deploying your Document Processing project in an authoring environment
Deploying your Document Processing project in a runtime environment
Sample deployment scripts
Determining your Document Processing project ID
Content Project Deployment Service REST API
Deployment REST API endpoints
Developing a document processing application
Creating a document processing application
Setting security for your application
Deploying your document processing application
Moving your application to runtime
Granting runtime users access to your application
Document Processing templates and toolkits
Configuring the display of fields in applications
Processing documents
Overview of the concepts
Processing single documents
Processing batches
Creating batches
Fixing classification issues
Fixing data extraction issues
Developing document processing integrations
Integrating content by using GraphQL
Integrating with IBM Datacap
Automation Document Processing API
Requests
Outputs
Response codes
Error codes
Administration APIs
Administration APIs
Document Processing webhooks with Content Platform Engine
Integrating with IBM App Connect Enterprise
Installing IBM App Connect Enterprise
Configuring the IBM App Connect Enterprise environment for IAM authentication
Creating an IBM App Connect Enterprise REST API project
Deploying to the IBM App Connect Enterprise integration server
Creating the Content Platform Engine Webhook Event Action
Initiating the integration flow
Integrating with IBM Business Automation Workflow
Configuring your environment variables
Running your application
External Services Flow
Enabling callbacks
Creating an external egress for Document Processing engine when an external application uses webhooks
Troubleshooting Document Processing
Updating memory settings for the ClassifyProcess pod
Creating a sweep for retention date changes
Troubleshooting project deployment
Troubleshooting webhook
Troubleshooting a deployment in an authoring environment
Using the Clean Deployment utility
Deleting and recreating a project database
Troubleshooting runtime applications
Troubleshooting address parsing and extraction
Glossary
Workflow automation
Overview
What is a process
What are services
What is a case solution
Managing projects
Enabling application-specific logging in Process Designer
Converting project artifacts
Working with projects
Versioning projects
Naming conventions
Managing versions
Creating a version
Copying a version
Exporting a version
Deleting a version
Defining the instance migration policy
Managing tokens
Moving tokens
Deleting tokens by using the REST API
Deleting tokens in the Process Inspector
Defining the instance migration policy by using a REST API
Exporting projects
Importing projects
Subscribing to Blueworks Live processes
Subscribing in the designer
Managing changes for Blueworks Live processes
Removing Blueworks Live subscriptions
Managing branches
Creating branches
Editing branches
Setting the default branch
Deleting branches
Configuring projects for CI/CD integration
Integrating with Github
Integrating with JFrog artifactory
Managing servers
Adding a server configuration
Customizing the container runtime environment Workflow Server to connect to Workflow Center
Managing access
Granting access to the repository
Installing snapshots
Snapshot deployment requirements
Snapshot installation
Installing snapshots to a connected workflow server
Installing snapshots to an offline server
Using Business Automation Studio
Installing workflow projects to an offline server by calling REST APIs
Clearing deployment packages
Building a custom deployment service flow
Troubleshooting snapshot installations
Snapshot installation process
Administering the Workflow Center index
Manually re-creating or updating the Workflow Center index
Configuring the Workflow Center index
Setting environment variables
Adding support to Case Package for non-English locales
Modifying toolkit dependencies
Viewing toolkit dependencies
Building
Creating a workflow automation
Processes
Creating a process
Implementing activities
Working with inline user tasks
Configuring page templates for inline user tasks
Converting inline user tasks to use stand-alone implementations
Creating loops
Configuring simple loops
Configuring multi-instance loops
Associating loop activity instances with different items
Configuring conditional activities
Implementing a conditional activity
Using JavaScript
External implementations
Creating an external implementation
Invoking an external implementation
Using the Authoring Assistant
Creating an unstructured (ad hoc) activity
Setting preconditions
Example: Starting an unstructured (ad hoc) activity (JavaScript API)
Converging and diverging process flows
Task types
Modeling subprocesses
Modeling non-reusable subprocesses
Working with linked processes
Calling a linked process dynamically
Modeling event subprocesses
Modeling events
Event types
Modeling delays, escalations, and timeouts
Modeling message events
Using start message events
Using intermediate and boundary message events to receive messages
Using message (receiving) event to receive messages
Using intermediate message events and message end events to send messages
Using message end events
Modeling event gateways
Handling errors using error events
Handling errors in processes
Handling errors in services
Reserved error codes
Undercover agents
For a message event
For a scheduled message event
For a content event
Setting the target for a UCA message event
Assigning teams to a process
Process instance owners team
Assigning a dynamically retrieved team
Assigning teams to user tasks
Starting a process
Document start event
Starting a process by using a REST API call
Creating user interfaces for process instances
Making process instance user interfaces reusable
Visualizing process data
Visualize data variables
Visualize tag groups
Selecting Business Automation Workflow or an external ECM system to manage folders
Adding references
Local documents
Linked process folders
Managing external files
Configuring managed asset and managed asset classloader cache sizes
Adding managed files
Updating or replacing managed files
Creating a team
Using team services to define dynamic teams
Setting up a team retrieval service
Defining team managers
Creating user interfaces
User interface concepts
Themes
Human services
Dashboards
Coaches
Views
Templates
Properties
General
Positioning
Configuration
User-defined events
Visibility
HTML attributes
Formulas
Dynamic property configuration
Drill-down trees
Data binding for views
Binding data and configuration options
Boundary events
Event handlers for views
Addressing
Custom functions
Framework-managed vs view-managed
Advanced items for views
Content box
Custom HTML
Modeling client-side human services
Tools for client-side human services
Building a client-side human service
Validating data in client-side human services
Reusing client-side human services
Data mapping in nested client-side human services
Example: Reusing a nested client-side human service
Declaring variables
JavaScript API for client-side human service development
Calling another service
Implementing exclusive gateways
Adding notes
Saving the execution state
Validating pages
Without exiting the coach
After exiting a coach
Handling errors
Catching errors by using error intermediate events
Catching errors by using error event handlers
Throwing errors by using error end events
Handling data changes
Assigning pre- and post-execution scripts
Adding HTML meta tags
Enabling work to be postponed and resumed at run time
Enabling tasks to be reassigned at run time
Navigation options after service completion
Running and debugging
Troubleshooting errors
Building coaches
Developing reusable views
Providing information about views
Categorizing views
Defining view behavior
Accessing a child view
Configuring the design-time appearance of views
Adding variables to views
Defining the contents of views
Adding bidirectional language support
Setting the visibility of views
Calling services from views
Generating URLs of managed assets
Generating a unique ID for a view
Laying out a page or view using the grid layout
Tips for debugging view lifecycle method inside client-side human services
Accessing coach performance statistics
Troubleshooting user interfaces
Responsive settings for views
Localizing workflow automations
Creating localization resources
Localizing user interfaces
Localizing configuration options for views
Enabling document support
Integrating with ECM systems
Adding an ECM server
Enabling the creation, update, and download of ECM documents
Disabling the ECM Query Authorization Service
Outbound interactions
Outbound operations
Authentication scenarios
CMIS web service clients
Attaching different policy sets or bindings
How to use views to store or view documents
Configuring coach views for ECM documents
Integrating with an ECM system or a BPM document store
Building a query for an ECM search operation
Working with a search result programmatically
Working with document content
Data mapping
Authorization of documents and folders in a process
Inbound events
Runtime behavior
Performing modeling tasks for inbound events
Subscribing to events
Content event types
Creating attached services
For a content event
Adding a content event to a process
The ECMContentEvent business object
Performing administrative tasks for inbound events
Creating an event handler
Using the event handler for FileNet Content Manager
Troubleshooting
Integration considerations for ECM products
References to external ECM systems from a BPM folder
IBM FileNet Content Manager
Alfresco Community
Microsoft SharePoint
Accessing the SharePoint CMIS provider
Enabling processes for tracking and reporting
Tracking performance data
Designing process interactions for business users
Configuring a role-based business user interface
Making business data available in searches and views
Creating a user attribute definition
Automatically starting the user's next task
Enabling process instance management
Due dates for processes and activities
Setting the work schedule for a process
Creating and managing time and holiday schedules
Specifying activity due dates
Generating names for process instances
Services
Service types
Integrating services
Overview: Integrating external services
Creating a service flow
Service Flow editor palette
Using transient variables in service flows
Adding a service from the library
Adding a generative AI task to a service flow
Building a generative AI task in a service flow
Sample prompts
Adding a decision task to a service flow
Using decision tables
Using action rules
Business rule parts and structure
Exporting rules and decision tables
Using a remote decision service
Calling another service
Using IBM ODM business rules
Handling errors
Catching errors
Throwing errors
Using scriptlets in script tasks
Assigning pre- and post-execution scripts
Globalizing service flows
Implementing exclusive gateways
Sending messages to undercover agents
Enabling runtime data tracking
Calling services from views
Securing services
Running and debugging
Enabling transactional service flows
Calling an external service
Invoking a REST service
Specifying a REST server
Invoking a REST service by using JavaScript
Passing input parameters
Specifying authentication, modifying binding information, and working with response headers
Passing files
Handling REST service errors
OpenAPI support
Invoking a web service
Discovering and invoking a web service
Adding a web services server
Creating implicit SOAP headers
Adding SOAP headers to a SOAP request message
Retrieving SOAP headers from the SOAP response message
Troubleshooting web services and outbound web service integrations
Troubleshooting XML schema messages for web service integrations
Invoking a Java service
Invoking SQL Integration service flows
Integrating AI agents
Integrating applications
Customizing application connector configuration
Microsoft Exchange
Exposing services
Kafka services
MQ services
REST services
Response handling for asynchronous operations
Web services
Automation services
Providing workflow automation services
Calling an automation service
Business objects and variables
Variable types
Variable scope
Creating business objects
Importing business objects
Shared business objects
Save services
Business object advanced properties
Declaring and passing variables
How variables are passed
Declaring variables
Mapping input and output data for an activity in processes or human services
Initializing parent objects for data mapping
Mapping input and output data for an activity in a service flow
Declaring variables for a subprocess
Using complex variables and lists
Retrieving and setting properties of a business object
Creating exposed process values
Setting variables in pre and post assignments
Making business data available in searches and views
Tracking groups of process variables
Creating a tracking group
Associating process variables to a tracking group
Running and debugging
Processes
Client-side human services
Service flows
Using breakpoints
Restricting access to debugging for services
Logging in as another user
Searching for process instances
Inspector reference
Run actions
Debug actions
Deploying and installing
Workflow automations and automation services
To an offline server by calling REST APIs
Customizing
Customizing Business Automation Workflow Runtime to connect to Workflow Center on premise
Customizing Business Automation Workflow Runtime to connect to Workflow Authoring
Customizing Business Automation Workflow with multiple target object stores
Customizing Business Automation Workflow properties
Setting the time zone
Updating the deployment after an LDAP password change
Enabling generative AI
Through the model gateway
Through direct connection to watsonx.ai
watsonx.ai Lightweight Engine
Processing documents with generative AI
Configuring Workplace Assistant
Enabling Content Assistant features
Configuring Authoring Assistant
Configuring email for Workplace notifications
Configuring how external UIs open in Workplace
Configuring custom Liberty data sources
Customizing transaction and data source settings for Workflow components
Enabling the Liberty feature to integrate with IBM MQ
Enabling Intelligent Task Prioritization
Activating Workforce Insights
Enabling full text search
Customizing an independent JMS server for Business Automation Workflow
Enabling the audit log
Adding system lane users
Configuring security
Enabling Process Federation Server and Common UI
Customizing Process Federation Server
Configuring event emitters
Installing and configuring event emitters
BPM event emitter configuration
Container deployments of IBM Business Automation Workflow
On-premises installations of IBM Business Automation Workflow
Prerequisites
Retrieving your Kafka connection information and generating the BPMEventEmitter.yml file
Installing the BPM event emitter
Updating the BPMEventEmitter.war file
Customizing the configuration file
Uninstalling the BPM event emitter
Case event emitter configuration
Container deployments of IBM Business Automation Workflow
On-premises installations of IBM Business Automation Workflow
Prerequisites
Manual installation and configuration
Preparing the Case event emitter application for deployment
Deploying the Case event emitter application
Updating the Case event emitter configuration
Automated installation and configuration
Automated deployment
Automated update
Automated uninstallation
Completing post-installation tasks for the case event emitter
Configuring event output to Kafka
Workforce Insights event emitter configuration
Troubleshooting event emitters on Kubernetes
Troubleshooting the BPM event emitter
Enabling tracing
Resolving events not flowing to the JMS queue
Resolving events flowing to the JMS queue but not to Kafka
Troubleshooting JMS destination issues
Troubleshooting the Case event emitter
Enabling tracing
Resolving JAR file and class loading errors
Resolving user authentication errors
Replaying Case events
Stopping the CP4BA operator
Stopping the case event emitter
Stopping the Flink job
Deleting the OpenSearch data
Deleting the Case event emitter bookmarks
Resetting the Flink job
Optional: setting the start date for the replay
Restarting the case event emitter
Reference for event emission
Reference for BPMN events
BPMN event formats
BPMN raw event formats
BPMN time series formats
Process time series format
Activity times series format
Tracking time series format
Tracked field format in time series
BPMN summary event formats
EnableBAI.py script syntax
BPM emitter configuration property values
Historical Data Playback REST API
Reference for Case events
Structure of the Case event emitter JSON file
EnableCaseBAI.py script syntax
Case event formats
Case event types
Case raw event formats
Examples of raw event attributes
Case time series formats
Shared fields
Cases
Activities
Stages
Documents
Case comments
Activity comments
Document comments
FileNet Process Engine workflows
FileNet Process Engine workitems
Summary event formats
Case summary event formats
Activity summary event formats
Stage summary event formats
FileNet PE process summary formats
FileNet PE userTask summary formats
Reference for BPEL events
BPEL event formats
BPEL event types
BPEL raw event formats
BPEL time series formats
BPEL process time series format
BPEL activity time series format
BPEL human task time series format
BPEL summary event formats
EnableBAI.py script syntax
BPM emitter configuration property values
The 100Custom.xml file and configuration
Location of 100Custom configuration files
Creating a 100Custom.xml configuration file
Deploying a 100Custom.xml file to a deployment environment
Modifying individual configuration properties
Increasing the maximum number of cached objects during refactoring
Disabling user registry group synchronization during server startup
Retrieving all user registry groups during server startup
Resolving user mismatch between the user information cache and the database
Controlling administrator access to task instance data
Restricting Inspector actions for online workflow servers
Specifying an absolute URL for the TWManagedFile JavaScript API
Web services
Specifying a timeout for a web service
Controlling warning limits for variable sizes of process and service flows
Detecting infinite loops in services and process instances
Disabling updates for user names with trailing blanks
Restrictions on large file uploads and SVG browser display for ECM documents
Disabling group membership update at login time for web applications
Enabling adding user registry groups of a user at login time for web applications
Optimizing the login time for web applications
Specifying that members of a group member cache are retrieved from the database
Optimizing the group member cache heap size
Limiting the number of REST calls to the server
Enabling heritage coaches
Viewing the history of a task
Enabling the format of the task subject to contain a prefix
Adjusting REST timeout length
Message handling configuration properties for JMS errors, message size, and documentation suppression
Process application custom logging
Administering
Accessing the Process Admin Console
Managing installed snapshots
Activating installed process applications
Deactivating installed process applications
Whether process instances run in deactivated snapshots
Designating default snapshots
Synchronizing snapshots
Configuring runtime settings for installed snapshots
Configuring exposed processes and services
Configuring runtime teams
Configuring runtime environment variables
Administering processes with Process Inspector
Process Inspector
Runtime activity states
Troubleshooting errors and failures in a failed process instance
Actions in the Process Inspector
Managing workflow servers
Viewing the status of process instances and applications
Detecting and ending infinite loops in JavaScript activities
Modifying runtime server configuration properties
Changing server settings in the Process Admin Console
Changing web service server settings
Changing REST server settings
Changing Enterprise Content Management server settings
Enterprise Content Management configuration settings: technical details
Enabling or disabling event subscriptions
Managing workflow server caches and databases
Reviewing workflow server caches
Deleting tasks from the Process database
Managing exposed process values (EPVs)
Monitoring workflow servers
Capturing process instrumentation data
Disabling process instrumentation data
Using process instrumentation data for cache tuning
Monitoring processes and services
Identify infinite loops in process applications
Tracking the rate of instance creation and service requests
Data displayed in the Process Monitor
Interpreting Process Monitor data
Enabling or disabling logging
Overriding the behaviour of separated runtime logs for process applications
Administering users and groups
Runtime user availability and lifecycle
Creating and maintaining users and groups
Creating and managing groups
Assigning user attributes
If you select View by Attribute
If you select View by User
Synchronizing users and groups
Administering the Federated Data Repository indexes
Enabling and configuring the Federated Data Repository
Understanding the Federated Data Repository process indexing
Indexing case instances
Federated Data Repository indexes
How tasks are stored in the Federated Data Repository
How process instances are stored in the Federated Data Repository
How case instances are stored in the Federated Data Repository
Applying a rolling update strategy
Programming
REST APIs programming
Workflow REST APIs
Authorization
Starting a process
Processing a user task
Preventing cross site request forgery
Process REST APIs
Resource URIs
HTTP methods
HTTP header fields and generic URI parameters
Testing REST APIs
REST APIs and federated environments
Authorization control for runtime REST API calls
Authorization roles
REST API authorization for task actions
Changing roles for REST API authorizations on task actions
REST API authorization for user, group, and team actions
REST API authorization for accessing repository assets at run time
REST API authorization for process instances
Removing the assignedToRole column
Syntax for JavaScript in text
JavaScript API
Variable availability
JavaScript reference examples
Starting a new process
Getting the current process instance
Getting the current userid
Getting the name of the current process or service flow
Returning the owner of a task
Returning a list of reference links
Extracting a managed file
Searching processes and tasks
Improving TWSearch performance
Interacting with cases and activities
Retrieving data from XML
Viewing all process instances by using a TWSearch API query
Managing work
In Workplace
Starting Workplace
Setting preferences
Searches in Workplace
Basic
Advanced
Managing work
Completing work
Managing work for teams
Using Workplace Assistant
Interacting with documents
Use cases
User prompts
Limitations
Managing workstreams
Overview
Videos
Setting up roles
User roles and access control
Assigning user roles
Configuring
Creating
Governing
Using
Limitations
In Process Portal
Starting Process Portal
Setting preferences
Dashboards
Process Performance
The Gantt chart
Team Performance
Searches in Process Portal
Searches and saved searches
Basic searches
Searches using FullTextSearch
Searches for specific types and business data
Managing work
Completing work on tasks
Task assignment: Frequently asked questions
Completing work on process instances
Working on activities
Managing work for teams
Limitations
Managing work with the IBM Workflow Runtime MCP Server
Getting started with IBM Workflow Runtime MCP Server
MCP tools
Troubleshooting
Troubleshooting Business Automation Workflow or Workstream Services
Enabling Business Automation Workflow Server or Authoring container logs
Customizing the Process Federation Server Liberty server trace setting
Troubleshooting Machine Learning Server
Troubleshooting Intelligent Task Prioritization
Troubleshooting Workforce Insights
Recovering Elasticsearch or OpenSearch data if PV is deleted
Improving login speed
Container fails to start
Pod fails to start
Pod takes a long time to start
Init job fails to import toolkits
Case init job fails after Workflow is added
Enable db init job logs
Errors when using PostgreSQL with self-signed certificates
Can't access Business Automation Studio
No desktops after a Cloud Pak for Business Automation deployment with OCP
Connectivity issues prevent access to the Process Portal task list
Business Performance Center charts show "No data available yet"
CreateContainerError for Business Automation Workflow server pod
504 Gateway timeout error when you apply an audit manifest, a security manifest, or deploy a solution
Troubleshooting Workflow Process Service
Reference
Toolkits
System Data toolkit
UI toolkit
Alerts
Area chart SDS
Badge
Bar chart SDS
Breadcrumbs
Button
Caption box
Check box
Check box group
Collapsible panel
Configuration
Data
Data export
Date/time picker
Decimal
Deferred section
Device sensor
Display text
Donut chart SDS
Event subscription
Geo coder
Geo location
Horizontal layout
Horizontal line
Horizontal split
Icon
Image
Input group
Integer
Line chart
Link
Map
Masked text
Modal alert
Modal section
Multi purpose chart
Multi select
Navigation event
Navigation item
Navigation list
Navigation menu
Note
Notification
OpenLayers API
Panel
Panel footer
Panel header
Password
Pie chart SDS
Places
Plain text
Pop-up menu
Progress bar
QR code
Radio button
Radio button group
Responsive sensor
Rich text
Service call
Service data table
Signature
Single select
Slider
Spacer
Spinner
Stack
Status box
Step chart
Style
Switch
Tab section
Table
Table layout
Text area
Text reader
Timer
Tooltip
Type ahead text
Variant
Vertical layout
Video
Well
Workplace toolkit
Case toolkit
Add Activity
Add Case
Case Activities
Case Calendar
Case Comments
Case Folder
Case Folder Tree
Case History
Case List
Case Search
Case Search by using external payload
Case Stages
Case Tasks List
Quick tasks
To-do tasks
Process tasks
Case Visualizer
Create Package
Role Picker
Manage Roles
Manage Team
Related Cases
Create Case service
Get Case Calendar Events service
Get Case Instance Object service
Get Repository Name service
Initialize Case Content Objects service
Save Case Properties service
Split Case service
Split Case
Content Management toolkit
Settings for upload of large documents
Document Explorer
Document Reference
ECM Document List
ECM File List
ECM File Properties
ECM File Revisions
ECM File Uploader
ECM Folder List
File Viewer
Services
Content Services toolkit
BAI events
BPMN event types
Service integration monitoring events
BPMN raw event formats
Coach and event handler reference information
Coach API
The view object (this)
The context object
Event handlers for view design-time preview
The com_ibm_bpm_global object
Event handlers
load
unload
view
change
validate
APIs
REST APIs
Workflow REST APIs
Operations REST APIs
Operations REST APIs reference
Process REST APIs
Process REST APIs reference
REST interface for process-related resources
Activity Instance (Ad Hoc)
GET
PUT
Activity Instance (available actions)
GET
Activity Instance (current tasks)
GET
Advanced Integration Service
GET
Alert Definitions
GET
PUT (bulk save)
DELETE (bulk delete)
Alert Definitions Status
GET
Asset Comparison List
GET
Asset List
GET
Assets Copy
POST
BPD Data
GET
BPD Tag Groups
GET
Branch Snapshot List
GET
Bulk Commands
POST (bulk commands)
Business Object
GET
Collaboration Systems Integrations
GET
Delete All Mentions
DELETE
Delete Mentions
DELETE
ECM Event
POST
Environment Variables
GET
Event Manager - Pause [deprecated]
POST
Event Manager - Resume [deprecated]
POST
Exposed Items
GET
Exposed Items (with filter)
GET
Exposed Process Value
GET
External Activity Model
GET
Followed Instances
GET
Global Team
GET
GlobalTeamUser
GET
Group
GET
PUT
Groups
GET
Instance Activity Stream
GET
Instance Following
GET
POST
DELETE
Instances Mentions
GET
ManagedGlobalTeam Resource
GET
Participant Group
GET
Performance Instance Query [traditional only]
GET
Performance Query [traditional only]
GET
Post Threaded Comment
POST
Process
POST (start)
GET (bulk instance details)
POST (sendMessage)
Process Actions
GET
Process Applications
GET
POST
Process Instance
GET
PUT (suspend, resume, terminate, or retry)
PUT (update due date)
DELETE (delete process instance)
POST (add document)
PUT (update document)
DELETE (delete document)
PUT (run an adhoc event within a process)
PUT (evaluate a javascript expression)
POST (comment)
POST (fire timer)
POST (move token)
POST (delete token)
Processes with Exposed Performance Metrics (with filter)
GET
Process Instance All Variables (bulk update)
PUT
Process Instance Bulk Operations
PUT
Process Instance Bulk Operations with Filter Options
PUT
Process Instance Business Data
GET
Process Instance Depended On Processes
GET
Process Instance Dependent Process
GET
Process Instance Queries [deprecated]
GET
Process Instance Query Attributes [deprecated]
GET
Process Instance Query Entity List [deprecated]
GET
Process Instance Query Entity List Count [deprecated]
GET
Process Instance Related Processes
GET
Process Instance Relationship
POST
DELETE
Process Instance Relationships
GET
Process Instance Runtime Error Information
PUT
Process Instance Task Summary
GET
Process Instance Variable
PUT
Process Instance Variables (bulk update)
PUT
Process Instances Search
GET
Process Instances Status Overview
GET
Process Instances Visual Model [traditional only]
GET
Process Model
GET
Process Visual Model [traditional only]
GET
Project Application Settings
GET
Project Branches List
GET
Project Named Snapshots List
GET
Relationship
PUT
DELETE
Resource Environment Provider Properties
GET
Resource Environment Providers
GET
Saved Search Bulk Operation
POST
Reusable Search Queries
GET
POST
Reusable Search Query
GET
PUT
DELETE
Saved Search Definition
GET
PUT
DELETE
Saved Search Definition User Actions
GET
Saved Search Definitions
POST
GET
Search
POST
Search [deprecated]
PUT (perform custom search)
Search Definition MetaData By Type
GET
Search Execution
GET
PUT
Search Metadata [deprecated]
GET
Search Queries Transfer
POST
Server
GET
ServerAccessToken
GET
Service
POST (start)
GET (currently running)
GET (getData)
PUT (stop)
PUT (resume)
PUT (evaluate javascript)
PUT (setData)
Service Level Agreement
GET
Service Model
GET
Service Visual Model
GET
Show Process Actions
GET
Show Process Instance Ad Hoc Activities
GET
Snapshot Change History
GET
Snapshot Change History Comparison
GET
Systems Metadata
GET
Task
GET (bulk task details)
PUT (bulk claim)
PUT (bulk cancel)
PUT (get next)
Task Actions
GET
Task Activity Stream
GET
Task Experts
GET
Task Following
GET
POST
DELETE
Task Instance
GET
GET (getData)
POST (invite task collaboration)
PUT (start task)
PUT (assign task)
PUT (update)
PUT (complete, finish)
PUT (claim)
PUT (cancel)
PUT (setData)
Task Instance Client Settings
GET
Task Instance Queries [deprecated]
GET
Task Instance Query Attributes [deprecated]
GET
Task Instance Query Entity List [deprecated]
GET
Task Instance Query Entity List Count [deprecated]
GET
Task Template
GET
Task Template Client Settings
GET
Task Template Queries
GET
Task Template Query Attributes
GET
Task Template Query Entity List
GET
Task Template Query Entity List Count
GET
Team (by Team ID)
GET
Team (by Team Name)
GET
Team Members
GET
Team Member Summary
GET
Team Summaries
GET
Team Summary
GET
Team Tasks
PUT
Team Task Trend
GET
Teams Tasks
PUT
Timing Interval
GET
Toolkits
GET
POST
Tracking Group
GET
Undercover Agent
GET
User
GET
PUT
User Details
GET
User Task Data
GET
UserAvatar
GET
POST
DELETE
Users
GET
Web Service
GET
REST APIs for advanced searches support
The advanced search query definition
REST interface for IBM Process Federation Server resources
REST interface for IBM BPM repository resources
Export
GET
Import
POST
JavaScript APIs
JavaScript API namespaces
Formats of case property values
UI toolkit JavaScript API
Alerts
Area chart SDS
Badge
Bar chart SDS
Breadcrumbs
Button
Caption box
Check box
Check box group
Collapsible panel
Configuration
Data
Data export
Date Picker (deprecated)
Date/time picker
Decimal
Deferred section
Device sensor
Donut chart SDS
Event subscription
Exit Safeguard (deprecated)
Geo coder
Geo location
Horizontal layout
Horizontal split
Icon
Image
Input group
Integer
JSON text area
Horizontal line
Line chart SDS
Link
Map
Masked text
Modal alert
Modal section
Multi purpose chart
Multi select
Navigation event
Navigation item
Navigation menu
Note
Notification
OpenLayers API
Display text
Panel
Panel footer
Panel header
Password
Pie chart SDS
Places
Pop-up menu
Progress bar
QR code
Radio button
Radio button group
Responsive sensor
Service call
Service data table
Signature
Single select
Slider
Spacer
Spinner
Stack
Status box
Step chart SDS
Style
Switch
Tab section
Table
Table layout
Table layout cell
Table layout row
Plain text
Text area
Rich text
Text reader
Timer
Tooltip
Type ahead text
Variant
Vertical layout
Video
Well
Workplace toolkit JavaScript API
Instance Viewer
Instance List
Task List
Task Viewer
Case toolkit JavaScript API
Add Activity
Add Case
Case Activities
Case Calendar
Case Comments
Case Folder
Case Folder Tree
Case History
Case List
Case Search
Case Stages
Case Tasks List
Case Visualizer
Create Package
Manage Roles
Manage Team
Related Cases
Role Picker
Split Case
Content Management toolkit JavaScript API
BPM Document List
BPM File Dropzone
BPM File List
BPM File Properties
BPM File Revisions
BPM File Uploader
Document Explorer
Document Reference
ECM Document List
ECM File List
ECM File Properties
ECM File Revisions
ECM File Uploader
ECM Folder List
File Viewer
JavaScript API in processes, cases, and service flows
Case management
Designing your case management solution and application
Preparing the design environment
Copying existing metadata into the case management development environment
Importing the solution template to the target environment
Identifying your solution artifacts
Adding and deploying a case management solution
Adding a case solution
Adding and managing properties
Adding and selecting roles
Roles in solutions
Solution pages for roles
Configuring in-baskets for roles
Adding custom in-baskets to roles
Adding and modifying document classes
Document classes
Adding and modifying business objects
Business objects
Adding and modifying case types
Case types
Creating and configuring stages for a case type
Defining views
Defining case page layouts
Defining properties views
Containers
Container width and height
Adding workflow data fields and workgroups to the properties view
Adding external properties to the properties view
Property editor settings
Properties
Business rules
Setting completion menu options
Adding activities
Activities in solutions
Activities that start processes
Custom workflow activities
To-do tasks
Quick tasks
Activity preconditions
Activity initiation
Activity states
Adding activities with processes
Adding an activity with a new process
Creating flexible case activities
Adding an activity with an existing process
Working with content object variables
Data objects
Content objects
Case and activity properties
Roles and teams
Content object support
Interacting with a parent case from a process
Troubleshooting case and process integration
Versions are not visible for an upgraded workflow project
Activities are associated with the wrong version of a workflow automation
Changes to workflow automations are not reflected in activities
Results output by a business process are not shown in an activity
Multiple user editing of solutions
Designing the case management client application
Client-side human services
Solution layouts
Creating custom solution layouts
Solution task layouts
Task List configurations
Creating new case layouts using human services
Using a default page layout
Creating a custom page
Adding widgets to a human service UI
Creating classic case pages using widgets
Creating a custom page with widgets
Classic pages
Adapter
Solution
Case Details
Add Cases
Split Case
Add Activity
Custom Activity Details
Widgets
Attachments
Configuring displayed content
Adding and checking in documents
Events
Outgoing
Incoming
Calendar
Events
Incoming
Case Information
Activity view
Documents view
Displaying extra properties on Documents view
History view
Summary view
Events
Outgoing
Incoming
Case List
Events
Outgoing
Incoming
Case Stages
Events
Incoming
Case Toolbar
Events
Incoming
Chart
Events
Incoming
Content List
Preparing
Configuring the list of documents
Events
Outgoing
Incoming
In-baskets
Configuring displayed content
Configuring reassignment items
Including process work items
Filtering and sorting process work items
Events
Outgoing
Incoming
Instruction
Events
Incoming
Markup
Configuring content
Displaying content using an event
Events
Incoming
Original Case Properties
Events
Incoming
Page Container
Events
Outgoing
Incoming
Process History
Events
Incoming
Properties
Events
Outgoing
Incoming
Script Adapter
Transforming or validating event data
Debugging events
Events
Outgoing
Incoming
Search
Events
Events
Incoming
Select Case Documents
Events
Incoming
Split Case Properties
Events
Outgoing
Incoming
Task Toolbar
Events
Incoming
Timeline Visualizer
Displaying process activities
Events
Outgoing
Incoming
To-Do List
Events
Incoming
Toolbar
Events
Viewer
Wiring widgets for document display
Events
Incoming
Website Viewer
Events
Incoming
Work Item Toolbar
Events
Incoming
Action events
Designing views for to-do tasks
Testing your solution
Promoting case solutions to workflow projects
Sample business rules
Configuring auditing
Validating preconditions
Resetting the test environment
Saving user-defined assets before you reset the test environment
Managing case solutions
Upgrading and creating templates and case solutions
Copying an existing solution
Copying a solution to another development environment
Copying case solutions that are associated with workflow automations
Comparing solutions
Scenario: Upgrading a customized case management solution
Deleting a deployed solution
Creating and distributing solution templates
Converting a solution into a template
Distributing solutions as templates
Unlocking solution assets
Translating case management applications
Translating custom strings
Translating workflow assets from Content Platform Engine
Translating content solution assets from Content Platform Engine
Translating content solution assets from other repositories
Adding workflow processes to existing solutions
Administering your case management system
Restarting components in a CP4BA environment
Setting up project areas
Planning for project areas
Planning for target environments
Creating a target object store
Managing project areas
Planning for shared or dedicated desktops
Setting up target environments
Creating or upgrading a target object store for test or production environments
Creating custom desktops
Defining and registering target environments
Managing target environment definitions
Indexing event logs for older case types to enable case health analysis of work items
Enabling and disabling plug-ins for the IBM Business Automation Workflow desktop
Enabling favorites and sync
Preparing a database for the case history store
Case history visualizer
Pruning case history
Enabling tracing
Configuring or disabling the Activity Sweep Custom policy
Enabling or disabling case health analysis
Monitoring system performance
Configuring a file store for an existing object store
Updating an object store
Synchronizing cases with solution data
Enabling the Browse view
Enabling access to case solutions in IBM Content Navigator desktop
Configuring your environment to show display names in Case Client
Customizing the case package PDF file
Migrating and deploying case management solutions
Solution migration and deployment
Preparing for solution migration
Identifying solution assets for migration
Workflow assets
Solution application assets
Solution List page
Preparing customized migration and deployment instructions
Preparing the system configuration for migration
Migrating solutions
Exporting solution assets
From a design object store
Exporting the security configuration
Exporting the audit configuration
Exporting other Content Cortex assets
Using FileNet Deployment Manager to export other Content Cortex assets
Include options for assets in FileNet Deployment Manager
Exporting other Content Cortex assets by using the Process Configuration console
Exporting other IBM and external assets
Importing workflow assets
By using a solution package
Reimporting assets with environment-specific references
Installing solution assets
Deploying migrated solutions
Backing up the target environment before deploying solutions
Deploying prerequisite assets for case management solutions
Importing assets by using FileNet Deployment Manager
Importing assets by using the Process Configuration console
Deploying a solution
Deploying a legacy case solution to a production target object store by using the command line
Installing a case solution by using REST APIs
Deploying postrequisite assets
Importing assets by using FileNet Deployment Manager
Configuring the target environment after solution deployment
Importing the security configuration
Importing the audit configuration
Migrating the translated user interface elements of your case management application
Configuring system settings after solution deployment
Opening pages using URLs
Modifying solutions after deployment
Redeployment restrictions for modifying a solution
Synchronizing cases with solution data
Verifying solution deployment
Programming case solutions
Developing case management applications with JavaScript API
Workflow JavaScript packages
icm.model
icm.action
Action contexts
icm.base
icm.dialog
icm.pgwidget
icm.util
icm.widget.menu
IBM Business Automation Workflow Case JavaScript API Reference
Example: Working with case Management business objects in JavaScript
Developing case management applications with Java API
Java API Components
Case class
CaseMgmtObjectStore class
CaseType class
DeployedSolution class
Example: Java API Context
IBM Business Automation Workflow Case Java API
Developing case management applications with REST protocols
Creating and managing case objects by using the workflow REST protocol
Case management REST resource URIs
Symbolic names
Error responses
Common JSON payload for cases and case types
Getting and changing information about deployed solutions
List of document classes resource
GET method
List of solutions resource
GET method
Particular solution resource
GET method
Deployment resource
POST method
Deployment status resource
GET method
Associated object stores resource
GET method
Import manifest resource
POST method
Apply manifest resource
POST method
Import legacy solutions
POST method
Getting information about deployed case types
List of case types resource
GET method
List of view definitions resource
GET method
List of discretionary activity types resource
GET method
Particular case type resource
GET method
POST method
Case page resource
GET method
Getting and changing case instance information
Cases resource
POST method
Particular case instance resource
GET method
POST method
PUT method
Deleting a particular case resource
POST method
Status of particular case resource
GET method
Related cases for a particular case resource
GET method
List of activity instances resource
GET method
Create new activity resource
GET method
POST method
Particular activity instance resource
PUT method
Case comments resource
GET method
POST method
Case history resource
GET method
Case stage
GET method
POST method
List of case folder resources
GET method
Security manifest
Post method
Managing workflows, roles, and in-baskets by using the Content Platform Engine REST Service
Open case APIs
Managing case folders and documents by using IBM CMIS for Content Cortex
Configuring a solution to create a case when a document is added to the object store
Setting values to case content object properties
Getting case data from an external data source
Implementing an external data service by using the REST protocol
Particular object type resource
POST method
Request modes
Client context for work items
Response to a request for case data
Error responses for an external data service
Persistence of case data
Example data flow for case creation
Retrieval of initial information for a new case
Update of a property that has dependencies
Creation of the new case
Content Platform Engine add-on extensions
Design object store
Target object store
History and analytics
Subscriptions and events
Using external properties
Defining external properties at run time
Defining external properties by using the Script Adapter widget
Retrieving and persisting external properties
Creating custom property editors and controllers
Creating custom inline messages and prompts
Creating custom page widgets and actions
Defining registry files for custom actions, properties, page widgets, and events
Defining the widget package catalog file
Defining a page widget definition file
Defining an action definition file
Defining a property for a page widget or an action
Defining a property type
Defining a widget event
Tips for sizing workflow widgets
Widget toolbar
Adding an event action to a widget toolbar or menu
Adding a script action to a widget toolbar or menu
Working with case solutions in Case Client
Managing access to cases through roles and case teams
In-baskets
Assigning work
Adding to favorites and syncing folders and documents
Reusing case data
Adding new activities to a case
Adding discretionary workflow activities
Adding discretionary to-do tasks
Adding quick tasks
Configuring email notifications for quick tasks assignments
Adding custom activities
Search tips for cases
Search tips for documents
Configuring EDS for Case Client
Troubleshooting case
Workflow log files
For the workflow administration client and Case Client
For Case Builder and the workflow API application
For the Content Platform Engine REST API
For solution deployment
Exception when numerous concurrent users create cases
Configuring logging for Case Builder and the Case API application
Annotations might not be auto-saved
Troubleshooting workflow administration
Configuration integration fails
Solution import problems
Removing invalid principal mappings after a solution is imported
Deleting a case
Removing a case type
No work items in personal in-basket for a deployed long-named solution
Solution deployment fails with a Content Platform Engine views error
Online deployment of a solution version fails after adding a security manifest
Assets changed in Case Builder cannot be viewed in Case Client
Removing proxy documents associated with external documents
Cannot reassign work items in the All Assigned Work in-basket
Incorrect display of messages and annotations in viewer
Unlocking a locked work item
Reused long-string properties in case type searches might have invalid operators
Validation errors in Step Designer for a workflow validated in IBM FileNet Process Designer
Changing the saved solution locale after solution deployment
Problems importing solutions using FileNet Deployment Manager
Cannot copy solutions that contain rule steps in a production environment
Rule steps do not run if processing timeout value is too low
Troubleshooting business rule errors
Troubleshooting case history table lock escalation errors
Database deadlock issue with large solution deployments
Event payloads can contain model objects that are not fully retrieved
Improve performance at case creation time by limiting subfolder structure
Case administration client does not remove all files that are related to the package
Supporting external documents in production environments
Older versions of an audit or security configuration might not be re-imported
Troubleshooting ECMException ObjectStore.get_RootFolder returns null
Re-creating a corrupted target object store in a development environment
Troubleshooting Case Builder
Changing the screen display resolution for Case Client and Case Builder
Solution deployment fails due to a queue table limit
Solution deployment fails if a value is not found for a required property
Deploying case solution fails with NullPointerException
Responding to validation errors in the Step Designer
Reviewing log entries in Case Builder
Cannot edit locked solution assets
Case type validation errors
Cannot reset the test environment because target object server does not exist
Deploy dataset not found when the test environment is reset
Document opens in another window even when the Viewer widget is present
Toolbar buttons on Rules and Activities pages are not displayed in Internet Explorer
Cannot add a column to display the case type for a work item in an in-basket
Columns overlap when sizes are set too large in the page designer
Troubleshooting overlap and gap warnings in table-based rules
Cannot view values when you edit cells in table-based rules
Comments in scripts cause a validation error
Workgroups are not marked as required fields in the Properties widget
Event actions cannot have duplicate labels
Cannot deploy a solution after changing the data types or cardinality of its property
Problems occur in Case Client if widgets are configured incorrectly
Cannot add workflow artifacts to locked Content Platform Engine configuration file
Unexpected behavior when you use duplicate values in choice lists
Different default values in instances of same property cause inconsistencies
Bi-directional step names do not display in the Step Designer swimlane
Fields in the Properties View Designer lose focus in Internet Explorer
Focus is lost when some settings in Properties View Designer are changed
The test solution link in Case Builder can redirect to the SiteMinder login page
Remove property from in-baskets, filters, and activities before changing its data type
Changing how a discretionary activity starts might not clear the response from the launch step
Percent signs (%) and underscores (_) do not work in case property filters
Adding many properties might cause a script warning message
Inconsistencies when adding same property with different object types to multiple in-baskets
Activities cannot be assigned to new sets before you save and close the solution
Unexpected results for float properties that use a number spinner
Preventing users from having to select a folder when they add documents
Workflow application issues in earlier minor versions of Internet Explorer
Certain property templates cannot be used in IBM Business Automation Workflow
Incorrect non-Engligh titles for documents added to email
Cannot open Workflow Designer from Case Builder
Queue changes might not take effect after a solution is deployed
Troubleshooting Case Client
Instance user interface fails to open for a solution in Case Client
Cannot open Workplace
A case cannot be created if the initiating document title contains a vertical bar (|)
Activities cannot communicate with a workflow process
Reducing the time needed for advanced searches
Changing the screen display resolution for Case Client and Case Builder
A search returns too many results
Prompt to stop the script is displayed when searching for cases
Sending a link to a case in an email opens an empty tab in the Firefox browser
Incrementing float values in number spinner property fields
Errors in Case Client property settings
Filtering the in-basket with an (is-like) filter returns only exact matches
Cannot add values to multi value properties
Some automatically completed activities show extra states in the case history
Document Modified events do not display in the histogram
Reserved words cannot be used in solution names
Cannot open a view that contains a datetime property with an invalid mask or pattern
The time mask pattern K does not work in Case Client
Some property values are empty for cases that are returned by a search that uses the icm.util.SearchPayload class
You cannot use the number grouping characters in integer or float values in IBM Business Automation Workflow
Some property containers are not displayed in Internet Explorer 9
The Browse button is disabled after you cancel from the Run Content Navigator File Tracker window
Unexpected viewer behavior in Case Client when you open documents for which the MIME types are not configured
Some search documents do not behave as expected when added to specific widgets
Changes in activity property events are not shown in the Timeline Visualizer widget
A completed caseState property does not reset back to Working
Different browsers can display workflow group fields differently in Case Client
Some container types in the Properties View Designer are incompatible with certain locales
Cannot cancel the check-out of documents in Case Client that were added from an Alfresco CMIS repository
Inconsistent user interface behavior with bidirectional locales in IBM Business Automation Workflow
Documents from external repositories cannot be removed or unfiled from a case folder if Content Platform Engine uses a database other than Db2
Favorites and sync features are not supported for IBM Business Automation Workflow documents from repositories other than IBM Content Cortex
Box actions are not displayed in the Documents view for existing solutions
Case packaging action is not displayed on Case Details or Cases page for existing solutions
Text in case package PDF file is not displayed correctly
Unicode names are incorrect in case package for documents with non-English characters in the file name
The file does not open when you click a link to a .zip file in a case package
Restarting a workflow activity that fails to start
Box Collaboration action fails in a distributed environment when the date/time is not synchronized
Cloud Pak foundational services
Reference
Cloud Pak for Business Automation architecture
CP4BA multi-pattern deployment reference
Business Automation configuration parameters for OpenShift console
Advanced configuration of Automation Document Processing
Advanced configuration of Business Automation Application
Advanced configuration of Content Cortex
Advanced configuration of Decision Intelligence Client Managed Software
Advanced configuration of Operational Decision Manager
Advanced configuration of Workflow Authoring
Advanced configuration of Workflow Process Service Authoring
Advanced configuration of Workflow Runtime and Workstream Services
Custom resource configuration parameters
IBM Cloud Pak for Business Automation foundation parameters
Application Engine parameters
IBM Business Automation Insights parameters
Common and administration services parameters
Kafka parameters
Flink parameters
Application setup parameters
Event processing parameters
Business Performance Center parameters
Management service parameters
IBM Business Automation Navigator parameters
IBM Business Automation Studio parameters
IBM Automation Document Processing parameters
IBM Business Automation Application parameters
IBM Business Automation Workflow Runtime and Workstream Services parameters
IBM Business Automation Workflow Authoring parameters
IBM Content Cortex parameters
Datasource parameters
Content Cortex common parameters
Monitoring parameters
Logging parameters
Content Platform Engine parameters
Content Search Services parameters
Content Management Interoperability Services parameters
Content Services GraphQL parameters
Task Manager parameters
Content Cortex for Microsoft Office parameters
Initialization parameters
Verify parameters
Directory Configuration Properties (SCIM Directory)
IBM Content Collector for SAP Applications parameters
IBM Enterprise Records parameters
Content Cortex License Service Reporter parameters
IBM Decision Intelligence Client Managed Software parameters
Decision Designer parameters
Decision runtime parameters
Shared parameters by Decision Designer and the decision runtime
IBM Operational Decision Manager parameters
IBM Operational Decision Manager decision engine versions
IBM Workflow Process Service Authoring parameters
Shared configuration parameters
Custom external database configuration
LDAP configuration
Pattern configuration
Shared configuration
Custom resource statuses for components
Environment variables for silent mode installation
IBM Content Cortex AI Services deployment parameters
Shared configuration parameters for AI Services
Reasoning Service configuration parameters
Core MCP Server configuration parameters
CP4BA Content Cortex deployment reference
Custom resource statuses for components
IBM Content Cortex configuration parameters for OpenShift Console
Advanced configuration of Content Cortex
IBM Content Cortex custom resource parameters
IBM Content Cortex parameters
Datasource parameters
Content Cortex common parameters
Monitoring parameters
Logging parameters
Content Platform Engine parameters
Content Search Services parameters
Content Management Interoperability Services parameters
Content Services GraphQL parameters
Task Manager parameters
Content Cortex for Microsoft Office parameters
Initialization parameters
Verify parameters
IBM Content Collector for SAP Applications parameters
IBM Enterprise Records parameters
IBM Business Automation Navigator parameters
IBM Business Automation Insights parameters
Common and administration services parameters
Kafka parameters
Flink parameters
Event processing parameters
Business Performance Center parameters
Management service parameters
Shared configuration parameters
Custom external database configuration
LDAP configuration
Pattern configuration
Shared configuration
CP4BA Process Federation Server parameters
CP4BA Workflow Process Service Runtime parameters
CP4BA Automated Upgrade REST API
CP4BA Automated Upgrade Helm chart parameters
CP4BA Audit Logging service log records
Automation Document Processing audit log records
Business Automation Application audit log records
Business Automation Insights audit log records
Business Automation Navigator audit log records
Business Automation Studio audit log records
Decision Intelligence Client Managed Software audit log records
Content Cortex audit log records
Operational Decision Manager audit log records
Workflow automation audit log records
Zen Service audit log records
Pod security context
Kubernetes API Access