Oracle Workflow Diagnostic Tests

This appendix describes the diagnostic tests that workflow administrators can run to check the setup of Oracle Workflow.

This appendix covers the following topics:

Oracle Workflow Diagnostic Tests

Oracle Diagnostics Framework provides a mechanism which makes Oracle E-Business Suite more supportable and robust by providing predefined tests to check for key setup requirements. Oracle Workflow provides several tests through Oracle Diagnostics Framework that you can use to check the setup of Oracle Workflow and review debugging information.

The Oracle Workflow tests are available in Oracle Diagnostics Framework under the Application Object Library application. For information on running tests in Oracle Diagnostics Framework, see: Oracle Diagnostics Framework User's Guide.

Workflow Tests

The following tests are available in the Workflow Tests group.

Duplicate User Test

This test checks the Oracle Workflow directory service to verify that there are no roles in the WF_LOCAL_ROLES table with the same internal name, originating system, and originating system ID. This test does not require any input parameters.

If any duplicate roles are found, the test reports the internal name, display name, originating system, and originating system ID of those roles. Use this information to investigate and remove any invalid roles from your directory service. Otherwise, users may encounter errors when accessing their workflow processes and notifications. See: Setting Up an Oracle Workflow Directory Service.

Notification Preference Validation Test

This test checks the Oracle Workflow directory service to ensure that all roles with a notification preference for receiving e-mail notifications have an e-mail address defined. This test does not require any input parameters.

If any roles with a notification preference for e-mail do not have an e-mail address defined, the test reports the internal name, display name, originating system, originating system ID, and notification preference of those roles. Enter e-mail addresses for these roles in the Oracle Workflow directory service to enable notification mailers to send them e-mail notifications. If any roles should not receive e-mail notifications, change the notification preference for those roles to QUERY ("Do not send me mail"). See: Implementing Notification Mailers, Setting Up an Oracle Workflow Directory Service, Setting Global User Preferences, and Preferences, Oracle E-Business Suite User's Guide.

Rule Function Validation Test

This test checks the rule functions defined for subscriptions and the generate functions defined for events in the Business Event System. For PL/SQL functions, the test verifies that the package and function exist in the database and are valid. For Java functions, the test verifies that the Java class exists in the classpath. This test does not require any input parameters. See: Event Subscriptions, Oracle Workflow Developer's Guide and Events, Oracle Workflow Developer's Guide.

If any subscription rule functions or event generate functions are missing or invalid, the test reports the name and problem status for each function. You must make these functions available for the Business Event System to execute the corresponding subscriptions or generate the event data for the corresponding events. For PL/SQL functions, load the appropriate packages and standalone functions to the database, and recompile the schema that owns them. For Java functions, ensure that your classpath includes the JAR files containing the appropriate classes.

GSM Setup Test

This test checks the Generic Service Management (GSM) setup required for Oracle Workflow in Oracle Applications Manager (OAM). Oracle Workflow implements service component containers for its Generic Service Component Framework as GSM service instances. The test verifies that GSM and the Oracle Workflow service instances are enabled. It also checks whether a high number of operating system processes have been created for a service instance in the last few minutes, which may indicate an error. This test does not require any input parameters.

The test reports the status of GSM and of the Oracle Workflow service instances.

BES Clone Test

This test checks certain standard agents and subscriptions required for internal Business Event System and notification mailer processing to verify that they are enabled and that their definitions include the correct local system. You can use this test after cloning or migrating an Oracle E-Business Suite instance to ensure that the local system references have been updated correctly for the new instance. This test does not require any input parameters.

The test reports the name of the local system currently defined in the global workflow preferences, as well as the standard agents and subscriptions to events required for internal processing. For each agent, the report shows the agent name, system name, and status. For each subscription, the report shows the event name, subscription rule function together with the subscribing system, out agent, and status.

GSC Control Queue Test

This test verifies that the Workflow control queue, WF_CONTROL, is properly accessible. The Generic Service Component Framework uses this queue to handle control events for containers and service components. This test does not require any input parameters.

The test reports whether it was able to establish a JMS connection to the WF_CONTROL queue and dequeue a message from the queue.

Workflow Advanced Queue Rule Validation Test

This test checks the standard WF_ERROR and WF_DEFERRED queues to verify that only one subscriber rule is defined for each queue. These queues are reserved for internal Oracle Workflow processing. You should not add any custom subscribers to these queues. This test does not require any input parameters. See: Standard Agents, Oracle Workflow Developer's Guide.

If either queue has more than one subscriber rule defined, the test reports the queue name and the invalid rules. Remove any custom subscribers that have been added to the queues. See: Managing Subscribers, Oracle Streams Advanced Queuing User's Guide and Reference.

Workflow Agents/AQ Status Test

This test checks the Business Event System agents for Oracle Workflow and Oracle XML Gateway, as well as the queues associated with these agents. The test verifies that the agents are enabled within the Business Event System. It also verifies that the queues and the queue tables in which they reside are valid database objects, and that the queues are enabled for enqueuing and dequeuing within Oracle Streams Advanced Queuing (AQ). This test does not require any input parameters. See: Oracle Streams AQ Administrative Interface, Oracle Streams Advanced Queuing User's Guide and Reference.

The test reports the status of the agents, queues, and queue tables, and also shows the subscribers and subscriber rules defined for the queues.

Workflow Objects Validity Test

This test checks the Oracle Workflow and Oracle XML Gateway database objects to verify that all the objects are valid. This test does not require any input parameters.

If any invalid objects are found, the test reports the name and type of those objects. Recompile those objects and ensure that they are valid.

XML Parser Installation Test

This test checks your Oracle E-Business Suite installation to verify that the Oracle XML parser is installed and valid. This test does not require any input parameters.

The test reports the version of the XML parser you have installed and shows the status of the XMLDOM PL/SQL package or xmlparser Java source object in each schema. If any XML parser object is invalid, reinstall the XML parser for that schema.

Mailer Component Test

This test checks your notification mailer service components to verify that at least one notification mailer has been configured with all the parameters needed to run it. This test does not require any input parameters.

If your installation does not include any notification mailer components with a completed configuration, the test reports that no notification mailer is configured. Navigate to the Service Components page in Oracle Workflow Manager to configure a notification mailer service component. You can either complete the configuration of the seeded Workflow Notification Mailer component, or create a new custom notification mailer component. See: Implementing Notification Mailers and Notification Mailer Configuration Wizard.

Note: This test does not report whether a configured notification mailer is currently running. You can use the Service Components page in Oracle Workflow Manager to check the current status of your notification mailer service components.

Mailer Component Parameter Test

This test checks your notification mailer service components to validate their configuration parameters. The test checks only those notification mailers for which all the mandatory configuration parameters have been defined. This test does not require any input parameters.

If any notification mailer has invalid configuration parameters, the test reports the errors. Navigate to the Service Components page in Oracle Workflow Manager to edit the configuration of a notification mailer. For some parameters, you may also need to check the corresponding setup outside the notification mailer.

See: Implementing Notification Mailers and Notification Mailer Configuration Wizard.

Event Diagnostic Test

This test reports details about the Business Event System, including the statuses of the local system and agent listeners, details about the definitions of the specified event and any subscriptions to that event, and details about the specified instance of the event if it appears on one of these queues:

You can use this information to check the status of a particular event or to investigate errors. Enter the event name and event key for the event that you want to review and run the test. The Event Name and Event Key fields are case-sensitive. See: Setting Up the Business Event System.

Note: You can also obtain this information through SQL*Plus using the wfbesdbg.sql script. See: Wfbesdbg.sql.

Event Raise Test

This test checks the basic operation of the Business Event System by raising a test event from Java and from PL/SQL and executing synchronous and asynchronous subscriptions to that event. This test does not require any input parameters. See: Setting Up the Business Event System and Event Subscriptions, Oracle Workflow Developer's Guide.

The test reports whether the event was raised successfully and whether the synchronous subscriptions were executed successfully. You can optionally use the test event name and event key provided in the report to run the Event Diagnostic Test in order to verify the execution of the asynchronous subscriptions or perform further diagnosis for any failures. See: Event Diagnostic Test.

Mailer Tests

The following test is available in the Mailer Tests group.

Mailer Diagnostic Test

This test reports details about a notification and about the notification mailer that sent the notification. You can use this information to check the status of a particular notification or to investigate errors. Enter the notification ID (NID) of the notification that you want to review and run the test. See: Implementing Notification Mailers.

Note: You can also obtain this information through SQL*Plus using the wfmlrdbg.sql script. See: Wfmlrdbg.sql.