Creating a document processing application

Use the Application Designer with the Document Processing templates and toolkit to create an end-user application for document processing.

Before you begin

These steps assume that you have already installed both the templates and the toolkits. Your templates and toolkits are installed by default when you choose the Document Processing pattern for installation.

Before you can create the document processing application, you must have already created and deployed the document processing project. For more information, see the following topics:

About this task

The Application Designer has a Basic mode and an Advanced mode. You can use the Advanced mode to customize the template or toolkit components. However, the Basic mode is appropriate for using the template and toolkit to create a fully functional application for document processing. These steps assume you are using the Basic mode.
Two templates are included:
Document processing template
This template assumes that you want to process a single document at a time.
Batch document processing template
This template assumes that you want to process a group of documents, or a batch, at one time.

The following steps show the creation of an application by using the Batch document processing template. For more information about both templates, see Templates and toolkits.

Important: Before you create an application for the first time after you deployed your project, you must preview the Batch document processing application configurator or the Document processing application configurator in Application Designer. This action prevents errors in the configuration of application environment variables.
To preview the configurators:
  1. From the Business Automation Studio menu, click Design > Business applications to open Application Designer.
  2. Click the Filter filter icon icon and select Studio extensions.
  3. Click the Preview link for Batch Document Processing Application Configurator and Batch Document Processing Application Configurator.

Procedure

To create a Batch Document Processing application:

  1. Log in to the Business Automation Studio, and from the menu, click Design > Business applications.
  2. Click Create, then click Application.
  3. In the configuration dialog, enter a name for your application, and select Open in Designer.
  4. Under Select a base template and snapshot, select Batch Document Processing template.

    If applicable, select the specific snapshot of the template that you want to use. For first-time application creation, you choose the default latest version.

  5. Optional: Specify a description that will help differentiate the purpose of this application from other Document Processing applications that you create.
  6. Click Create.
  7. For the application configuration settings, provide the following values:
    • Document Processing URL - The location of your deployed Document Processing component
    • Project ID - The identifier of the project that you created in the Document Processing Designer
    • Discard JSON after Verifying - Whether to keep or discard the JSON file
    • Repository name - The name of the content repository that you designated to store the documents that you are processing
    • Root Home - The location of your application.
  8. Save your configuration.
    The application is created.
    You can use the following views to explore the application that you are creating:
    Overview
    This view provides overview information about the application.
    Diagram
    This view provides a visual representation of the pages that are contained in the application and the interactions that are available between the pages.
    Variables
    Use the Variables view to validate or modify the configuration settings for your application.
    Page
    The page view enables you to choose from the available pages in the application. The pages are fully built in the template. However, you can see the components and edit anything that you want to change. The Batch Template includes the following pages:
    • Classification issues - List of batch documents that have document type or page order issues.
    • Classify - The page where you can fix the document type and page order issues.
    • Data list - List of batch documents that have data extraction issues.
    • Extraction issues - List of batches that have data extraction issues.
    • Review batch - List of batch documents after the batch has been finalized. This list is read-only.
    • Start - The landing page for the application, displays batches and navigation tiles for issues.
    • Update batch - The list of batch documents, which you can update by adding, replacing, or deleting documents.
    • Verify data - The page where you fix the data extraction issue.
    The Document Processing template includes the following pages:
    • Starting page - The landing page for the application that displays folders and documents to process.
    • VerifyPage - The page where you fix the data extraction issue.

    You can also select New… if you want to add a page to your application.

  9. To see how the application will look for your users, click Preview.
    Starting a preview publishes the application to the Application Engine so that it can be run and viewed.

    The application displays in a playback view browser window.

  10. Start an optional test of your application.
    1. From the Start page, click Add > Upload.
    2. In the Upload new batch window, provide a value in the Display name field, and an optional description.
    3. Specify the priority for the batch:
      • High
      • Medium
      • Low
    4. Optional: Assign a Batch group. This designation helps you distinguish and group like batches together.
    5. Optional: Add a Batch location. This designation helps you query and locate your batches.
    6. Click Select files. Use the browse window to select your files for the batch.
  11. Click the batch name to determine the status of your upload.
    You can also use the Add button to add more documents to your batch. For each document, you can use the Overflow menu Three dots menu menu for the following operations:
    • View
    • Replace document
    • Add document above
    • Add document below
    • Download
    • Properties
    • Delete document
  12. When you have included all required documents, click Submit.
    The view returns to the Start page. You can see the status of your submitted batch in the Batch list.
  13. If your batch status indicates that the batch has problems, use the tiles to examine and correct the issues.
    Although you are running a preview version of the application, your connection to the repository is real. Any documents or batches that you process exist in your repository.

    If you find any issues with your application during the preview, you can close the preview window, return to the application, and make updates.

  14. When you are satisfied with your application, click the Snapshot icon to take a snapshot of the application.
    This makes your application available to deploy on a desktop in IBM Business Automation Navigator.
  15. Preview your application again to make it available to the application service.