Gateway Queue

The Gateway Queue lets you view documents queued for delivery from any gateway in the system. It also allows you to view all gateways that have documents queued for delivery, display and remove documents in a queue, and enable or disable gateways.

The Gateway Queue can be used to ensure that time-sensitive documents are not left standing in the queue. It can also be used to ensure that the maximum number of documents to be queued is not exceeded. Using the Gateway Queue, you can:

Viewing the gateway list

To view a list of documents residing in the gateway, use the following procedure:

  1. Click Viewers > Gateway Queue. The Console displays the Gateway Queue window.
  2. Input the parameters shown in Table 27.
    Table 27. Gateway Queue window
    Criteria Description

    Queued at least

    Minimum number of minutes a document has been waiting in the gateway queue. For example, if 6 minutes is selected, all gateways containing documents that have been waiting for delivery for 6 minutes or more will be displayed. The default is 0.

    Minimum Queued

    Minimum number of documents in a gateway queue. The default is 1.

    Sort By

    Sort search results by Participant (default), Gateway Name, or Last Sent Timestamp.

    Direction

    Click Ascend to display documents starting with the oldest time stamp or end of the alphabet, or Descend to display documents starting with the most recent time stamp or the beginning of the alphabet.

    Refresh

    Turn refresh on or off (default).

    Refresh Rate

    Number of seconds the Console waits before updating displayed data.

  3. Click Search. The system finds all documents in the gateway that match your search criteria. Table 28 shows the information returned form the search.
    Table 28. Results after gateway queue search
    Criteria Description

    Participant

    Trading partner associated with gateway

    Gateway

    Name of the gateway

    Queued

    Number of documents in the gateway queue waiting for delivery. Link to gateway details

    State

    Shows whether the gateway is online or offline

    Last Sent

    Last date and time a document was sent to the gateway successfully

Note:
For the Console to display a gateway, the gateway must meet all the requirements of the search criteria using AND logic.

Viewing queued documents

To search for queued documents that meet specific search criteria, use the following procedure:

  1. Click Viewers > Gateway Queue.
  2. From the Gateway Queue window, click Search.
  3. Complete the following parameters in the window:
    Table 29. Search criteria for the Gateway Queue
    Parameter Description

    Participant

    Name of the trading partner receiving the document

    Gateway

    Name of the gateway

    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

    Sort By

    Sorts search results by Participant (default), Reference ID, Document ID, or time document entered gateway queue

    Direction

    Click Ascend to display documents starting with the oldest time stamp or end of the alphabet, or Descend to display documents starting with the most recent time stamp or beginning of the alphabet

  4. To view in-depth document details, click Reference ID. For descriptions of the in-depth information displayed when viewing document details, see the topic "About document viewer" in the online help.

Removing documents from the delivery queue

The following procedure describes how to remove documents from the delivery queue. You must be logged in as Hub Admin to remove documents from the queue.

  1. Click Viewers > Gateway Queue.
  2. From the Gateway Queue window, click Search.
  3. Complete the parameters in the window (see Table 29).
  4. Click the delete icon to delete the document.

Viewing gateway details

To view information about a particular gateway, including a list of documents in the queue, use the following procedure:

  1. Click Viewers > Gateway Queue.
  2. From the Gateway Queue window, type the search criteria (see Table 27).
  3. Click Search.
  4. From the list of gateways, click the document count link in the Queued column. Gateway details and a list of queued documents appear.

Changing gateway status

To place a gateway online or offline, use the following procedure:

  1. Click Viewers > Gateway Queue.
  2. From the Gateway Queue window, type the search criteria (see Table 27).
  3. Click Search.
  4. From the list of gateways, click the document count link in the Queued column. Gateway details and a list of queued documents appear.
  5. Click Online in Gateway Info to place a gateway offline, or click Offline to place gateway online. (You must be logged in as Hub Admin to change gateway status.)

Copyright IBM Corp. 2003, 2005