Updating events

You can use the istool event updateEventType command to customize the email notifications that are sent by the Subscription Manager for a particular event type and to change the description of the event type.

Purpose

The istool event updateEventType command customizes the email notifications that are sent by the Subscription Manager for a particular event type. It also changes the description of the event type. When you create a subscription and select email notification for an event type in the Subscription Manager, you receive notification emails that use a default format and content. If you want to customize the format and content of the emails, you can use the event updateEventType command. For example, you can add hyperlinks, images, and additional information.

For each event type, you can create or edit template files to customize the subject line and the HTML body of the emails. You specify the location of the templates in the command. To customize the email notification for multiple event types at the same time, you can run the commands in a script.

You can also the use the event updateEventType to change the default description of an event type to a phrase that is more meaningful to your organization.

Note: Some parameters of the event updateEventType command are reserved for IBM internal use. You cannot change the name or the properties of the event type, the descriptions of the properties, or the required roles for working with an event type. Such changes might stop existing subscriptions from working or prevent users from seeing and subscribing to events.

Prerequisites

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

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

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.

Command syntax

Optional parameters and values in the syntax are enclosed in brackets, [ ]. 

event updateEventType
authentication parameters
generic parameters
-eventProviderName "name_of_event_provider"
-eventTypeName name_of_event_type
[-eventTypeDescription "description_of_event_type"]
[-emailSubjectTemplate email_subject_template_file]
[-emailBodyTemplate email_body_template_file]
[-requiredRoles required_roles]

Parameters

When a parameter value includes spaces, enclose the entire value in double quotation marks (").

If you do not provide a value for an optional parameter, the existing value for that parameter remains unchanged.

authentication parameters
Required. All asset interchange commands use authentication parameters to connect to a specific installation of InfoSphere Information Server.
generic parameters
The generic parameters are available to all asset interchange commands. Use the generic parameters to request help on command syntax, to specify silent or verbose operation, and to use a script to run commands.
-eventProviderName | -epn "name_of_event_provider"
Required. Specifies the provider of the event type. For an exception event type, specify "Exception Provider". For a governance event type, specify "InfoSphere Information Governance Catalog".
-eventTypeName | -etn name_of_event_type
Required. Specifies the single event type that you are updating.
-eventTypeDescription | -etd "description_of_event_type"
To change the description of the event type, enter a new description, without commas. The description is shown in the Subscription Manager when users select the event type.
-emailSubjectTemplate | -est email_subject_template_file
Enter the name and path of the email subject template TXT file that you want to apply to notifications for the specified event type.
-emailBodyTemplate | -ebt email_body_template_file
Enter the name and path of the email body template HTML file that you want to apply to notifications for the specified event type.
-requiredRoles | -rr roles_required_for_event_type
Enter the user role ids that are required to view or subscribe to the specified event type. If you specify roles, a user must have at least one of these roles to view or subscribe to the event type. If you do not specify any role, the Suite Administrator role is used.
Note: Use this parameter with caution, changing required roles could cause existing subscribers to be unable to see the event type or subscribe to it.
As a value, specify a comma-separated list of role ids. Refer to the following table for a list of valid role ids.
Role Role id
Suite User SuiteUser
Suite Administrator SuiteAdmin
DataStage and QualityStage Operations Viewer DataStageOperationsViewer
DataStage and QualityStage Administrator DataStageAdmin
DataStage and QualityStage Developer DataStageDeveloper
DataStage and QualityStage User DataStageUser
DataStage and QualityStage Production Manager DataStageProductionManager
DataStage and QualityStage Operator DataStageOperator
DataStage and QualityStage Super Operator DataStageSuperOperator
Data Click Author DCAuthor
Data Click User DCUser
Common Metadata Importer CMImporter
Common Metadata Administrator CMAdmin
Common Metadata User CMUser
FastTrack Project User FastTrackProjectUser
FastTrack Project Author FastTrackProjectAuthor
FastTrack Project Administrator FastTrackAdministrator
FastTrack Project Manager FastTrackProjectManager
FastTrack User FastTrackUser
Information Governance Catalog Glossary Author GlossaryAuthor
Information Governance Catalog Information Asset Assigner GlossaryAssigner
Information Governance Catalog Information Asset Author MDWUser
Information Governance Catalog Glossary Basic User GlossaryBasicUser
Information Governance Catalog Information Asset Administrator MDWAdministrator
Information Governance Catalog Glossary Administrator GlossaryAdmin
Information Governance Catalog User GlossaryUser
Exception Management Steward Manager EMStewardManager
Exception Management Business Steward EMBusinessSteward
Exception Management Data Steward EMDataSteward
Exception Management Administrator EMAdmin
Information Analyzer User SorcererUser
Rules Administrator RulesAdministrator
Information Analyzer Project Administrator SorcererAdmin
Information Analyzer Developer SorcererDeveloper
Information Analyzer Data Administrator SorcererDataAdmin
Information Analyzer Data Analyst SorcererDataAnalyst
Information Analyzer Data Steward SorcererDataSteward
Rules Author RulesAuthor
Rules Manager RulesManager
Information Analyzer DrillDown User SorcererDrilldownUser
Rules User RulesUser
Information Analyzer Data Operator SorcererOperator
Information Analyzer Business Analyst SorcererBusinessAnalyst
ISD Project Administrator ISDProjectAdministrator
ISD User ISDUser
ISD Designer ISDDesigner
ISD Consumer ISDConsumer
ISD Administrator ISDAdministrator
ISD Operator ISDOperator

Examples

The following command changes the existing event type description for the NEW_EXCEPTIONS_EVENT event type to the description that is specified in the command.

event updateEventType -eventProviderName "Exception Provider" -eventTypeName NEW_EXCEPTIONS_EVENT 
-eventTypeDescription "This event is generated in either Information Analyzer or an Exceptions stage." 
-domain localhost:9443 -username myUsername -password myPassword

The following command specifies that notifications for subscriptions to the IGC_BUSINESSTERM_EVENT event type are sent by using the specified subject template file and body template file. You can use a script to apply the same template files to all of the governance event types.

event updateEventType -epn "InfoSphere Information Governance Catalog" 
-etn IGC_BUSINESSTERM_EVENT -emailSubjectTemplate C:\EmailSubjectTemplate.txt 
-ebt C:\EmailBodyTemplate.html -domain localhost:9443 -u myUsername -p myPassword