Document Analysis

Use the Document Analysis tool to get a detailed overview of the number of documents in the system, by state, within a specific time period.

Use the search criteria to locate failed documents and investigate the reason for the failures.

The Document Analysis screen includes an alarm. If a process has failed, the row containing the failed process flashes red.

Document States

The following table describes the different document states.

Table 31. Document States
State Description

Received

The document has been received by the system and is waiting for processing.

In Progress

The document is currently in one of the following processing steps:

  • Incomplete. For example, the system is waiting for other documents.
  • Data Validation. For example, the system is checking document content.
  • Translation. For example, the system is converting the document to another protocol.
  • Queue. For example, the document is waiting to be routed to the participant or Community Manager.

Failed

Document processing was interrupted due to errors in the system, data validation, or duplicates.

Successful

The final message that completes document processing has been transmitted from the system to the target participant.

Viewing documents in the system

  1. Click Tools > Document Analysis. The system displays the Document Analysis Search screen.
  2. Select the search criteria from the drop-down lists.
    Table 32. Document Search Criteria
    Value Description

    Start Date & Time

    The date and time the process was initiated.

    End Date & Time

    The date and time the process was completed.

    Source Participant

    The participant that initiated the business process (Community Manager only).

    Target Participant

    The participant that received the business process (Community Manager only).

    Search On

    Search on From document flow or To document flow.

    Gateway Type

    For example, Production or test. Test is only available on systems that support the test gateway type.

    Package

    Describes document format, packaging, encryption, and content-type identification.

    Protocol

    Document protocol available to the participants.

    Document Flow

    Specific business process.

    Sort By

    Sort results by Source Participant Name or Target Participant Name.

    Refresh

    Controls if the search results are refreshed periodically (Community Manager only).

    Refresh Rate

    Controls how often search results are refreshed (Community Manager only).

  3. Click Search. The system displays the Document Analysis Summary.

Viewing process and event details

  1. Click Tools > Document Analysis. The system displays the Document Analysis Search screen.
  2. Select the search criteria from the drop-down lists.
  3. Click Search. The system displays the Document Analysis Summary.
  4. Click the View details icon next to the Source and Target participants that you want to view. The system displays a list of all documents for the selected participants. Document quantity is arranged in columns by document processing state.
  5. Select the quantity link in the Received, In Progress, Failed, or Successful columns. The system presents document processing details in the Document Analysis Report. If you selected Failed, the report also includes a Document Event Summary.

Copyright IBM Corp. 2003, 2005