Customizing the Data Quality Exception Console to send exception sets to different IBM BPM process applications in IBM Stewardship Center

To use your own IBM® BPM process applications to manage exception sets that are generated by IBM InfoSphere® Information Server exception providers, you must configure the Data Quality Exception Console to send exception sets to your process applications.

Before you begin

  • Follow the steps that are outlined in Create your own IBM BPM process application with the Stewardship Center Application Toolkit.
  • To register IBM BPM applications and create new subscriptions to exception events for those applications by using Subscription Manager, you must have the Exception Management Steward Manager role.
  • To work with the default subscription for NEW_EXCEPTIONS_EVENT, you must have the InfoSphere Information Server Suite Administrator role.

About this task

You need to register your IBM BPM process applications so that they are notified when a user of the Data Quality Exception Console chooses to manage new exception sets with IBM Stewardship Center. Then, you use Subscription Manager to update the subscription that was configured by default to send all exception sets to the Data Quality Exception sample process application in IBM Stewardship Center.

Procedure

  1. Define a friendly name for each IBM BPM process application. You use this name when you register a callback and create subscriptions.
  2. Register a callback to each IBM BPM process application, and specify the following values:
    Table 1. Parameter values for the istool event registerCallback command
    Parameter Value
    -authentication parameters The user name and password for the computer where IBM BPM is installed.
    -eventTypeName NEW_MANAGED_SET_EVENT
    -callbackType HTTP_POST
    -callbackName The friendly name that you define for your IBM BPM process application.
    -callbackDescription The friendly description that you define to help identify your IBM BPM process application.
    -callbackService The REST URL to your IBM Stewardship Center sample process application. Use the format, 
    https://<bpm_server>:<SSL_port>/rest/bpm/wle/v1/service/<BPM_process_application_acronym>@<service>?action=start

    Where:

    <BPM_process_application_acronym>
    The acronym for your IBM BPM process application.
    <service>
    Name of the service in the IBM BPM process application that is accessible by URL.

    For example, if you define the friendly name for your IBM BPM process application as DataStage_exception_workflow, you might run the following command:

    event registerCallback -eventTypeName "NEW_MANAGED_SET_EVENT" -callbackType "HTTP_POST" -callbackName "DQ_workflow" -callbackDescription "When a NEW_MANAGED_SET_EVENT occurs, this callback is invoked to send the exception set to DataStage_exception_workflow."-callbackService "https://my_bpm_server.com:9443/rest/bpm/wle/v1/service/DQWKFLW?@StartProcess?action=start" -u isadmin -p infsv123pwd

  3. To specify which exception sets are sent to which IBM BPM process application, create new subscriptions with event filters.
    1. Specify these values for each subscription
      Table 2. Properties of a NEW_MANAGED_SET_EVENT subscription
      Subscription properties Values
      Name A friendly name for your subscription, for example, DQ_workflow
      Event Type NEW_MANAGED_SET_EVENT
      Notification Type Application
      Application The friendly name that you defined for your IBM BPM process application. This name is also the value that you specified on the –callbackName parameter when you registered the callback. To send exception sets to the Data Quality Exception sample process application, select IBM Stewardship Center - Data Quality Exception
      Application user name TheIBM BPM cell admin ID.
      Application password The password for the IBM BPM cell admin ID that you specified for the Application Username property
    2. Specify values for the event filters for each subscription to limit which exception sets are sent to which IBM BPM process application in IBM Stewardship Center. You can limit by application or project, or for InfoSphere Information Analyzer, by data rule. You can use these event filters:
      Table 3. Event filters to limit exception sets
      Event filters Valid values
      applicationType Information Analyzer

      Exception Stage
      projectName <IA_project_name>

      <DS_project_name>, for example DQ_project
      exceptionSummaryName
      • If you specify Information Analyzer for applicationType, specify the name of a data rule in the specified project.
      • If you specify Exception Stage for applicationType, specify the name of an exception descriptor in an Exceptions stage in the specified project.
        Note: You receive notifications for events of the selected type that occur in any stage in any job in the specified project where the stage contains an exception descriptor of the specified name. To limit notifications to events from a single stage, define a unique name for the exception descriptor in that stage.
      Note: Your subscription includes events of the selected type that occur in any stage in any job in the specified project where the stage contains an exception descriptor of the specified name. To limit the subscription to events from a single stage, define a unique name for the exception descriptor in that stage.
    When a user of the Data Quality Exception Console selects an exception set and clicks Manage, the exception set is sent to the appropriate IBM BPM process application, depending on the filters that you specify in your subscription.
  4. Optional: If you do not want exception sets sent to a specific IBM BPM process application, delete the NEW_MANAGED_SET_EVENT subscription for that process application. For example, the subscription for the default Data Quality Exception sample process application has the following properties:
    Table 4. Properties of the subscription that was configured by default to send all exception sets to the Data Quality Exception sample process application
    Property Value
    Name NEW_MANAGED_SET_EVENT/<Unique_ID>
    Event type NEW_MANAGED_SET_EVENT
    Application IBM Stewardship Center - Data Quality Exception
    Event filters None
  5. Optional: To restore the default configuration so that all exception sets that are generated by IBM InfoSphere Information Server exception providers are sent to the Data Quality Exception sample process application, delete all subscriptions for the event type NEW_MANAGED_SET_EVENT, and then add a new subscription, specifying the properties in Table 4. Do not specify filter properties for this subscription.

Example

A data steward manager wants to route exception sets that are generated by InfoSphere Information Analyzer to be managed with the Data Quality Exception sample process application, and route exceptions sets that are generated by the InfoSphere DataStage® project, IOD_Bank_Demo to be managed with a different IBM BPM process application, DataStage_exception_workflow.

On the Subscriptions tab of the Subscription Manager, the administrator deletes the subscription to the Data Quality Exception sample process application that is created by default.

Next, the administrator creates two subscriptions, both with NEW_MANAGED_SET_EVENT as the event type and Application as the form of notification. For the first subscription, the administrator specifies IBM Stewardship Center - Data Quality Exception as the application and filters the events by using the applicationType property to specify that the subscription is for only those exception events from InfoSphere Information Analyzer. With this subscription, only exceptions that are generated by InfoSphere Information Analyzer are sent to the Data Quality Exception sample process application.

Next, the administrator creates another subscription with the same properties, specifies DataStage_exception_workflow as the application, and filters the events by using the projectName property to specify that the subscription is for only those exception events from the project IOD_Bank_Demo. With this subscription, exception sets that are generated by the IOD_Bank_Demo project are sent to the DataStage_exception_workflow process application. Exceptions that are generated by other InfoSphere DataStage projects are ignored and not sent to the IBM Stewardship Center.

Parent topic: Customizing the Data Quality Exception Console
Related tasks:
Sending exception sets to IBM Stewardship Center
Related information:
Subscriptions
Subscribing to events