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. 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 window.
- Select the search criteria from the drop-down lists, described
in Table 22.
Table 22. Document Viewer search criteria
Value |
Description |
Start Date |
Date the document flow process was initiated. |
Start Time |
Time the document flow process was initiated. |
End Date |
Date the document flow process was completed. |
End Time |
Time the document flow process was completed. |
Source Participant |
Represents the participant that initiated
the document flow. The default is All. |
Target Participant |
Represents the participant that received the
document flow. The default is All. |
Search on |
Indicates whether to search on source document
flow or target document flow. The default is Source Document Flow. |
Gateway Type |
Identifies the nature of the document being
exchanged (for example, whether it is used for production or test
purposes). The default is All. |
Document Status |
Current document status in system: In Progress,
Successful, or Failed. The default is All. |
Package |
Describes the document format, packaging,
encryption, and content-type identification. Limits the search to
the package listed. The default is All. |
Protocol |
Type of process protocol available to the
participants. |
Document Flow |
The specific business process. |
Original File Name |
The original file name. |
Document ID |
Created by the source participant. Criteria
can include asterisk (*) wildcard. |
Reference ID |
The ID number created by the system for tracking
document status. |
Source IP Address |
The 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 acknowledgment or request and response. |
Sort By |
Indicates whether the documents will be sorted
by Target Timestamp, Source Document Flow, or Target Document Flow.
The default is Target Timestamp. You can also indicate whether the
documents should be sorted in ascending or descending order. The
default is Descend. |
Results Per Page |
Number of records displayed per page. |
Descend |
Sort results in either descending or ascending
order. |
Note:
Only warning events are displayed by default. To
see all events, select Debug.
- Click Search. The system displays the
results of your search, described in Table 23.
Note:
The term participants is used on the Viewer windows
to identify a hub community member, including the Community Manager.
Table 23. Document details
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 acknowledgment or request and response. |
Viewing document details, events, and
raw documents
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search window.
- 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 Viewing EDI documents for
details.
- To view the raw document along with any transport headers, click
the Display raw document icon next to the document. The system displays
the raw document's content.
The document processing information is displayed when you view
document details, described in Table 24.
Table 24. Document processing values available through 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 click the View original
document icon.
Tip:
For information on how to troubleshoot documents that
have failed processing, see
Viewing
data validation errors in
the following section.
Viewing EDI documents
In addition to pass through support for EDI Interchanges,
WebSphere Partner Gateway supports the de-enveloping and enveloping
of EDI Interchanges. The EDI interchange documents are de-enveloped
when received from either a Community participant or a Community
manager. Transaction documents that are de-enveloped from the incoming
interchange can then be processed by WebSphere Partner Gateway like
any other business document.
WebSphere Partner Gateway envelopes EDI transactions and generates
EDI Interchanges. EDI transaction documents are generated by transforming
XML, EDI, and ROD documents into EDI transactions. EDI transaction
documents that were de-enveloped from the EDI interchanges received
by WebSphere Partner Gateway can be transformed into another EDI
transaction document type. WebSphere Partner Gateway envelopes EDI
transaction documents into an EDI Interchange document and then
sends the EDI interchange document to its intended recipient.
The following scenarios will assist you in locating this information:
Refer to the Hub Configuration Guide for
more information on de-enveloping and enveloping EDI Interchanges.
Viewing EDI document source transactions
WebSphere Partner Gateway de-envelopes incoming EDI transactions
from EDI interchanges.
To view the resulting EDI transaction children:
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search window.
- Select the search criteria from the drop-down lists.
- Click Search. The system displays a list
of documents.
- Click the View details icon next to the Document ID.
- Click the Source radio button in the Document
Children section to view the document children details.
Viewing EDI document target transactions
WebSphere Partner Gateway routes outgoing EDI transactions
to the interchange to be enveloped.
To view the EDI transaction children that are contained in the
resulting interchange:.
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search window.
- Specify the search criteria to locate the EDI interchanges received
by WebSphere Partner Gateway.
- Click Search. The system displays a list
of all the documents that meet your search criteria.
- Click the View details icon next to the Document ID for the
document that you want to view.
- Click the Target radio button in the Document
Children section to view the document children details.
Locating the source interchange
You can use the Document Viewer to obtain the source interchange
for an EDI transaction:
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search window.
- Select the search criteria from the drop-down lists.
- Click Search. The system displays a list
of documents.
The source interchange Document ID is listed for each EDI transaction.
Locating the target interchange
You can use the Document Viewer to obtain the target interchange
for an EDI child transaction:
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search window.
- Select the search criteria from the drop-down lists.
- Click Search. The system displays a list
of documents.
- Click the View details icon next to the Document ID.
- Click the Information radio button in
the Document Events section.
- Click the Expand icon next to EDI Transaction Enveloped in the
Event Name column.
- Locate and copy the Envelope activity id from the Event Details
list.
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search window.
- Paste the Envelope activity id into the Reference ID field and
click Search.
The Document Viewer displays the target interchange information.
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 colors are used to distinguish between the error
fields, as outlined in Table 25.
Table 25. 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:
For details on viewing 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.
Stopping a document that is in process
Click Stop Process to stop a document
currently in progress. This feature is only available to hub admin
users.
Note:
It can take up to one hour for the system to stop
the document. During this time, the Document Viewer continues to
display the document status as in progress.
Resending failed and successful documents
You can resend failed documents after correcting the cause
of the failure. Additionally, you can resend successfully processed
documents if requested. For example, a partner may request that
a document be resent if the original document was lost on the client
server before it interfaced with the back-end system. This feature
is only available to hub admin users.
There are two basic types of documents that Administrators can
resend:
- In documents are those that come into
WebSphere Partner Gateway, either from the Backend or the participant.
These documents can fail in the Receiver, Document Acquisition Engine
(DAE), or Business Process Engine (BPE).
- Out documents are those that leave WebSphere
Partner Gateway, either to the Backend or to the participant. These
documents can fail either in the BPE or Delivery Manager.
To resend a failed In document, the Administrator
selects the In document and clicks the Resend button.
The document is resubmitted either from DAE or BPE based on the
failure location. For example, In document
failures can occur in DAE in the following cases:
- Received document size is more than the maximum size limit.
- Non-repudiation of the received document failed.
- Failed sending the document to BPE.
In document failures can occur in BPE in
the following cases:
- Fixed inbound workflow failures
- While unpackaging, the message failures can occur while
decrypting the message or verifying the signature. This can be caused
by incorrect configuration of certificates at the partner or hub.
- B2B capabilities are not configured for the partner.
- Variable workflow failures
- Validation maps are not configured.
- Invalid Translation maps are configured.
Note:
Documents that fail in the Receiver are resubmitted
when the Administrator resolves the problem.
To resend failed Out documents, the Administrator
selects the Out document and clicks the Resend button.
The document is resubmitted either from BPE or Delivery Manager.
Out document failures can occur in the
following cases:
- For a BPE failure resubmitting the Out document
itself does not make sense, so in a BPE failure the In document
should be resubmitted. This will insure that anything that was incorrect
in the BPE flow that was corrected will get picked up. An example
of a correction may be in the transformation. Out document
failures in BPE can be Fixed outbound workflow failures. Packaging
of the message can fail while encrypting or signing the message
due to incorrect certificate configurations for partner or hub.
- For a Delivery Manager failure:
- If the problem was due to an error in the BPE flow, the In document
should be resubmitted. This insures that anything that any corrections
in the BPE flow will get picked up. For example, if the Gateway
target information was incorrect.
- If the failure was caused by something else, for example,
the Gateway target transport was down, then a re-submit of the Out document
can be done, although the In document can
also be resubmitted.
There is an underlying assumption that nothing has changed that
would break a resend, especially from the DAE or BPE. For example,
if the In document is encrypted, the certificates
required to decrypt the document should not have been changed from
the certificates that were used to encrypt the document. The administrator
has to be aware of any potential consequences of the resend.
To resend a document:
- Click Viewers > Document Viewer.
The system displays the Document Viewer Search window.
- Select the search criteria from the drop-down lists.
- Click Search. The system displays a list
of documents.
- Place a checkmark in the box next to the document or documents
that you want to resend.
- Click Resend.
You will receive a confirmation message after the resend is processed.
