This page describes how to use Alerts management features in Axiodis and corresponding key points.
Goals
Alerts management allows the system to define and send alerts (e-mail alerts, SMS, ...) to inform and prevent final users and / or customers about execution of different events and process which could require a specific monitoring as for instance :
- Sending an alert for the final customer to confirm the order integration in Axiodis
- Sending an alert for the final customer to confirm the planned date / time of a delivery
- Sending an alert for the final customer to confirm the date / time of approach of a delivery
- Sending an alert for the final customer to confirm the real date / time of a delivery
- Sending an alert about a status update for an order
- ...
Sending SMS alerts needs to have dedicated API with a phone operator.
Administration
Alerts status can be defined in "Administration" module, "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 reminder, the diagram belows show links and relations betweens 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 can be linked to business contacts (0 to n alerts for each contact)
Alerts can be defined in "Data and Constraints" module, "Alerts" screen :
The grid propose all alerts defined in the system with :
- Description of the alert : validity period, alert type, content, options, ...
- Triggers to execute the alert
Description
Alerts can be defined with following attributes :
- Validity period
Attribute | Description |
|---|---|
| Automatic process | Define if the alert has to be sent in a manual or automatic way |
| Beginning / End | Define the period of validity to send the alert in an automatic way |
- Alert type & Sending frequence
Attribute | Description |
|---|---|
| Type | Define the alert type to send :
Note : if both alerts type are active, it is possible to define the order to send alerts (first e-mail then sms, first sms then e-mail, ...) |
| Active | Define if the alert type is active or not :
|
| Sending frequence | Define the frequence to send the alert in a an automatic way :
|
| 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) |
- Alert Content (Mail / SMS)
Attribute | Description | Applicable on Mail alert | Applicable on SMS alert |
|---|---|---|---|
| Transmitter email / SMS | Define the e-mail transmitter to use for the alert for the first message and next messages (1) | Yes | No |
| Transmitter name | Define the name transmitter to use and display for the alert for the first message and next messages (1) | Yes | No |
| Carbon copy (Cc) | Define the e-mails adress to use and put in carbon copy (Cc) of the e-mail for the alert for the first message and next messages (1) | Yes | No |
| Blind carbon copy (Bcc) | Define the e-mails adress to use and put in Blind carbon copy (Bcc) of the e-mail for the alert for the first message and next messages (1) | Yes | No |
| Subject | Define the subject e-mail to use for the alert for the first message and next messages (1) | Yes | No |
| Header | Define the header e-mail to use and display for the alert for the first message and next messages (1) | Yes | Yes |
| Body | Define the body e-mail to use and display for the alert for the first message and next messages (1) | Yes | Yes |
| Footer | Define the footer e-mail to use and display for the alert for the first message and next messages (1) | Yes | Yes |
| Parameters | Define the parameters to use and display in the e-mail content for the alert for the first message and next messages (1) (2) | Yes | Yes |
(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 following rules :
(2) Content alert Parameters
Parameters grids allows to define some parameters to include in the message (body) of the alert and based on informations about routes, sequences, operations, ... :
| Attribute | Description | Example |
|---|---|---|
| Object | Define the Axiodis object to use for the parameter :
| 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 : beginning of the date/hour of delivery or collection to display in the message of the alert |
| Format | Format to apply to the attribute below for displaying 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 identifcal | Define 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 "date / hour" of the sequence and the sequence is composed of 3 operations, the system will send only one alert with the following content :
Instead of sending 3 alerts as following :
|
| Hour | Define different options about hours attributes to display in the message of the alert (available only for hours attributes) :
|
|
| Morning | Define the label to display in the message of the alert for the hour attribute if hour is defined on "Half day" value and hour < 12h | Morning, AM, ... |
| Afternoon | Define the label to display in the message of the alert for the hour attribute if hour is defined on "Half day" value and hour >= 12h | Afternoon, PM, ... |
| Rounding min | Define the value to apply the minimum rounding value for the hour attribute if hour is defined on "Half day" or "Rounded" value | -15, +15, ... |
| Rounding max | Define the value to apply the maximum rounding value for the hour attribute if hour is defined on "Rounded" value | +15, +30, +60, ... |
Icon 
displays a popup to resume the content of the alert which will be sent.
Triggers
Triggers allow to define criteria to take into account to send alerts in a automatic way (disabled if alerts are defined in a manual moode) :
- 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 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 condition on the field value) : quantity, free information, ...
- Required notification (it means that if notification is linked to an operation and defined as a criterion, an alert will be sent automatically)
TODO :
- Link with Business Contacts
- Link with Logistics Sites
Alerts can be defined in "Data and Constraints" module, "Alerts" screen :
Cockpits display
Alerts options are available in different cockpits (planning, execution management) by displaying view "Alerts" in menu "Perspectives / Windows" :
In progress. Coming soon...