Using the Service Operations Monitor

This chapter discusses how to:

• Filter asynchronous and synchronous service operations data.

• Monitor asynchronous service operations.

• View asynchronous service operations details.

• Monitor synchronous service operations.

• View synchronous service operation details.

• Resubmit and cancel service operations for processing.

• View service operation IB info data.

• View service operation errors.

• View and edit service operation XML.

• View service operation nonrepudiation signature information.

• Run batch error notification processes.

• Archive service operation instances.

• Run batch service operations archiving processes.

• View system performance statistics.

• Manage pub/sub server domains.

• Set up domain failover.

• Manage down nodes.

• Pause, test and ping nodes.

• Pause and start queues.

• Clean up orphaned data from segment batch processing errors.

• Used custom-defined components to view service operations data.

• Purge runtime monitor tables.

• Use the Service Operations Monitor component interface.

• Use PeopleCode to read and write errors to the asynchronous messaging error queue.

Understanding the Service Operations Monitor

This section provides and overview of the Service Operations Monitor and discusses:

• Service Operations Monitor security.

• Service Operations Monitor features and components.

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.

Service Operations Monitor Features and Components

System administrators use the Service Operations Monitor to monitor asynchronous and synchronous service operations information, node status, queue status, manage domains and more.

Features

The Service Operations Monitor provides:

• 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.

  You can 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.

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.

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.

Filtering Asynchronous and Synchronous Service Operations Data

This section discusses:

• Selecting filtering criteria.

• Saving filtering criteria.

Understanding Filtering Asynchronous and Synchronous Service Operations 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.

See Also

Filtering Asynchronous Service Operations 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.

   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.’

Monitoring Asynchronous Service Operations

This section discusses how to:

• Filter asynchronous service operations data.

• Save asynchronous data filtering selections.

• View asynchronous filtering results.

• View monitor output for asynchronous service operations data.

• Monitor service operation transactions.

• Monitor asynchronous service operation instances.

• Monitor publication contracts.

• Monitor subscription contracts.

Understanding Monitoring Asynchronous Service Operations Data

This section provides an overview of asynchronous service operation statuses.

Asynchronous Service Operation Statuses

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. Contracts created.

However, the Service Operations Monitor can display any of the statuses listed in the following table.

Service Operation Status and Blocked and Stalled Queues

This section discusses:

• Blocked queues.

• Stalled queues.

Blocked Queues

Queues preserve the order in which service operations are processed.

The pub/sub system guarantees that items are processed in the order they are sent. If a service operation has a status of Error, Timeout, or Edited, the service operation queue becomes blocked and no processing occurs until you resolve the problem with the service operation.

For publications, queues are partitioned in queues by sub queues.

For publication contracts, the queues is further partitioned into queues by sub queue and target node. If a queue is ordered, items in that queue and in the same queue are processed in the order sent. The dispatcher does not begin processing an item until all items ahead of it in the queue have the status Done or Cancelled. An item with a status of Error, Timeout, or Edited blocks all items behind it in the same queue. If the remote node is unavailable, the dispatcher does not attempt to process the contract and the queue is blocked until the remote node becomes available. That is why publication contracts are partitioned by target node.

If a queue is unordered, an item (such as the publication, publication contract, or subscription contract) never blocks another item. All items are processed in parallel.

Stalled Queues

Stalls do not occur by design. They are caused by gaps in functionality, user errors, defects, and so forth.

For example, a queue can become stalled when:

• Multiple domains access the same database and one of the domains is shut down abnormally.

  Items may be stalled in the Started or Working status.

  Note. You can use the Domain Status page to correct the problem.

• A change occurs to the pub/sub runtime tables through direct SQL.

  The copies of the database tables that dispatchers have in memory are not updated. In this situation, you must reboot the dispatchers.

Pages Used to Monitor Asynchronous Service Operations

Filtering Asynchronous Service Operations 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.

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.

Viewing Monitor Output for Asynchronous Service Operations 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:

Monitoring Service Operation Transactions

Use the Monitor Overview page for a high-level overview of the status of asynchronous service operation transactions. You can group transactions by queue or service operation for viewing.

To access this page, select PeopleTools, Integration Broker, Service Operations Monitor, Asynchronous Services. The Monitor Overview page shown in the following example appears:

After you search for queue information to view, the Results grid displays the results of your search.

This page displays search results by queue name or service operation name, depending on the selection you make in the Group By dropdown 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 preceding example shows that there are four service operation instances in New status in the ROLE_MAIN queue and one service operation instance in New status for the TREE_MAINT queue.

The number of operation instances in a particular status display as a linked value. Click the link to open the data in the Operation Instances page where you can view more detailed information.

See Also

Filtering Asynchronous Service Operations Data

Viewing Monitor Output for Asynchronous Service Operations Data

Asynchronous Service Operation Statuses

Monitoring Asynchronous Service Operation Instances

Monitoring Asynchronous Service Operation Instances

The Operation Instances page enables you to monitor the status and details related to individual asynchronous service operation instances.

To access the Operation Instances page, select PeopleTools, Integration Broker, Monitor Integrations, Monitor, Asynchronous Services and click the Operation Instances tab. The following page appears:

After you select your filtering options, click Refresh.

See Also

Filtering Asynchronous and Synchronous Service Operations Data

Viewing Monitor Output for Asynchronous Service Operations Data

Asynchronous Service Operation Statuses

Viewing Asynchronous Service Operation Details

Resubmitting and Canceling Service Operations for Processing

Viewing Queue Partitioning Information

Monitoring Publication Contracts

The Publication Contracts page shows outbound publication transactions to send to remote nodes.

To access the page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Services. Then click the Publication Contracts tab. The following example shows the Publication Contracts page:

The system does not create publication contracts for routing to the local node.

See Also

Filtering Asynchronous and Synchronous Service Operations Data

Viewing Monitor Output for Asynchronous Service Operations Data

Asynchronous Service Operation Statuses

Viewing Asynchronous Service Operation Details

Resubmitting and Canceling Service Operations for Processing

Viewing Queue Partitioning Information

Monitoring Subscription Contracts

The Subscription Contracts page enables you to view transactions to which the local node subscribes. Subscription contracts for remote nodes do not appear.

To access this page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Services. Then click the Subscription Contracts tab. The following example shows the Subscription Contracts page:

Note. When viewing the status of bulk subscription contracts (such as 100,000 or more) using a Solaris operating system and an Oracle database, your browser session may close unexpectedly. As a result, you should filter the number of subscription contracts for which to view status information. To do so, use the settings in the Time Period box to filter information by date and time. The volume of service operations in the system determines the best values to enter.

See Also

Filtering Asynchronous and Synchronous Service Operations Data

Viewing Monitor Output for Asynchronous Service Operations Data

Asynchronous Service Operation Statuses

Viewing Asynchronous Service Operation Details

Resubmitting and Canceling Service Operations for Processing

Viewing Queue Partitioning Information

Viewing Queue Partitioning Information

If queue partitioning exists for a queue, a Sub Queue column appears in the Results grid on the Monitor Overview page, the Publication Contracts page, and the Subscription Contracts page of the Asynchronous Services component.

If you click the sub queue name link, the Sub Queue Operation Instances page displays and you can view all service operations in the sub queue in the order in which they will be processed. You can also resubmit service operations or cancel the submission of service operations on this page.

Note. When viewing sub queue info, even if the primary page was displaying archived data, this page always shows current data.

The following example shows the Sub Queue Operation Instances page:

The row in bold is the row you were viewing on the previous page.

Descriptions of the page elements that appear on the page are described elsewhere in this section.

See Viewing Monitor Output for Asynchronous Service Operations Data.

Viewing Asynchronous Service Operation Details

The Asynchronous Details component 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.

This section discusses how to:

• View asynchronous service operation instance details.

• View asynchronous publication contract details.

• View asynchronous subscription contract details

Common Elements Used to View Asynchronous Service Operation Details

See Also

Resubmitting and Canceling Service Operations for Processing

Viewing Service Operation IB Info Data

Viewing Service Operation Errors

Viewing and Editing Service Operation XML

Viewing Service Operation Nonrepudiation Signature Information

Pages Used to View Asynchronous Service Operation Details

Viewing Asynchronous Service Operation Instance Details

Use the Asynchronous Details page to view asynchronous service operation instance details. To access the page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Details. The following example shows the Asynchronous Details 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.

Note. The data and fields that display in the Publication Contracts and Subscription Contracts section of the page are discussed elsewhere in this section.

Other page elements that appear on the page are discussed elsewhere in this section.

See Also

Common Elements Used to View Asynchronous Service Operation Details

Resubmitting and Canceling Service Operations for Processing

Viewing Service Operation IB Info Data

Viewing Service Operation Errors

Viewing and Editing Service Operation XML

Viewing Service Operation Nonrepudiation Signature Information

Viewing Asynchronous Publication Contracts Details

Use the Publication Contracts section of the Asynchronous Details page to view asynchronous publication contract details. The following example shows this section:

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.

Other page elements that appear on the page are discussed elsewhere in this section.

See Common Elements Used to View Asynchronous Service Operation Details, Resubmitting and Canceling Service Operations for Processing, Viewing Service Operation IB Info Data, Viewing Service Operation Errors, 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. The following examples show the Information tab:

The Information tab contains the following information about the publication contract:

Other page elements that appear on the page are discussed elsewhere in this section.

See Common Elements Used to View Asynchronous Service Operation Details, 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.

Note. The page elements that appear on the page are discussed elsewhere in this section.

See Common Elements Used to View Asynchronous Service Operation Details, Resubmitting and Canceling Service Operations for Processing, Viewing Service Operation IB Info Data, Viewing Service Operation Errors, 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. The following examples show the Information tab:

Note. The page elements that appear on the page are discussed elsewhere in this section.

See 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.

   Note. Do not enter a negative value.

   Click the Save button.

Monitoring Synchronous Service Operations

This section discusses how to:

• Filter synchronous service operations data.

• View monitor output for synchronous service operations data.

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:

Page Used to View Synchronous Service Operations

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. The following example shows the Synchronous Services component:

Use the following filter criteria when working with the Synchronous Services page to reduce your search results.

See Also

Archiving Service Operation Instances

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 Message ID Information

The following example shows the Message ID tab of the Results grid on the Synchronous Services page.

You can view the following data in the section:

Viewing Synchronous Service Operation General Information

The following example shows the Information tab of the Results grid on the Synchronous Services page.

You can view the following data in the section:

Viewing Synchronous Service Operation Instance Details

This section discusses how to synchronous service operation details.

Pages Used to View Synchronous Service Operations 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. The following example shows the Synchronous Details page.

The page displays data in the following page elements:

See Also

Viewing and Editing Service Operation XML

Viewing Service Operation IB Info Data

Viewing Service Operation Nonrepudiation Signature Information

Resubmitting and Canceling Service Operations for Processing

Understanding Synchronous Service Operation Statuses

Resubmitting and Canceling Service Operations for Processing

This section discusses how to:

• Resubmit or cancel individual service operations for processing.

• Resubmit or cancel service operations for processing in bulk.

Understanding Resubmitting and Canceling Service Operations for Processing

You can resubmit and cancel service operations only for those to which you have permissions. If you attempt resubmit or cancel a service operation for which you do not have permission, the system ignores the action.

Pages Used to Resubmit and Cancel Service Operations 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

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.

Viewing Service Operation IB Info Data

This section discusses how to view IB info data.

Pages Used to View 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.

The following example shows the View IB Info page:

When you are done reviewing the data, click the Return button to return to the previous page.

Viewing Service Operation Errors

This section discusses how to:

• View asynchronous service operation instance errors.

• View publication contract errors.

• View subscription contract errors.

• View subscription service operation instance errors.

Common Elements Used in This Section

Pages Used to View Service Operation Errors

Viewing Asynchronous Service Operation Instance Errors

When an error occurs while processing an asynchronous service operation instance, an Error Message link appears on 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.

The following example shows the Instance Error Messages page:

The fields that display in this section are discussed elsewhere in this section.

See Common Elements Used in This Section.

Viewing 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.

The following example shows the Publication Contract Error Messages page:

The fields that display in this section are discussed elsewhere in this section.

See Common Elements Used in This Section.

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.

The following example shows the Subscription Contract Error Messages page:

The page displays the following information:

The fields that display in this section are discussed elsewhere in this section.

See Common Elements Used in This Section.

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.

The page displays the following information:

Other fields that display in this section are discussed elsewhere in this section.

See Common Elements Used in This Section.

Viewing and Editing Service Operation XML

This section discusses how to:

• View service operation XML.

• Edit 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 dropdown list box select Header and Detail.

Pages Used to View and Edit Service Operation XML

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, as shown in the following example:

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, as shown in the following example:

The page enables you to edit the XML to correct any errors.

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.

Viewing Service Operation Nonrepudiation Signature Information

This section discusses how to view nonrepudiation signature information in XML format for service operations.

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.

Pages Used to View Service Operation Nonrepudiation Signature Information

Viewing Nonrepudiation Signatures in XML Format

The Signature (NR) page displays nonrepudiation information for asynchronous service operations. The following example shows the 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.

Running Batch Error Notification Processes

This section provides an overview of batch error notification and discusses how to run batch error notification programs.

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.

To access the program, select PeopleTools, Integration Broker, Monitor Integrations, Error Notification.

Note. You can use PT_AMM_WF to notify users of errors relating to asynchronous service operations only.

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.

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

See Also

Enterprise PeopleTools 8.49 PeopleBook: Security Administration

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.

   1. Select PeopleTools, Security, Permissions & Roles, Roles.

   2. Select and open the APP_MSG_ADMINISTRATOR role.

   3. Click the Workflow tab.

   4. 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.

Running Batch Error Notification

You use the Error Notification page to run the PT_AMM_WF process. To access the page, select PeopleTools, Integration Broker, Monitor Integrations, Error Notification.

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.

Archiving Service Operation Instances

This section discusses how to:

• Archive service operation instances.

• Retrieve archived service operation instances.

Prerequisites

To archive service operation instances you must activate archiving on the service operation queue.

See Managing Service Operation Queues.

Pages Used to Archive Service Operation Instances

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.

See Also

Viewing Asynchronous Service Operation Instance 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.

Running Batch Service Operation Archiving Processes

This section discusses how to run 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 operation to clear space on your live runtime monitor tables.

The PeopleSoft system provides an Application Engine program that scans all of the runtime monitor tables in the system for service operation archiving purposes. You use the Archive Messages component (RUN_APMSGARCH) to access the program.

You can use the Run Archive page to archive all service operations with a status of Done or Cancel. Or you can archive service operations based on their status, their age, or a combination of the two. For example, you can choose to archive service operations with a status of Done that have been in the messaging system for more than 14 days.

Prerequisites for Running Batch Service Operation Archiving Processes

Before you run a batch service operation archive process, inactivate the pub/sub server domain. Then, after you run the process, reactive the pub/sub server domain.

See Also

Using the Integration Broker Quick Configuration Page

Page Used to Run Batch Service Operation Archiving Processes

Running Batch Service Operation Archiving Processes

You use the Run Archive page to invoke the archive process. To access the page, select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Archive Monitor Data. The following example shows the Run Archive page:

To run the batch service operation archiving processes:

1. Select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Archive Monitor Data.

2. Select an existing run control ID, or add a new one.

   The Run Archive page appears.

3. Select the service operation to archive

   Archive All	Select this check box to archive all service operations in the messaging system with a status of Done or Cancel, regardless of how long they have been in the messaging system.
   Archive Synch	Check the box to archive all synchronous service operations. Warning! Leaving the box unchecked deletes all synchronous service operations.
   Done	Select to archive service operations in the messaging system with a status of Done.
   Cancel	Select to archive only those service operations in the messaging system with a status of Cancel.
   Older Than	Enter a numeric value between 1 and 999. Do not enter 0 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, 2004, service operations dated August 13, 2004 and earlier are archived.

4. Click the Run button.

   The Process Schedule Request page appears.

5. Make the appropriate selections, and click OK.

Note. Using APPMSGARCH to archive service operation data is the batch approach. You can also archive individual service operations online using the Archive option on the Asynchronous Services-Monitor Overview page and the Synchronous Services page.

See Also

Monitoring Service Operation Transactions

Monitoring Synchronous Service Operations

Using Process Monitor

Using Report Manager

Viewing System Performance Statistics

This section provides an overview of messaging system performance statistics and discusses how to:

• Enable the messaging system performance statistics feature.

• Filter statistics data.

• View inbound asynchronous post statistics.

• View broker handler statistics.

• View subscription contract handler statistics.

• View publication contract handler statistics.

• View inbound synchronous service operations statistics.

• View outbound synchronous service operations statistics.

• View local synchronous service operations 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 Service Operations Monitor provides performance statistics for the flow of asynchronous service operations through the pub/sub system. Statistics are captured for the flow of service operations through the following pub/sub components:

In addition, the Service Operations Monitor provides performance statistics for the following synchronous transaction types.

In the case of asynchronous service operation flow through the publication contract handler and outbound synchronous transactions, you can capture statistics about performance on remote PeopleSoft systems.

Common Elements Used in this Section

Pages Used to View System Performance Statistics

Viewing Messaging System Performance Statistics

You can view messaging system performance statistics in numeric or graphical format.

By default, the statistics appear in numeric format on tabbed pages.

Note. All times shown on the Statistics pages are in milliseconds.

You can select to view the statistics in graphical bar chart or pie chart format from any of the pages by using the View Bar Chart and View Pie Chart buttons. When you click either button, another page opens and displays the statistics in the graphical format. To return to the numeric format view of the data, click the Return button at the bottom of the page.

Note. Data displayed in bar chart and pie chart formats are averages.

The following example shows the inbound synchronous performance statistics in bar chart format:

The following example shows the same statistics in pie chart format:

Enabling the 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, Service Operations Monitor, Administration, Monitor Setup Options.

   The Monitor 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.

Selecting Statistics Data to View

When you select an transaction type for which to view statistics, you can filter data by various criteria.

The following common elements are used to filter statistics data.

To view select statistics data to view:

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:

   • Inbound Asynchronous Post.

   • Broker Handler.

   • Subscription Contract Handler.

   • Publication Contract Handler.

   • Inbound Synchronous.

   • Outbound Synchronous.

   • Local Synchronous.

   The Search Criteria dialog box for the transaction type you selected displays.

3. Enter values in the Search Criteria dialog box, based on the data you want to view.

   See Common Elements Used in this Section.

4. Click the Refresh button.

Viewing Inbound Asynchronous Post Statistics

The following table describes the fields and data that displays on the Transactions, Gateway Request Times and Application Server Times tabs on the Inbound Asynchronous Post page. This information also applies to the information that appears when you view the data in graphical format.

Viewing Broker Handler Statistics

The following table describes the fields and data that appear on the Transactions and Times tabs on the Broker Handler page. This information also applies to the information that appears when you view the data in graphical format.

Viewing Subscription Contract Handler Statistics

To view subscription contract handler statistics, click the Subscription Contract Handler link on the Statistics page. The Subscription Contract Handler page appears.

The following table describes the fields and data that appear on the Transactions and Times tabs on the Subscription Contract Handler page. This information also applies to the information that appears when you view the data in graphical format.

Viewing Publication Contract Handler Statistics

To view publication contract handler statistics, click the Publication Contract Handler link on the Statistics page. The Publication Contract Handler page appears.

The following table describes the fields and data that appear on the Transactions, Publication Contract Total, Publication Handler, Gateway, and Remote PeopleSoft System tabs on the Publication Contract Handler page.

The following table describes the average total values displayed in the Average Total Time section when you view publication contract handler statistics in graphical format. The fields in the Average Time section are described in the preceding table.

Viewing Inbound Synchronous Service Operation Statistics

To view inbound synchronous service operation statistics, click the Inbound Synchronous link on the Statistics page.

The following table describes the fields and data that appear on the Transactions, Gateway Request Times, PeopleCode Times and Application Server Times tabs on the Inbound Synchronous page. This information also applies to the information that appears when you view the data in graphical format.

Viewing Outbound Synchronous Message Statistics

To view outbound synchronous service operation statistics, click the Outbound Synchronous link on the Statistics page. The Outbound Synchronous page appears.

The following table describes the fields located on the Transactions, Synchronous Total, Synchronous Processing and Gateway Request Times, Remote PeopleSoft Systems and Gateway Response Times tabs on the Outbound Synchronous page.

The following table describes the average total values displayed in the Average Total Time section when you view outbound synchronous statistics in graphical (bar chart or pie chart) format. Note that the fields shown in the Average Time section are described in the previous table.

Viewing Local Synchronous Service Operation Statistics

To view local synchronous service operation statistics, click the Local Synchronous link on the Statistics page. To view outbound synchronous service operation statistics, click the Outbound Synchronous link on the Statistics page. The Local Synchronous page displays.

The following table describes the fields located on the Transactions, Synchronous Total, Synchronous Processing, Gateway Request Times and Gateway Response tabs on the Local Synchronous page.

The following table describes the average total values displayed in the Average Total Time section when you view outbound synchronous statistics in graphical format. Note that the fields shown in the Average Time section are described in the preceding table.

Managing Pub/Sub Server Domains

This section discusses how to work with the Domain Status page and how to:

• View dispatcher status.

• Activating pub/sub server domains.

• Inactivate pub/sub server domains.

• Change dispatcher status for processes.

• Set domain grace periods.

Understanding Managing Pub/Sub Domains

PeopleSoft Integration Broker includes a set of BEA 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.

The Domain Status page enables you to view the domains that have pub/sub servers on them that are running against the application database. You can also use this page to manually set domain grace periods to allow processing in a domain to finish before you pause the processing or take the domain offline.

In addition, if a machine with a domain on it crashes, the integration system may still operate as if the processes in the domain are still working on items in the runtime tables. The Domain Status page enables you to set the domains to inactive so that other pub/sub servers can complete the processing of these items. This enables you to recover from domain and machine crashes.

Page Used to Manage Domain Status

Working with the Domain Status Page

The Domain Status page features three sections, the Domain Criteria section, the Domain Status section, and the Dispatcher Status section.

The following example shows the Domain Status page:

The Domain Criteria section enables you to perform actions on all domains in the integration system, such as apply a grace period to all domains, activate or inactivate all domains, and purge the current information in the Dispatcher Status section.

The Domains section enables you to activate and inactivate domain status and set domain grace periods. You can also use this section to view failover information for a domain.

The Domain Status section provides application server name and path information for all machines that have domains on the messaging system. For any machine, you can use the dropdown list to activate or inactivate the machine and all domains on it. You can also set grace periods for domains on specific machines.

The Domain Status page also features the following controls:

Viewing Dispatcher Status

The Dispatcher Status section displays information about machines in the integration system that have dispatcher processes associated with them. This area displays the machine name, the dispatcher process name, the application server path, the dispatcher status, and any grace periods set for a process running on the domain.

There are three valid dispatcher status values:

Activating Pub/Sub Server Domains

Before you can use the pub/sub system, you must activate the domain on which a pub/sub server resides.

To activate a domain:

1. Select PeopleTools, Integration Broker, Service Operations Monitor, Administration, Domain Status..

   The Domain Status page appears.

2. In the Domains section:

   1. Locate the row that lists the machine where the domain resides that you want to activate.

   2. In the Domain Status dropdown list box, select Active.

3. Click the Update button.

Inactivating Pub/Sub Server Domains

To inactivate pub/sub servers on domains:

1. Inactivate pub/sub server domains:

   1. To inactivate domains on all machines in the messaging system, select the All Domains Inactive check box. To activate the servers at a later time, select the All Domains Active box.

   2. To inactivate domains on individual machines, locate the domains to inactivate. In the dropdown list box, select Inactivate. To activate the servers at a later time, select Activate in the list.

2. Click the Update button.

The domain status for the domains that you inactivate changes from Active to Inactive. In addition, in the Dispatcher Status section, the dispatcher status of all processes associated with the domains changes from active (ACT) to cleanup (CLNUP). Click the Refresh button until the dispatcher status changes to inactive (INACT).

If you inactivated all domains, a Force Reset button appears under the Update button. The Force Reset button enables you to force the dispatcher status to change from cleanup to inactive.

Changing Dispatcher Status for Processes

The Force Reset button appears only when you change the domain status for all domains on all machines by selecting the All Domains Inactive check box.

To change dispatcher status for all processes on all machines from cleanup to inactive:

1. Click the Force Reset button.

2. Click Update.

Setting Domain Grace Periods

The time that appears in the Grace Period column indicates when the cleanup process ends. The time equals the system time and the cleanup time interval that you enter.

To set one grace period to apply to domains on all machines, locate the Grace Period for all Domains field in the Domain Criteria section and enter the number of minutes for the grace period. Click Update.

To set grace periods for individual domains, enter the number of minutes for the grace period for each domain. Click Update.

A grace period that you set for an individual domain takes precedence over the setting for all groups.

The grace period setting for all domains is a convenient way to set a grace period for all dispatchers in all the domains. You can set a grace period of all domains at the top of the page and then press the Tab key to access individual domains and override the group setting.

Setting Up Domain Failover

This section discusses how to:

• Enable failover on domains.

• Set up dynamic master-slave dispatchers.

• Check the validity of queue sets.

• View queues assigned to failover groups.

Understanding Domain Failover

This section discusses domain failover.

Domain Failover

Domain failover ensures that PeopleSoft Integration Broker continues processing message requests and responses, even if it incurs errors or other problems on the primary domain. When failover is activated, service operation processing will switch to back up domains should Integration Broker incur any errors or problems on the primary domain. In addition, should the domain fail, you can send a system-generated email notification to individuals.

If the connection with the database is lost and the handlers are processing service operations at that time, the handlers attempt to reboot. If initialization fails, the handlers are not rebooted. If you are using failover, the failover process takes over and failover of the domain occurs.

Domain Failover Groups

You can set up domain failover groups, so that all failover takes place on specific domains. To set up failover groups, you assign a domain a failover group number. After you assign domains to a group, you then assign the failover priority for all domains within the group.

Note. If you do not use dedicated messaging servers, you typically do not need to use groups.

Note. Queue sets within groups must be identical; queue sets between groups must be unique.

The example of the Failover Configuration page in the Setting Up Failover on Domains section in this chapter shows five domains attached to the application server. The first three domains have been assigned to failover group one, as indicated by the value 1 in the Failover Group field for each domain. The last two domains have been assigned to failover group two, as indicated by the value 2 in the Failover Group field for each domain.

The failover priority within group one is as follows: the first domain in the list, HLAM032002, is the first back-up domain as indicated by the failover priority value 1; the second domain in the list, HLAM042503, is the second back-up domain as indicated by the failover priority value 2; the third and final back-up domain for failover group one is indicated by the failover priority value 3 and is the domain HLAM072500.

The failover priority within group two is as follows: the fourth domain in the list, HLAMCMPQ, is the first back-up domain for group two as indicated by the failover priority value 1; the last domain in the list, MOBRIEN, is the second back-up domain as indicated by the failover priority value 2.

Failover Priorities

If you modify failover priorities when failover is enabled and change the priorities of the current active domain, all domains are reset to inactive and the domain with the priority value of 1 is activated. However, if failover is not active and you change priorities, PeopleSoft Integration Broker saves the changes without any domain status reset.

Understanding Dynamic and Static Master-Slave Dispatchers

You can implement master-slave dispatchers in conjunction with domain failover.

When dynamic slaves are implemented, the domain with the highest priority will become the active domain (master domain) in each group during failover. The next domain in priority is automatically programmatically configured as an active slave domain. You configure dynamic slaves in the Service Operations Monitor.

Static domain slaves are always slaves. You configure static slaves in PSADMIN.

See Implementing Master-Slave Dispatchers.

Page Used to Set Up Domain Failover

Enable Failover on Domains

Use the Failover Configuration page to enable failover on domains. The following example shows the page:

To set up domain failover:

1. Access the Failover Configure page.

2. Select the Enable Failover box.

3. In the IB Failover Time (minutes) field, specify the number of minutes that can pass without the domain registering itself before the failover should commence

4. (Optional.) To implement dynamic slaves, select the Dynamic Slave Option.

5. (Optional.) In the Failover Group field, enter a numeric value to specify a group to which a domain belongs.

   A value of 1 indicates that the domain is the first backup domain; a value of 2 indicates that the domain is the second back-up domain if the first backup domain fails; and so on.

6. In the Failover Priority field, enter a numeric value to specify the priority for a back up domain in the failover configuration.

   A value of 1 indicates that the domain is the first backup domain; a value of 2 indicates that the domain is the second back up domain; and so on.

7. (Optional.) In the Email_TO field, specify the email addresses of people to whom the system sends a notification about the domain failure if it occurs.

   Separate multiple email addresses with a semicolon.

8. (Optional.) In the Email_CC field, specify the email addresses of people who receive copies of the domain failure notification.

   Separate multiple email addresses with a semicolon.

9. Click the Save button.

Setting Up Dynamic Master-Slave Dispatchers

When dynamic slaves have been set the Slave Indicator column on the Failover Configuration page displays the status Dynamic to indicate the domains that are serving as dynamic slaves.

The following example shows the Failover Configuration page with two dynamic slaves in place.

As noted earlier, the domain in a failover group with the highest priority becomes the master and the domain with the second highest priority becomes the slave.

To set up master-slave dispatchers, follow the procedure for setting up failover and verify that you:

• Check the Enable Failover box.

• Check the Dynamic Slave Option box.

• Set up at least one failover group that contains at least two domains.

• Set a failover priority for each domain in the failover group.

• Save your settings.

Checking Queue Set Validity

Use the Check Group Validity link on the Failover Configuration page to verify that all queues assigned to the pub/sub processes in a failover group are the same.

When you click the link a message box appears that indicates if the group is valid.

Viewing Queues Assigned to Failover Groups

Use the View Group Queues link on the Failover Configuration page to view the queues assigned to each dispatcher in a failover group. Queues must be identical among all groups.

Managing Down Nodes

This section discusses how to:

• View nodes that are down.

• Clear transaction data for system node restart.

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.

Page Used to Manage Down Nodes

Viewing Transaction Information for Down Nodes

Use the Undelivered Node Transaction page to view information about nodes that are down. The following example shows this 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.

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.

Pausing, Testing, and Pinging Nodes

This section discusses how to:

• Add a pause time to a local node.

• Delete pause times.

• Test local nodes.

• Ping remote 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 timeout period. When this happens, the transaction assumes a Timeout status in the publisher’s queue. The timeout 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.

Page Used to Pause, Test and Ping Nodes

Adding Pause Times to Local Nodes

Use the Node Status page to add pause time to local nodes. The following example shows the page:

To add a node pause time:

1. Click Add Pause.

2. Select a day of the week in the Start Day dropdown list box.

3. Enter a value in the Start Time edit box.

4. Select a day of the week in the End Day dropdown list box.

5. Enter a value in the End Time edit box.

6. After you have entered the appropriate start and end values to define your pause interval, click OK.

Deleting Pause Times

To delete an existing pause time:

1. In the pause time list, locate the pause time (interval) to delete.

2. Click the Delete button to the right of the entry in the pause time list.

Testing Local Nodes

To test the local node:

1. Make sure you are logged on to the node that you want to test.

2. Click the Test Node button.

Pinging 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. In the Ping a Node to Determine Availability section, select the node in the Message Node Name dropdown list box to display a list of active nodes.

   The Location column in the grid below reveals the locations defined for the node.

2. 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.

See Using the Send Master Utility, Using the Simple Post Utility.

Pausing and Starting Queues

This section discusses how to:

• Pause queues.

• Start queues.

Page Used to Pause and Start Queues

Pausing Queues

Use the Queue Status page to pause queues on the local database. The following examples shows the 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.

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.

Cleaning Up Orphaned Data From Segment Batch Processing Errors

The section discusses how to clean 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.

See Also

Using Restartable Processing for Publishing Large Messages in Batch

Page Used to Clean Up Orphaned Data from Segment Batch Processing

Cleaning Up Orphaned Data from Segment Batch Processing Jobs

Use the Segment Data Cleanup page to clean up orphaned data from segment batch processing jobs. The following example shows this page:

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.

Using Custom-Defined Components to View Service Operations Data

This section discusses how to:

• Specify the service operation to associate to a custom-defined component.

• Specify custom-defined component parameters.

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.

Pages Used for Using Custom-Defined Components to View Service Operations Data

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 custom-defined component.

Associating Service Operations to Custom-Defined Components

Use the User Details Component to associate a service operation to a custom-defined component.

The following example shows the User Details Component.

Active	Indicates if the component is active. Clear the box to inactivate the component. By default the component is active.
Menu Name	From the dropdown list box, select the menu name where the page is located.
Menu Bar Name	From the dropdown list box, select the menu bar name where the page is located.
Bar Item Name	From the dropdown list box, select the bar item name.
Panel Item Name	From the dropdown list box, select the page name.
Action	From the dropdown list box, 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. Up/Dsp All. (Update/Display All.) Select to update current and future rows in an effective-dated 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.

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.

Using the Services Operations 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.

You can 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
   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

See Also

Introducing Component Interfaces

Using PeopleCode 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:

See Also

PeopleCode API Reference Preface