Document Viewer

Use the Document Viewer to view individual documents that make up a process. You can use search criteria to display raw documents and associated document processing details and events.

When viewing cXML document details, all documents related to the selected request or response are displayed under the Associated Documents header. The magnifying glass icon will be missing from the first document. It represents the document that is currently being viewed in the details above.


Table 27. Document Viewer tasks

What do you want to do? See

Searching for documents

page "Searching for events"

Viewing document details, events, and raw document

page "Viewing document details, events, and raw document"

Viewing data validation errors

page "Viewing data validation errors"

Using the Stop Process feature

page "Using the Stop Process feature"

Searching for documents

  1. Click Viewers > Document Viewer. The system displays the Document Viewer Search screen.
  2. Select the search criteria from the drop-down lists.

    Table 28.

    Document Viewer search criteria
    Value
    Description

    Start date and time

    Date and time the process was initiated.

    End date and time

    Date and time the process was completed.

    Source and Target Participant

    Identifies the source (initiating) and the target (receiving) Participants (Community Manager only).

    Participant

    Identifies if the search applies to all Participants or the Community Manager (Participant only).

    My role is the

    Identifies if the search looks for documents in which the Participant is the Target or Source (Participant only).

    Search on

    Search on From or To document flow.

    Gateway Type

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

    Document status

    Current document status in system: failed, successful, in-progress, or all.

    Package

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

    Protocol

    Type of process protocol available to the Participants.

    Document Flow

    The specific business process.

    Document ID

    Created by the source Participant. Criteria can include asterisk (*) wildcard.

    Synchronous Filter

    Search for documents received in synchronous mode. This means that the connection between the initiator and the Document Manager stays open until the transaction is complete, including request and acknowledgement or request and response.

    Sort By

    Value used to sort results.

    Results per page

    Number of records displayed per page.

    Descend

    Sort results in descending or ascending order.

    Note:
    Warning events are displayed by default. To see all events, select Debug.
  3. Click Search. The system displays a list of documents that meet your search criteria.

    Table 29.

    Document information available using the Document Viewer
    Value
    Description

    Participants

    Source (From) and target (To) Participants involved in the business process.

    Time Stamps

    Date and time the document begins and ends processing.

    Document Flow

    Business process that is being transacted.

    Gateway Type

    Test or production. Test is only available on systems that support the test gateway type.

    Synchronous

    Identifies that the document was received in synchronous mode. This means that the connection between the initiator and the Document Manager stays open until the transaction is complete, including request and acknowledgement or request and response.

Viewing document details, events, and raw document

  1. Click Viewers > Document Viewer. The system displays the Document Viewer Search screen.
  2. Select the search criteria from the drop-down lists.
  3. Click Search. The system displays a list of documents.

The following document processing information is displayed when you view document details:

Table 30.

Document processing values available using the Document Viewer
Value
Description

Reference ID

Unique identification number assigned to the document by the system.

Document ID

Unique identification number assigned to the document by the source Participant.

Doc Time Stamp

Date and time document was created by Participant.

Gateway

Gateway the document passed through.

Connection Document Flow

Actions performed on a document by the system to ensure its compatibility with business requirements between Participants.

Source and Target

Source and target Participants involved in business process.

In Time Stamp

Date and time the document was received by the system from the Participant.

End State Time Stamp

Date and time the document was successfully routed by the system to the target Participant.

Source and Target Business ID

Business identification number of Source and Target Participants, for example, DUNS.

Source and Target Document Flow

The specific business process transacted between source and target Participants.

Restrictions:
Raw documents greater than 100K are truncated. For example, when the signature is located at the bottom of the raw document (.rno file), and the size of the raw document exceeds 100K, or the signature is present after the first 100K of the .rno file, the signature will not be shown in Document Viewer.
Tip:
If the system displays a Duplicate Document event, view the previously sent original document by selecting the blue arrow icon next to the Duplicate Document event, then selecting .
Tip:
To troubleshoot documents that have failed processing, see "Viewing data validation errors".

Viewing data validation errors

You can quickly search for documents that have failed processing using the color-coded text in the XML fields that contain validation errors. Fields that contain validation errors are displayed in red. If up to three separate validation errors occur within nested XML fields, the following colors are used to distinguish between the error fields:

Table 31. Color-coded document validation errors

Value
Description

Red

First validation error

Orange

Second validation error

Green

Third validation error

The following is an example of nested XML validation errors:




Example of non-nested XML validation errors:




To view validation errors in a raw document, see "Viewing raw documents".

Restrictions:
The console only displays the first 100KB of a raw document. Validation errors beyond 100KB are not viewable.

Using the Stop Process feature

Click Stop Process to fail a document currently in progress. This feature is only available to hub admin users.

Note:
It may take up to one hour for the system to fail the document. During this time, the Document Viewer will continue to display the document status as in progress.

Copyright IBM Corp. 2003, 2004