event registerCallback command

The suite administrator can use the istool event registerCallback command to register an application so that it can receive and process notifications of events of a specific type.

Purpose

When you use the Subscription Manager to create a subscription for an event type, you can specify the name of an application that is registered to work the event type. Some event providers register applications by default. To register a new application, or to register an application for use with a different event type, you use the event registerCallback command.

If you no longer need to use the application, you can unregister it by using the event unregisterCallback command.

Each time you run the event registerCallback command you can specify only one event type. You can use the same application name and description with different event types. For example, if you want to send governance events of multiple types to the Email Notification sample application, run the event registerCallback command once for each event type. Use the same application name and description in each command. You can use a script to run multiple commands.

Requirements

You must have the IBM® InfoSphere® Information Server suite administrator role.

Run the command from a computer that is on the engine tier or the client tier.

Command syntax

The preferred way to run this command is in the istool command-line window. If you run this command in your operating system command-line window or in scripts, you must add istool before the command name.

event registerCallback
authentication parameters
generic parameters
-eventTypeName event_type
[-callbackType application_type]
-callbackName application_name
[-callbackDescription application_description]
-callbackService application_service

Parameters

These parameters are specific to the event registerCallback command. For authentication parameters and generic parameters, see Commands and common parameters for istool.

-eventTypeName | -etn event_type: Required. Specifies the name of a single event type that you want to make the application available for.
-callbackType | -cbt application_type: Either HTTP_POST or IIS_SERVICE. If you do not specify -callbackType, the value defaults to HTTP_POST.
-callbackName | -cbn application_name: Required. The name of the application. Surround the name in double quotation marks (") if it contains spaces. If you use event registerCallback multiple times to link different event types to the same application, specify the same application name in each command.
-callbackDescription | -cd application_description: The description of the application. Specify a description of 255 characters or less that describes what the application does with the event information. Descriptions are displayed in the Subscription Manager to help users determine which application to choose.
-callbackService | -cbs application_service: Required. If -callbackType is HTTP_POST or not specified, specify the REST URL to your application service. If -callbackType is IIS_SERVICE, specify the Java class name for the service.; The URL or Java class name cannot contain spaces. If you surround a name that contains spaces in double quotation marks, the application registers, but the subscription does not work.

Example 1

You can register an application to link the event type IGC_BUSINESSRULE_EVENT with the sample application Governance Rule Approval. When you create the subscription in the Subscription Manager interface after registering the application, you filter the event type by specifying the SEND_FOR_APPROVAL action. Whenever an information governance rule is marked to send for approval, an event is created and sent to the sample application for processing.

event registerCallback -eventTypeName IGC_BUSINESSRULE_EVENT 
-callbackType HTTP_POST 
-callbackName "Governance Rule Approval" -callbackService  
https://BPM_Server:SSL_Port/
rest/bpm/wle/v1/service/IIGC@StartRuleApproval?action=start
-callbackDescription "This application sends email to selected users when the 
governance event type IGC_BUSINESSRULE_EVENT occurs for a SEND_FOR_APPROVAL action. 
You can use the application to track approval of information governance rules."
 -domain localhost -u myUserName -p myPassword

Example 2

You can register an application to link the event type IGC_BUSINESSTERM_EVENT to the sample application Email Notification. When terms are created, modified, deleted, or subject to a workflow process, they are sent to the Email Notification application and selected users are notified.

event registerCallback -eventTypeName IGC_BUSINESSTERM_EVENT 
-callbackType HTTP_POST 
-callbackName "Email Notification" -callbackService 
https://BPM_Server:SSL_Port/
rest/bpm/wle/v1/service/IIGC@StartEMail?action=start" 
"This application sends email to selected users when any 
governance event type except IGC_GLOSSARY_IMPORT_EVENT occurs. The application 
is invoked for all action types except deletion of an asset." 
-domain localhost -u myUsername -p myPassword

Example 3

You can register an application to send notifications of events of the type NEW_EXCEPTIONS_EVENT to an application that is named Exception Sets for Project XA5.

event registerCallback -eventTypeName NEW_EXCEPTIONS_EVENT 
-callbackType IIS_SERVICE
-callbackName "EM Exception Set Creation" 
-callbackService com.ibm.iis.emc.callback.ExceptionEventCallbackService
-callbackDescription "This callback is invoked to send the exception set 
to the Data Quality Exception Console when a NEW_EXCEPTIONS_EVENT occurs."
-u isAdminUser -p isAdminPwd