Understanding Monitoring Asynchronous Service OperationsThis chapter discusses how to:
Filter asynchronous service operations data.
Save asynchronous data filtering selections.
View asynchronous filtering results.
View monitor output for asynchronous service operations data.
Monitor service operation transactions.
Monitor asynchronous service operation instances.
Monitor publication contracts.
Monitor subscription contracts.
Understanding Monitoring Asynchronous Service OperationsThis section provides an overview of :
Asynchronous service operation statuses.
Blocked queues.
Stalled queues.
Asynchronous Service Operation Statuses
This section discusses:
Processing statuses for asynchronous service operations.
Processing errors.
Processing Statuses for Asynchronous Service Operations
For asynchronous service operations, the Service Operations Monitor displays different statuses as service operations progress through the system.
The typical status progression for asynchronous service operations is:
New.
Started.
Working.
Done.
However, the Service Operations Monitor can display any of the statuses listed in the following table.
|
Status |
Description |
|
Canceled |
The item has been canceled. The system cannot process the item until you resubmit it. |
|
Done |
This status indicates different outcomes, depending on the type of process that you are monitoring. For operation instances this status indicates that the operation instance has completed processing and that the publication or subscription contracts have been created. For publication contracts this status indicates that publication contract was successfully sent to the external system. For subscription contracts the status indicates that the subscription notification processed successfully. |
|
Edited |
The publication data for the item has been edited. Processing does not resume until you resubmit the item. |
|
Error |
An error occurred during processing. Manual intervention is required. |
|
Hold |
This field is used in conjunction with message segmentation and future-dated publications. The status of a segmented message is Hold while the system is processing the segments in the message. The status of a future-dated publication is Hold until the date and time specified to process the publication is reached. |
|
New |
Either the item has been written to the database but has not been dispatched yet, or the item has just been resubmitted. |
|
Retry |
The system encountered an intermittent error during processing. The system retries service operations with this status automatically. |
|
Started |
The dispatcher is in the process of passing the item to a handler, but the handler has not received it yet. |
|
Submit |
This status indicates that a process schedule instance has been created for the transaction. |
|
Timeout |
The system has reached the maximum retry count to send a service operation. |
|
Working |
The handler has accepted the item and is currently processing it. |
Asynchronous Service Operation Status of Done with Error Link Enabled
The status for a service operation typically displays Error in the Service Operations Monitor when the system cannot create a publication or subscription contract or if there is some other framework error (for example a SQL error).
However, there are situations when the system displays a status of Done for an operation instance, publication contract, or subscription contract, yet also displays an Error link indicating that it encountered a problem during processing.
This can occur when:
Attempting to publish a service operation that contains segmented messages to a node that is not segment aware.
The routing on a publication contract is inactive.
There is no service operation handler for a subscription contract.
And so on.
The system sets the status for an operation instance, publication contract, or subscription contract to Done when it has successfully created the instance or contract. In each of the cases described in the list, the system encounters an error after it has evaluated the transaction and has successfully created the operation instance or contract. The system therefore displays an Error link that you can use to access the corresponding error message. The system does not sent the service operation until the error is corrected.
The following table lists the pages where you can access an Error link should any of these situations occur:
|
Type |
Error Link Location |
|
Operation instance |
Asynchronous Services – Operation Instances page. (PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Services. Operation Instances tab.) |
|
Publication contract |
Asynchronous Details page. (PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Service Details.) |
|
Subscription contract |
Asynchronous Details page. (PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Service Details.) |
Blocked Queues
Queues preserve the order in which service operations are processed.
The pub/sub system guarantees that items are processed in the order they are sent. If a service operation has a status of Error, Timeout, or Edited, the service operation queue becomes blocked and no processing occurs until you resolve the problem with the service operation.
For publications, queues are partitioned in queues by sub queues.
For publication contracts, the queues is further partitioned into queues by sub queue and target node. If a queue is ordered, items in that queue and in the same queue are processed in the order sent. The dispatcher does not begin processing an item until all items ahead of it in the queue have the status Done or Cancelled. An item with a status of Error, Timeout, or Edited blocks all items behind it in the same queue. If the remote node is unavailable, the dispatcher does not attempt to process the contract and the queue is blocked until the remote node becomes available. That is why publication contracts are partitioned by target node.
If a queue is unordered, an item (such as the publication, publication contract, or subscription contract) never blocks another item. All items are processed in parallel.
Stalled Queues
Stalls do not occur by design. They are caused by gaps in functionality, user errors, defects, and so forth.
For example, a queue can become stalled when:
Multiple domains access the same database and one of the domains is shut down abnormally.
Items may be stalled in the Started or Working status.
Note. You can use the Domain Status page to correct the problem.
A change occurs to the pub/sub runtime tables through direct SQL.
The copies of the database tables that dispatchers have in memory are not updated. In this situation, you must reboot the dispatchers.
Filtering Asynchronous Service Operation Data
Use the following filter criteria to reduce your search results. The value you set on one page in the Asynchronous Services component is carried forward to all pages of this component. Unless stated otherwise, the fields display on all pages of the Asynchronous Services component.
|
The Archived check box enables you to search for either archived or live service operation data. To search archived data, select the check box. To search live data, clear the check box. |
|
|
User Level View |
Check the User Level View box to display information only for those service operations to which you are assigned permission list access. |
|
External Service Name |
This field appears on the Operation Instances page in the Asynchronous Services component only. Enter the name of the inbound service operation received from an integration partner. This name is equivalent to the routing alias. |
|
Group By |
This field appears on the Monitor Overview page in the Asynchronous Services component only. Use the drop-down list box to select how to group returned data. The valid values are:
|
|
Publish Node, Node Name |
Indicates the node that published the service operation. Note. The Service Operations Monitor only allows you to view information for the local system (database). However, the queues for the local database can contain service operations published by remote nodes, as well the local node. There is only one local node for a database. |
|
Queue Level |
This field appears on the Monitor Overview page in the Asynchronous Services component only. The valid options are:
|
|
Queue Name |
To view service operation data within a specific queue, select the appropriate queue value in the Queue Name drop-down list box. |
|
Refresh |
Click the button to apply the filtering criteria selected. When you click the Refresh button the system saves your search criteria for subsequent searches. |
|
Status |
To view service operation data by status, select the status criteria from the Status drop-down list box. The status options reflect the status columns that appear on the Monitor Overview page. Descriptions of the possible service operation statuses are described elsewhere in this chapter. |
|
Time Period |
The Time Period group box features four fields for searching by date and time: From Date, To Date, From Time and To Time. If you complete just the date fields, the time fields automatically populate from 12:01 a.m. to 11:59 p.m. When left blank, no date or time is used as part of the search criteria. |
|
Transaction ID |
To search for a specific transaction, enter the transaction ID. |
On the pages where filtering applies, you enter your filtering criteria in the Message Criteria group box. The result set appears in the status grid directly below the filtering options.
See Also
Filtering Service Operation Data
Viewing Monitor Output for Asynchronous Service Operation Data
After you filter and search for asynchronous service operations data in the pages of the Asynchronous Services pages, the output displays in grid format at the bottom of the pages.
The following page elements display data related to integrations using asynchronous service operations in the grids:
|
Alias |
Service operation alias name, if defined for the service operation. The Alias field, in conjunction with the Service Operation Version field, helps to differentiate when there are two routings on the same node with different aliases, for example, when transformations are in use. |
|
Details |
Each row of filtering results on the Operation Instances page, Publication Contracts page and Subscription Contracts page displays a Details link. Click the link to view the data in the Asynchronous Details page, where you can view service operation properties, details about any service operation errors that have occurred, and view service operations in XML format. |
|
Orig Trans ID |
The original transaction ID generated and used for the service operation instance. As contracts are created another transaction ID is created for each publication or subscription contract. However, the original transaction ID is always available as a reference. |
|
Publishing Node |
Name of the node sending node. |
|
Queue Name |
The name of the queue used for the transaction. |
|
Segment Number |
When implementing message segments, indicates the number of the segment message. |
|
Service Operation |
Name of the service operation. |
|
Service Operation Version |
Version of the service operation. |
|
Status |
Status of the service operation in the system. Descriptions of the possible service operation statuses are described elsewhere in this chapter. |
|
Subscriber Node |
Name of the receiving node. |
|
Sub Queue |
If queue partitioning exists for a queue, a Sub Queue column appears in the Results grid on the Operation Instances page, Publication Contracts page and Subscription Contracts page . Click the link to open the Sub Queue Message Queue page to view all transactions in the sub queue. |
|
Time Stamp |
Date and time of the transaction. |
|
Transaction ID |
The unique identifier assigned to the transaction by the system. |
Monitoring Asynchronous Service Operation Transactions
Use the Monitor Overview page for a high-level overview of the status of asynchronous service operation transactions. You can group transactions by queue or service operation for viewing.
To access this page, select PeopleTools, Integration Broker, Service Operations Monitor, Asynchronous Services. The Monitor Overview page shown in the following example appears:
After you search for queue information to view, the Results grid displays the results of your search.
This page displays search results by queue name or service operation name, depending on the selection you make in the Group By drop-down list box.
The processing status of service operations displays in the status columns (for example, Error, New, Started, and so on).
Most of the time, the status for a service operation that appears in the Result grid isDone. This means that the service operation instance arrived in the publication queue (creating the service operation headers only). However, other statuses can appear. For instance, if the pub/sub system is down, the status is New. If there are transformation or PeopleCode errors, the service operation status is Error. In addition, if you access the Service Operations Monitor at certain times, you might see a status of Started or Working. Use the other pages in this component to view more comprehensive status information.
The number of operation instances in a particular status display as a linked value. Click the link to open the data in the Operation Instances page where you can view more detailed information.
See Also
Filtering Asynchronous Service Operation Data
Viewing Monitor Output for Asynchronous Service Operation Data
Asynchronous Service Operation Statuses
Monitoring Asynchronous Service Operation Instances
Monitoring Asynchronous Service Operation Instances
The Operation Instances page enables you to monitor the status and details related to individual asynchronous service operation instances.
To access the Operation Instances page, select PeopleTools, Integration Broker, Monitor Integrations, Monitor, Asynchronous Services and click the Operation Instances tab. The following page appears:
After you select your filtering options, click Refresh.
See Also
Filtering Asynchronous Service Operation Data
Viewing Monitor Output for Asynchronous Service Operation Data
Asynchronous Service Operation Statuses
Viewing Asynchronous Service Operation Details
Resubmitting and Canceling Service Operations for Processing
Viewing Queue Partitioning Information
Monitoring Publication Contracts
The Publication Contracts page shows outbound publication transactions to send to remote nodes.
To access the page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Services. Then click the Publication Contracts tab. The following example shows the Publication Contracts page:
The system does not create publication contracts for routing to the local node.
Descriptions of the page elements that appear on the page are described elsewhere in this section.
See Viewing Monitor Output for Asynchronous Service Operation Data.
See Also
Asynchronous Service Operation Statuses
Filtering Service Operation Data
Viewing Queue Partitioning Information
Viewing Asynchronous Service Operation Details
Resubmitting and Canceling Service Operations for Processing
Monitoring Subscription Contracts
The Subscription Contracts page enables you to view transactions to which the local node subscribes. Subscription contracts for remote nodes do not appear.
To access this page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Services. Then click the Subscription Contracts tab. The following example shows the Subscription Contracts page:
Note. When viewing the status of bulk subscription contracts (such as 100,000 or more) using a Solaris operating system and an Oracle database, your browser session may close unexpectedly. As a result, you should filter the number of subscription contracts for which to view status information. To do so, use the settings in the Time Period box to filter information by date and time. The volume of service operations in the system determines the best values to enter.
See Also
Asynchronous Service Operation Statuses
Filtering Service Operation Data
Viewing Monitor Output for Asynchronous Service Operation Data
Viewing Queue Partitioning Information
Viewing Asynchronous Service Operation Details
Resubmitting and Canceling Service Operations for Processing
Viewing Queue Partitioning Information
If queue partitioning exists for a queue, a Sub Queue column appears in the Results grid on the Monitor Overview page, the Publication Contracts page, and the Subscription Contracts page of the Asynchronous Services component.
If you click the sub queue name link, the Sub Queue Operation Instances page displays and you can view all service operations in the sub queue in the order in which they will be processed. You can also resubmit service operations or cancel the submission of service operations on this page.
Note. When viewing sub queue info, even if the primary page was displaying archived data, this page always shows current data.
The following example shows the Sub Queue Operation Instances page:
If more than one row of data appears in the Operation Queue grid, the row in bold is the row you were viewing on the previous page.
Descriptions of the page elements that appear on the page are described elsewhere in this section.
See Also
Viewing Monitor Output for Asynchronous Service Operation Data