Google has deprecated legacy versions of AutoML services, which directly impacts IDP's core functionality. Additionally, the IDP application was deprecated with Appian 23.2. Customers who wish to use the application will need to refactor plug-ins using AutoML. |
Installing the Intelligent Document Processing application consists of nine main steps:
eu
region, update the connected systems compute region.Optional steps are part of the installation process if you plan to use Google's AutoML service to classify extracted documents in IDP.
If you have the IDP application pre-installed on your cloud site, you don't need to go through these installation steps. Go to Updating a pre-installed application to update the Google Cloud values in your Appian instance.
Before starting the installation process, review the System Requirements to make sure all minimum requirements are met.
If your Appian installation includes different environments, such as development, staging, and production, we recommend following these instructions to install or update your pre-installed application on your source environment first. This is usually your development environment. After installation, you can use your source environment to fine-tune your application before deploying the changes to a target environment.
After you have installed the application (or updated a pre-installed application) in your source environment, follow the same steps to install (or update) the application in your target environment.
If you made any modifications to the application in the source environment, follow the steps in Deploying Patches to deploy the changes to your target environment.
Note: These steps only apply if you plan to use Google's AutoML service to classify extracted documents in IDP.
Starting with version 20.1 of Appian, if you are a new Appian customer, the IDP application is pre-installed on your cloud site. However, in order to use your own Google Cloud values in your Appian environment, you will need to perform the following steps:
DU_CLOUD_PROJECT_ID
constantDU_CLOUD_REGION
constant: Depending on the region you chose for your storage bucket setup, enter us-central1
for U.S. or eu
for Europe.DU_AUTOML_CLOUD_BUCKET
and DU_STORAGE_CLOUD_BUCKET
constants: Enter a storage bucket that does not delete content after a certain period of time. Otherwise, the documents might be deleted before the model training or prediction has completed.DU_DATA_SOURCE_NAME
constant with your environment's data source name. For example,jbdc/<your data source name>
.DU Google Cloud AutoML
and DU Google Cloud Storage
connected systems, use the Google Cloud information to update the configuration values, then click TEST CONNECTION.
eu
multi-region:
DU Google Cloud AutoML
connected system, for the Compute Region, select eu
.For the DU Google Cloud Storage
connected system, for the Compute Region, select one of the Europe regions. These region options start with europe-
.
DU Google Cloud General
connected system and upload the Service Account Key file that was provided or generated in Step 1: Set up Google Cloud, then click AUTHORIZE TO VERIFY.
Note: If the authorization is not successful, you will need to address the error message. You might have to double-check your Service Account Key file, or update the Google Cloud service account permissions.
Follow these steps to set up AutoML Natural Language and create your Google Service Account and key.
Tip: AutoML Natural Language and Document AI can share Google service accounts (for authentication) and storage buckets (for prediction and extraction).
To set up Google Cloud AutoML Natural Language:
Cloud AutoML API
, Google Cloud Storage JSON API
, and Cloud Document AI API
.Region
us-central1
Standard
(sometimes displayed in the Cloud Storage browser as Regional)Multi-region
eu
Standard
(sometimes displayed in the Cloud Storage browser as Multi-Regional)Note: You may choose to have two buckets: one for the training documents and one for the prediction documents. Or, you can use the same storage bucket for both. If you use two buckets, then they must be in the same regional location.
To create your Google Service Account and key:
AutoML Admin
, Storage Admin
, and Document AI Admin
permissionsCustomers should visit the Document Extraction page in the Admin console to choose which vendor they'd like to use to extract documents.
----BEGIN/END PRIVATE KEY----
or similar. This portion is required for the configuration to work properly.In order for the IDP application to work, the following plug-ins are required:
To deploy plug-ins for self-managed installations, see Appian Suite Plug-Ins.
To deploy the plug-ins for cloud installations:
Note: IDP relies on a set of bundled plugins that Appian supports as part of the application. Support for use of these plugins in other scenarios is provided by the Appian community in accordance with AppMarket guidelines.
The next step in installing IDP is to download the software package that contains the following files. These files will be used in the remaining set up steps.
To download the software package:
IntelligentDocumentProcessing(IDP)v1.8.0CombinedFiles.zip
file to access the installation files.Next you will need to update the IntelligentDocumentProcessing(IDP)v1.8.0.properties
file that you downloaded in Step 4: Download software package to use the Google Cloud values that were generated in Step 1: Set up Google Cloud. This document will be uploaded when you import the application and will automatically update certain design objects with the values you specify.
To update the import customization file:
IntelligentDocumentProcessing(IDP)v1.8.0.properties
file that you downloaded in Step 4.DU_DATA_SOURCE_NAME
constant with your environment's data source name. For example,jbdc/<DataSourceName>
.@
) with the Google Cloud values you obtained in Step 1. For example, you'll paste a real value to replace @ProjectId@
.
DU_CLOUD_REGION
constant: For storage buckets in the us
region, enter us-central1
. For storage buckets in the eu
region, enter europe-north1
, europe-west1
, europe-west2
, europe-west3
, or europe-west4
depending on your storage bucket set up.DU_AUTOML_CLOUD_BUCKET
and the DU_STORAGE_CLOUD_BUCKET
constant: enter a storage bucket that does not delete content after a certain period of time. Otherwise, the documents might be deleted before the model training or prediction has completed.In order to set up your database for the IDP application, you will need to run the DDL script in your database.
To run the DDL script in your business database, run the IntelligentDocumentProcessing(IDP)v.1.8.0.sql
DDL file that was downloaded in Step 4: Download software package.
Note: The DDL file is meant to be used for MySQL databases. If you use a different database you may need to modify the database commands.
Next you will import the application files into the your Appian environment.
To import the application:
IntelligentDocumentProcessing(IDP)v1.8.0.zip
file that was downloaded in Step 4.IntelligentDocumentProcessing(IDP)v1.8.0.properties
file that was downloaded in Step 4 and updated in Step 5: Update import customization file.Note: If your business database is not called Appian, a warning will occur when importing the data store. To fix this, after the import is complete, open the DU Data Store object and select your business database from the Data Source dropdown list.
If your storage bucket is in the eu
multi-region, you will need to update the compute region for two of the connected systems.
To update the connected systems:
DU Google Cloud AutoML
connected system.eu
.DU Google Cloud Storage
connected system.europe-
.There are a few more steps you need to take to get your application up and running.
You may need to add a user start page for any groups that will use IDP as their primary site.
We recommend setting the user start page for the DU Reconciliation Desk Parent Group
so that when they click on a task from their email, they will be taken to the IDP site instead of Tempo.
To add a user start page:
https://
your-appian-instance.com
/suite/sites/intelligent-document-processing
. Replace your-appian-instance.com
with your site URL.DU Reconciliation Desk Parent Group
and any other groups that will use IDP as their primary site.To make sure admin users receive important email notifications about the application, you will have to add them to the DU Administrators
group.
To add admins to the administrators group:
DU Administrators
group and add the appropriate admin users.To get started with the application right away without modifying it, check out the Configuring IDP for instructions on how to complete the initial configuration of the application.
If you need to modify your application, check out the resources mentioned in the Customizing IDP section of the Intelligent Document Processing (IDP) Overview page.
Installing IDP