Triaging Documents (Technology Preview)

Stardust provides an index screen for a simple triaging of incoming documents. For details on the general concept of Document Triage in Stardust, please refer to chapter Document Triage in the Stardust Concepts Document Triage in the Concepts part.

Note
This functionality is technology preview only. It may not be functionally complete and is not intended for production use!

Section Preparing an Indexing Activity required for Document Triage describes the requirements for using the index screen.

The index screen consists of the following panels:

Refer to section Document Triage Example for an example on how to set up a workflow to perform a Document Triage.

Preparing an Indexing Activity required for Document Triage

To invoke a Document Triage, you require a UI Mashup application activity using specific resources. For details on UI Mashup applications, please refer to chapter UI Mashup Application in the Business Process Modeling Handbook.

The technology preview jar provided for Document Triage contains UI Mashup resources to invoke the Document Triage index screen. To create a UI Mashup application activity using these resources, perform the following steps:

  1. Create a new or edit an existing model
  2. If your model has a configuration variable serverBaseUrl (you can create one in the Eclipse modeler), make sure the value is set correctly:
  3. In the model Outline tree right-click Applications and select Create UI Mashup. The UI Mashup properties panel opens.
  4. In the Parameters tab, add an in/out parameter with a structured data that is enabled to be used as a Business Object.

    Parameters

    For details on defining structured data as Business Objects refer to section Using the Data as Business Object (Technology Preview) of chapter Specifying Data in the Business Process Modeling Handbook.
  5. Switch to the Configuration tab and enter the following URL referring to the documentAssignmentPanel.html resource provided in the Document Triage preview technology jar:
  6. Add this application to a process containing ....
  7. Create a process for Document rendezvous as described in chapter
  8. Running the Document rendezvous process, waiting for a Document...

You can find a completed example model here:

Populating the Data Panel

Once the index screen is displayed, a drop-down list is provided to select a Business Object.

Select a Business Object
Figure: Select a Business Object

Selecting a Business Object populates the Process Data panel accordingly.

Data Panel
Figure: Data Panel populated for Business Object

For details on using Business Objects, please refer to chapter Managing Business Objects (Technology Preview).

Using the Process Data Panel

In the entry fields you can enter business data from the incoming documents and perform a lookup into a record keeping system.

Data Entry Fields
Figure: Data Entry Fields

Record Set Lookup

Tabbing out of a field where you entered a value, initiates a lookup against a record keeping system. The results are returned in a table below.

Data Panel Table
Figure: Data Panel Table

Clicking a row in the table selects that participant record and initiates a search for Pending Activities using this record set. The results of this search are populated in the Pending Processes and Activities Panel tree. However, it is not mandatory to select a record set.

Note
Each new search resets the Pending Processes and Activities tree.

Document Thumbnails Panel

A Thumbnail panel is provided to support navigating the documents associated with the in-scope Process Instance and also to support drag operations for adding documents to both, the Pending Processes and Activities Panel and the Startable Processes Panel.

Document Thumbnails Panel
Figure: Document Thumbnails Panel

A checkmark shows if the document, or all pages of the document, has/have been assigned.

Document Checkmark
Figure: Checkmark indicating that Document is assigned

Expanding and Collapsing Pages

In case a document has more than one page, you have the option to expand and collapse the pages. Click the expand/collapse icon in the upper right corner of the document thumbnail to expand Document pages.

Expand/Collapse Document pages
Figure: Expand/Collapse Document pages

The single pages of the Document are now listed below the Document name.

Expanded Pages
Figure: Expanded Pages

Changing the Page Order

You have the option to re-order or reverse the order of pages in a document.

Re-ordering pages

To re-order pages in the document, simple drag and drop pages to a desired location in the Thumbnails document.

Reversing the page order

To reverse the page order of documents having more than one page, click the Reverse Page Order icon in the upper right corner of the document.

Reverse Page order
Figure: Reverse Page order

Opening the Document or Page in the Document Viewer

Clicking a document or page in the Thumbnails panel opens or updates the Document Viewer Panel with that document or page.

Dragging Documents to create References

Documents can be dropped onto Process Attachments or Specific Documents to create a document reference in that target process instance. Refer to the Process Attachments or Specific Documents sub-sections of sections Pending Processes and Activities Panel and Startable Processes Panel for details on dragging and dropping documents to these nodes.

Splitting Documents

Splitting multi-page documents is supported for TIFF and PDF files.

To split a document, select the thumbnail pages of the document that you want to split and drag it to one of the following nodes:

This will create a new document.

A dialog opens to ask if you like to create a new document with the dragged pages.

Confirm Split
Figure: Confirm splitting of document

A checkbox is provided to decide if the pages from the original source document should be deleted. Click OK to confirm or Cancel to cancel the split process.

Note that the new document resulting from the split will be saved as a TIFF file. The new document will be created with the selected document pages in the target node and added to the Thumbnails panel.

New Document
Figure: New Document created from split pages

Document Viewer Panel

A document viewer panel is provided to render document content. Clicking a document or page(s) in the Thumbnail panel opens the document or page(s) in this embedded viewer.

Note that clicking a document in the Pending Processes and Activities Panel or Startable Processes Panel tree opens it in a separate Document Viewer tab and not in the Document Viewer panel.

Document Viewer Panel
Figure: Document Viewer Panel

In case a document is not supported, a "unsupported file type" message is displayed in the viewer.

Using the Document Toolbar

The document toolbar supports:

Pending Processes and Activities Panel

The Pending Processes and Activities tree lists the process and activity instances matching the participant data that are waiting for documents.

It supports document rendezvous by allowing documents to be dragged from the Indexing Activity of the Process Instance (document thumbnails) to process instances or activities that are waiting for these documents.

For details on the Stardust Document Rendezvous concept please refer to chapter Document Rendezvous in the Stardust Concepts Document Rendezvous in the Concepts guide.

Pending Processes and Activities Panel
Figure: Pending Processes and Activities Panel

A checkbox is provided to choose if to display or hide completed process instances.

Show/Hide Completed Processes
Figure: Show/Hide Completed Processes

The following tree nodes are displayed:

Process Instances

Each top-level node represents a Process Instance that has at least one Activity that is waiting for one or more documents.

Launching Process History

An option to launch Process History is provided on the right side of the process instance node.

Launching Process History
Figure: Launching Process History

Descriptors

The Descriptors node displays the descriptor key value pairs in a comma separated list.

Rendezvous Activity Instances

Activity nodes are listed for each Activity Instance that is waiting for documents. The specific document that the Rendezvous Activity is waiting on appears as a sub-node under the waiting Activity and it is indicated as not filled.

Rendezvous Activity nodes
Figure: Rendezvous Activity nodes

When a document is dropped onto a waiting Rendezvous Activity node the document is immediately added and the waiting activity is completed.

Drag Document
Figure: Dragging a document to a Rendezvous Activity node

The node of the completed activity is removed from the tree.

Removed Rendezvous Activity node
Figure: The Rendezvous Activity node is removed.

For details on the Stardust Document Rendezvous concept please refer to chapter Document Rendezvous in the Stardust Concepts Document Rendezvous in the Concepts guide.

Specific Documents

All specific documents for the Process Instance are listed as Specific Documents nodes.

When a document is dropped onto a Specific Document node the document is immediately added to the Process Instance.

Drag Document
Figure: Dragging a document to a Specific Document node

The specific document icon is filled to indicate that a document is added.

Filled Document icon
Figure: Filled Document icon

Note that this does not trigger any Activity completion!

Once a specific document is filled, that document is locked and is no longer a drop target.

Moving the mouse over a document opens a tooltip with details like content type, name and number of pages.

Process Attachments

Process Attachments nodes provide a drop target for adding documents to process attachments via drag-and-drop of the document thumbnails.

Dropping a document onto the Process Attachments node immediately adds that document to the Process Instance as a process attachment.

Dragging a document to Process Attachments
Figure: Dragging a document to Process Attachments


Figure: Select a

All process attachments in the Process Instance are listed.

Moving the mouse over a document opens a tooltip with details like content type, name and number of pages.

Startable Processes Panel

The Startable Processes tree contains all processes that the currently logged-in user is authorized to start.

The following tree nodes are displayed:

Startable Processes Panel
Figure: Startable Processes Panel

Startable Process Node

Each top-level node represents a startable process in Stardust and is used to stage new process instances.

When a Document is dragged onto a Startable Process node as described in section the following happens:

Note that only one Startable Process Instance can be staged per Startable Process at one time. If a user wants to create multiple Process Instances in the same Process Definition, he must stage and submit each of them one at a time.

Specific Documents

Each specific document has its own document node and is indicated as either filled or not filled. See section Specific Documents for pending processes and activities for more details.

Process Attachments

The Process Attachments node is a container node for adding process attachments. A leaf node is displayed for each document in process attachments. Please see section Process Attachments for pending processes and activities for more details.

Document Triage Example

To prepare an example workflow to demonstrate Document Triage, we create a model containing two processes, one for Document Rendezvous waiting for incoming Documents, and one for the Document Triage, containing a UI Mashup activity for indexing.

You can also find a completed example model here: ClaimsProcessing.xpdl.

Creating Business Object and Document Data

In the model, create the following data:

  1. Structured Data, which is enabled to be used as Business Object, e.g.:

  2. Create Document data that will be required for Document rendezvous and indexed in the Index screen for Document Triage.

Preparing a Document Rendezvous

To prepare a simple process with a Document Rendezvous, which will be available in our document triage, do the following:

  1. Create a manual activity reading data to be entered in your structured data fields
  2. Create an OR gateway
  3. Create a Route Activity (Task = None) for each document that is requiring rendezvous:
    1. Begin the Activity ID of each Route Activity with DocumentRendezvous, e.g. DocumentRendezvous_DisabilityCertificate. Do not include spaces in the ID.
    2. Mark each of these Activities as Hibernate Initially

    Route Activity Properties

  4. Create a joining gateway for these activities

The following screenshot shows an example Document Rendezvous process for Claim processing:

Claims Processing Example
Figure: Claims Processing Example Workflow

For details on the Document Rendezvous concept in general, please refer to chapter Document Rendezvous in the Stardust Concepts Document Rendezvous in the Concepts part.

Creating a Document Upload and Indexing Process

To invoke a Document Triage, we require a UI Mashup application activity as described in section Preparing an Indexing Activity required for Document Triage. Perform the following steps to create a process including such an activity:

  1. Add a manual activity to provide the option to upload documents
  2. Add a UI Mashup application activity as described in section Preparing an Indexing Activity required for Document Triage as follow-up activity

The following screenshot shows an example Document upload and indexing process:


Figure: Example Document Upload and Indexing process

Running the Example

To run your Document Triage example:

  1. After deploying your model, start the Document Rendezvous process
  2. Enter values in the data fields for your structured data and complete the activity
  3. The subsequent Document rendezvous activities are hibernated waiting for the incoming Documents
  4. Now start the process for Document upload and indexing
  5. Attach the required Documents to the Document Upload activity and complete it
  6. The Document Indexing screen opens for Document Triage
  7. Select the Business Object and proceed by using the functionality described in the above sections

Example Index Screen
Figure: Example Index Screen