Deployment overview

After you create the project in Document Processing Designer, you use the deployment process to make the capabilities and artifacts available for integration into an application and into the destination repository.

Deployment is the process by which the document types, model, and overall project definition are made available for use. After a project is deployed, it can be integrated with a user application for document processing. Deploying the project also prepares the repository object store for storing and classifying your documents.

Authoring environment

In an authoring environment, the Doc Processing Analyst user, typically the user who created the project, uses the Document Processing Designer user interface tool to deploy the project. The following steps illustrate a high-level lifecycle for a project in an authoring environment:
  1. Create the project in Document Processing Designer.
  2. Save the project to Git by using the Share function.
  3. When the project is complete, use the version function in the Document Processing Designer interface to create a version of the project.
  4. When you are ready to deploy the project, use the Deploy function in the Document Processing Designer interface to deploy the project.
  5. Use the Application Designer to create a document processing application for the end user that is based on your project.
  6. Return to the Document Processing Designer as needed to improve or add to your project.
  7. Repeat the deployment and iteration until the project and application are complete and tested.

Runtime environment

In a runtime environment, the project and application are ready for test, staging, and eventually production. Deployment is the responsibility of another user, the Doc Processing Manager. The following steps illustrate a high-level lifecycle for a project in an authoring environment:
  1. Collect the relevant information about your project and the environment, including the project ID and version.
  2. Confirm that the destination runtime environment is initialized and ready for the project deployment.
  3. Run the deployment script, providing information about the project and the destination environment.
  4. If applicable, move your document processing end-user application to the new runtime environment.

Deployment description

In both the authoring and runtime environments, deployment accomplishes the following steps:
  • Retrieving and parsing the project definition JSON files from Git.
  • Checking the object store and design repository for previous versions to prevent deployment conflicts.
  • Creating the Business Teams.
  • Creating the metadata for PropertyTemplates, ClassDefinitions, roles, and deployment records.
  • Creating roles.
  • Importing the machine learning model.
  • Importing the document types and fields, and field enrichment.

Security model

Only users of certain roles can deploy a document processing project.

In an authoring environment, a Doc Processing Managers or Doc Processing Analysts user can deploy the project with the Designer interface tool.

In a runtime environment (test, staging, or production), a Doc Processing Manager can deploy the project by running the deployment scripts at the command line.

You have different sets of users and groups for authentication in each of your environments. For details on document processing roles and their respective authorization, see Document Processing security and roles.