14 Setting Up Error Handling

This chapter provides and overview and discusses how to create user roles, associate email addresses to user roles, configure notification details, and how to set up error handling configuration details.

This chapter includes the following sections:

14.1 Introduction to Setting Up Error Handling

Setting up error handling involves configuring the following items:

Figure 14-1 illustrates the way in which error handling setup elements enable Error Notification functionality.

Figure 14-1 Error Handling Setup Elements That Enable Error Notification Functionality

This image is described in surrounding text

Figure 14-2 illustrates the way in which error handling setup elements enable Oracle Worklist functionality.

Figure 14-2 Error Handling Setup Elements That Enable Oracle Worklist Functionality

This image is described in surrounding text

14.2 How to Create Error Handling User Roles

To create error handling user roles:

  1. Access the Oracle WebLogic Server Administration Console: http://<host>:<port>/console.

  2. In the Domain Structure menu, click Security Realms.

  3. On the Summary of Security Realms page, select myrealm.

  4. On the Settings for myrealm page, select the Users and Groups tab.

  5. Select the Users tab.

  6. Create and modify user roles for use with the Error Handling Framework. For error handling notification and worklist functionality to work as designed, ensure that you are using user roles and not groups.

For more information about setting up user roles, see "Using the Administration Console to Manage Users, Groups, and Roles" in Oracle Fusion Middleware Securing Resources Using Roles and Policies for Oracle WebLogic Server.

Note:

Any user roles you create in the WebLogic Server Administration Console are stored in the Oracle WebLogic Server's embedded LDAP server. You may integrate a third-party LDAP solution to the embedded LDAP server.

For more information about Oracle WebLogic Server s embedded LDAP server, see "Security Provider Databases" in Oracle Fusion Middleware Understanding Security for Oracle WebLogic Server.

14.3 How to Associate Email Addresses with Error Handling User Roles

To associate email address with error handling user roles:

  1. Access the My Messaging Channels page in the Oracle User Messaging Service standalone user interface: http://<soa-host>:<soa-port>/sdpmessaging/userprefs-ui.

    For more information about creating, updating, and deleting a message channel, see "How to Manage Messaging Channels" in Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite.

  2. Associate an email address with an error handling user role.

    For more information about creating user roles, see Section 14.2, "How to Create Error Handling User Roles."

  3. Ensure that the messaging channel name you enter corresponds to an error handling user role name you have created according to information in Section 14.2, "How to Create Error Handling User Roles."

14.4 How to Configure Notification Details

To configuration notification details:

  1. Set up workflow notification properties in the Oracle Enterprise Manager.

    For more information about how to set up these properties, see "Configuring Human Workflow Notification Properties" in Oracle Fusion Middleware Administrator's Guide for Oracle SOA Suite and Oracle Business Process Management Suite.

  2. Configure an email messaging channel. This enables the messaging service to resolve the email address when trying to send a notification to a user.

    For more information about how to configure an email messaging channel, see Oracle WebLogic Communication Services Developer's Guide.

  3. Set the sender address for email notifications to a valid email address. Set this value in the FROM.EMAIL.ID property in the Error Handling Module section of the AIAConfigurationProperties.xml file. For example:

    <Property name="FROM.EMAIL.ID">Email:AIA-Error-Handling@oracle.com</Property>

    For more information about requirements for working with AIAConfigurationProperties.xml, see "How to Set Up AIA Workstation" in Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack.

14.5 How to Set Up AIA Error Handling Configuration Details

This section includes the following topic: Section 14.5.1, "What You Need to Know about Setting Up Error Handling Configurations."

To set up AIA error handling configuration details:

  1. Access the Error Notifications page. To access the page,

    Access the AIA Home Page. In the Setup area, click the Go button. Select the Error Notification tab. The Error Notification page displays as shown in Figure 14-3 and Figure 14-4.

    Figure 14-3 Error Notification Page (1 of 2)

    This image is described in surrounding text

    Figure 14-4 Error Notification Page (2 of 2)

    This image is described in surrounding text

  2. Use the page elements to define and modify error handling configuration details for processes operating in an Oracle AIA ecosystem, including Error Notification and Oracle Worklist roles and Error Notification throttling parameters.

The error handling configurations you define on the Error Notifications page are stored in the AIA_ERROR_NOTIFICATIONS table.

Note:

For a given process, if no entry is found in the AIA_ERROR_NOTIFICATIONS table, the Actor and FYI roles specified in AIAConfigurationProperties.xml are used for Error Notifications and Oracle Worklist assignments, if enabled. By default, the Actor role is set to AIAIntegrationAdmin. Therefore, you are not required to populate the AIA_ERROR_NOTIFICATIONS table unless there is an explicit need.

For more information, see "Configuring Oracle AIA Processes for Error Handling and Trace Logging" in Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack.

Descriptions of key elements on the Error Notification page are discussed in Table 14-1.

Table 14-1 Error Notification Page Elements

Element Description

ErrorCode

For BPEL and Mediator process system error notifications, this is the fault code.

For business errors using catch blocks, this is the business error code you are catching. This is user-defined, for example, OUT_OF_INV.

SystemCode

This is the system code of the participating application.

ProcessName

This is the business process in which the service is participating.

ServiceName

For BPEL and Mediator services, this is the name of the service that experiences the error for which you are defining error notification details. For example, SampleBPELProcess.

NotificationRole

If you have enabled Error Notifications, specify the user role that you want to receive Actor error notifications for a process.

If you have enabled Oracle Worklist functionality, specify the role to which you want to assign Actor tasks for a process.

The Actor role is responsible for taking action to correct the error that generated the notification.

For Error Notifications or Oracle Worklist functionality, ensure that the role you specify here has a corresponding entry in the Oracle WebLogic Server Administration Console user store.

For more information, see Section 14.2, "How to Create Error Handling User Roles."

For Error Notifications functionality, ensure that the user role has an email address defined in the Oracle WebLogic User Messaging Service.

For more information, see Section 14.3, "How to Associate Email Addresses with Error Handling User Roles."

FyiNotificationRole

If you have enabled Error Notifications, specify the user role that you want to receive FYI error notifications for a process.

If you have enabled Oracle BPM Worklist functionality, specify the role to which you want to assign FYI tasks for a process.

This is the role that will be given information about the error, but will not be responsible for taking any actions to correct the error that generated the notification.

For Error Notifications or Oracle BPM Worklist functionality, ensure that the role you specify here has a corresponding entry in your implementation s user management store. By default, the AIA user management store is WebLogic s embedded LDAP server.

For more information, see Section 14.2, "How to Create Error Handling User Roles."

For Error Notifications functionality, ensure that the user role has an email address defined in Oracle User Messaging Service preferences.

For more information, see Section 14.3, "How to Associate Email Addresses with Error Handling User Roles."

ErrorType

The default value is AIA_EH_DEFAULT. Use this value if you want to use the AIA default error listener as the consuming component for this error notification.

Enter a unique value here if you are using extended error handling functionality.

For more information about extending error handling, see "Configuring Oracle AIA Processes for Error Handling and Trace Logging" in Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack.

If you want to use default and extended error handling functionality in a single error notification definition, add multiple Error Type values separated by commas. For example, AIA_EH_DEFAULT, ORDER_FO, where AIA_EH_DEFAULT is the default Oracle AIA follow-through action, and ORDER_FO identifies the custom JMSCorrelationID for the extended error handling implementation. The listeners and associated actions for both of these error types will be executed at run time.

ErrorExtHandler (error extension handler)

The default value is ERRORHANDLER_EXT. Use this value for the error notification if you are not using an extended handler and the fault message will be generated based on the default fault message schema.

For more information about extending fault messages, see "Configuring Oracle AIA Processes for Error Handling and Trace Logging" in Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack.

If you are using an extended handler to extend the fault message for this error notification, enter a unique value to identify the extension handler that will be used to enrich the fault message.

AggrCountTot (aggregation count total)

Error notification throttling must be enabled before this field value can be used to control the issuance of error notifications.

For more information, see Section 15.2.2, "How to Enable Error Notification Throttling."

Enter the total number of error notifications you want the system to suppress during a specific time interval for the given error scenario. The count is valid only during the specified time interval.

An error notification email is issued for the first error during the time interval. After reaching the count value, the count is reset to 0 and another error notification email is issued.

StDatetime/EndDatetime

Error notification throttling must be enabled before these field values can be used to control the issuance of error notifications.

For more information, see Section 15.2.2, "How to Enable Error Notification Throttling."

Enter the start and end date-and-time intervals to which you want the count value to apply.

For example, if you set the AggrCountTot field value to 100, the start date and time to 30-Oct-2009 18:00:00, and the end date and time to 01-Nov-2009 17:00:00, one error notification email will be sent out on the first occurrence of an error in the time interval. When the count value entered in the AggrCountTot field is reached, the count is reset to 0 and another error notification email is issued.

The date and time values used to track the time interval are derived from the database. The date and time displayed in the fields are derived from your browser time. Hover over the field values to view the database time.

14.5.1 What You Need to Know about Setting Up Error Handling Configurations

The Error Handling Framework uses run-time values and the data you enter on this page to execute the following hierarchical logic to determine the appropriate Error Notification and Oracle BPM Worklist assignment roles for an error.

  1. If all four run-time values (SYSTEM CODE, ERROR CODE, SERVICE NAME, and PROCESS_NAME) are available and they map to an entry in this table, use the specified roles.

  2. If the ERROR CODE, SERVICE_NAME, and PROCESS_NAME are available and map to an entry in this table, use the specified roles.

  3. If the SERVICE_NAME and PROCESS_NAME are available and map to an entry in this table, use the specified roles.

  4. If the SERVICE_NAME is available and maps to an entry in this table, use the specified roles.

  5. If none of these values are available, the default values are fetched from the AIAConfigurationProperties.xml file.