The Notifiers tab is under the Flows menu and sends notifications to various recipients after a successful or failed deployment attempt. It also can specify when deployed files have been changed, a Request Task used, or that an Endpoint is down. A Notifier can be used as part of your continuous Delivery Pipeline to automatically update users and contains all technical information necessary. DeployHub can use SMTP (Simple Mail Transfer Protocol), Slack, and HipChat for this purpose.


Individual notifications are created through another DeployHub object known as a Notify Template. A Notifier contains one or more of these. Each contains the subject and body of the actual notification, and if via email, a list of recipients. Recipients can be members of one or more Groups as well as the owners of the Application, the owner of the Environment, and/or the owners of its Servers.


Using these two objects, Notifiers and Notify Templates, notifications can be sent whenever a deployment to an Environment fails or succeeds, whenever a Request Task is executed, or the state of an End Point changes, using a variety of email or messaging systems, with individually tailored notifications containing all information needed to inform all relevant teams.

NOTE: All Users can be assigned email addresses for email type notifications. See the chapter on Users and Groups.


In order to create a Notifier, go to the Flows menu. Select the Notifier tab, and right click on any Domain.  Select “New Notifier in this Domain”. This causes the Notifier Edit dialog to appear. To the right of the tree structure are several tabs which allow the User to modify Notifiers. These are listed below, along with the fields contained in each tab, and an explanation for the use and functions of each:

Editing and Deleting a Notifier

To the right of the tree structure are several tabs which allow the User to modify Notifiers. The General tab shows a summary of the Notifier’s configuration. You can edit information in the Notifier’s General tab by clicking on the pencil icon in the upper right-hand corner of the window. You can also delete a Notifier by right clicking on the Notifier in the tree structure and selecting the ‘Delete’ option.

Properties Tab

Field

Description

Name:

Available Options:


From:  The email address of the sender, typically a shared address accessible to users who deploy Releases to Environments.


HTML: Sends emails in HTML format.


SSL: Uses Secure Sockets Layer for sending email.


Mailserver:  The name of the email server, i.e., smtp.mycompanyserver.com.


Mailport The port that receives email on the mail server. Typically 26, but it could be different.


Password:  The password for the mail server.


Username:  The user name for the mail server.


Logfile:  Location of the logfile.


If the Type field has been set to ‘txtlocal’, then only ‘from’, ‘password’, and ‘username’ appear in the Name field:


Available options for HipChat:


webhook: The url for the group chat, topic chat, or chat room.


HTML:  Sends messages in HTML format.


logfile:  Location of the logfile on the server that is running DeployHub.


Available options for Slack:


webhook: The url for a Slack Workspace.


channel: A particular channel within a Workspace. These can be public, private, or shared.


logfile: Location of the logfile on the server that is running DeployHub.


Value

The actual value for the property that was selected from the Name field.

Encrypted

Checkbox that indicates that the value is to be encrypted in the DeployHub database.

Override

Checkbox that indicates the property can be changed. This is used for ‘scripted’ notifications where the action editor includes a ‘notify’ action. This allows the notify action to override the value, for example, of the username or hostname of the Notifier.


Access tab

The Access tab allows you to configure how Users within designated Groups will Access the Notifier.  To add a Group to one of the access lists, drag and drop the Group from the Available Groups list on the far right into the desired Access list. All Users who belong to a Group that appear in one of the Access lists will be granted access to the Notifier in the following ways:


Access

Description

View

Allows Users to see the Notifier. If the User does not belong to a Group in the View Access list, the Notifier will not appear in the tree structure.

Change

Allows Users to changes the Notifier’s characteristics i.e. Name, Summary, etc.

Send

Allows Users to send an email.


NOTE:  DeployHub Team has only two Groups, Administrators and Users. If you need more granularity in Groups, you will need to upgrade to DeployHub Pro.


General Tab

The General tab contains fields with basic information for the selected Notifier. Information can be changed by clicking on the edit pencil in the upper right-hand corner.


Field

Description

Name

The name of the Notifier.

Type

The type of Notifier;

Options include: smtpemail, slack, hipchat, and  txtlocal

Owner

The owner of the Notifier, defaults to the name of the User who created it. The default owner is the User who created the Notifier. When editing this field, the Owner Type field is available which includes Owner and Group as choices. Selecting one of these causes the Owner field to display either Users or Groups to choose from.

Summary

A short text field to describe the Notifier and its use.

Created

The date and time the Notifier was created.

Modified

The date and time the Notifier was last changed.

Credential

The name of the Credential with username/password for accessing the Notifier.

Credentials are created under the End Points menu. These contain the User Names and Passwords for accessing a Notifier.


Editing and Deleting Notify Templates

Clicking on a Notifier in the tree structure allows the User to select “New Notify Template for this Notifier” in order to create Templates for the selected Notifier. This causes the Template dialog to appear. To the right of the tree structure are several tabs which allow the User to modify Templates. These are listed below, along with the fields contained in each tab, and an explanation for the use and functions of each:

General Tab

Field

Description

Name

The name of the Template.

Summary

A short text field to describe the Template and its use.

Created

The date and time the Template was created.

Modified

The date and time the Template was last changed.


Recipients Tab

This tab contains the list of Users that will receive the email created from this Template if it is an email type Template. Clicking on the plus (+) sign in the upper right will cause a pop-up window to appear which contains a list of values to choose from. The list will change according to which value is chosen from the Type drop down list:


List

Description

Calculated

One of three choices:

${environment.owner}: the Environment that was deployed to.

${server.owner}: the Server that was deployed to.

${version.owner}: the Version that was deployed.

Users

All of the individual Users in the DeployHub installation.

Groups

All of the Groups in the DeployHub installation.


Click on a User or Group from these three lists and click the OK button to place the selected value into the Recipients list. All Users and Groups assigned to the Recipients list will receive the email.


Body tab

This contains two fields, Subject and Body, which will be used as the subject and body of the notification that is sent.


General tab

This tab contains the fields for the name of the Template and a Summary for the entry of a short description. Created and Modified fields are also included on this tab.