MAS Notifications

From Vendita MAS
Jump to: navigation, search

Overview

The Vendita Master Automation Sequencer (MAS) notifications allows MAS users to be contacted through email of events that occur during the execution of MAS processes. This documentation covers the following areas related to notifications using email:

  • Notification Events
  • Notification Setup
  • Process Notification Runtime Setup
  • Email Server Setup

Notification Events

Vendita Master Automation Sequencer (MAS) will allow users or groups to be notified based on the occurrence of certain events associated with process execution . These events are:

  • Process Start
  • Process Completion
  • Process Abnormal Event

The section below provides more detail on process abnormal events.

Process Abnormal Events

Process abnormal events occur when a process has not successfully run.
The table below lists the reasons for a process to be classified as abnormal.

Reason Description
Stalled Process has not started within the time expected. Note that delayed processes can still run successfully.
Killed Process was killed using the facility available on the MAS Administration Interface.
Aborted Process ran and did not complete successfully.
Watchdog Process ran and had an execution time longer than is normal.

Notification Setup

MAS has a powerful parameter management feature known as configuration management that is used to store parameters for all manner of operations. To support user email notifications, a configuration management form is provided with MAS: developed for user preference prototype. These are discussed in the next two sections.


User Preferences Form

The user preferences allows management of the preferred email address, and preferred default output. A screenshot is shown below of this form:

The user preferences form captures individual user preferences for MAS. This prototype is new to MAS and is being introduced with MAS notifications. The form created from the user preferences prototype will allow a user to select one or more of their email addresses stored in the aforementioned user information form to be used for notifications. If the user has no email addresses in their user information form, then there are no email addresses that can be used for notifications. A default user preferences form will be created for every user.

To find the user preferences form for a user, select "Entities" from the top menu, and select "form" on the drop down filter. See the screenshot below:

In the screenshot there are three forms shown. The table below describes these forms:

form Description
mas0000.user..<username>.form.user_preferences The default user preference form. This form is automatically created whenever a MAS user is created.
mas0000.user.group.<group name>.form.group_information The default group email preference form. This form is automatically created whenever a MAS group is created.
mas0000.user.<username>.form.user_information The default user information form, not currently used. Will be used in the future.

To edit any of the forms press the "Edit" button.

Group email preference forms are shown if a user is a member of one or more groups. In this example, the user is member of the "mysqldba" group.

Group Information Form

The group information form is used to store information about each MAS group. The form created from this prototype will allow one email addresses to be specified for a group. Note that email addresses are not mandatory for groups, and the email address on this form created from the group information prototype can be left blank.

The email address for a group can refer to an email group on a mail server. In order to use an email group, the email address for the group must be used, as opposed to the group name used by the email server. Note that MAS users who are part of the group, do not receive notifications due to their group membership. This is to avoid MAS users receiving multiple email messages for the same event on MAS.

A screenshot of the group information form is shown below:

New Job Notification Runtime Parameters

In the prior sections, notification events and notification setup was covered. The graphic below depicts the notification events and available notification recipients. The steps shown must be performed in order shown. At least one event must be selected before users, groups can be selected, email addresses specified. Note that demo/sample users and groups are shown.

When a user submits a process for execution with the “New Job” form, checkboxes will be used to allow any of the three events to be selected:

  • Process Start
  • Process Completion
  • Process Abnormal Event

By default the MAS user running a process will receive notifications, so long as an email address exists for the user in the user information forms, and a preferred email address(s) are selected in the user preference form. On the “New Job” form, users can also select other MAS users or MAS groups to receive notifications for the process. The new process form is shown below:

Pay attention to the checkboxes for events, users, and groups. Sample groups and users are shown in this image. The "addresses" field on the form allows one-time, "ad hoc" email addresses to be entered. Note also that when notifications are selected, the process "Run" button label changes to "Monitor". This is to remind the MAS users that the process will be monitored via notifications. Be aware that sending notifications for a process in no way impacts the performance of a process. If a failure occurs associated with notifications, there is no effect on the process that is monitored.

New Schedule Runtime Parameters

When a user schedules a process for execution with the “New Schedule” form, checkboxes will be used to allow any of the three events to be selected:

  • Process Start
  • Process Completion
  • Process Abnormal Event

By default the MAS user scheduling a process will receive notifications, so long as an email address exists for the user in the user information forms, and a preferred email address(s) are selected in the user preference form. On the “New Schedule” form, users can also select other MAS users or MAS groups to receive notifications for the process. When notifications are selected through the “New Schedule” form, notifications will be sent on every execution. It is the responsibility of the MAS user to ensure that use of notifications with the New Schedule form does not result in excessive, unwanted messages, or that the email server is not overwhelmed with messages. The screenshot below shows the form for scheduling, with notifications.Note that sample users are shown.

In this example, notifications will be delivered to the user "grace" when the process runs every day at 11:00 PM/23:00 hours, when the process completes, and if the process fails. A record of the actual output of the process can be viewed in the "jobs" menu.

Notification Failures

Notification failures occur when the email cannot be sent due and invalid or missing email address, email server failure, or network issue. Notification failures are indicated on the job screen.

Email Server Setup

The MAS Administration Page has a section for an email server to be configured for use with MAS notifications. There will be support for three email server types:

  • Microsoft Office 365
  • Microsoft MS Exchange
  • Google Gmail

You can access the MAS administration page by typing the fully qualified name for the MAS server in a web browser to reveal the page shown below:

Select "Vendita MAS Administration"

Login with the password for the admin user "mas". Once logged in, scroll down to reveal the email server setup:


Service Selection Description
Google gsuite Google Email Service
Microsoft
Office 365
office365 Microsoft Office 365
Microsoft Exchange relay Microsoft Exchange Server

If you have questions or doubts about the correct values, or need to have an account created for sending mail, please work with your email administrator.