Troubleshooting project deployment

Use this information to help solve issues that might arise during the deployment of your Document Processing project.

Note: To resolve some of the issues that are described later in this page, you use either a CPDS (Content Project Designer Service) REST API endpoint request or a script. For more information about either, see Sample deployment scripts and Content Project Deployment Service REST API.

Checking the deployment status

The first time a document processing project version is deployed, the following artifacts are created:
  • A deployed project is created for the project name.
  • A deployed project version is created for the version of the project.
  • A deployment record is created for this instance of the deployment. The deployment record contains information about the deployment as well as the record entries for each stage of the deployment.
You can use the Administration Console for Content Platform Engine to check the status of the last deployment, or of previous deployments:
  1. From the object store, click Search > New object store search.
  2. Under the Simple view class, select the deployed project, and click Run.
    • Repo Primary Key shows the name of the project.
    • Current Deployed Version shows the last successfully deployed version.
    • Last Deployed Version shows the latest deployment version.
    • Deployment Status shows the status of the last deployment, 0 for in progress, 1 for success, and 2 for failure. 3, 4, and 5 are project cleaning states.
    • Last Deployment Error is not set if there is no errors for the last deployment. However, if the deployment fails an error will be recorded.
  3. Click on the Last Deployed Version to get the Deployed Project Version.
    • Display Name is the project name.
    • Snapshot Name contains the version that is deployed, for example, v2-2021-06-18-2311.
    • Deployed Definition contains the definitions for the deployment.
    • CA Project Descriptor is the Document Processing engine project GUID (globally unique identifier) for the project deployment.
Note: The deployment Document Processing engine project is a separate Document Processing engine project from the one that is used for the content design. Only one Document Processing engine project is deployed for a Deployed Project within an object store. If the project is deployed on more than one object store, a separate CA project is created for each object store where it is deployed.

Several deployments can exist for a version. The Deployment Records shows all the deployments for this project version. The Last Deployment Record is the GUID for the last deployment of this version. The Last Deployment Error is populated if an error occurred during the deployment.

Click the Last Deployment Record to bring up the Deployment Record. For each stage of the deployment, a Record Entry is recorded. Each entry has an entryTime value for the record, an entryType value, which would be Detail or Error, and a messageKey value.
  • projectDeployment.recordEntry.readingGITProject - Retrieving and parsing the project definition JSON files from Git.
  • projectDeployment.recordEntry.deployTeams - Creating the Business Teams.
  • projectDeployment.recordEntry.deployClassesAndProperties - Creating the metadata for PropertyTemplates, ClassDefinitions, roles, and deployment records.
  • projectDeployment.recordEntry.deployRoles - Creating roles.
  • projectDeployment.recordEntry. importingCAMachineLearning - Importing the machine learning model.
  • projectDeployment.recordEntry.importing CAOntology - Importing the document types and fields, and data field enrichment.

If errors are returned, messageArguments records the message and the errorEntry property returns true.

If an error occurs, the full message is found in the record entry and you can also see the stages that were completed before the failure.

You can view the “Record Information” to check the statistics and timings for the deployment, for example:
{
  "startTime": "2021-06-18T23:11:57.961Z",
  "completionTime": "2021-06-18T23:12:37.127Z",
  "newProject": false,
  "newVersion": true,
  "totalPropertyTemplates": 3,
  "newPropertyTemplates": 2,
  "totalClasses": 1,
  "newClasses": 0,
  "totalRoles": 13,
  "newRoles": 0,
  "propertiesAndClassesElapsedTime": 1310,
  "rolesElapsedTime": 4773,
  "totalElapsedTime": 39166,
  "dataDefinitionsParsed": 3,
  "precheckElapsedTime": 589,
  "ca_newProject": false,
  "ca_startTime": "2021-06-18T23:12:32.167Z",
  "ca_projectCreationElapsedTime": 0,
  "ca_ontologyElapsedTime": 3754,
  "ca_machineLearningElapsedTime": 1206,
  "teamsElapsedTime": 6321,
  "totalTeams": 9,
  "newTeams": 0,
  "currentStage": null,
  "gitelapsedTime": 19515
}

Deploying to the repository

You can deploy or redeploy a project that has failed after the deployment issue is corrected.
  • Either send the following CPDS REST API endpoint request.
    POST /v1/deployment/projects/{projectIdentifier}/branches/{branchName}/snapshots/{snapshotName}
  • Or run the cpds_deployProj.sh script sample.
    The cpds_deployProj.sh script uses the synchronous mode deployment. To make your request in asynchronous mode, set the operationMode argument to Async.
    Note: For asynchronous deployment, a 202-return code might not be an error because this code is also used to indicate that the project is in progress. For details about the deployment, you can check the returned deployment record.

For more information, see Sample deployment scripts and Content Project Deployment Service REST API.

Issue: No Document Processing engine projects are available

Problem
This issue might be reported with the following messages:
FNRDD0525 – No Document Processing engine project database are available to host a new project.
or
FNRDD0513 – Failed to create a Document Processing engine project.  ( which includes the error from this CA)
CIWCA13100 - There are no tenant databases available.
For example:
{"code":202,"message":"Failed to create a Document Processing engine project: [::400::{\"status\": {\"code\": 400, \"messageId\": \"CIWCA13100\", \"message\": \"There is no tenant database available.\"}, \"error\": {\"errorId\": \"CIWCA13100\", \"explanation\": \"There is no tenant database available.\", \"action\": \"Please contact System Admin.\"}}].","messageId":"FNRDD0513E"}}
Solution
Contact the system administrator to create more Document Processing engine projects. See Creating additional project databases. Use the Content Project Deployment Service GET /precheck REST API endpoint or run the cpds_systemPrecheck.sh script to view the value of the caProjectsAvailable parameter.
As soon as a Document Processing engine project is available, you can redeploy your document processing project.
Note: You do not need to clean up the deployment project.

Issue: The object store project ID conflicts with the design repository project ID

Problem
This issue might be reported with the following message:
FNRDD0613 - The project cannot deploy because a project name {0} was previously deployed to the object store using project id {1}. The object store project id conflicts with the project id in the design repository.
Cause
A project with the same name was previously created and deleted from the design repository.
Solution
Before you deploy a new project with the same name, make sure that you clean up the old project from any object store where it was previously deployed. Or create the new project with a different name.
Removing the old project
To remove the old project, you can either run a script, or use a REST API endpoint.
  • Run the cpds_cleanUpProject.sh script. For instructions, see the Deleting an Automation Document Processing project from a CPE Object Store IBM Support page.
  • If you are familiar with REST APIs, clean up the project by calling the CPDS POST /projects/{projectId}/cleanup endpoint. As the projectId value for the cleanup, use the project identifier that is returned in the error.
    Note: It is not necessary to delete the associated Property Templates.
Working with a new project
As an alternative, you can create a project with a different name in Business Automation Studio and deploy this new project.

Issue: Connection failures

Problem
This issue might be reported with the following messages:
FNRDD0506 – Missing Content Platform Engine URL

FNRDD0508 – The Document Processing Designer Repository API URL is not defined or is invalid: root cause. {0}
FNRDD0511 – The Team Server URL is not defined or is invalid: root cause {0}
FNRDD0517 – The Document Processing engine URL is not defined or is invalid: root cause {0}
Solution
Ask the administrator to review the error logs on the Content Project Deployment Service container for details of the issue.
As soon as the issue is corrected, you can redeploy the project.
Note: You do not need to clean up the deployment project.
Note: It is not needed to do a cleanup of the deployment project.

Issue: Missing or invalid URLs

Problem
This issue might be reported with the following messages:
FNRDD0505 – Connection to the Content Platform Engine failed.
FNRDD0507 – Failed to connect to the Document Processing Repository API: root cause {0}
FNRDD0510 – Failed to connect to the Team Server: root cause {0} 
FNRDD0515 – Failed to connect to Document Processing engine: root cause {0}
Solution
Ask the administrator to review the error logs on the Content Project Deployment Service container. The check CPDS environment variables are as follows:
  • CPE_URI – Content Platform Engine URI, for example, https://icp4adeploy-cpe-svc:9443/wsi/FNCEWS40MTOM
  • REPO_SERVICE_URL – Document Processing Designer Repository. For design environments, https://icp4adeploy-cdra-svc:9443/cdapi, and for runtime environments, https://cpds-adp-project.designserver.com:443/cdapi
  • CA_SERVICE_URL – Document Processing engine Service URL, for example, https://icp4adeploy-spbackend:5000
  • TEAMSERVER_URL – Team Server URL, for example, https://teams-adp-project.server.com:443
As soon as the issue is corrected, you can redeploy the project.
Note: You do not need to clean up the deployment project.

Issue: Content Designer does not display repository for deployment

Problem
This issue surfaces when you try to deploy the project in the designer interface and the repository is not available in the Deploy to repository menu.
This issue might also be reported with the following message.
FNRDD1101 – Object store {0} does not exist.
Solution
  1. By using the CPDS REST API endpoint GET /v1/repositories/{repositoryIdentifier}/initialization or the cpds_getOSConfigStatus.sh script sample, verify that the object store repository is at the correct release level: the isInitialized parameter must return true. For more information about this REST API and this script, see Deploying to the repository earlier in this page.
  2. If the isInitialized parameter returns false, you must reconfigure the object stor. Again, use the CPDS REST API endpoint POST /v1/repositories/{repositoryIdentifier}/initialization or the cpds_configureOS.sh sample script to configure the object store to the appropriate release level.
  3. Restart the Content Platform Engine pods by deleting the original pods one at a time to avoid a complete break in service. The Kubernetes infrastructure automatically starts new pods to bring the total back to your original number.