Document
Viewer
The Document Viewer is used to locate and view a specific
document that you want to research. You can search for documents
based on date, time, type of process, (From Process or To Process),
participant connection, gateway type, document status, protocol,
document flow, and process version. The search results display all documents
that meet your search criteria, and identify time stamps, process, participant
connection, and gateway types. Locate the target document and use
the viewer's features to view the raw document. You can
also use the Document Viewer to resend failed or successful documents.
Searching for documents
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search screen.
- Select the search criteria from the drop-down lists.
Table 23. 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. |
Participant |
Identifies the participant (Community Manager
only). |
My role is the |
Specifies if the participant is the source
(initiating) or the target (receiving). |
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. You can
choose In Progress, Successful, or Failed. The default is 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. |
Reference ID |
ID number created by the system for tracking
document status. |
Source IP Address |
IP address of the source participant. |
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.
- Click Search. The system displays a list
of documents that meet your search criteria.
Table 24. 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
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search screen.
- Select the search criteria from the drop-down lists.
- Click Search. The system displays a list
of documents.
- To view a document's details and events, click the
open folder icon next to the document displayed under the Associated
Documents header. The system displays process details and events
for the selected document. For EDI Interchange documents, if there
are child EDI transactions from either de-enveloping or enveloping,
they can be shown by selecting the Document children source
or target radio button. See the Administrator Guide for
more information on viewing EDI documents.
- To view the raw document with HTTP header, click the Display
raw document icon next to the document. The system displays the
raw document's content.
The following document processing information is displayed when
you view document details:
Table 25. 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 larger than 100K are truncated.
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 click the View original
document icon.
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 26. 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.
