Using the Clean Deployment utility

After you first check that all services are configured and running normally without connection issues, if the deployment of your content project version fails again after repeated attempts, you can use the Cleanup Deployment utility to clean up deployed project artifacts in the target environment and resolve the deployment failure.

Before you begin

Before you set out to apply the Clean Deployment utility, read Troubleshooting project deployment.

If your project does not deploy properly, some checks and updates are necessary before you use the Clean Deployment utility. Contact your system administrator and ask them to review the error logs on the Content Project Deployment Service application server. The error messages provide information about why the deployment was unsuccessful.

The administrator can check and test the following settings where issues might exist:
  • The connection to the Content Platform Engine
  • The connection to the Document Processing Designer Repository API
  • The connection to the Team Server
  • The connection to Document Processing engine
Attention:
  • To run the Clean Deployment utility, a user must be a Document Processing Manager, a Document Processing Analyst, or an Object Store Admin.
  • The Clean Deployment utility is destructive. Therefore, before you use it, you must attempt other troubleshooting and resolution options.

About this task

What the Clean Deployment utility does
  • It cleans or removes all repository artifacts, such as ClassDefinitions, roles, runtime document or object instances, deployment record or artifact objects that are associated with the project.
  • It cleans or removes all Document Processing engine artifacts, machine-learning models, and then document types and fields.
What the Clean Deployment utility does NOT do
  • It does not affect Property Templates.
  • It does not clean Document Processing Designer artifacts.
  • It does not clean or remove business teams.
  • The Clean Deployment utility cannot delete documents for which the retention period is not expired. In such a case, the Clean Deployment utility does not complete.

Procedure

To run the Clean Deployment utility:

  1. From the main Designer page, click Version/Deploy.
  2. Under Deploy, click Clean up the deployment.
  3. Review the information on the dialog and confirm that you have completed all troubleshooting attempts.
  4. Click Clean up to run the utility.

What to do next

If you did run the Clean Deployment utility, because it deletes the document processing project from your project database, learn how to restore the database in Deleting and recreating a project database.