Deleting Notification Subscriptions

Purpose

Follow this procedure to delete notification subscriptions.

To delete notification subscriptions:

  1. In Dimensions Build select the Notifications tab.

  2. In the navigation pane select Notifications, select Subscriptions, and select the Dimensions project containing the build configuration where you want to delete notification subscriptions.

  3. In the navigation pane select the build configuration and select Events.

  4. In the content pane select the check box next to each notification event that you want to delete.

  5. Click Delete. To confirm that you want to delete the notification events click Yes.

  6. Add New Notification Template Dialog Box

    The Add New Notification Template dialog box allows you to add a new notification template.

    Field

    Description

    Rules and Guidelines

    Template

    Type the name of this notification template.

     

    Subject

    Type the subject of this notification template.

    To add a pre-defined variable to the subject do the following:

    a        Place the cursor where you want to add the variable.

    b        Click Insert Variable. The Insert Notification Variable to the Field dialog box appears.

    c        From the Variable Name field select a variable. The content of the variable is displayed in the Preview field. The Description field briefly describes the variable.

    d        Click OK. The variable is added to the end of the field.

    After you have inserted variables you can add freeform text anywhere in the field. You can also cut and paste variables if you want to rearrange their order.

    Message

    Type the message for this notification template.

    Add pre-defined variables and HTML formatting tags if required.

    Adding Notification Events

    Adding Notification Subscriptions

    Edit Notification Template Dialog Box

    The Edit Notification Template dialog box allows you to edit an existing notification template.

    Field

    Description

    Rules and Guidelines

    Template

    Edit the name of this notification template.

     

    Subject

    Edit the subject of this notification template.

    To add a pre-defined variable to the subject do the following:

    a        Place the cursor where you want to add the variable.

    b        Click Insert Variable. The Insert Notification Variable to the Field dialog box appears.

    c        From the Variable Name field select a variable. The content of the variable is displayed in the Preview field. The Description field briefly describes the variable.

    d        Click OK. The variable is added to the end of the field.

    After you have inserted variables you can add freeform text anywhere in the field. You can also cut and paste variables if you want to rearrange their order.

    Message

    Edit the message for this notification template.

    Add pre-defined variables and HTML formatting tags if required.

    Adding Notification Events

    Adding Notification Subscriptions

    Create New Copy of the Notification Template Dialog Box

    The Create New Copy of the Notification Template dialog box allows you to copy an existing notification template.

    Field

    Description

    Rules and Guidelines

    Template

    Edit the name of this notification template.

     

    Subject

    Edit the subject of this notification template.

    To add a pre-defined variable to the subject do the following:

    a        Place the cursor where you want to add the variable.

    b        Click Insert Variable. The Insert Notification Variable to the Field dialog box appears.

    c        From the Variable Name field select a variable. The content of the variable is displayed in the Preview field. The Description field briefly describes the variable.

    d        Click OK. The variable is added to the end of the field.

    After you have inserted variables you can add freeform text anywhere in the field. You can also cut and paste variables if you want to rearrange their order.

    Message

    Edit the message for this notification template.

    Add pre-defined variables and HTML formatting tags if required.

    Adding Notification Events

    Adding Notification Subscriptions

    Delete Notification Template(s) Dialog Box

    The Delete Notification Template(s) dialog box allows you to delete all the notification templates that are listed in the dialog box.

    Add New Notification Event Dialog Box

    The Add New Notification Event dialog box allows you to add a new notification event.

    NOTE  If you do not specify a subject, message, or notification template the notification event is ignored.

    Field

    Description

    Rules and Guidelines

    Project

    Select the Dimensions project where you want to add a notification event.

     

    Build Configuration

    Select the build configuration where you want to add a notification event.

     

    Target

    Select the target to which the notification event will apply.

    To trigger a notification for all targets select All Targets.

    Event

    Select the type of event that will trigger the notification event.

    Select one of the pre-defined event types. Some events also require that you select an additional option. For example, if you select the Build is finished event type you must also select an option from the Build Result list.

    Template

    Select the notification template that will be used to populate the subject and message fields in the email message.

    Optional

    If you do not want to use a template select <none>.

    Subject

    If you did not select a notification template, type the subject of this notification event.

    If you do not specify a subject the notification template subject is used.

    To add a pre-defined variable to the subject do the following:

    a        Place the cursor where you want to add the variable.

    b        Click Insert Variable. The Insert Notification Variable to the Field dialog box appears.

    c        From the Variable Name field select a variable. The content of the variable is displayed in the Preview field. The Description field briefly describes the variable.

    d        Click OK. The variable is added to the end of the field.

    After you have inserted variables you can add freeform text anywhere in the field. You can also cut and paste variables if you want to rearrange their order.

    Message

    If you did not select a template, type the message for this notification event.

    If you do not specify a message the notification template message is used.

    Add pre-defined variables and HTML formatting tags if required.

    Adding Notification Subscriptions

    Adding Notification Templates

    Edit Notification Event Dialog Box

    The Edit Notification Event dialog box allows you to edit an existing notification event.

    NOTE  If you do not specify a subject, message, or notification template the notification event is ignored.

    Field

    Description

    Rules and Guidelines

    Project

    Modify the Dimensions project for the notification event.

     

    Build Configuration

    Modify the build configuration for the notification event.

     

    Target

    Modify the target to which the notification event applies.

    To trigger a notification for all targets select All Targets.

    Event

    Modify the type of event that triggers the notification event.

    Select one of the pre-defined event types. Some events also require that you select an additional option. For example, if you select the Build is finished event type you must also select an option from the Build Result list.

    Template

    Modify the notification template that is used to populate the subject and message fields in the email message.

    Optional

    If you do not want to use a template select <none>.

    Subject

    If you did not select a template, type the subject of this notification event, or edit an existing subject.

    If you do not specify a subject the notification template subject is used.

    To add a pre-defined variable to the subject do the following:

    a        Place the cursor where you want to add the variable.

    b        Click Insert Variable. The Insert Notification Variable to the Field dialog box appears.

    c        From the Variable Name field select a variable. The content of the variable is displayed in the Preview field. The Description field briefly describes the variable.

    d        Click OK. The variable is added to the end of the field.

    After you have inserted variables you can add freeform text anywhere in the field. You can also cut and paste variables if you want to rearrange their order.

    Message

    If you did not select a template, type the message for this notification event, or edit an existing message.

    If you do not specify a message the notification template message is used.

    Add pre-defined variables and HTML formatting tags if required.

    Adding Notification Subscriptions

    Adding Notification Templates

    Delete Notification Event(s) Dialog Box

    The Delete Notification Event(s) dialog box allows you to delete all the notification events that are listed in the dialog box.

    Add New Notification Subscriber Dialog Box

    The Add New Notification Subscriber dialog box allows you to add a new notification subscriber to an existing notification event.

    Field

    Description

    Rules and Guidelines

    Subscriber Type

    Select User or Group.

     

    Subscriber Name

    Select a user or group.

    You can only add users and groups that are defined in your process model. For information about adding users and groups see the Process Configuration Guide or the Administration Console help.

    Subject

    Type the subject of this notification subscription.

    If you do not specify a subject the notification event subject is used.

    To add a pre-defined variable to the subject do the following:

    a        Place the cursor where you want to add the variable.

    b        Click Insert Variable. The Insert Notification Variable to the Field dialog box appears.

    c        From the Variable Name field select a variable. The content of the variable is displayed in the Preview field. The Description field briefly describes the variable.

    d        Click OK. The variable is added to the end of the field.

    After you have inserted variables you can add freeform text anywhere in the field. You can also cut and paste variables if you want to rearrange their order.

    Message

    Type the message for this notification subscription.

    If you do not specify a message the notification event message is used.

    Add pre-defined variables and HTML formatting tags if required.

    Adding Notification Templates

    Adding Notification Events

    Edit Notification Subscriber Dialog Box

    The Edit Notification Subscriber dialog box allows you to edit an existing notification subscription.

    Field

    Description

    Rules and Guidelines

    Subscriber Type

    Select User or Group.

     

    Subscriber Name

    Select a user or group.

    You can only add users and groups that are defined in your process model. For information about adding users and groups see the Process Configuration Guide or the Administration Console help.

    Subject

    Type, or modify, the subject of this notification subscription.

    If you do not specify a subject the notification event subject is used.

    To add a pre-defined variable to the subject do the following:

    a        Place the cursor where you want to add the variable.

    b        Click Insert Variable. The Insert Notification Variable to the Field dialog box appears.

    c        From the Variable Name field select a variable. The content of the variable is displayed in the Preview field. The Description field briefly describes the variable.

    d        Click OK. The variable is added to the end of the field.

    After you have inserted variables you can add freeform text anywhere in the field. You can also cut and paste variables if you want to rearrange their order.

    Message

    Type, or modify, the message for this notification subscription.

    If you do not specify a message the notification event message is used.

    Add pre-defined variables and HTML formatting tags if required.

    Adding Notification Templates

    Adding Notification Events

    Delete Notification Subscriber(s) Dialog Box

    The Delete Notification Subscriber(s) dialog box allows you to delete all the notification subscriptions that are listed in the dialog box.

    Notification Service Configuration Dialog Box

    The Notification Service Configuration dialog box enables you to configure and modify the settings for the Dimensions Build Notification Service. You must configure the Notification Service to be able to send email notifications.

    Field

    Description

    Rules and Guidelines

    Host

    Type or modify the name of the node hosting the email server that will send the notifications.

     

    Port

    Type or modify the port number that the email server is listening on.

     

    Hello host

    Type or modify the string required to establish a connection through the SMTP protocol.

     

    User

    Type or modify the name of a user that can access the email server.

    Not required if you do not select an authentication method.

    Password

    Type or modify the password for the user that you specified.

    Not required if you do not select an authentication method.

    Confirm Password

    Retype the password.

    Not required if you do not select an authentication method.

    Authentication

    Select or change the SMTP server authentication method.

     

    Sender Mail

    Type or modify the email address from who the notification emails will be sent.

     

    Sender Name

    Type or modify the name that will appear in the From field in the notification emails.

     

    Insert Notification Variable to the Field Dialog Box

    The Insert Notification Variable to the Field dialog box enables you to add pre-configured variables to the Subject and Message fields in a notification template, notification event, or notification subscription.

    Field

    Description

    Rules and Guidelines

    Variable Name

    Lists all the variables that are available.

    Select a variable from the list.

    Preview

    Previews the content of the variable that you select from the Variable Names list.

     

    Description

    The description of the variable that you select from the Variable Names list.