Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


This page describes how to use Alerts management features in Axiodis and corresponding key points.

...

Alerts management allows the system to define and send alerts (e-mail alerts, SMS, ...) to inform and prevent final users and/or customers about the execution of different events and process which could require a specific monitoring as for instance :

...

Alerts status can be defined in the "Administration" module", menu "General / Status / Alerts notifications status" screen :

A workflow is dedicated for alerts status and each status can be highlighted with a customized color in the different cockpits (planning module, execution management module).

Data and constraints

...

For a reminder, the diagram belows show below shows links and relations betweens between objects about alerts : 

  • Logistics sites → Business contacts: Business contacts can be linked to logistics sites (0 to n contacts for each logistics site) 
  • Business contacts → Alerts  Alerts: Alerts can be linked to business contacts (0 to n alerts for each contact)


Alerts can be defined in the "Data and Constraints" module, "Alerts / Alerts" screen :




The grid propose proposes all alerts defined in the system with :

...

Alerts can be defined with the following attributes :


  • Validity period


Attribute
Description
Automatic processDefine if the alert has to be sent in a manual or automatic way
Beginning / EndDefine the period of validity to send the alert in an automatic way


  • Alert type & Sending frequencefrequency
Attribute
Description
Type

Define the alert type to send :

  • Mail: the alert is sent by e-mail
  • SMS: the alert is sent by SMS

Note: if both alerts type are active, it is possible to define the order to send alerts (first e-mail then smsSMS, first sms SMS then e-mail, ...)

Active

Define if the alert type is active or not :

  • Yes: the alert is active
  • No: the alert is inactive
Sending frequencefrequency

Define the frequence frequency to send the alert in a an an automatic way :

  • In real time: the alert is sent in real time (as soon as corresponding requirements are fullfilledfulfilled)
  • At a fixed time: the alert is sent at a fixed time (if corresponding requirements are fullfilledfulfilled
Exclude the alerts on routes whose scheduled departure is beyond

Define an option to exclude alerts sending for routes in the past (it means routes whose departure date/hour is higher than defined values)


Exclude the alerts on sites whose scheduled date is below

Define an option to exclude alerts sending for routes sequences (sites visits) in the past (it means sequences whose beginning date/hour of visit (delivery/collection) is higher than defined values)

...

Attribute
Description
Applicable on Mail alertApplicable on SMS alert
Transmitter email / SMSDefine the e-mail transmitter to use for the alert for the first message and the next messages (1)YesNo
Transmitter nameDefine the name transmitter to use and display for the alert for the first message and the next messages (1)YesNo
Carbon copy (Cc)Define the e-mails adress address to use and put in carbon copy (Cc) of the e-mail for the alert for the first message and the next messages (1)YesNo
Blind carbon copy (Bcc)Define the e-mails adress address to use and put in Blind carbon copy (Bcc) of the e-mail for the alert for the first message and the next messages (1)YesNo
SubjectDefine the subject e-mail to use for the alert for the first message and the next messages (1)YesNo
HeaderDefine the header e-mail to use and display for the alert for the first message and the next messages (1)YesYes
BodyDefine the body e-mail to use and display for the alert for the first message and the next messages (1)YesYes
FooterDefine the footer e-mail to use and display for the alert for the first message and the next messages (1)YesYes
ParametersDefine the parameters to use and display in the e-mail content for the alert for the first message and the next messages (1) (2)YesYes

...

(1) First message / next messages : Define some rules management about messages content to send in case of several alerts can be sent to a final customer and based on the following rules :


Image RemovedImage Added


(2) Content alert Parameters

Parameters grids allows allow to define some parameters to include in the message (body) of the alert and based on informations information about routes, sequences, operations, ... :

AttributeDescriptionExample
Object

Define the Axiodis object to use for the parameter :

  • Route
  • Sequence
  • Operation
  • Answer to notification
Sequence: Sequence object selected to display a sequence information in the message of the alert
Attribute

Define the attribute of the Axiodis object above to use for the parameter

Sequence .beginning: the beginning of the date/hour of delivery or collection to display in the message of the alert
FormatFormat to apply to the attribute below for displaying the value in the message of the alert (available only for specific attributes types: date/hour, integer, float, boolean, ...)dd/MM/yyyy HH:mm: the message will display date/hour of delivery or collection in the following format 15/02/2018 11:05
Group of identifcalidenticalDefine an option about attributes to consider to apply only one grouped sending for the alert (it means that the system will send only one alert instead of several alerts if the value if the same for attributes defined as "grouped")

If "Group of identical" is defined on the attribue attribute "date/hour" of the sequence and the sequence is composed of 3 operations, the system will send only one alert with the following content :

  • Alert 1
    • "Operation 1 to deliver 15/02/2018 11:05"
    • "Operation 2 to deliver 15/02/2018 11:05"
    • "Operation 3 to deliver 15/02/2018 11:05"

Instead of sending 3 alerts as following :

  • Alert 1 : "Operation 1 to deliver 15/02/2018 11:05"
  • Alert 2 : "Operation 1 to deliver 15/02/2018 11:05"
  • Alert 3 : "Operation 1 to deliver 15/02/2018 11:05"
Hour

Define different options about hours attributes to display in the message of the alert (available only for hours attributes) :

  • Alike : the date/hour displayed in the message of the alert is strictly the value applying the format defined ab
  • Half day : the date/hour displayed in the message of the alert is the label or value defined for "Morning" and "Afternoon" attributes below as following :
    • If hour < 12h then the date/hour displayed in the message will be "Morning" label
    • If hour >= 12h then the date/hour displayed in the message will be "Afternoon" label
  • Rounded : the date/hour displayed in the message of the alert is the value rounded to a value defined in "Rounding min" attribute below
  • Date range : the date/hour displayed in the message of the alert is the date range defined with in with "Rounding min" and "Rouding Rounding max" attributes below and rounded to the lower quarter (15 min)
  • Alike : 15/02/2018 11:05
  • Half day : 15/02/2018 Morning (because 11:05 < 12h)
  • Rounded : 15/02/2018 11:15 if "Rounding min" value = 15
  • Date range : 15/02/2018 11:15 - 15/02/2018 11:30 if "Rounding min" value = +15 and "Rounding max" value = +30
MorningDefine the label to display in the message of the alert for the hour attribute if the hour is defined on "Half day" value and the hour < 12hMorning, AM, ...
AfternoonDefine the label to display in the message of the alert for the hour attribute if the hour is defined on "Half day" value and the hour >= 12hAfternoon, PM, ...
Rounding minDefine the value to apply the minimum rounding value for the hour attribute if the hour is defined on "Half day" or "Rounded" value-15, +15, ...
Rounding maxDefine the value to apply the maximum rounding value for the hour attribute if the hour is defined on "Rounded" value+15, +30, +60, ... 

...

Triggers allow to define criteria to take into account to send alerts in a an automatic way (disabled if alerts are defined in a manual moodemode) :


  • Sequence : Following criteria on sequences level can be considered to send an alert automatically
    • Progress status of the sequence (see "Progress status" defined in Administration module, "General / Status / Progress status" screen)
    • Value of sequence attribute (by selecting a sequence field and an a condition on the field value): quantity, free information, ...
    • Required notification (it means that if notification is linked to a sequence and defined as a criterion, an alert will be sent automatically)

...

  • Transport operation : Following criteria on operations level can be considered to send an alert automatically
    • Logistics status of the operation (see "Logistics status" defined in Administration module, "General / Status / Logistics status" screen)
    • Progress status of the operation (see "Progress status" defined in Administration module, "General / Status / Progress status" screen)
    • Value of operation attribute (by selecting an operation field and an a condition on the field value) : quantity, free information, ...
    • Required notification (it means that if notification is linked to an the operation and defined as a criterion, an alert will be sent automatically)

...

Alerts can be linked to business contacts in the "Data and Constraints" module, "Alerts / Business contacts" screen :


Business contacts can be linked to logistics sites in the "Data and Constraints" module, "Logistics sites / Logistics sites" screen :

Cockpits display

...

FeatureDescription
1Routes grid

In the routes grid, the following fields are proposed about alerts :

  • Leds LEDs on alerts status: display all the routes sequences, each sequence defined by the customized icon and the color corresponds to the status of the last alert sent for this sequence
  • Alert The alert ID of the last alert sent for this sequence
  • Date/hour of the last alert sent for this sequence
2Sequences grid

In the sequences grid, the following fields are proposed about alerts :

  • Leds LEDs on alerts status: each sequence defined by the customized icon and the color corresponds to the status of the last alert sent for this sequence
  • Alert The alert ID of the last alert sent for this sequence
  • Date/hour of the last alert sent for this sequence
3Alerts view

Alerts options are available in different cockpits (planning, execution management) by displaying view "Alerts" in the menu "Perspectives / Windows" :


Alerts The alerts view display displays the historical history of all alerts sent by the system with the following informations :

  • Alert ID: Alert ID
  • Date/Hour: Date/hour of the alert sending
  • Status: Alert status
  • Type: Alert type (e-mail or SMS)
  • Sending mode: Automatic or manual
  • Route ID: Route ID concerned by the alert
  • Site: Site ID concerned by the alert
  • Operation ID: Operation ID concerned by the alert
  • Contacts: Contacts ID concerned by the alert

...

  • Send an alert : Send manually an alert for the route, sequence or operation depending of on the selected object by selecting the alert to send in the popup
  • Block sending alert : Block the sending alert for the route, sequence or operation depending of on the selected object
  • Allow sending alert : Allows the sending alert for the route, sequence or operation depending of on the selected object




www.maplink.global