ADP Dev vs. Runtime: Key Differences, Deployment Order & Setup

1. Purpose

This guide describes the roles of the Authoring (Dev) and Runtime environments in IBM Automation Document Processing (ADP). It explains the recommended deployment order and how trust is established between environments using the Zen route certificate for IBM Cloud Pak for Business Automation (CP4BA).

This guidance aligns with IBM documentation for the following topics:

• Configuring document processing resources
• Importing the Zen route certificate into a runtime environment

2. High-Level Architecture

+------------------------+         Secure HTTPS         +------------------------+
|  Authoring (Dev)       | -------------------------->  |  Runtime               |
|                        |   Zen Route (CDRA API)       |                        |
|  - Designer UI         |                              |  - Runtime Engine      |
|  - CDRA                |                              |  - Deployment Service  |
|  - Model Training      |                              |  - Worker Pods         |
+------------------------+                              +------------------------+

CPDS enables project deployment from the Authoring environment to the Runtime Content Platform Engine (CPE).

3. Deploy the Authoring Environment

Complete the following steps to deploy the Authoring environment:

• Run CP4BA prerequisite and deployment scripts
• Configure the Authoring custom resource with document processing authoring components
• Verify access to Business Automation Studio and Designer UI
• Create, train, and deploy document processing projects
• Create Business applications in Business Automation Studio (BCAT or CAT)

4. Prepare and Deploy the Runtime Environment

Before deploying projects, the Runtime environment must trust the Authoring environment.

Deploy the Runtime Environment

• Run CP4BA prerequisite and deployment scripts for Runtime
• Generate required secrets, trust stores, and database resources
• Configure the Runtime custom resource with execution components
• Confirm Runtime pods start successfully

Import the Authoring Zen Route Certificate

Before applying the Runtime custom resource, import the Authoring Zen route certificate so Runtime can securely connect to the Authoring CDRA API.

• Create the Zen route certificate as a Kubernetes secret named cdra-tls-secret
• Add the certificate to the Runtime trusted certificate list
• Update the Runtime shared_configuration.trusted_certificate_list and repo_service_url so Runtime can trust and query the Authoring CDRA API

Update the Runtime Custom Resource

shared_configuration:
  trusted_certificate_list:
    - cdra-tls-secret

cpds:
  production_setting:
    repo_service_url: <zen-route>/adp/cdra/cdapi

5. Project Deployment Flow to Runtime

Preparation

Update the CPDS properties file in the Authoring environment.

• Locate the CPDS scripts directory

  cert-kubernetes/scripts/ADP/

• Copy and edit the properties file

  cp cpds.properties.sample cpds.properties 
  vi cpds.properties

Populate the properties file with the following values:

• Authoring and Runtime Zen URLs
• IAM or LDAP credentials
• Runtime CPDS REST endpoint
• Zen route certificate secret name
• Project name and snapshot version
• Target object store name

Precheck Validation

Check object store status - Before deployment, confirm your target object store is configured and ready:

./cpds_getOSConfigStatus.sh --file cpds.properties

What this does:

• Calls CPDS REST API to confirm object store readiness
• If not initialized, the script shows isInitialized=false

./cpds_configureOS.sh --file cpds.properties

System Precheck

Validate authentication and credentials:

./cpds_systemPrecheck.sh --file cpds.properties

Project Precheck

Project version, snapshot visibility:

./cpds_precheckProj.sh --file cpds.properties

Deploy the Project

Deploy the Project - Validate the script executes successfully before continuing:

./cpds_deployProj.sh --filename cpds.properties

Optionally retrieve the deployment record:

./cpds_getDeployedProjSnapshot.sh --file cpds.properties

6. Using Applications in Runtime

1. Access the Runtime environment - Log in to the Runtime environment by using the Navigator route (https://cpd-
2. Import the runtime application- Import the application that was deployed from the Authoring environment in BAstudio & This step makes the application available for use in Runtime.
3. Assign application roles- Assign the required roles and permissions to users and groups & Ensure that users have access to run the application
4. Create and assign desktops (if applicable)- Create a desktop for the runtime application & Assign the desktop to the appropriate users or groups
5. Verify document processing- Upload sample documents & Verify that documents are processed successfully and results are returned as expected

7. References

• Deploying document processing projects
• Moving runtime applications
• Importing Zen route certificates
• Configuring document processing

8. Acknowledgments

I would like to sincerely thank @Lindsey Wong and @Arya Apurvakumar Shah for their valuable contributions and insightful reviews on this blog.