PeopleTools 8.56: Integration Broker Service Operations Monitor

PeopleTools 8.56: Integration Broker
Service Operations Monitor
June 2017
PeopleTools 8.56: Integration Broker Service Operations Monitor
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and
disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement
or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute,
exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or
decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you
find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf
of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any
programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial
computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental
regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any
operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be
subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications. It is
not developed or intended for use in any inherently dangerous applications, including applications that may create a
risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible
to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation
and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous
applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their
respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used
under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD
logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a
registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and
services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all
warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an
applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any
loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as
set forth in an applicable agreement between you and Oracle.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://
www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers that have purchased support have access to electronic support through My Oracle Support. For
information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/
topic/lookup?ctx=acc&id=trs if you are hearing impaired.
Contents
Preface: Preface..........................................................................................................................................vii
Understanding the PeopleSoft Online Help and PeopleBooks............................................................ vii
PeopleSoft Hosted Online Help.....................................................................................................vii
Locally Installed Help....................................................................................................................vii
Downloadable PeopleBook PDF Files...........................................................................................vii
Common Help Documentation..................................................................................................... viii
Field and Control Definitions....................................................................................................... viii
Typographical Conventions...........................................................................................................viii
ISO Country and Currency Codes.................................................................................................. ix
Region and Industry Identifiers...................................................................................................... ix
Translations and Embedded Help.................................................................................................... x
Using and Managing the PeopleSoft Online Help................................................................................. x
Understanding the Integration Broker Service Operations Monitor...................................................... x
PeopleTools Related Links..................................................................................................................... x
Contact Us..............................................................................................................................................xi
Follow Us...............................................................................................................................................xi
Chapter 1: Understanding the Integration Broker Service Operations Monitor................................13
Service Operations Monitor Features................................................................................................... 13
Service Operations Monitor Components............................................................................................ 13
Service Operations Monitor Security................................................................................................... 14
Chapter 2: Filtering Service Operation Data......................................................................................... 15
Filtering Service Operation Data..........................................................................................................15
Selecting Filtering Criteria....................................................................................................................15
Saving Filtering Selections................................................................................................................... 15
Chapter 3: Monitoring Asynchronous Service Operations................................................................... 17
Understanding Asynchronous Service Operations Statuses................................................................. 17
Processing Statuses for Asynchronous Service Operations........................................................... 17
Asynchronous Service Operation Status of Done with Error Link Enabled..................................19
Blocked Queues and Processing Statuses...................................................................................... 19
Stalled Queues and Processing Statuses........................................................................................ 20
Filtering Asynchronous Service Operation Data..................................................................................20
Viewing Monitor Output for Asynchronous Service Operation Data.................................................. 22
Monitoring Asynchronous Service Operation Transactions.................................................................23
Monitoring Asynchronous Service Operation Instances...................................................................... 24
Monitoring Publication Contracts.........................................................................................................25
Monitoring Subscription Contracts.......................................................................................................26
Viewing Queue Partitioning Information............................................................................................. 27
Chapter 4: Viewing Asynchronous Service Operation Details............................................................. 29
Understanding Viewing Asynchronous Service Operation Details......................................................29
Common Elements Used to View Asynchronous Service Operation Details...................................... 29
Viewing Asynchronous Service Operation Instance Details................................................................ 31
Viewing Asynchronous Publication Contracts Details.........................................................................33
Viewing and Working with Publication Actions........................................................................... 33
Viewing Publication Information Details.......................................................................................33
Viewing Asynchronous Subscription Contracts Details.......................................................................34
Viewing and Working with Subscription Actions......................................................................... 34
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
iii
Contents
Viewing and Working with Subscription Information................................................................... 35
Setting the Data Length View Limit for Displaying XML.................................................................. 35
Viewing Logical Transformation XML Output....................................................................................36
Chapter 5: Monitoring Synchronous Service Operations..................................................................... 37
Understanding Synchronous Service Operation Statuses.....................................................................37
Filtering Synchronous Service Operations Data.................................................................................. 37
Viewing Monitor Output for Synchronous Service Operations Data...................................................38
Viewing Synchronous Service Operation Transaction Information...............................................38
Viewing Synchronous Service Operation General Information.....................................................39
Chapter 6: Viewing Synchronous Service Operation Instance Details................................................ 41
Viewing Synchronous Service Operation Details................................................................................ 41
Chapter 7: Viewing Integration Gateway Logging Data for Service Operations............................... 45
Viewing Integration Gateway Logging Data in the Service Operations Monitor................................ 45
Understanding Viewing Integration Gateway Logging Data in the Service Operations
Monitor........................................................................................................................................... 45
Prerequisites for Viewing Integration Gateway Logging Data in the Service Operations
Monitor........................................................................................................................................... 46
Enabling Integration Gateway Message Logging in the Service Operations Monitor...................46
Changing the Storage Directory for Integration Gateway Transaction Logs.................................47
Viewing Integration Gateway Logging Data for Service Operation Transactions.........................48
Chapter 8: Resubmitting and Canceling Service Operations for Processing...................................... 51
Understanding Resubmitting and Canceling Service Operations for Processing................................. 51
Understanding Resubmitting and Canceling Future-Dated Publications............................................. 51
Resubmitting and Canceling Individual Service Operations................................................................51
Resubmitting and Canceling Service Operations in Bulk.................................................................... 51
Chapter 9: Viewing Service Operation IB Info Data.............................................................................53
Viewing IB Info Data........................................................................................................................... 53
Chapter 10: Viewing Service Operation Errors..................................................................................... 55
Understanding Viewing Service Operation Errors............................................................................... 55
Common Elements Used to View Service Operation Errors............................................................... 55
Viewing Asynchronous Service Operation Instance Errors................................................................. 55
Viewing Asynchronous Publication Contract Errors............................................................................56
Viewing Asynchronous Subscription Contract Errors..........................................................................56
Viewing Synchronous Service Operations Errors................................................................................ 57
Chapter 11: Viewing and Editing Service Operation XML.................................................................. 59
Understanding Viewing and Editing Service Operation XML.............................................................59
Asynchronous Service Operation XML.........................................................................................59
Synchronous Service Operation XML........................................................................................... 59
Viewing Service Operation XML.........................................................................................................60
Editing Service Operation XML...........................................................................................................60
Chapter 12: Viewing Service Operation Nonrepudiation Signature Information.............................. 63
Understanding Viewing Service Operation Nonrepudiation Signature Information............................ 63
Viewing Nonrepudiation Signatures in XML Format.......................................................................... 63
Chapter 13: Running Batch Error Notification Processes.................................................................... 65
Understanding Batch Error Notification...............................................................................................65
Prerequisites for Using Batch Error Notification................................................................................. 66
Creating Static Error Notification Lists................................................................................................67
Running Batch Error Notifications.......................................................................................................67
Chapter 14: Archiving Service Operation Instances............................................................................. 69
Understanding Archiving Service Operation Instances........................................................................69
Archiving Service Operations...............................................................................................................69
iv
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Contents
Retrieving Archived Messages............................................................................................................. 69
Chapter 15: Running Batch Service Operation Archiving Processes.................................................. 71
Understanding Running Batch Service Operation Archiving Processes.............................................. 71
Prerequisites for Running Batch Service Operation Archiving Processes........................................... 71
Running Batch Service Operation Archiving Processes...................................................................... 71
Chapter 16: Viewing System Performance Statistics.............................................................................75
Understanding Messaging System Performance Statistics...................................................................75
Service Operation Types................................................................................................................ 75
Processing Components..................................................................................................................75
Overhead Processing...................................................................................................................... 76
Processing Times............................................................................................................................ 77
Using the Statistics Pages.....................................................................................................................77
Enabling the System Performance Statistics Feature........................................................................... 83
Searching for System Performance Statistics.......................................................................................84
Common Elements Used to Search for System Performance Statistics........................................ 84
Searching for Performance Statistics............................................................................................. 84
Viewing Messaging System Performance Statistics.............................................................................85
Common Elements Used to View Messaging System Performance Statistics.............................. 85
Viewing Inbound Asynchronous Statistics.................................................................................... 87
Viewing Outbound Asynchronous Statistics..................................................................................89
Viewing Inbound Synchronous Service Operation Statistics.........................................................92
Viewing Outbound Synchronous Statistics.................................................................................... 95
Purging System Performance Statistics.............................................................................................. 101
Chapter 17: Managing Down Nodes......................................................................................................103
Understanding Managing Down Nodes..............................................................................................103
Viewing Transaction Information for Down Nodes........................................................................... 103
Clearing Transaction Data for System Node Restart......................................................................... 104
Chapter 18: Pausing, Testing, and Pinging Nodes............................................................................... 105
Understanding Pausing Nodes............................................................................................................ 105
Adding Pause Times to Local Nodes................................................................................................. 105
Deleting Pause Times......................................................................................................................... 106
Testing Local Nodes........................................................................................................................... 106
Pinging Remote Nodes....................................................................................................................... 107
Chapter 19: Pausing and Starting Queues............................................................................................109
Pausing Queues................................................................................................................................... 109
Starting Queues................................................................................................................................... 110
Chapter 20: Cleaning Up Orphaned Data From Segment Batch Processing Errors........................111
Understanding Cleaning Up Orphaned Data from Segment Batch Process Errors............................ 111
Cleaning Up Orphaned Data from Segment Batch Processing Jobs..................................................111
Chapter 21: Using Custom-Defined Components to View Service Operations Data........................113
Understanding Using Custom-Defined Components to View Service Operation Data......................113
Specifying Service Operations to Associate to Custom-Defined Components.................................. 113
Associating Service Operations to Custom-Defined Components..................................................... 113
Chapter 22: Purging Runtime Service Operations Monitor Tables................................................... 117
Purging Runtime Monitor Tables....................................................................................................... 117
Chapter 23: Using the Service Operations Monitor Component Interface....................................... 119
Using the Monitor Component Interface............................................................................................119
Chapter 24: Using PeopleCode to Read and Write Errors to the Asynchronous Error Queue....... 121
Using PeopleCode Methods to Read and Write Errors to the Asynchronous Error Queue................121
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
v
Contents
vi
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Preface
Understanding the PeopleSoft Online Help and PeopleBooks
The PeopleSoft Online Help is a website that enables you to view all help content for PeopleSoft
Applications and PeopleTools. The help provides standard navigation and full-text searching, as well as
context-sensitive online help for PeopleSoft users.
PeopleSoft Hosted Online Help
You access the PeopleSoft Online Help on Oracle’s PeopleSoft Hosted Online Help website, which
enables you to access the full help website and context-sensitive help directly from an Oracle hosted
server. The hosted online help is updated on a regular schedule, ensuring that you have access to the
most current documentation. This reduces the need to view separate documentation posts for application
maintenance on My Oracle Support, because that documentation is now incorporated into the hosted
website content. The Hosted Online Help website is available in English only.
Note: Only the most current release of hosted online help is updated regularly. After a new release is
posted, previous releases remain available but are no longer updated.
Locally Installed Help
If your organization has firewall restrictions that prevent you from using the Hosted Online Help
website, you can install the PeopleSoft Online Help locally. If you install the help locally, you have more
control over which documents users can access and you can include links to your organization’s custom
documentation on help pages.
In addition, if you locally install the PeopleSoft Online Help, you can use any search engine for full-text
searching. Your installation documentation includes instructions about how to set up Elasticsearch for
full-text searching. See PeopleTools Installation for your database platform, “Installing PeopleSoft Online
Help.” If you do not use Elasticsearch, see the documentation for your chosen search engine.
Note: See Oracle Support Document 2205540.2 (PeopleTools Elasticsearch Home Page) for more
information on using Elasticsearch with PeopleSoft.
Note: Before users can access the search engine on a locally installed help website, you must enable the
Search field. For instructions, go to your locally installed PeopleSoft Online Help site and select About
This Help, Managing Locally Installed PeopleSoft Online Help, Enabling the Search Button and Field in
the Contents sidebar.
Downloadable PeopleBook PDF Files
You can access downloadable PDF versions of the help content in the traditional PeopleBook format.
The content in the PeopleBook PDFs is the same as the content in the PeopleSoft Online Help, but it has
a different structure and it does not include the interactive navigation features that are available in the
online help.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
vii
Preface
Common Help Documentation
Common help documentation contains information that applies to multiple applications. The two main
types of common help are:
•
Application Fundamentals
•
Using PeopleSoft Applications
Most product families provide a set of application fundamentals help topics that discuss essential
information about the setup and design of your system. This information applies to many or all
applications in the PeopleSoft product family. Whether you are implementing a single application, some
combination of applications within the product family, or the entire product family, you should be familiar
with the contents of the appropriate application fundamentals help. They provide the starting points for
fundamental implementation tasks.
In addition, the PeopleTools: Applications User's Guide introduces you to the various elements of the
PeopleSoft Pure Internet Architecture. It also explains how to use the navigational hierarchy, components,
and pages to perform basic functions as you navigate through the system. While your application or
implementation may differ, the topics in this user’s guide provide general information about using
PeopleSoft Applications.
Field and Control Definitions
PeopleSoft documentation includes definitions for most fields and controls that appear on application
pages. These definitions describe how to use a field or control, where populated values come from, the
effects of selecting certain values, and so on. If a field or control is not defined, then it either requires
no additional explanation or is documented in a common elements section earlier in the documentation.
For example, the Date field rarely requires additional explanation and may not be defined in the
documentation for some pages.
Typographical Conventions
The following table describes the typographical conventions that are used in the online help.
viii
Typographical Convention
Description
Key+Key
Indicates a key combination action. For example, a plus sign (
+) between keys means that you must hold down the first key
while you press the second key. For Alt+W, hold down the Alt
key while you press the W key.
. . . (ellipses)
Indicate that the preceding item or series can be repeated any
number of times in PeopleCode syntax.
{ } (curly braces)
Indicate a choice between two options in PeopleCode syntax.
Options are separated by a pipe ( | ).
[ ] (square brackets)
Indicate optional items in PeopleCode syntax.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Preface
Typographical Convention
Description
& (ampersand)
When placed before a parameter in PeopleCode syntax,
an ampersand indicates that the parameter is an already
instantiated object.
Ampersands also precede all PeopleCode variables.
⇒
This continuation character has been inserted at the end of a
line of code that has been wrapped at the page margin. The
code should be viewed or entered as a single, continuous line
of code without the continuation character.
ISO Country and Currency Codes
PeopleSoft Online Help topics use International Organization for Standardization (ISO) country and
currency codes to identify country-specific information and monetary amounts.
ISO country codes may appear as country identifiers, and ISO currency codes may appear as currency
identifiers in your PeopleSoft documentation. Reference to an ISO country code in your documentation
does not imply that your application includes every ISO country code. The following example is a
country-specific heading: "(FRA) Hiring an Employee."
The PeopleSoft Currency Code table (CURRENCY_CD_TBL) contains sample currency code data. The
Currency Code table is based on ISO Standard 4217, "Codes for the representation of currencies," and
also relies on ISO country codes in the Country table (COUNTRY_TBL). The navigation to the pages
where you maintain currency code and country information depends on which PeopleSoft applications
you are using. To access the pages for maintaining the Currency Code and Country tables, consult the
online help for your applications for more information.
Region and Industry Identifiers
Information that applies only to a specific region or industry is preceded by a standard identifier in
parentheses. This identifier typically appears at the beginning of a section heading, but it may also appear
at the beginning of a note or other text.
Example of a region-specific heading: "(Latin America) Setting Up Depreciation"
Region Identifiers
Regions are identified by the region name. The following region identifiers may appear in the PeopleSoft
Online Help:
•
Asia Pacific
•
Europe
•
Latin America
•
North America
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
ix
Preface
Industry Identifiers
Industries are identified by the industry name or by an abbreviation for that industry. The following
industry identifiers may appear in the PeopleSoft Online Help:
•
USF (U.S. Federal)
•
E&G (Education and Government)
Translations and Embedded Help
PeopleSoft 9.2 software applications include translated embedded help. With the 9.2 release, PeopleSoft
aligns with the other Oracle applications by focusing our translation efforts on embedded help. We
are not planning to translate our traditional online help and PeopleBooks documentation. Instead we
offer very direct translated help at crucial spots within our application through our embedded help
widgets. Additionally, we have a one-to-one mapping of application and help translations, meaning that
the software and embedded help translation footprint is identical—something we were never able to
accomplish in the past.
Using and Managing the PeopleSoft Online Help
Click the Help link in the universal navigation header of any page in the PeopleSoft Online Help to see
information on the following topics:
•
What’s new in the PeopleSoft Online Help.
•
PeopleSoft Online Help accessibility.
•
Accessing, navigating, and searching the PeopleSoft Online Help.
•
Managing a locally installed PeopleSoft Online Help website.
Understanding the Integration Broker Service Operations Monitor
System administrators use the Integration Broker Service Operations Monitor to monitor integrations
among other PeopleSoft and third-party systems.
This product documentation describes how to use the Integration Broker Service Operations Monitor to
monitor asynchronous and synchronous service operation information, node status, queue status, view
system performance statistics, and more.
PeopleTools Related Links
Hosted Online Help Home
PeopleSoft Information Portal
My Oracle Support
x
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Preface
Oracle University
Oracle's PeopleSoft PeopleTools 8.56 Home Page (Doc ID 2259140.2)
Elasticsearch Home Page (Doc ID 2205540.2)
"PeopleTools Product/Feature PeopleBook Index" (PeopleTools 8.56: Getting Started with PeopleTools)
Contact Us
Send your suggestions to PSOFT-INFODEV_US@ORACLE.COM. Please include release numbers for
the PeopleTools and applications that you are using.
Follow Us
Facebook.
YouTube
Twitter@PeopleSoft_Info.
PeopleSoft Blogs
LinkedIn
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
xi
Chapter 1
Understanding the Integration Broker
Service Operations Monitor
Service Operations Monitor Features
The Integration Broker Service Operations Monitor provides the following features:
•
Status on queues, nodes, and individual service operations.
You can also view and edit service operation XML.
•
Control and administration of domains that have publication and subscription (pub/sub) servers
running against the current database.
Ability to activate or deactivate domains, recover from stalls, and so forth.
•
Workflow notification of error messages and archival of service operations.
•
Batch processes for error notification and service operation archival.
Service Operations Monitor Components
There are thirteen components associated with the Service Operations Monitor that are located within
Monitor and Administration menus in the PeopleSoft Pure Internet Architecture navigation structure.
The following components are located under the Monitor menu. Access them by selecting PeopleTools,
Integration Broker, Service Operations Monitor, Monitoring.
Asynchronous Services
Use this component to monitor asynchronous service operations
and view information about service operation instances,
publication contracts and subscription contracts.
Asynchronous Details
View asynchronous service operation details, including
information about the service operation instance, its publication
or subscription contracts, error messages, and service operation
instance XML. If transformations have been applied to the
service operation, you can view the transformed XML for the
publication and subscription contracts.
Synchronous Services
Use this component to view synchronous service operations.
Synchronous Details
View synchronous service operation details and service
operation errors, and view request and response XML (before or
after transformation).
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
13
Understanding the Integration Broker Service Operations Monitor
Chapter 1
Error Notification
Run batch processes to receive notification of issues affecting
the messaging system.
Archive Monitor Data
Run the batch process to archive service operations.
Statistics
View runtime performance statistics for asynchronous and
synchronous transactions that flow through the messaging
system. View statistics in numeric or graphical format.
The following components are located under the Administration menu in the PeopleSoft Pure Internet
Architecture navigation structure. Access them by selecting PeopleTools, Integration Broker, Service
Operations Monitor, Administration.
Domain Status
View and maintain domain status and activate pub/sub server
domain. Use this component to also setup domain failover.
Node Status
View node status. Ping node.
Queue Status
View and maintain queue status.
Segment Cleanup
Delete orphaned data after segment batch processing errors.
User Details Component
Define a custom component to review service operation
transaction details for a specific service operation.
Monitor Setup Options
Define parameters for using the system performance statistics
feature and for setting the data length view limit for loading
XML data into the monitor. Enable gateway logging.
Service Operations Monitor Security
This section discusses service operations monitor security.
Understanding Service Operations Monitor Security
Upon accessing the monitor, you can see a list of all transactions in the system, but to see specific
information about a transaction and to view transaction details, you must have permission to the service
operation.
Understanding Service Operations Monitor Security for REST Consumer
Transactions
To view REST-based consumer service operation information in the Service Operation Monitor, you must
set the Log Detail option on the routing definition to Header and Details, as well as set permissions to the
service operation.
Related Links
"Setting Permissions to Service Operations" (PeopleTools 8.56: Integration Broker)
"Configuring Routing Definitions" (PeopleTools 8.56: Integration Broker)
14
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 2
Filtering Service Operation Data
Filtering Service Operation Data
Before you begin monitoring the integration system, there are a few general guidelines that enable you to
quickly drill down to the information you need.
When monitoring asynchronous and synchronous service operations, the Service Operations Monitor
provides information about the entire integration system, you need to understand how to filter the
information to reduce the number of items. For instance, rather than sifting through every service
operation in the entire system, the Service Operations Monitor enables you to filter by publishing node,
queue, service operation name, publish date and time, live and archived service operations, and so on.
Selecting Filtering Criteria
When you filter data in the Asynchronous Services component or the Synchronous Services component,
the value you set on one page in the component is carried forward to other pages in the component.
Related Links
Filtering Asynchronous Service Operation Data
Filtering Synchronous Service Operations Data
Saving Filtering Selections
You can save your filtering options so that the next time you use it, your previous filtering choices are set
automatically.
To save filtering selections:
1. Select the filtering options on one of the Asynchronous Services or Synchronous Services component
pages.
2. Click Refresh button.
Clicking Refresh not only refreshes the page according to the most recent filtering selections, it
also saves the most recent filtering selections to the database. The system then associates a given
set of filtering selections with your user ID. The next time that you sign in and launch the Services
Operation Monitor, the system displays the service operation data according to your most recent
filtering selections.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
15
Filtering Service Operation Data
Chapter 2
Note: In situations where multiple people are signing in with the same user ID, it is possible that their
changes may collide with each other if more than one is refreshing the monitor pages at the same
time. In such cases the system displays the message, ‘Data updated by another user.’
16
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 3
Monitoring Asynchronous Service
Operations
Understanding Asynchronous Service Operations Statuses
This section provides an overview of how to:
•
Processing statuses for asynchronous service operations.
•
Processing errors.
•
Blocked queues and processing statuses.
•
Stalled queues and processing statuses.
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:
1. New.
2. Started.
3. Working.
4. 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.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
17
Monitoring Asynchronous Service Operations
Chapter 3
Status
Description
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. This
can include publications sent using guaranteed or best effort
delivery.
For subscription contracts the status indicates that the
subscription notification processed successfully.
Done NoAck.
This status appears for publication contracts sent in Best Effort
delivery mode and indicates that the publication contact was
successfully sent, but no acknowledgement was received.
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.
18
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.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 3
Monitoring Asynchronous Service Operations
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 send 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 and click the 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 Details.)
Blocked Queues and Processing Statuses
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.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
19
Monitoring Asynchronous Service Operations
Chapter 3
For publications, queues are partitioned in queues by sub queues.
For publication contracts, queues are 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 and Processing Statuses
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.
Archived
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.
Correlation ID
This field appears on the Operation Instances page, Publication
Contracts page, and Subscription Contracts page in the
Asynchronous Services component.
A correlation ID is an identifier used to correlate messages, sent
separately, into a single transaction.
To view service operations with a specific correlation ID, enter
or select a value in the Correlation ID field.
External Service Name
20
This field appears on the Operation Instances page in the
Asynchronous Services component only.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 3
Monitoring Asynchronous Service Operations
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:
•
Queue. (Default.)
Displays results by queue name.
•
Service Operation.
Displays results by service operation name.
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:
•
Oper Inst (Operation Instance). (Default.)
•
Pub Con (Publication Contract).
•
Sub Con (Subscription Contract).
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.
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.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
21
Monitoring Asynchronous Service Operations
Chapter 3
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.
User View
Check the User Level View box to display information only for
those service operations to which you are assigned permission
list access.
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.
Related Links
Understanding Asynchronous Service Operations Statuses
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.
•
22
Running. The queue is running.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 3
Monitoring Asynchronous Service Operations
•
Paused. The queue is paused.
Queue Status
Indicates the status of the queue. The possible values are:
Remote Details
The Remote Details link appears if the node where a transaction
is being sent is defined in the integration network.
Click the link to view the details of the remote system's monitor
data for the transaction ID.
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.
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.
Related Links
Understanding Asynchronous Service Operations Statuses
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.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
23
Monitoring Asynchronous Service Operations
Chapter 3
Image: Asynchronous Services – Monitor Overview page
This example shows the Asynchronous Services – Monitor Overview page.
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.
Related Links
Filtering Asynchronous Service Operation Data
Viewing Monitor Output for Asynchronous Service Operation Data
Understanding Asynchronous Service Operations 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.
24
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 3
Monitoring Asynchronous Service Operations
Image: Asynchronous Services – Operation Instances page
This examples shows the Asynchronous Services – Operation Instances page.
After you select your filtering options, click the Refresh button.
Related Links
Filtering Asynchronous Service Operation Data
Viewing Monitor Output for Asynchronous Service Operation Data
Understanding Asynchronous Service Operations Statuses
Understanding Resubmitting and Canceling Service Operations for Processing
Understanding Viewing Asynchronous Service Operation Details
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.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
25
Monitoring Asynchronous Service Operations
Chapter 3
Image: Asynchronous Services – Publication Contracts page
The following example shows the Asynchronous Services – Publication Contracts page.
The system does not create publication contracts for routings to the local node.
Descriptions of the page elements that appear on the page are described elsewhere in this section.
Related Links
Viewing Monitor Output for Asynchronous Service Operation Data
Understanding Asynchronous Service Operations Statuses
Filtering Service Operation Data
Viewing Queue Partitioning Information
Understanding Viewing Asynchronous Service Operation Details
Understanding 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.
26
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 3
Monitoring Asynchronous Service Operations
Image: Asynchronous Services – Subscription Contracts page
This example shows the Asynchronous Services – Subscription Contracts page.
Note: When viewing the status of bulk subscription contracts (such as 100,000 or more) using an Oracle
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.
Related Links
Understanding Asynchronous Service Operations Statuses
Filtering Service Operation Data
Viewing Monitor Output for Asynchronous Service Operation Data
Viewing Queue Partitioning Information
Understanding Viewing Asynchronous Service Operation Details
Understanding 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.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
27
Monitoring Asynchronous Service Operations
Chapter 3
Image: Sub Queue Operation Instances page
This 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.
Related Links
Viewing Monitor Output for Asynchronous Service Operation Data
28
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 4
Viewing Asynchronous Service Operation
Details
Understanding Viewing Asynchronous Service Operation Details
The Asynchronous Details component (IB_MONITOR_DET) enables you to gather in-depth information
about a specific asynchronous service operation. It also enables you to perform tasks such as correct
errors and resubmit service operations.
Note: The pages and tabs in the Asynchronous Details component appear in read-only mode if you do not
have the proper permissions.
Related Links
Viewing Asynchronous Service Operation Instance Details
Viewing Asynchronous Publication Contracts Details
Viewing Asynchronous Subscription Contracts Details
Setting the Data Length View Limit for Displaying XML
Viewing Logical Transformation XML Output
Common Elements Used to View Asynchronous Service
Operation Details
Cancel
Click the Cancel button to cancel processing attempts for
a service operation. This button is enabled when a service
operation has a status of New, Retry, Time Out, Error, or Edited.
Edit XML
An Edit XML link appears when there are errors with the
transaction. Click the link to edit the service operation instance,
publication contract or subscription contract XML to correct
errors.
If you do not have appropriate permission for the particular
service operation being viewed, this link is disabled.
Error Messages
This link can appear in the service operation instance details
section, the publication contracts section, or the subscription
contracts section.
Click the link to view error messages for these items.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
29
Viewing Asynchronous Service Operation Details
Chapter 4
If the link is disabled, there are no errors to view or you do not
have the appropriate permissions to view the information.
Handler Tester
This control appears on the Asynchronous Details page only
when viewing details for subscription contracts.
Click the link to launch the service operation Handler Tester
populated with the data from the subscription contract
transaction.
Last Update Date/Time
Displays the date and time the transaction was last updated.
Process Identifier
Identifies the process ID on the local application server.
Resubmit
Click the Resubmit button to resubmit a service operation for
processing. This button is enabled when a service operation has
a status of Time Out, Error, Edited, or Cancelled. If a service
operation contains an error or has timed out, typically you can
just correct the problem and resubmit the service operation.
After you edit a service operation, the status becomes Edited.
When you resubmit the service operation, the status changes, yet
again, to New.
If you do not have appropriate permission for the particular
service operation being viewed, this button is disabled.
Retry Count
If the first attempt to deliver the service operation failed, this
value reflects the number of times the system has attempted to
resend the service operation.
Segment
If using message segments, indicates the segment number for
which the page or section is displaying information.
If you are using non-segmented messages, a value of 1 appears.
When working with asynchronous operation instance details,
use the Segment drop-down list box to select a different segment
for which to view information. Click the Refresh button to
refresh the page.
Service Operation
Indicates the name 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 topic.
30
Transaction ID
Displays the unique identifier that the system assigns to each
transaction.
Transaction Type
Indicates the transaction type. The valid values are:
•
Inbound synchronous.
•
Outbound synchronous.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 4
Viewing Asynchronous Service Operation Details
Version(Service operation)
Indicates the service operation version.
View IB Info
Click the link to view IB info.
If you do not have appropriate permission for the particular
service operation being viewed, this link is disabled.
View XML
Click the link to view XML for the service operation instance,
publication contract or subscription contract.
If you do not have appropriate permission for the particular
service operation being viewed, this link is disabled.
Viewing Asynchronous Service Operation Instance Details
Use the Asynchronous Details page (IB_MONITOR_DET) to view asynchronous service operation
instance details. To access the page, select PeopleTools, Integration Broker, Service Operations Monitor,
Monitoring, Asynchronous Details.
Image: Asynchronous Details page
This example illustrates the fields and controls on the Asynchronous Details page. You can find
definitions for the fields and controls later on this page.
The section at the top of the Asynchronous Details page provides general information pertaining to a
particular service operation instance to assist in troubleshooting.
At the bottom of the page, a Publication Contracts grid appears when you are monitoring outbound
asynchronous integrations. When you are monitoring inbound asynchronous integrations, a
Subscription Contracts grid appears at the bottom of the page. These grid are described elsewhere in the
documentation.
See the following topics:
•
Viewing Asynchronous Publication Contracts Details.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
31
Viewing Asynchronous Service Operation Details
•
Chapter 4
Viewing Asynchronous Subscription Contracts Details.
The Asynchronous Details page features the following fields and controls:
External Service Name
Indicates the name of the service operation sent by the sending
node.
Publishing Node
Identifies the name of the sending node.
Queue Name
Identifies the queue to which the service operation is associated.
Queue Status
Indicates the status of the queue. The possible values are:
Queue Sequence ID
•
Running. The queue is running.
•
Paused. The queue is paused.
Identifies the sequence of a particular service operation in a
queue.
This field is applicable to only service operations in ordered
queues.
Sub Queue
If queue partitioning exists for a queue, indicates the name of
the sub queue to which the service operation is associated.
Original Publishing Node
Indicates the name of the original sending node.
In most cases the original publishing node and the publishing
node are the same. However, if the service operation goes
through a hub, the original publishing node and publishing node
differ.
Refresh
Click the button to refresh page data.
Archive
Click the Archive button to archive a service operation. This
button is enabled when a service operation has a status of Done
or Cancelled and no associated contract has pending work. If the
queue is not set up for archiving, the Archive button is replaced
with a Delete button.
Uncompressed Data Length
Indicates the size of the XML service operation in bytes.
Data Length View Limit
Indicates the maximum size of an XML document in bytes that
is automatically loaded in the XML Viewer page.
The default is 100000 bytes.
Set this property in the Service Operations Monitor using the
Monitor Setup Options page.
See Setting the Data Length View Limit for Displaying XML.
Other page elements that appear on the page are discussed elsewhere the documentation.
32
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 4
Viewing Asynchronous Service Operation Details
Related Links
Common Elements Used to View Asynchronous Service Operation Details
Understanding Resubmitting and Canceling Service Operations for Processing
Viewing IB Info Data
Understanding Viewing Service Operation Errors
Understanding Viewing and Editing Service Operation XML
Viewing Asynchronous Publication Contracts Details
Use the Publication Contracts section of the Asynchronous Details page to view asynchronous publication
contract details.
Image: Publication Contracts section
This example shows the Publication Contracts section of the Asynchronous Details page. It features an
Action tab and an Information tab.
Note: The section displays only when there are publication contracts associated with the service
operation.
Viewing and Working with Publication Actions
The Actions tab reveals all the nodes subscribing to a particular service operation and the current status
of the publication contract, as in whether the publication has been successfully posted to the subscribing
node.
The Actions tab in the Publication Contracts section provides the following information.
Subscriber Node
Identifies the name of the subscribing or receiving node.
Other page elements that appear on the page are discussed elsewhere in this section.
Related Links
Common Elements Used to View Asynchronous Service Operation Details
Understanding Resubmitting and Canceling Service Operations for Processing
Viewing IB Info Data
Understanding Viewing Service Operation Errors
Understanding Viewing and Editing Service Operation XML
Viewing Publication Information Details
The Information tab reveals details about the publication transaction, including the transaction ID, the
transaction time stamp, and so on.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
33
Viewing Asynchronous Service Operation Details
Chapter 4
Image: Information tab
This example shows the Information tab in the Publication Contracts section of the Asynchronous Details
page.
The Information tab contains the following information about the publication contract:
Signature
When nonrepudiation is implemented, this page element
displays as a hyperlink.
Click the link to view nonrepudiation information associated
with the publication contract.
Other page elements that appear on the page are discussed elsewhere in this section.
Related Links
Common Elements Used to View Asynchronous Service Operation Details
Understanding Viewing Service Operation Nonrepudiation Signature Information
Viewing Asynchronous Subscription Contracts Details
Use the Subscription Contracts section of the Asynchronous Details page to view asynchronous
subscription contract details. The following example shows this section:
Note: The section displays only when there are subscription contracts associated with the service
operation.
Viewing and Working with Subscription Actions
The Actions tab of the Subscription Contracts section of the Asynchronous Services page reveals the
status of a particular subscription contract.
Image: Actions tab
This example shows the Actions tab in the Publication Contracts section of the Asynchronous Details
page.
Note: The page elements that appear on the page are discussed elsewhere in this section.
34
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 4
Viewing Asynchronous Service Operation Details
Related Links
Common Elements Used to View Asynchronous Service Operation Details
Understanding Resubmitting and Canceling Service Operations for Processing
Viewing IB Info Data
Understanding Viewing Service Operation Errors
Understanding Viewing and Editing Service Operation XML
Viewing and Working with Subscription Information
The Information tab reveals details about the subscription transaction, including the transaction ID, the
transaction time stamp, and so on.
Image: Information tab
This example shows the Information tab in the Subscription Contracts section of the Asynchronous
Details page.
Note: The page elements that appear on the page are discussed elsewhere in this section.
Related Links
Common Elements Used to View Asynchronous Service Operation Details
Setting the Data Length View Limit for Displaying XML
The data view length limit determines the size of service operation XML (in bytes) that is automatically
loaded into the XML Viewer in the Asynchronous Details component.
The default is 100000 bytes.
If the limit is exceeded, you are given the option of downloading and uploading the XML to view it or
make changes.
You can change the default value using the Monitor Setup Options page in the Services Operations
Monitor.
To set the data length view limit:
1. Select PeopleTools, Integration Broker, Service Operations Monitor, Administration, Monitor
Setup Options.
The Monitor Setup Options page appears.
2. In the Data Length View Limit box, enter a value in bytes.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
35
Viewing Asynchronous Service Operation Details
Chapter 4
Note: Do not enter a negative value.
Click the Save button.
Viewing Logical Transformation XML Output
If an asynchronous subscription contract or publication contract contains a logical transformation, you can
view the logical transformation output.
To view logical transformation XML output:
1. Select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous
Details.
The Asynchronous Details page appears.
2. On the Actions tab in the Publication Contracts or Subscription Contracts section, click the View
XML link. The IB XML Page appears and displays the service operation XML.
3. Click the View Logical Transform link.
Another IB XML Page appears and displays the logical transformation XML for the transaction.
Note: The View Logical Transform link appears only if the transaction has a logical transformation.
4. Click the Return button to return to the IB XML Page to view the service operation XML. Click the
Return button again to return to the Asynchronous Details page.
36
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 5
Monitoring Synchronous Service
Operations
Understanding Synchronous Service Operation Statuses
For synchronous service operations, the Service Operations Monitor displays the following statuses as
synchronous service operations progress through the integration system:
Status
Description
Done.
Indicates the synchronous request was successful.
Error.
Indicates that an error occurred during processing. Manual
intervention is required.
Filtering Synchronous Service Operations Data
Use the Synchronous Services page to filter and view inbound synchronous service operations data in
the integration system. To access the page, select PeopleTools, Integration Broker, Service Operations
Monitor, Monitoring, Synchronous Services.
Image: Synchronous Services page
This example illustrates the fields and controls on the Synchronous Services page. You can find
definitions for the fields and controls later on this page.
Use the following filter criteria when working with the Synchronous Services page to reduce your search
results.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
37
Monitoring Synchronous Service Operations
Chapter 5
Node Name
Identifies the name of the sending node.
Service Operation
Identifies the name of the service operation for which to view
data.
Archived
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.
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.
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.
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.
When left blank, no date or time is used as part of the search
criteria. If only the date fields are populated, the system
automatically fills in the time fields.
Related Links
Understanding Synchronous Service Operation Statuses
Viewing Monitor Output for Synchronous Service Operations Data
After you filter and search for synchronous service operations data on the Synchronous Services page, the
output displays in a Results grid at the bottom of the page.
Viewing Synchronous Service Operation Transaction Information
Use the Transactions tab on the Synchronous Services page to view information about the transactions,
such as the time of the transaction, transaction ID, general service operation information, and more.
38
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 5
Monitoring Synchronous Service Operations
Image: Transactions tab
This example illustrates the fields and controls on the Transactions tab. You can find definitions for the
fields and controls later on this page.
You can view the following data in the section:
Timestamp
Identifies the date and time that the service operation instance
was last processed.
Transaction ID
Displays the transaction ID, the unique identifier that the system
assigns to each transaction.
Service Operation
Indicates the name of the service operation.
Version
Indicates the version of the service operation.
Trans Type
Identifies the transaction type. Values are:
•
OutSync: Outbound Synchronous.
•
InSync: Inbound Synchronous.
Publishing Node
Indicates the sending node.
Status String
Displays the status of the transaction.
Details
Click the link to open the Synchronous Details page for
the service operation to view more in-depth data about the
transaction.
Viewing Synchronous Service Operation General Information
Use the Information tab on the Synchronous Services page to view information about the publisher,
including the node from which the transaction was published, timestamp information, and more.
Image: Information tab
This example illustrates the fields and controls on the Information tab. You can find definitions for the
fields and controls later on this page.
You can view the following data in the section:
Publisher
Indicates the name of the sending node.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
39
Monitoring Synchronous Service Operations
40
Chapter 5
Last Upd Dt Tm
Indicates the date and time the transaction was last updated.
NRID (Nonrepudiation ID)
Displays when nonrepudiation is implemented. Identifies a
unique number used to associate a service operation instance
with the nonrepudiation log.
Dest Pub Node
Identifies the name of the node where the service operation will
be sent.
Final Dest Node
Identifies the name of the node of the final destination for the
service operation.
Details
Click the link to open the Synchronous Details page for
the service operation to view more in-depth data about the
transaction.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 6
Viewing Synchronous Service Operation
Instance Details
Viewing Synchronous Service Operation Details
The Synchronous Detail page provides read-only information about synchronous service operations in the
system. It also enables you to view signature information for a service operation if it was processed with
nonrepudiation logic.
To access the page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring,
Synchronous Services.
Image: Synchronous Details page
This example illustrates the fields and controls on the Synchronous Details page. You can find definitions
for the fields and controls later on this page.
The page displays data in the following page elements:
Archive
Click the button to archive the synchronous service operation.
Delete
Click the delete button to delete the transaction from the
database.
Destination Publish Node
Identifies the name of the node where the service operation was
sent.
Error Messages
Click the link to view error messages associated with the
processing of the service operation.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
41
Viewing Synchronous Service Operation Instance Details
Chapter 6
Final Destination
Identifies the name of the node of the final destination for the
service operation.
Log Type
Select a value from the drop-down list box and click the View
XML link to view the corresponding information.
Note: For synchronous service operations, to view full service
operation details in XML you must set a parameter in the
routing definition for the service operation. On the RoutingRouting Definitions page, from the Log Detail drop-down list
box select Header and Detail.
Values are:
•
Request Original: Displays the original request data in XML
format.
•
Request Transformed: Displays transformed request data, if
applicable, in XML format.
•
Response Original: Displays the original response data in
XML format.
•
Response Transformed: Displays the transformed response
data, if applicable, in XML format.
Non-Repudiation ID
Identifies a unique number used to associate a service operation
instance with the nonrepudiation log.
Publisher
Publisher of the service operation. This is usually the user
ID of the person in the publishing system who triggered the
publication.
Pub/Sub Timestamp
Identifies the date and time that the service operation instance
was last processed.
Service Operation
Identifies the name of the service operation published.
Service Version
Identifies the version of the service operation published.
Signature
If a service operation is sent with a signature, a Signature link
appears next to the Non-Repudiation ID field. When you click
the Signature link, the service operation signature appears in
XML format.
Status
Identifies the status of the service operation.
Descriptions of the possible service operation statuses are
described elsewhere in this topic.
Transaction Type
Identifies the transaction type. Values are:
•
42
OutSync: Outbound Synchronous.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 6
Viewing Synchronous Service Operation Instance Details
•
InSync: Inbound Synchronous.
Unique Identifier
Displays the transaction ID, the unique identifier that the system
assigns to each transaction.
Updated
Identifies the date and time the service operation was last
updated.
View IB Info
Click the link to view IB info in XML format for the service
operation, such as transaction ID.
View XML
Click to view the service operation content in XML format.
Related Links
Understanding Synchronous Service Operation Statuses
Understanding Resubmitting and Canceling Service Operations for Processing
Viewing IB Info Data
Understanding Viewing and Editing Service Operation XML
Understanding Viewing Service Operation Nonrepudiation Signature Information
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
43
Viewing Synchronous Service Operation Instance Details
44
Chapter 6
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 7
Viewing Integration Gateway Logging Data
for Service Operations
Viewing Integration Gateway Logging Data in the Service
Operations Monitor
This topic discusses how to:
•
Enable integration gateway logging in the Service Operations Monitor.
•
Change the storage directory for integration gateway logs.
•
View integration gateway logging data for service operation transactions.
Understanding Viewing Integration Gateway Logging Data in the Service
Operations Monitor
This section provides an overview of viewing integration gateway logging data for service operations
from the Service Operations Monitor.
Integration Gateway Logging Data
You can generate and view integration gateway logging data on an on-demand basis for outbound
requests in the Service Operations Monitor.
When on-demand logging is enabled in the Service Operations Monitor, the integration gateway creates
log files corresponding to the transaction IDs of outbound requests, that is <transaction ID>.html.
Depending on the log level set, the standard integration gateway message log will also contain the
transactional message logging data. Data logged also includes the URL of the gateway performing the
logging, including the transaction ID and IP address. If you have implemented inbound load balancing
using virtual application server domains, this information will help you determine the gateway that is
performing the logging.
The location of the transaction logs is controlled by the integration gateway property
ig.transactionLog.directory. By default the property is set to the following value:
<PIA_HOME>/peoplesoft/PSIGW.war/WEB-INF/directory
The default gateway logging data location is the same default directory for regular error and message
logging. If you set the log level in the Service Operation Monitor to one of the error logging levels,
the file is placed in the same directory as the errorLog.html file. If you set the log level in the Service
Operation Monitor to one of the message logging levels, the file is placed in the same directory as the
msgLog.html file.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
45
Viewing Integration Gateway Logging Data for Service Operations
Chapter 7
As the transactional data in the Service Operations Monitor is archived or deleted, the system deletes the
associated transactions gateway log file. You can also delete this file at anytime.
Integration Gateway Logging Data Access
When gateway logging is enabled, a View Gateway Logs link appears on the Asynchronous Details
page for asynchronous transactions and on the Synchronous Details page for synchronous transactions to
access the logs from PIA.
As described earlier, the default location for the logs is <PIA_HOME>/peoplesoft/PSIGW.war/WEB-INF/
directory. Since /WEB-INF is not a public directory, the log files are not viewable from PIA by default,
but they can be accessed via the file system.
To view gateway logs from PIA using the View Gateway Log links you must set the following path in the
Gateway Logging URL field on the Monitor Setup Options page to a publicly accessible path, such as:
<PIA_HOME>/peoplesoft/PSIGW.war/
Important! Before you change the write location of the gateway logging data consider potential security
issues that doing so may present.
Prerequisites for Viewing Integration Gateway Logging Data in the Service
Operations Monitor
Before you can view log data for asynchronous or synchronous transactions you must enable gateway
message logging in the monitor, as described in the next section..
In addition, to view synchronous log data you must also enable logging on the routing definition used at
runtime for the service operation.
Related Links
"Configuring Routing Definitions" (PeopleTools 8.56: Integration Broker)
Enabling Integration Gateway Message Logging in the Service Operations
Monitor
Before you can view integration gateway message log data for service operation transactions in the
Service Operations Monitor, you must enable the feature using the Monitor Setup Options page.
To access the Monitor Setup Options page, select PeopleTools, Integration Broker, Service Operations
Monitor, Administration, Monitor Setup Options.
46
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 7
Viewing Integration Gateway Logging Data for Service Operations
Image: Monitor Setup Options page
This example illustrates the Monitor Setup Options page showing gateway logging enabled in the Service
Operations Monitor.
To enable integration gateway message logging in the Service Operations Monitor:
1. Access the Monitor Setup Options page (PeopleTools, Integration Broker, Service Operations
Monitor, Administration, Monitor Setup Options.)
2. Check the Enable Gateway Logging box.
3. From the On Demand Log Level drop-down list box, select a logging level. The valid options are:
•
1. Log standard gateway exception errors.
•
2. Log all errors and warnings. (Default.)
•
3. Log errors, warnings and important information.
•
4. Log errors, warnings, important and standard information.
•
5. Log errors, warnings important, standard and low importance information.
4. Click the Save button.
This procedure enables you to access gateway logs from the file system. To access the log information
from PIA in the Service Operations Monitor using the Asynchronous Details page or the Synchronous
Details page, you must also change the default storage directory for the transaction logs. The next section
describes changing the storage directory for the transaction logs.
Changing the Storage Directory for Integration Gateway Transaction Logs
Log files are written to the directory specified in the ig.transactionLog.directory property in the
integrationGateway.properties file. By default this value is set to the path of the current gateway directory.
When the default directory location is specified, you can access the logs manually in the file system,
however, the log files are not accessible in PIA using the View Gateway Log links on the Asynchronous
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
47
Viewing Integration Gateway Logging Data for Service Operations
Chapter 7
Details page and the Synchronous Details page. You must change the directory location to a public-facing
directory, such as <PIA_HOME>/peoplesoft/PSIGW.war/, or another location of your choosing.
Important! Before you change the write location of the gateway logging data consider potential security
issues that doing so may present.
To change the storage directory for integration gateway transaction log files:
1. Create a new directory for storing the log files on the system.
2. Set the ig.transactionLog.directory property in the integrationGateway.properties file to the new
storage location.
See "Accessing Gateway Setup Properties" (PeopleTools 8.56: Integration Broker Administration)
This property is located in the Transaction Logging section of the file.
3. Set the new directory location in the Monitor Setup Options page in the PeopleSoft Pure Internet
Architecture.
a. Access the Monitor Setup Options page (PeopleTools, Integration Broker, Service Operations
Monitor, Administration, Monitor Setup Options.)
b. In the Gateway Logging URL field enter the path or URL to the new storage directory.
c. Click the Save button.
Viewing Integration Gateway Logging Data for Service Operation
Transactions
This table describes the navigation paths for viewing gateway logging data for service operation
transactions using the Service Operations Monitor.
48
Transaction Type
Navigation
Comments
Asynchronous
1.
Select PeopleTools, Integration Broker,
Service Operations Monitor, Monitoring,
Asynchronous Details.
2.
Select the transaction that contains the
logging data that you want to view. The
Asynchronous Details page appears.
Before you can view log data you must enable
gateway message logging in the monitor.
Performing this task is discussed earlier in this
topic.
3.
In the Publications Contracts section,
select the Information tab.
4.
Click the View Gateway Logs link.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 7
Viewing Integration Gateway Logging Data for Service Operations
Transaction Type
Navigation
Comments
Synchronous
1.
Select PeopleTools, Integration Broker,
Service Operations Monitor, Monitoring,
Synchronous Details.
2.
Select the transaction that contains the
logging data that you want to view. The
Synchronous Details page appears.
Before you can view log data you must enable
gateway message logging in the monitor.
Performing this task is discussed earlier in this
topic.
3.
Click the View Gateway Logs link.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
In addition, to view synchronous log data you
must also enable logging using the Log Detail
field on the routing definition used at runtime
for the service operation. See "Configuring
Routing Definitions" (PeopleTools 8.56:
Integration Broker)
49
Viewing Integration Gateway Logging Data for Service Operations
50
Chapter 7
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 8
Resubmitting and Canceling Service
Operations for Processing
Understanding Resubmitting and Canceling Service Operations
for Processing
You can resubmit and cancel service operations but only if you have permissions for them. If you attempt
to resubmit or cancel a service operation for which you do not have permission, the system ignores the
action.
Related Links
Understanding Resubmitting and Canceling Future-Dated Publications
Resubmitting and Canceling Individual Service Operations
Resubmitting and Canceling Service Operations in Bulk
Understanding Resubmitting and Canceling Future-Dated
Publications
You can cancel a future-dated publication as you would any other service operation.
However, when you cancel a future-dated publication, the future date information is not retained. So if
you subsequently resubmit the publication, the system immediately submits it for processing.
Resubmitting and Canceling Individual Service Operations
To resubmit or cancel individual service operations, select the check box next to the appropriate service
operation and click the Resubmit or Cancel button.
To deselect a service operation, clear the check box next to the service operation.
Resubmitting and Canceling Service Operations in Bulk
You can resubmit and cancel service operations for processing in bulk using the Service Operations
Monitor.
Service operations to resubmit in bulk must be in one of the following statuses:
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
51
Resubmitting and Canceling Service Operations for Processing
•
Cancelled.
•
Edited.
•
Error.
•
Timeout.
Chapter 8
Service operations to cancel in bulk must be in one of the following statuses:
•
Edited.
•
Error.
•
Hold. (Service operation must be in Hold status as well as future-dated.)
•
New.
•
Retry.
•
Timeout.
In addition to the Clear All, Resubmit and Cancel buttons, you can also use the following links when
resubmitting and canceling service operations in bulk.
52
Select All
Click to select all service operations in the results grid to
resubmit or cancel. After you click this link, click the Resubmit
or Cancel button as appropriate.
Deselect All
Click the link to deselect all service operations in the results
grid.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 9
Viewing Service Operation IB Info Data
Viewing IB Info Data
A View IB Info link appears in several locations on the Asynchronous Details page and enables you to
view IB info data for asynchronous service operations instances, publication contracts and subscription
contracts. In addition, a View IB Info link displays on the Synchronous Details page and enables you to
view IB info data for synchronous service operation as well.
When you click the View IB Info link, the View IB Info page appears and displays information such as
requesting node, transaction ID, content type, and so on.
Image: View IB Info page
This example illustrates the View IB Info page.
When you are done reviewing the data, click the Return button to return to the previous page.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
53
Viewing Service Operation IB Info Data
54
Chapter 9
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 10
Viewing Service Operation Errors
Understanding Viewing Service Operation Errors
The Service Operations Monitor provides you with the ability to view service operation error information
when the error occurs during the processing of asynchronous service operation instances, publication
contracts, subscription contracts, and subscription service operation instances.
Related Links
Viewing Asynchronous Service Operation Instance Errors
Viewing Asynchronous Publication Contract Errors
Viewing Asynchronous Subscription Contract Errors
Viewing Synchronous Service Operations Errors
Common Elements Used to View Service Operation Errors
Description
Displays a description of the error.
Error Message
Displays the error message.
Error Timestamp
Displays the date and time that the error occurred.
Return
When you have completed reviewing the error information,
click the button to return to the previous page.
Segment Index
Indicates the index of the segment inside a message.
If a message has three segments, you can look at each segment
by the index. Segment index 1 is the first segment, segment
index 2 is the second segment, and segment index 3 is the third
segment.
Viewing Asynchronous Service Operation Instance Errors
When an error occurs while processing an asynchronous service operation instance, an Error Message link
appears in the operation instance section of the Asynchronous Details page. Click the link to access the
Instance Error Messages page and information about the error.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
55
Viewing Service Operation Errors
Chapter 10
Image: Instance Error Messages page
This example illustrates the Instance Error Messages page.
The fields displayed in this section are discussed in the Common Elements Used to View Service
Operation Errors topic.
Viewing Asynchronous Publication Contract Errors
When an error occurs while processing a publication contract, an Error Message link appears on the
Asynchronous Details page in the Publication Contracts section on the Actions tab. Click the link to
access the page and information about the error.
Image: Publication Contract Error Messages page
This example shows the Publication Contract Error Messages page.
The fields displayed in this section are discussed in the Common Elements Used to View Service
Operation Errors topic.
Viewing Asynchronous Subscription Contract Errors
When an error occurs while processing a subscription contract, an Error Message link appears on the
Asynchronous Details page in the Subscription Contracts section on the Actions tab. Click the link to
access the page and information about the error.
56
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 10
Viewing Service Operation Errors
Image: Subscription Contract Error Messages page
This example illustrates the Subscription Contract Error Messages page.
The fields displayed in this section are discussed in the Common Elements Used to View Service
Operation Errors topic.
Viewing Synchronous Service Operations Errors
When an error occurs with a synchronous service operation transaction, an Error Messages link appears
on the Synchronous Details page. Click the link to access the Instance Error Messages page and details
about the error.
Image: Instance Error Message page
This example illustrates the fields and controls on the Instance Error Message page. You can find
definitions for the fields and controls later on this page.
The page displays the following information:
Int Broker Error Location
Displays the location of the error in the PeopleSoft Integration
Broker system, if known.
Other fields that display in this section are discussed elsewhere in the documentation.
Related Links
Common Elements Used to View Service Operation Errors
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
57
Viewing Service Operation Errors
58
Chapter 10
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 11
Viewing and Editing Service Operation XML
Understanding Viewing and Editing Service Operation XML
The Service Operations Monitor enables you to view service operation XML for asynchronous service
operation instances, asynchronous publication contracts, asynchronous subscription contracts and for
synchronous service operation instances.
Note: You can view and edit XML only if you have the appropriate service operation permission.
Asynchronous Service Operation XML
If viewing or editing XML for a publication or subscription contract, the transformed XML appears if any
transformations were applied for the publication contract or subscription contract. Use the View XML
link or the Edit XML link in the service operation instance section to view and edit the original XML that
was received.
Synchronous Service Operation XML
In certain situations, the XML content of a service operation isn’t visible in the Service Operations
Monitor. This is because of the way service operation data is logged. Initially, the log data (including the
service operation XML) for any transaction is held in system memory.
With synchronous transactions, PeopleSoft Integration Broker retains the log data in memory for a longer
period, to allow for certain operations to complete. The delay before you can view the XML content in
the Synchronous Details component depends on several factors, including the details of the integration
and whether you’re at the sending or the receiving end of the transaction. If you don’t see the service
operation XML content right after the service operation was transmitted, exit the Synchronous Details
component and wait for a minute, then reopen the service operation and check the XML view again.
Note: For synchronous service operations, to view full service operation details in XML you must set a
parameter in the routing definition for the service operation. On the Routing-Routing Definitions page,
from the Log Detail drop-down list box select Header and Detail.
Related Links
Viewing Service Operation XML
Editing Service Operation XML
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
59
Viewing and Editing Service Operation XML
Chapter 11
Viewing Service Operation XML
You can view the XML for an asynchronous service operation instance, publication contract, subscription
contract or synchronous service operation by clicking the View XML link. When you click the link, the
IB XML page appears and displays the data in read-only format.
Image: IB XML Page
This example shows the IB XML Page displaying XML in read-only format.
Editing Service Operation XML
When an error occurs processing an asynchronous service operation instance, publication contract
subscription contract, or synchronous service operation instance, an Edit XML link appears. Click the link
to access the IB XML Page and to correct errors in the XML.
60
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 11
Viewing and Editing Service Operation XML
Image: IB XML Page
This example illustrates the IB XML Page.
To edit XML you must have the appropriate permissions to the service operation and the service operation
must have a status of New, Error, Retry, Timeout, Edited or Cancelled.
When you have completed editing the XML click the Save button to save your changes. Click the Return
button to return to the Asynchronous Details page.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
61
Viewing and Editing Service Operation XML
62
Chapter 11
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 12
Viewing Service Operation Nonrepudiation
Signature Information
Understanding Viewing Service Operation Nonrepudiation
Signature Information
If an asynchronous or synchronous service operation is sent with a signature you can view the
nonrepudiation signature in XML format.
Related Links
Viewing Nonrepudiation Signatures in XML Format
Viewing Nonrepudiation Signatures in XML Format
The Signature (NR) page displays nonrepudiation information for asynchronous service operations.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
63
Viewing Service Operation Nonrepudiation Signature Information
Chapter 12
Image: Signature-Non-Repudiation (NR) of Origin page
This example shows the Signature-Non-Repudiation (NR) of Origin page.
The Signature link to this page appears only if the service operation is sent with a signature. When you
click the Signature link, the service operation signature appears in XML.
Click the Confirm button to confirm the nonrepudiation status. Click the Return button to return to the
previous page.
64
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 13
Running Batch Error Notification Processes
Understanding Batch Error Notification
Although you can easily use the Service Operations Monitor to scan your system for service operations,
that approach requires you to launch the Service Operations Monitor on a scheduled basis to search for
any issues affecting the messaging system. The Error Notification component (PT_ERR_RUNCNTL)
provides access to an Application Engine batch program, PT_AMM_WF, that you can schedule to run on a
recurring basis.
The PT_AMM_WF process is designed notify users to report on service operations which are in Error or
Timeout status in the Service Operation Monitor.
The PT_AMM_WF process reports errors and time-out issues one time. The expectation is that after issues
are reported, that they are resolved. During subsequent runs of the process, the system reports only new
issues found, and does not report previous issues that may still be unresolved.
Note: You can use PT_AMM_WF to notify users of errors relating to asynchronous service operations
only.
To access the program, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring,
Error Notification.
The following table describes the information for which PT_AMM_WF scans, how it notifies
administrators, and what administrators should do after receiving an error notification.
Step
Task
Description
1
Query Message Queues
The program scans the following
messaging queues in the database in
search of service operation with a status
of either Error or Timeout.
2
Trigger Workflow
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
•
Publications Contracts Queue
•
Subscriptions Contracts Queue
Upon encountering a service operation
status of either Error or Timeout, PT
_AMM_WF sends a workflow to all
users assigned to the APP_MSG_
ADMINISTRATOR role at runtime. The
query for this role associates a service
operation with a user through the service
operation’s queue name property. All
users that have at least read-access to the
service operation queue are notified.
65
Running Batch Error Notification Processes
Chapter 13
Step
Task
Description
3
Resolve Issue
Administrators also receive a new
worklist item reflecting the problematic
service operation. To access the service
operation, an administrator clicks the
item in the worklist.
The link leads to the Asynchronous
Details component. The component
is presented with the specified service
operation loaded.
Related Links
Prerequisites for Using Batch Error Notification
Creating Static Error Notification Lists
Running Batch Error Notifications
Prerequisites for Using Batch Error Notification
To enable the workflow notification functionality, you need to have the following items in place within
security definitions:
•
Grant access to the PT_AMM_DUMMY component interface. Navigate to PeopleTools, Security,
Permissions & Roles, Permission Lists, Component Interfaces.
•
Assign users to the APP_MSG_ADMINISTRATOR role using PeopleTools, Security, Permissions
& Roles, Roles, Members.
PeopleSoft delivers the APP_MSG_ADMINISTRATOR role.
•
Add email addresses for users assigned to the APP_MSG_ADMINISTRATOR role to their user
profiles so that they can receive the notification.
To complete this task, select PeopleTools, Security, User Profiles, User Profiles, Edit Email
Addresses
•
Grant users read-only access (at a minimum) to the service operation queue.
In addition you must set several PeopleSoft Workflow default options using the Set Worklist Defaults
page (WF_SYS_DEFAULTS). Note that after you set these options you must reboot the application
server.
To set the workflow default options for using batch error notification:
1. Access the Set Worklist Defaults page (select PeopleTools, Workflow, Defaults & Messages, Set
Worklist Defaults).
2. In the System Default User section, select the system User ID.
3. In the System Wide Route Processing section, select the Email Active box.
66
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 13
Running Batch Error Notification Processes
4. Click the Save button.
5. Restart the application server.
Related Links
"Managing Permission Lists" (PeopleTools 8.56: Security Administration)
"Managing Roles" (PeopleTools 8.56: Security Administration)
"Setting Workflow System Defaults" (PeopleTools 8.56: Workflow Technology)
Creating Static Error Notification Lists
By default, error notifications are sent to all users who can monitor the service operation queue; these are
users assigned to the Query role. However, you can send error notifications to a static list of users that
belong to the APP_MSG_ADMINISTRATOR role. To do so you must turn off the Use Query to Route
Workflow option for the APP_MSG_ADMINISTRATOR role, and assign specific users to the role.
To view users assigned to the APP_MSGADMINISTRATOR role, run the
ROLE_APP_MSG_ADMINISTRATOR query.
To create a static error notification list:
1. Turn off the User Query to Route Workflow option.
a. Select PeopleTools, Security, Permissions & Roles, Roles.
b. Select and open the APP_MSG_ADMINISTRATOR role.
c. Click the Workflow tab.
d. In the Workflow Routing Options box, clear the Use Query to Route Workflow option, and click
Save.
2. Assign specific users to the APP_MSG_ADMINISTRATOR role.
See "Specifying User Profile Attributes" (PeopleTools 8.56: Security Administration).
Running Batch Error Notifications
You use the Error Notification page (PT_ERR_RUNCNTL) to run the PT_AMM_WF process. To access
the page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Error
Notification.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
67
Running Batch Error Notification Processes
Chapter 13
Image: Error Notification page
This example illustrates the fields and controls on the Error Notification page. You can find definitions for
the fields and controls later on this page.
To run PT_AMM_WF:
1. Select PeopleTools, Integration Broker, Monitor Integrations, Error Notification.
2. Select an existing run control ID, or add a new one using the Add button.
The Error Notification page appears.
3. Select a process frequency.
Options are:
•
Process Once. Select to run PT_AMM_WF manually.
•
Process Always. Select to run PT_AMM_WF constantly.
•
Don't Run. Select to disable a recurring PT_AMM_WF run.
4. Add a request ID and description.
These attributes uniquely identify a run control. You only see the IDs when you have a list of run
controls.
5. In the URL field, enter the PeopleSoft Pure Internet Architecture URL to provide in the email error
notification. Users use the URL to link to the error.
The URL of the current web server displays in this field by default.
6. ClickRun.
7. Click OK on the Process Scheduler Request page to submit the process.
68
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 14
Archiving Service Operation Instances
Understanding Archiving Service Operation Instances
For asynchronous service operations, archiving is determined at the queue level. To archive asynchronous
service operation instances you must activate archiving on the service operation queue.
For synchronous service operations, archiving is determined by the user by selecting service operation
instances to archive.
Related Links
"Adding Queue Definitions" (PeopleTools 8.56: Integration Broker)
Archiving Service Operations
You can archive service operation instances one at a time from the Asynchronous Details component or
the Synchronous Details component by clicking the Archive button that appears on the right side of the
page.
Related Links
Understanding Viewing Asynchronous Service Operation Details
Viewing Synchronous Service Operation Details
Retrieving Archived Messages
You can retrieve archived service operation instances from the following pages in the Asynchronous
Services component: Monitor Overview page, Operation Instances page, Publication Contracts page, and
Subscription Contracts page.
To retrieve archived service operations instances, select theArchive check box and click Refresh.
Archived service operations appear in the results grid on the page. For any returned row, click the Details
link to view the service operation header and service operation content.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
69
Archiving Service Operation Instances
70
Chapter 14
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 15
Running Batch Service Operation Archiving
Processes
Understanding Running Batch Service Operation Archiving
Processes
For performance and general maintenance reasons you may want to archive older service operations to
clear space on the live runtime monitor tables.
You use the Run Archive page (RUN_APMSGARCH) to invoke the Application Engine process
APPMSGARCH.
Using the APPMSGARCH process to archive service operation data is the batch approach. You can
also archive individual service operations using the Archive option that appears on the Asynchronous
Services-Monitor Overview page and on the Synchronous Services page.
See Monitoring Asynchronous Service Operation Instances Viewing Synchronous Service Operation
Details
Related Links
Prerequisites for Running Batch Service Operation Archiving Processes
Running Batch Service Operation Archiving Processes
Prerequisites for Running Batch Service Operation Archiving
Processes
Before you run a batch service operation archive process, inactivate the pub/sub server domain. Reactivate the pub/sub server domain after you run the process.
Related Links
"Activating Pub/Sub Server Domains" (PeopleTools 8.56: Integration Broker Administration)
Running Batch Service Operation Archiving Processes
This topic discusses how to:
•
Access the Run Archive page.
•
Archive asynchronous service operations in batch mode.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
71
Running Batch Service Operation Archiving Processes
•
Chapter 15
Archive synchronous service operations in batch mode.
Accessing the Run Archive Page
To access the Run Archive page, select PeopleTools, Integration Broker, Service Operations Monitor,
Monitoring, Archive Monitor Data.
Image: Run Archive page
This example illustrates the fields and controls on the Run Archive page. You can find definitions for the
fields and controls later on this page.
Archiving Asynchronous Service Operations in Batch Mode
To archive asynchronous service operations in batch mode:
1. Access the Run Archive page:
a. Select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Archive
Monitor Data.
b. Select an existing run control ID or add a new one.
The Run Archive page appears.
2. Select the service operations to archive using the following controls:
72
Archive All
Select this check box to archive all asynchronous service
operations in the messaging system with a status of Done
or Cancel, regardless of how long they have been in the
messaging system.
Done
Select this box to archive asynchronous service operations
in the messaging system with the corresponding operation
instances in the status of Done.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 15
Running Batch Service Operation Archiving Processes
Cancel
Select to archive only those asynchronous service operations
in the messaging system with the corresponding operation
instances in the status of Cancel.
Older Than
Enter a numeric value between 1 and 999. Do not enter 0 (
zero) or a decimal value. Messages older, in days, than the
value that you enter will be archived.
This option archives service operations based on days. If the
date is August 15, 2012, service operations dated August 13,
2012 and earlier are archived.
3. Click the Run button.
The Process Scheduler Request page appears.
4. Make the appropriate selections and click OK.
Archiving Synchronous Service Operations in Batch Mode
To archive synchronous service operations in batch mode:
1. Access the Run Archive page:
a. Select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Archive
Monitor Data.
b. Select an existing run control ID or add a new one.
The Run Archive page appears.
2. Select the service operations to archive using the following controls:
Archive Synch
Check the box to archive all synchronous service operations
in the messaging system.
Older Than
Enter a numeric value between 1 and 999. Do not enter 0 (
zero) or a decimal value. Messages older, in days, than the
value that you enter will be archived.
This option archives service operations based on days. If the
date is August 15, 2012, service operations dated August 13,
2012 and earlier are archived.
Note: The Done and Cancel controls do not apply to archiving synchronous transactions. They apply
only to archiving asynchronous transactions. Selecting the Done control or Cancel control triggers
asynchronous transactions to be archived as well, according to the processing logic described in the
previous section about batch archiving asynchronous service operations.
3. Click the Run button.
The Process Scheduler Request page appears.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
73
Running Batch Service Operation Archiving Processes
Chapter 15
4. Make the appropriate selections and click OK.
Related Links
"Understanding Process Monitor" (PeopleTools 8.56: Process Scheduler)
"Understanding Report Manager" (PeopleTools 8.56: Process Scheduler)
74
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Understanding Messaging System Performance Statistics
The Service Operations Monitor provides a Statistics page that enables you to view performance statistics
for asynchronous and synchronous service operations that flow through PeopleSoft Integration Broker.
The statistics can help you to identify bottlenecks and other performance issues in your integration
system.
Service Operation Types
The Service Operation Monitor provides performance statistics for the following service operation
transaction types:
•
Inbound asynchronous.
•
Outbound asynchronous.
•
Inbound synchronous.
•
Outbound synchronous.
Definitions for these service operations are provided elsewhere in the product documentation.
See "Service Operation Types" (PeopleTools 8.56: Integration Broker).
Processing Components
The following table lists the system processing components for which PeopleSoft Integration Broker
captures performance statistics and briefly describes the types of processing that each performs:
Application Server
The application server performs all data handling, processing
event handlers, performs security, routes service operations,
performs transformations, and manages load balancing and
master/slave processing, and more.
Broker (Handler)
The broker analyzes all service operations in the queue and
determines the transaction type. Based on the transaction type, it
creates a subscription contract, publication contract, or both.
Gateway
On inbound requests, the integration gateway performs request
serialization/deserialization, request authentication, applies
transformations, and performs the Jolt request to the application
server. On outbound requests, the integration gateway applies
transformations, and determines the target connector for the
request and hands off the request accordingly.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
75
Viewing System Performance Statistics
Chapter 16
For statistics to display for the integration gateway processing
you must enable the statistics feature on the integration gateway.
See Enabling the System Performance Statistics Feature.
Publication (Contract Handler)
The publication contract handler routes service operations to
another destination.
Remote Server
When you perform synchronous transactions with PeopleSoft
system, those systems send back processing statistics with their
requests and/or responses. These statistics appear in the category
Remote Server on the statistics pages.
Subscription (Contract Handler)
The subscription contract handler runs PeopleCode associated
with a service operation.
Tuxedo Queue
PeopleSoft Integration Broker includes a set of Oracle Tuxedo
servers that monitor database tables and process items in
the tables. The processing can include running PeopleCode
programs, creating publication and subscription contracts, and
so forth.
Several of the Statistics pages provide information for the
processing on these queues.
Overhead Processing
When you view the statistical details of system processing, some of the numbers fall into the categories of
Overhead. and Connection Overhead.
Statistics in these categories are for miscellaneous processing that do no fall into the major categories
shown, but count toward the overall processing on a component or for the transaction.
The following table lists types of overhead processing that can be included in these categories. The
information in the table is not exhaustive, and other items, processing, and even system configuration and
capacity may contribute to overhead processing statistics generated on your system:
Component
Example of Overhead Processing
All
•
Calls between processing.
•
Receiving/handing off a transaction to another
component.
•
Internal processing.
•
And so on.
•
Time taken to determine the contracts to create.
•
And so on.
Broker handler
76
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Component
Example of Overhead Processing
Integration gateway
•
Determining the connector to use for a transaction.
•
Data deserialization and serialization.
•
Authentication.
•
Performing the Jolt request to the application server.
•
And so on.
•
Authentication.
•
Data compression.
•
And so on.
Application server
Processing Times
Note the following information regarding processing times that appear in the Statistics pages:
•
All processing times are averages.
•
Processing times are displayed in milliseconds (ms.).
•
Processing times appear in the following format: Avg.(x) nn.nn ms.
The value of x in parentheses is the number of transactions on which the average processing time is
based.
The value of nn.nn is the average processing time in milliseconds (ms.).
•
Processing times of less than one millisecond appear as 00.00 ms.
•
In some instances the system displays No Data Available for a system component.
In such situations no processing was performed on the component.
As an example, the link for the Gateway component might display No Data Available if you
were viewing statistics for transactions processed with the InBoundPublish method, whereby the
integration gateway is bypassed to publish transactions.
Using the Statistics Pages
PeopleSoft Integration Broker provides a Statistics page where you select the service operation
transaction type of the performance statistics to view. To access the page select PeopleTools, Integration
Broker, Service Operations Monitor, Monitoring, Statistics.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
77
Viewing System Performance Statistics
Chapter 16
Image: Statistics page
Use the Statistics page to select the service operation transaction type of the system performance statistics
to view.
The Statistics page presents four categories of service operation transaction types for which you can view
performance statistics.
After you select a service operation transaction type, a separate window appears that contains a search
dialog box. The search dialog box that appears is based on the transaction type you selected. Use the page
to enter search criteria for data to retrieve and view.
78
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Image: Inbound Asynchronous page
Use the Inbound Asynchronous page to search for inbound asynchronous messaging system performance
statistics to view.
After you enter your search criteria and press the Refresh button, the system displays the search results
in the results. If you enter no search criteria and simply press the Refresh button, the system displays all
performance statistics in the database for the transaction type.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
79
Viewing System Performance Statistics
Chapter 16
Image: Inbound Asynchronous page
This example shows a completed search for inbound asynchronous performance statistics for the
publishing node QE_LOCAL. The results grid shows general data about the transactions in numeric
format.
The Subscription Timing Data grid in the previous graphic shows partial results of all results returned.
The results grid shows general data about the transactions in numeric format.
Note: Due internal system processing, not all transactions profiled display in the results grid. However
averages displayed are accurate.
Based on the transaction type of the data you're viewing, the system displays additional options to view
more detailed data and data in graphical format.
For example, when you click the Averages and Analysis link for inbound asynchronous system
performance data, a graphical display of the messaging system component displays. Next to each graphic
is a numeric link, which corresponds to the amount of processing time on the component.
80
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Image: Averages and Analysis page
This example shows the Averages and Analysis page for inbound asynchronous transactions.
The flow of the transactions are from left to right. In this case you are viewing inbound asynchronous
processes, therefore the integration gateway receives the requests and sends the Jolt requests to the
application server. The broker evaluates the subscription contracts, and then subscription processing takes
place.
Click the links under each component to view more detailed information about processing times during
system processing.
When you click the link under the Subscription on the Averages and Analysis page, the Subscription
Contract Averages page appears.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
81
Viewing System Performance Statistics
Chapter 16
Image: Subscription Contract Averages page
This example shows the Subscription Contact Averages page.
The Subscription Contract Averages page depicts subscription processing times in graphical format.
In this example, the bar chart shows the average time for PeopleCode processing and overhead
processing for the service operations ALICE_POLL_ASYNC, FLIGHTPLAN,PARTS_ASYNC, and
QE_FLIGHTPLAN_TRANSFORM. The number in parentheses next to each service operation name is the
number of transactions involving that service operation reflected in the data.
To view the transactions that comprise the graphical representation shown, click the View Transactions
link. The transactions appear in the Subscription Contracts Details grid of the Subscription Contract
Details page..
82
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Image: Subscription Contract Details page
This example shows the Subscription Contract Details page. The information in the Subscription Contract
Details grid is the raw data on which the graphs are based on the Subscription Contract Averages page.
Note that this is a partial example and does not show all the data on which the bar charts in the previous
graphic are based.
Enabling the System Performance Statistics Feature
To view messaging system performance information, you must enable the statistics feature on the Monitor
Setup Options page in the Service Operations Monitor as well as on integration gateway through the
integrationGateway.properties file.
The setting in the Service Operations Monitor enables the system to capture performance statistics for
activity on the application server. The setting on the integration gateway enables the system to capture
performance statistics for activity on the integration gateway.
If you enable the feature only in the Service Operations Monitor and not on the integration gateway, the
system captures statistics only for activity on the application server and does not capture any information
for activity on the integration gateway.
Note: It is recommended that you enable the statistics feature on both the application server and on the
integration gateway.
You do not need to perform any setup tasks in the integration gateway or in the Service Operations
Monitor to capture performance statistics on the remote PeopleSoft system. The sending PeopleSoft
system includes an identifier in the message request that prompts the remote PeopleSoft system for
performance information. This information is returned as part of the response message.
To enable the statistics feature on the application server:
1. Select PeopleTools, Integration Broker, Configuration, System Setup Options.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
83
Viewing System Performance Statistics
Chapter 16
The System Setup Options page appears.
2. Check the IB Profile Status On check box.
3. Click the Save button.
To enable the statistics feature on the integration gateway:
1. Access the integrationGateway.properties file.
2. Locate the Profile Information section at the end of the file.
3. Set the ig.ProfileInformation property to TRUE.
4. Save the file and refresh the integration gateway.
Searching for System Performance Statistics
This section describes how to search for performance statistics to view.
Common Elements Used to Search for System Performance Statistics
Publish Node
The sending node.
Queue Name
Name of the queue used to send or receive the integration.
Refresh
Click the button to refresh the page based on the search criteria
entered.
The results display in the grid at the bottom of the page.
Service Operation
Name of the service operation for which to display statistics.
Subscriber Node
Name of the node that subscribes to the service operation.
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.
All must be left blank or all must be populated. When left blank,
no date or time is used as part of the search criteria.
Searching for Performance Statistics
To search for system performance statistics:
1. Select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Statistics. The
Statistic page displays.
2. Click the link that corresponds to the transaction type for which you want to view statistics. The
choices are:
•
84
Inbound Asynchronous.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
•
Outbound Asynchronous.
•
Inbound Synchronous.
•
Outbound Synchronous.
This options enables you to view statistics for local synchronous transaction in addition to those
for outbound synchronous transactions.
A separate page appears that contains a Search Criteria dialog box.
3. Enter values in the Search Criteria dialog box, based on the data you want to view.
See Common Elements Used to Search for System Performance Statistics.
4. Click the Refresh button.
The system displays the results in numeric format in the grid under the search dialog box.
Viewing Messaging System Performance Statistics
This section discusses how to:
•
View inbound asynchronous messaging system statistics.
•
View outbound asynchronous messaging system statistics.
•
View inbound synchronous messaging system statistics.
•
View outbound asynchronous messaging system statistics.
Related Links
Using the Statistics Pages
Common Elements Used to View Messaging System Performance Statistics
Action Name
The name of the service operation handler.
Connection Time Total
Avg.(Connection Time Total Average)
When viewing outbound synchronous transactions, the value
displayed on the link label indicates the average processing
time between local and remote servers. This time includes the
processing time of sending the request to the integration partner,
as well as receiving the response.
When viewing outbound asynchronous transactions, the value
displayed on the link label indicates the average processing time
between integration gateway and the remote system.
Click the link to view separate statistics for application server
and remote server processing.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
85
Viewing System Performance Statistics
Chapter 16
Integration Service Total
Complete processing time for the specific transaction.
Orig Transaction ID(Original
Transaction ID)
Original transaction IDs are associated with asynchronous
transactions only.
The system creates an original transaction ID when it creates the
message instance.
Note: An original transaction ID is different than a transaction
ID. An original transaction ID is associated with a message
instance, and a transaction ID is associated with a publication or
subscription contract
Purge All Statistic Files,Purge All
Synchronous Timings,Purge All
Subscription Timings,Purge All
Publication Timings
Click one of these buttons to purge performance statistics for the
given transaction type.
Warning! The Purge All Statistics Files button will permanently
delete data on all the Statistics page. The other buttons
permanently delete statistics on the page on which they appear.
Use these options when you are done using the statistics or want
to view new performance statistics.
These options are discussed in additional detail elsewhere in this
topic.
See Purging System Performance Statistics.
Segment
When a service operation contains segmented message, this
field indicates the number of the message segment.
If a service operation does not contain a segmented message, the
field displays a value of 1.
The default value of this field is 1.
Sync Total(Synchronous Total)
Displays when working with outbound synchronous
transactions.
Indicates the total processing time for a single synchronous
transaction.
Transaction ID
The unique identifier for the transaction assigned by the system.
TCA(Target Connector Adapter)
Displays when viewing outbound synchronous transactions
This field indicates the processing time of the adapter to connect
to an integration partner and receive a response for a single
transaction.
Timestamp
86
Displays the date and time that the service operation flowed
through the system.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Transaction Local Avg.(Transaction
Local Average)
Viewing System Performance Statistics
This link displays when working with inbound synchronous
statistics.
The value displayed on the link label indicates the average
processing time for all selected transactions on the local system.
Click the link to view more detailed information for application
server processing times.
Transaction Total Avg.(Transaction
Total Average)
Displays when working with synchronous statistics.
The value displayed on the link label indicates the average
processing time (request and response) for all selected
transactions.
Click the link to view statistics for application server,
integration gateway, and remote server processing.
Viewing Inbound Asynchronous Statistics
Initial search results for inbound asynchronous messaging system performance statistics display in the
Subscription Timing Data grid. The data in grid provides high-level information about the transactions.
The fields that appear in this grid are described elsewhere in this section.
See Common Elements Used to View Messaging System Performance Statistics.
Click the Averages and Analysis link to show performance statistics for integration gateway, application
server, broker handler, and subscription contract processing times. The Averages and Analysis page for
inbound asynchronous transactions is shown earlier in this topic.
See Using the Statistics Pages.
The Averages and Analysis page shows the flow of transactions in graphical format. The flow of the
transaction(s) is from left to right. The integration gateway receives the requests and sends the Jolt
requests to the application server. The application server performs any service authentication and passes
the requests to the subscription broker. The broker evaluates the transactions and creates the subscription
contracts.
The following table lists the links that display on the Averages and Analysis page when viewing
inbound asynchronous transactions. It also lists the names of the pages that open when you click a link
and describes the data that may display. The actual data that displays depends on the makeup of the
transactions.
Gateway
The value that displays on the link label is the average
processing time for the selected transactions on the integration
gateway.
Click the link to open the Gateway Averages page. Use the
page to view the statistics that comprise the integration gateway
processing average. They can include:
•
Gateway Connector Avg. (Gateway Connector Average).
Connector processing of the transaction.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
87
Viewing System Performance Statistics
Application Server
Chapter 16
•
Gateway Transform Avg. (Gateway Transformation
Average). Transformation processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
The value that displays on the link label is the average
processing time for the selected transactions on the application
server.
Click the link to open the Server Averages page. Use this
page to view the statistics that comprise the application server
processing average. They can include:
Broker
•
Sever DB Avg. (Sever Database Average). Processing data
on the application server database.
•
Server Overhead Avg. (Server Overhead Average).
Application server overhead.
The value that displays on the link label is the average
publication broker processing time for the selected transactions.
Click the link to open the Broker Averages page. Use this
page to view the statistics that comprise the publication broker
processing average. They can include:
(Broker) Tuxedo Queue Size
•
PeopleCode Avg. (PeopleCode Average). OnRoute
PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Overhead Avg. (Overhead Average). Overhead processing
The value that displays on the link label is average Oracle
Tuxedo queue size at the time the broker processed the request.
Click this link to open the Tuxedo Queue Size page. Use this
page to view the average queue size during the processing of
each service operation.
The average queue size is the average number of processes or
items in the queue waiting for processing at the time the service
operation was processed.
Subscription
The value that displays on the link label is the average
subscription handler processing time for the selected
transaction.
Click the link to open the Subscription Contract Averages page.
Use this page to view the statistics that comprise the average
subscription handler processing time. They can include:
•
88
PeopleCode Avg. (PeopleCode Average). Processing time
for Notification PeopleCode.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
•
(Subscription) Tuxedo Queue Size
Overhead Avg. (Overhead Average). Overhead processing
The value that displays on the link label is the average Oracle
Tuxedo queue size at the time the subscription handler
processed the request.
Click the link to open the Tuxedo Queue Size page. Use this
page to view the average queue size during the processing of
each service operation.
The average queue size is the average number of processes or
items in the queue waiting for processing at the time the service
operation was processed.
Viewing Outbound Asynchronous Statistics
Use the Outbound Asynchronous page to search for statistics for outbound asynchronous integrations.
Image: Outbound Asynchronous page
This example illustrates the Outbound Asynchronous page.
Initial search results for outbound asynchronous messaging system performance statistics display in the
Publication Timing Data grid under the Search Criteria dialog box.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
89
Viewing System Performance Statistics
Chapter 16
The data in grid provides high-level information about the transactions. The fields that appear in this grid
are described elsewhere in this section.
See Common Elements Used to View Messaging System Performance Statistics.
Click the Averages and Analysis link to show performance statistics for subscription broker and
publication handler processing times.
Image: Averages and Analysis page
This example illustrates the fields and controls on the Averages and Analysis page. You can find
definitions for the fields and controls later on this page.
The Averages and Analysis page shows the flow of transactions in graphical format. The flow of the
transaction(s) is from left to right: the broker evaluates the transactions and creates the publication
contracts, and the publication handler processes the contracts.
The Publication Breakdown box shows the average time for creating the publication contracts as well as
average time for connecting to perform the posts to the integration gateway.
The following table lists the links that display on the Averages and Analysis page when viewing statistics
for outbound asynchronous transactions. It also lists the names of the pages that open when you click a
link and describes the data that may display. The actual data that displays depends on the makeup of the
transactions.
Broker
90
The value that displays on the link is the average broker
processing time for the selected transactions.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Click the link to open the Broker Averages page. Use this
page to view the statistics that comprise the broker processing
average. They can include:
(Broker) Tuxedo Queue Size
•
PeopleCode Avg. (PeopleCode Average). OnRoute
PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
The value that displays on the link label is average Oracle
Tuxedo queue size at the time the broker processed the request.
Click this link to open the Tuxedo Queue Size page. Use this
page to view the average queue size during the processing of
each service operation.
The average queue size is the average number of processes or
items in the queue waiting for processing at the time the service
operation was processed.
Publication
The value that displays on the link is the overall average
processing time for publication contracts.
Click the link to open the Publication Contract Averages.
Use this page to view the statistics that comprise the overall
publication contract processing average. They can include:
(Publication) Tuxedo Queue Size
•
PeopleCode Avg. (PeopleCode Average). PeopleCode
processing for OnSend and OnReceive PeopleCode events.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Connector Avg. (Connector Average). Connector processing
time.
•
Overhead Avg. (Overhead Average). Overhead processing.
The value that displays on the link label is the average Oracle
Tuxedo queue size at the time the publication handler processed
the request.
Click this link to open the Tuxedo Queue Size page. Use this
page to view the average queue size during the processing of
each service operation.
The average queue size is the average number of processes or
items in the queue waiting for processing at the time the service
operation was processed.
Publication Average
The value that displays on the link label is the average total
publication time for the selected transactions.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
91
Viewing System Performance Statistics
Chapter 16
Click the link to open the Publication Contract Averages page.
Use the page to view the publication statistics that are included
in the publication average. They can include:
Connection Time Total Avg
(Connection Time Total Average)
•
PeopleCode Avg. (PeopleCode Average). OnSend
PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
The value that displays on the link label is the average
connection processing time between the integration gateway and
the remote system for the selected contracts.
Click the link to open the Averages and Analysis page. Use the
page to view connection processing statistics that comprise the
connection time average. They can include:
•
PeopleCode Avg. (PeopleCode Average). OnSend and
OnAckReceive PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
Viewing Inbound Synchronous Service Operation Statistics
Results for searching for inbound synchronous statistics appear in under the Search Criteria section of the
Inbound Synchronous page.
92
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Image: Inbound Synchronous page
This example shows sample search results for inbound synchronous statistics.
The Inbound Synchronous Timing Data grid in the previous graphic shows partial results of all results
returned.
Initial search results for inbound synchronous messaging system performance statistics display in the
Inbound Synchronous Timing Data grid under the Search Criteria dialog box.
The data in grid provides high-level information about the transactions. The fields that appear in this grid
are described elsewhere in this section.
See Common Elements Used to View Messaging System Performance Statistics.
The value that displays in the Transaction Total Avg field is the average total transaction processing time
for the selected transactions. Click the link open the Averages and Analysis page to view the statistics that
comprise the total transaction processing time average.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
93
Viewing System Performance Statistics
Chapter 16
Image: Averages and Analysis page
The following example shows the Averages and Analysis page for inbound synchronous transaction
statistics
The Averages and Analysis page shows the flow of transactions in graphical format.
The flow of the transactions is from left to right. Remote servers send requests using HTTP to the
integration gateway. The integration gateway sends the requests to the application server using Jolt
requests.
The following table lists the links that display on the Averages and Analysis page when viewing statistics
for inbound synchronous transactions. It also lists the names of the pages that open when you click a
link and describes the data that may display. The actual data that displays depends on the makeup of the
transactions.
Remote System
The value that displays on the link label is the average
processing time on the remote server to send the request.
The link appears only when the sending remote server is a
PeopleSoft system. PeopleSoft systems send application server
performance statistics with request messages.
Click the link to open the Remote System Averages page. Use
the page to view the statistics that comprise the average remote
server processing time. The statistics displayed on this page can
include:
94
•
PeopleCode Avg. (PeopleCode Average). OnRequest and
OnRoute PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
•
Gateway
Overhead Avg. (Overhead Average). Overhead processing.
The value that displays on the link label is the average
processing time for the selected transactions on the integration
gateway.
Click the link to open the Gateway Averages page. Use the
page to view the statistics that comprise the integration gateway
processing average. They can include:
Application Server
•
Gateway Connector Avg. (Gateway Connector Average).
Connector processing of the transaction.
•
Gateway Transform Avg. (Gateway Transformation
Average). Transformation processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
The value that displays on the link label is the average
processing time on the application server.
Click the link to open the Local Server Averages page. Use this
page to view the statistics that comprise the application server
process average. They can include:
•
PeopleCode Avg. (PeopleCode Average). OnRequest and
OnRoute PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
Viewing Outbound Synchronous Statistics
Results for searching for outbound synchronous statistics appear in under the Search Criteria section of
the Outbound Synchronous page.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
95
Viewing System Performance Statistics
Chapter 16
Image: Outbound Synchronous page
The following example shows sample search results for outbound synchronous statistics.
Initial search results for outbound synchronous messaging system performance statistics display in the
Synchronous Timing Data grid under the Search Criteria dialog box.
The data in grid provides high-level information about the transactions. The fields that appear in this grid
are described elsewhere in this section.
See Common Elements Used to View Messaging System Performance Statistics.
In addition, three links appear on the page:
Transaction Total Avg.(Transaction
Total Average)
The value that appears on the link label is the average total
transaction processing time for the selected transactions. The
total includes processing on local and remote servers, as well as
the total connection time to remote servers.
Click the link to open the Averages and Analysis page. Use this
page to view the application server, gateway and remote server
statistics that comprise the total transaction processing time
average.
Transaction Local Avg.(Transaction
Local Average)
The value that appears on the link label is the average total
processing time on the local server for the selected transactions.
Click the link to open the Averages and Analysis page. Use this
page to view the application server statistics that comprise the
total average local transaction processing time average.
96
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Connection Time Total
Avg.(Connection Time Total Average)
Viewing System Performance Statistics
The value that appears on the link label is the average total
connection time between remote servers and local servers for
the selected transactions.
Click the link to open the Averages and Analysis page. Use this
page to view the integration gateway and remote server statistics
that comprise the connection time total average.
Viewing Average Transaction Processing Time Statistics — Local and Remote
Servers
From the outbound synchronous search results page, click the Transaction Total Avg. link.
Image: Averages and Analysis page
This example illustrates the fields and controls on the Averages and Analysis page. You can find
definitions for the fields and controls later on this page.
Application Server
The value that appears on the Application Server link label is
the average processing time on the application server for the
selected transactions. Click the link to open the Local Server
Averages page. Use the Local Server Averages page to view
the statistics that comprise the application server processing
average. They can include:
•
PeopleCode Avg. (PeopleCode Average). OnRoute
PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
97
Viewing System Performance Statistics
Gateway
Remote Server
Chapter 16
The value that appears on the Gateway link label is the average
processing time on the integration gateway for the selected
transactions. Click the link to open the Gateway Averages page.
Use the Gateway Averages page to view the statistics that
comprise the gateway processing average. They can include:
•
Gateway Request Avg. (Gateway Request Average).
Processing of the request on the integration gateway.
•
Gateway Response Avg. (Gateway Response Average).
Processing of the response on the integration gateway.
The value that appears on the Remote Server link label is the
average processing time of the transactions on the remote
system.
The link appears only when the remote server is a PeopleSoft
system. PeopleSoft systems send application server performance
statistics with response messages.
Click the link to open the Remote System Averages page.
Use the Remote System Averages page to view the statistics
that comprise the average remote server processing time. The
statistics displayed on this page can include:
•
OnRequest Avg. (OnRequest Average). Processing of
OnRequest PeopleCode on the remote system.
•
App. Server Receive Avg. (Application Server Receive
Average). Processing time for the request on the remote
system, as well as generating a response.
•
Overhead Avg. (Overhead Average). Overhead processing.
Viewing Average Transaction Processing Time Statistics — Local Server Only
From the outbound synchronous search results page, click the Transaction Local Avg. link.
98
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
Image: Averages and Analysis page
This example illustrates the fields and controls on the Averages and Analysis page. You can find
definitions for the fields and controls later on this page.
This example shows the average transaction processing time for outbound synchronous transactions.
Application Server
The value that appears on the application server link label is
the average processing time on the application server for the
selected transactions.
Click the link to open the Local Server Averages page. Use this
page to view the statistics that comprise the application server
processing average. They can include:
•
PeopleCode Avg. (PeopleCode Average). OnRoute
PeopleCode processing.
•
Transform Avg. (Transformation Average). Transformation
processing.
•
Overhead Avg. (Overhead Average). Overhead processing.
Viewing Average Transaction Connection Time Statistics
From the outbound synchronous search results page, click the Connection Time Total Avg. link.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
99
Viewing System Performance Statistics
Chapter 16
Image: Averages and Analysis page
This example illustrates the fields and controls on the Averages and Analysis page. You can find
definitions for the fields and controls later on this page.
This example shows the average transaction connection time for synchronous outbound transactions.
The following table lists the links that display on the page. It also lists the names of the pages that open
when you click a link and describes the data that may display. The actual data that displays depends on
the makeup of the transactions.
Gateway
The value that appears on the link label is the average
processing time on the integration gateway for the selected
transactions.
Click the link to open the Gateway Averages page. Use the
page to view the statistics that comprise the average integration
gateway processing time. They can include:
Remote Server
•
Gateway Request Avg. (Gateway Request Average).
Processing of the request on the integration gateway.
•
Gateway Response Avg. (Gateway Response Average).
Processing of the response on the integration gateway.
The value that appears on the link label is the average
processing time on the remote server for the selected
transactions. The link appears only when the remote server is a
PeopleSoft system. PeopleSoft systems send back application
server performance statistics with response messages.
Click the link to open the Remote System Averages page.
Use the page to view the statistics that comprise the average
100
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 16
Viewing System Performance Statistics
remote server processing time. Data appears on this page for
transactions where the remote server is a PeopleSoft system.
The statistics displayed on this page can include:
Connection Overhead
•
OnRequest Avg. (OnRequest Average). Processing of
OnRequest PeopleCode on the remote system.
•
App. Server Receive Avg. (Application Server Receive
Average). Processing time for the request on the remote
system, as well as generating a response.
•
Overhead Avg. (Overhead Average). Overhead processing.
The value that appears on the link label includes miscellaneous
connection processing times while sending the request from the
integration gateway on the local system to the remote system,
as well as connection time when the remote system returns a
response to the local system.
Purging System Performance Statistics
You can delete all statistics for transactions in the database or by transaction type.
Warning! Purging system performance statistics permanently deletes all statistics from the database for
the transaction type selected.
The following table summarizes the location to delete performance statistics based on the transaction type
you want to delete. The button to delete statistics data is located at the bottom the page listed. You need to
scroll down to locate this button if there are a lot of search results on the page:
Transaction Type
Page
Navigation
Button
All
Statistics
PeopleTools, Integration
Broker, Service Operations
Monitor, Monitoring,
Statistics.
Purge All Statistics Files
Inbound Asynchronous
Inbound Asynchronous
From the Statistics page, click Purge All Subscription
the Inbound Asynchronous
Timings
link.
Outbound Asynchronous
Outbound Asynchronous
From the Statistics page, click Purge All Publication Timings
the Outbound Asynchronous
link.
Inbound Synchronous
Inbound Synchronous
From the Statistics page, click Purge All Synchronous
the Inbound Synchronous
Timings
link.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
101
Viewing System Performance Statistics
102
Chapter 16
Transaction Type
Page
Navigation
Button
Outbound Synchronous
Outbound Synchronous
From the Statistics page, click Purge All Synchronous
the Outbound Synchronous
Timings
link.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 17
Managing Down Nodes
Understanding Managing Down Nodes
The Service Operations monitor enables you to view nodes that are down in the integration system and
clear transaction data so the system can attempt to restart the node.
Viewing Transaction Information for Down Nodes
Use the Undelivered Node Transaction page (AMM_NODESDOWN ) to view information about nodes
that are down.
Image: Undelivered Node Transaction page
This example illustrates the fields and controls on the Undelivered Node Transaction page. You can find
definitions for the fields and controls later on this page.
You can access this page using either of the following navigation paths:
•
Select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous
Services, Publication Contracts and click the Transaction Retry Queue link.
•
Select PeopleTools, Integration Broker, Service Operations Monitor, Administration, Node Status and
click the Transaction Retry Queue link.
You can work with the following page elements on the Undelivered Node Transaction page:
Node Name
Name of the node that is down or not responding.
Transaction Type
Indicates the transaction type.
Service Operation
Indicates the name of the service operation that was being
processed by the node when the node stopped responding.
Version
Indicates the version of the service operation being processed.
External Operation Name
Indicates the name of the service operation sent by the sending
node.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
103
Managing Down Nodes
Chapter 17
Clearing Transaction Data for System Node Restart
Undelivered node transaction information is stored in the Nodes Down table. The Force Retry All button
on the Undelivered Node Transaction page enables you to clear the table so that the system can attempt to
restart any nodes that are down.
For example, if a node is in the Nodes Down table and you change the URL of the node, the node
becomes free because it is still treated as inoperative (or down) based on the old URL. When you click the
Force Retry All button, the system retries starting the node.
Click the Force Retry All button on the Undelivered Node Transaction page to clear the Nodes Down
table so that the system can restart any nodes that are down.
104
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 18
Pausing, Testing, and Pinging Nodes
Understanding Pausing Nodes
A pause time is an interval of time during which the node becomes inactive. When the pause time begins,
the node is shut down until the pause time is scheduled to end.
You might schedule a pause time to perform maintenance tasks or devote server resources to an important
batch run. For example, say that you have a complex batch program that runs on the same server as a
particular node every Monday morning from 12:05 a.m. to 3:30 a.m. To make sure that the batch program
has enough memory devoted to it, you can set a pause time for the node that runs from 12 a.m. to 4 a.m.
During a pause time, transactions are not published or received by the local system. When the system
is paused, the node cannot accept service operations sent to it. Consequently, the publishing node must
attempt to send transactions again later. The publishing node continues to send transactions until it
exceeds the local time-out period. When this happens, the transaction assumes a Timeout status in the
publisher’s queue. The time-out period is an attribute of the publication queue, not the subscription queue.
If the system attempts to send a transaction while the node is paused, the system writes the transaction to
the publication and subscription queues, but it cannot publish the transaction until the system is no longer
in the paused state.
Note: Pause times do not appear in PeopleSoft Application Designer upgrade projects; you cannot
upgrade them.
If you have domain failover configured for your integration system, it is disabled when a node is paused.
However, there is a chance that failover could occur when you pause a node, due to the independent
timing between domain failover logic and the PeopleSoft Integration Broker runtime environment. The
chance of failover occurring during a node pause time increases if the failover time check (IB Failover
Time) on the Failover Configuration page is set to a low number of minutes.
Related Links
"Setting Up Domain Failover" (PeopleTools 8.56: Integration Broker Administration)
Adding Pause Times to Local Nodes
Use the Node Status page to add pause time to local nodes. To access the page select PeopleTools,
Integration Broker, Service Operations Monitor, Administration, Node Status.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
105
Pausing, Testing, and Pinging Nodes
Chapter 18
Image: Node Status page
This example shows the Node Status page.
To add a node pause time:
1. Access the Node Status page (PeopleTools, Integration Broker, Service Operations Monitor,
Administration, Node Status).
2. Click Add Pause.
3. Select a day of the week in the Start Day drop-down list box.
4. Enter a value in the Start Time edit box.
5. Select a day of the week in the End Day drop-down list box.
6. Enter a value in the End Time edit box.
7. After you have entered the appropriate start and end values to define your pause interval, click OK.
Deleting Pause Times
Use the Node Status page to delete pause times.
To delete an existing pause time:
1. Access the Node Status page (PeopleTools, Integration Broker, Service Operations Monitor,
Administration, Node Status).
2. In the pause time list, locate the pause time (interval) to delete.
3. Click the Delete button to the right of the entry in the pause time list.
Testing Local Nodes
Use the Node Status page to test local nodes.
106
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 18
Pausing, Testing, and Pinging Nodes
To test the local node:
1. Make sure you are logged on to the node that you want to test.
2. Access the Node Status page (PeopleTools, Integration Broker, Service Operations Monitor,
Administration, Node Status).
3. Click the Test Node button.
Pinging Remote Nodes
Use the Node Status page to ping remote nodes.
A successful ping indicates that the remote node is available to receive transactions. An unsuccessful ping
could indicate that the node, gateway, or both are not running.
To ping a remote node:
1. Access the Node Status page (PeopleTools, Integration Broker, Service Operations Monitor,
Administration, Node Status).
2. In the Ping a Node to Determine Availability section, select the node in the Message Node Name
drop-down list box to display a list of active nodes.
The Location column in the grid below reveals the locations defined for the node.
3. Click the Ping Node button.
The Node Information Section displays connector information defined for the node.
You can also ping remote nodes from the Send Master utility as well as the Simple Post utility.
Related Links
"Understanding Send Master" (PeopleTools 8.56: Integration Broker Testing Utilities and Tools)
"Understanding the Simple Post Utility" (PeopleTools 8.56: Integration Broker Testing Utilities and
Tools)
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
107
Pausing, Testing, and Pinging Nodes
108
Chapter 18
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 19
Pausing and Starting Queues
Pausing Queues
Use the Queue Status page (IB_MONITOR_QUEUES) to pause queues on the local database.
Image: Queue Status page
This example shows the Queue Status page.
Each row in the Queues list displays the queue name and its current status. The label on the button
indicates the status to which the queue will change when clicked.
To pause a queue:
1. Select PeopleTools, Integration Broker, Service Operations Monitor, Administration, Queue Status.
The Queue Status page appears.
2. In the Queues list, locate the row that contains the queue to pause.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
109
Pausing and Starting Queues
Chapter 19
3. Click the Pause button at the end of the row.
Starting Queues
To start a queue:
1. Select PeopleTools, Integration Broker, Service Operations Monitor, Administration, Queue Status.
The Queue Status page appears.
2. In the Queues list, locate the row that contains the queue to start.
3. Click the Run button at the end of the row.
110
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 20
Cleaning Up Orphaned Data From Segment
Batch Processing Errors
Understanding Cleaning Up Orphaned Data from Segment Batch
Process Errors
PeopleTools provides the ability to delete orphaned data left behind after a failed run of a batch segment
processing program.
Warning! Perform this clean up only when you are certain that data is orphaned and no segment
processing application engine processes are running.
If the batch program is in the middle of processing or if the batch program has abnormally terminated but
is to be restarted at a later time, the orphaned data is really not orphaned. Deleting orphaned data in these
situations may cause processing problems for the batch program.
Related Links
"Using Restartable Processing for Publishing Large Messages in Batch" (PeopleTools 8.56: Integration
Broker)
Cleaning Up Orphaned Data from Segment Batch Processing
Jobs
Use the Segment Data Cleanup page (IB_SEGMENTCLEANUP) to clean up orphaned data from
segment batch processing jobs. To access the page select PeopleTools, Integration Broker, Service
Operations Monitor, Administration, Segment Cleanup).
Image: Segment Data Cleanup page
This example shows Segment Data Cleanup page.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
111
Cleaning Up Orphaned Data From Segment Batch Processing Errors
Chapter 20
Warning! Deleting orphaned data rows can corrupt pending data being processed. Be sure there are no
running batch programs that process segment data. Any such program may be adversely affected by
deleting orphaned data prematurely.
To clean up orphaned data:
1. Select PeopleTools, Integration Broker, Service Operations Monitor, Administration.
2. Click the Delete Orphaned Data button.
After the system has deleted any orphaned data, it displays a message indicating the deletion is complete.
112
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 21
Using Custom-Defined Components to View
Service Operations Data
Understanding Using Custom-Defined Components to View
Service Operation Data
You can create a custom component and associate it to a service operation and version. This enables you
to navigate to the custom component when you click the Asynchronous Details or Synchronous Details
link to view the details for the specified service operation.
Specifying Service Operations to Associate to Custom-Defined
Components
To specify a service operation to associate to a custom-defined component:
1. Select PeopleTools, Integration Broker, Administration, User Details Component.
2. Click the Add a New Value tab.
3. In the Service Operations field, enter the name of the service operation.
4. Click the Add button.
The User Defined Components page appears and you can associate the service operation to the customdefined component.
Associating Service Operations to Custom-Defined Components
Use the User Details Component page (PSIBUSERCOMP) to associate a service operation to a customdefined component.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
113
Using Custom-Defined Components to View Service Operations Data
Chapter 21
Image: User Details Component page
This example illustrates the fields and controls on the User Details Component page. You can find
definitions for the fields and controls later on this page.
Active
Indicates if the component is active. Clear the box to inactivate
the component.
By default the component is active.
Menu Name
From the drop-down list select the menu name where the page is
located.
Menu Bar Name
From the drop-down list select the menu bar name where the
page is located.
Bar Item Name
From the drop-down list select the bar item name.
Panel Item Name
From the drop-down list select the page name.
Action
From the drop-down list select the action for the page. The valid
values are:
•
Add.
Select to add a new high-level key, such as a new employee
ID or customer. Except in the case of effective dating, Add
is used to insert a new current row or to update future rows.
•
Corr. (Correction.)
Select to update any rows (history, current, and future) in
an effective-dated record. Use only with effective-dated
records. This is translated to correct history at runtime.
•
114
Up/Dsp All. (Update/Display All.)
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 21
Using Custom-Defined Components to View Service Operations Data
Select to update current and future rows in an effectivedated record. Use only with effective-dated records.
Do not use these actions unless the main record that is
associated with the page definitions is effective-dated. This
is translated to include history at runtime.
•
Upd/Display. (Update/Display.)
Select to update existing rows only.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
115
Using Custom-Defined Components to View Service Operations Data
116
Chapter 21
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 22
Purging Runtime Service Operations
Monitor Tables
Purging Runtime Monitor Tables
The PeopleSoft system provides a collection of Data Mover scripts that you can run to purge the runtime
Service Operations Monitor tables within a database. These scripts reside in the PS_HOME\scripts
directory on your file server. The following table describes the purpose of each script.
Warning! Shut down the application server before running any of the Data Mover scripts described in this
section.
Script Name
Description
AppMsgPurgeAll.dms
Deletes queue data from every archive or live runtime Service
Operations Monitor table in the database, regardless of status.
Typically, you run this script after an upgrade or while
switching from a demonstration to a production environment.
AppMsgPurgeArchive.dms
Deletes queue data from every archive runtime Service
Operations Monitor table in the database.
AppMsgPurgeLive.dms
Deletes queue data from every live runtime Service Operations
Monitor table in the database.
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
117
Purging Runtime Service Operations Monitor Tables
118
Chapter 22
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 23
Using the Service Operations Monitor
Component Interface
Using the Monitor Component Interface
The Service Operations Monitor includes a collection of inquiry methods that you can access with a
component interface.
Use the MSGSTATUSSUMMARY component interface to extract information from the Service
Operations Monitor. The output of the component interface reveals the amount of contracts that are in the
queue. The contracts appear grouped by status and service operation or grouped by status and queue.
Use the following user-defined methods to extract information:
•
FillPubConByMsg()
•
FillPubConByChannel()
•
FillSubConByMsg()
•
FillSubConByChannel()
Beginning with PeopleTools 8.48, queues replaced channels from earlier PeopleTools 8.4x versions. As
a result, once you have a rowset object pointing to ByChannel, reference QUEUENAME when working
with the code.
The following example shows ASP code that accesses the MSGSTATUSSUMMARY component
interface with COM.
'Create a peoplesoft session
Set oSession = server.CreateObject ("PeopleSoft.Session")
nStatus = oSession.Connect(1, oConnectString, oUserName, oPassword,0)
'Get the skeleton of the APPMSGMON CI
Set oCI = oSession.GetCompIntfc("MSGSTATUSSUMMARY")
'get an instance of the CI
nStatus = oCI.Get()
'execute the method to fill the collection
If oChoice = 1 then
nStatus = oCI.FillPubConByChannel()
'Set oRows to the properties collection
Set oRows = oCI.PubConByChannel
End If
If oChoice = 2 then
nStatus = oCI.FillPubConByMsg()
'Set oRows to the properties collection
Set oRows = oCI.PubConBymsg
End If
If oChoice = 3 then
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
119
Using the Service Operations Monitor Component Interface
Chapter 23
nStatus = oCI.FillSubConByChannel()
'Set oRows to the properties collection
Set oRows = oCI.SubConByChannel
End If
If oChoice = 4 then
nStatus = oCI.FillSubConByMsg()
'Set oRows to the properties collection
Set oRows = oCI.SubConByMsg
End If
Related Links
"Understanding Component Interfaces" (PeopleTools 8.56: Component Interfaces)
120
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
Chapter 24
Using PeopleCode to Read and Write Errors
to the Asynchronous Error Queue
Using PeopleCode Methods to Read and Write Errors to the
Asynchronous Error Queue
PeopleSoft provides the following two methods to read and write errors to the asynchronous error queue:
GetMessageErrors
If an error occurs during processing of a service operation
instance, publication contract or subscription contract, the error
is read from the appropriate queue.
SetMessageError
If an error occurs during processing of a service operation
instance, publication contract or subscription contract, the error
is written to the appropriate queue.
Related Links
"IntBroker Class Methods" (PeopleTools 8.56: PeopleCode API Reference)
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.
121
Using PeopleCode to Read and Write Errors to the Asynchronous Error Queue
122
Chapter 24
Copyright © 1988, 2017, Oracle and/or its affiliates. All rights reserved.