6 Configuring Notification Alerts to External Programs

This sections describes how to send alerts to external programs; for example an email program. It contains these topics:

6.1 About Notification Templates

Oracle GoldenGate Monitor comes with a default SNMP notification template and you can add multiple email and command line interface (CLI) notification templates. All templates can be modified at any point in time and the changes are dynamic so a restart of Oracle GoldenGate Monitor is not necessary. When you add alert definitions based on a template, that template cannot be removed; you can only remove templates that are not associated with an alert.

Consider the following when using notification templates:

  • You do not need to restart Oracle GoldenGate Monitor when you add or modify notification templates.

  • You cannot delete notification templates that are associated with alert definitions.

  • Select at least one notification template to define an alert.

  • You can select notification templates for one or more notification template email, command line interface, and SNMP.

  • User can change notification template at any point in time.

Only Oracle GoldenGate Monitor Super Administrator, Administrator, or Power Operator users can configure alert notifications templates.

6.2 Managing Notification Templates

Use the Notification Template subtab of the Alert Management tab to create, view, and modify notification templates.

  • The Manage Notification Template table on this subtab displays the existing templates, with the following columns:

  • Name: The name of the template.

  • Type: The type of template, CLI, email, or SNMP.

  • Enabled: Indicates whether the template can be used for alert definitions (Enabled) or not (Disabled).

  • Date Modified: The date and time the template was last modified.

On the Alert Management tab, you can take the following actions:

  • To create an alert definition, click New Notification Template Definition. See Configuring an Alert Definition.

  • To edit an alert definition, click its name in the list to open the Edit Alert Definition screen. See Configuring an Alert Definition.

  • To delete a notification template, as long as it is not in use by any alert definitions, click the check box for the template you want to remove, then click Remove Notification Template, then click Yes to confirm the removal. All templates can be selected using the check box in the table header.

    You cannot remove the default SNMP template; attempts to do so result in a warning.

6.3 Configuring Email Alerts

You can create, view, modify, and delete email notification templates.

  1. On the Alert Management tab, click the Notification Template subtab.

  2. Click New Notification Template to create a new template.

  3. Use the options as follows to modify this template:

    Tip:

    You can use the Clear button to remove the contents of all of the options.
    Notification Template Type

    Select Email.

    Notification Template Name

    Enter a unique name for this template that is descriptive of the notification you are configuring.

    Notification Template Enabled

    Select this check box to enable the use of this template or deselect to disable it.

    SMTP Server Host

    Enter the hostname of your email server.

    SMTP Port

    Enter the port number that your email server uses.

    From Name

    Enter the default sender's name or use the default, Oracle GoldenGate Monitor.

    From Email address

    Enter the email address of the sender for Oracle GoldenGate Monitor communications generated from the email server.

    Secure SMTP

    Select this check box if your email server is running in secure mode. Enter the Email for Authorization and Password in the respective fields.

  4. Click Submit to save your changes and begin using them immediately, or Cancel to revert to the original configuration.

  5. Ask each Oracle GoldenGate Monitor user that should receive email alerts to activate them in the User Profile. For instructions, see Managing Your User Profile.

  6. Use the Alert Management tab to create your alerts. For instructions, see Managing Alert Definitions.

6.4 Configuring CLI Alerts

You can create, view, modify, and delete CLI notification templates.

  1. On the Alert Management tab, click the Notification Template subtab.

  2. Click New Notification Template to create a new template.

  3. Use the options as follows to modify this template:

    Tip:

    You can use the Clear button to remove the contents of all of the options.
    Notification Template Type

    Select Command Line Interface.

    Notification Template Name

    Enter a name for this template that is descriptive of the notification you are configuring.

    Notification Template Enabled

    Select this check box to enable the use of this template or deselect to disable it.

    Execution Directory

    Enter the directory that contains the command you want to execute. For example, /root.

    OS Command

    Enter the operating system command (or script) that you want to execute. For example, ls.

    Arguments

    You can add command arguments by clicking Add Argument, then enter the argument including dash (-), and then select the alert fields from the list of options. For example, -la.

    The alertField can be one of the following values associated with the alert definition:

    alertName

    The name of an alert definition.

    host

    The host of the Oracle GoldenGate object whose monitoring point triggers the alert.

    alertObjectName

    The name associated with the object whose monitoring point triggers the alert, such as an Extract process named EXACCT.

    alertSeverity

    The severity level defined for the alert.

    alertMessage

    The message generated by the alert. This is a combination of the condition defined for the alert, the value of the monitoring point, and literal text.

    changedValue

    The new monitoring point value that triggered the alert. For example, you create an alert that is triggered when lag is greater than 5 seconds. The lag is 4 seconds and then it goes to 7 seconds. This triggers the alert and the changedValue is 7.

    You can remove one or more arguments by selecting the argument check box and clicking Remove Argument. All arguments can be selected using the check box in the table header.

  4. Click Submit to save your changes and begin using them immediately, or Cancel to revert to the original configuration.

  5. Ask each Oracle GoldenGate Monitor user that should receive CLI alerts to activate them in the User Profile. For instructions, see Managing Your User Profile.

  6. Use the Alert Management tab to create your alerts. For instructions, see Managing Alert Definitions.

6.5 Configuring SNMP Alerts

This default template can be viewed and modified though not removed.

  1. On the Alert Management tab, click the Notification Template subtab.

  2. Double-click the Snmp_Default_Template to view or modify this template.

  3. Use the options as follows to modify this template:

    Tip:

    You can use the Clear button to remove the contents of all of the options.
    Notification Template Name

    Enter a different name for this template.

    Notification Template Enabled

    Select this check box to enable the use of this template or deselect to disable it.

    SNMP Server Host

    Enter the hostname of your SNMP server.

    SNMP Trap Port

    Enter the number of your notifications (trap) port.

    SNMP Community Name

    Enter the community name for authentication.

    Version

    Select the version number you want to use.

  4. Click Submit to save your changes and begin using them immediately, or Cancel to revert to the original configuration.

  5. Ask each Oracle GoldenGate Monitor user that should receive SNMP alerts to activate them in the User Profile. For instructions, see Managing Your User Profile.

  6. Use the Alert Management tab, to create your alerts. For instructions, see Managing Alert Definitions.