Punctuality check alert


In this page, learn how to enable alerting on punctuality check updates. For more information about punctuality check, see Punctuality check.

Once you've configured alerts, you must restart the OnPunctualityCheck route in Data Integration > Routes > in space 08-ST-Alerts space for the modifications to apply.

Alerting rules 

Key principles

Prebuilt alerts on punctuality check enables users to be notified when the status of a punctuality check has changed, which means that every transition from one status – Missing-Late-Normal – to another can raise an alert and send a notification based on a set of matching rules.

The alerting criteria are specified in a decision table which checks whether the criteria are fulfilled and if yes, redirect to the recipient specified in the outcome. 

Decision tables are stored in flat files, whose location is specified in the PUNCTUALITY_ALERT_DT property in the 08-ST-Alerts space.

The content structure is composed of:

  • A header – Consists of the attribute names of the file transfer, followed by <outcome>
  • The matching criteria values – Followed by the outcome value set with one or more email addresses and/or SNMP Trap.

Note

  • If you do not specify an absolute path for the file location, Decision Insight will search for the file in the var subfolder of the installation
  • To ignore an attribute, use the keyword <any>. For more information about the matching expressions or keywords available, see the latest Axway Decision Insight documentation at Decision table.
  • The operator AND is applied on the condition attributes. 
  • (warning) The ordering matters, because once there is a match for a punctuality check, the subsequent rows are ignored.

Decision table's structure

Column Name Description Possible values
punctualityStatus
Punctuality status
  • Missing
  • Normal
  • Late
punctualityId

Identifier of the Account File Check previously configured in page Configure punctuality check on file arrival for a specific account


account Account related to the punctuality check


expectedArrivalTime
This attribute corresponds to the " Expected Arrival Time " that you have specified when you define your " Account File Check " previously configured in the section Configure punctuality check on file arrival for a specific account

Any time value with the HH:mm:ss format

<outcome>

This column contains the list of emails of the person to send the alert when the condition is checked
  and/or  to send a SNMP Trap, the string  SEND_SNMP_TRAP_FLAG .

Email addresses, comma separated
String "SEND_SNMP_TRAP_FLAG"

Example of decision table


#punctualityStatus;punctualityId;account;expectedArrivalTime;<outcome>
Missing;<any>;<any>;11:00:00;Celine DESJARDINS <"cdesjardins@acme.com"> SEND_SNMP_TRAP_FLAG
Missing;<any>;<any>;15:00:00;Jean DUPONT <"jdupont@acme.com">
Normal;<any>;<any>;<any>;Jean DUPONT <"jdupont@acme.com">
Late;<any>;<any>;<any>;Jean DUPONT <"jdupont@acme.com">, Celine DESJARDINS <"cdesjardins@acme.com">


punctualityStatus

punctualityId

account

expectedArrivalTime

<outcome>

Comment
Missing <any> <any> 11:00:00

Celine DESJARDINS <"cdesjardins@acme.com"> SEND_SNMP_TRAP_FLAG

If the punctuality Status is Missing and expected arrival time is 11:00:00

Then send:

  • an Email alert to Celine DESJARDINS <"cdesjardins@acme.com">
  • a SNMP Trap
Missing <any> <any> 15:00:00

Jean DUPONT <"jdupont@acme.com">

If the punctuality Status is Missing and expected arrival time is 15:00:00 

Then send alert to Jean DUPONT <"jdupont@acme.com">

Late <any> <any> <any>

Jean DUPONT <"jdupont@acme.com">, Celine DESJARDINS <"cdesjardins@acme.com">

If the punctuality Status is Late

Then send alert to Jean DUPONT <"jdupont@acme.com"> and Celine DESJARDINS <"cdesjardins@acme.com">

Email

Customize the notification content

As for the routing logic, you can customize the body of notification messages using a template file. A template file is a text/html file where you can add the values of the punctuality check attributes to enrich the notification. 

Indicate the location of the template file in the property PUNCTUALITY_ALERT _ EMAIL_TEMPLATE   (see. table below). 

If you do not specify an absolute path for the file location, Decision Insight will search for the file in the var folder within the installation.


The following table lists the attributes you can use in your message template to enrich a notification message:

Attribute Description
$<body.punctualityStatus>$

The punctuality status.

Example: Missing

$<body.expectedArrivalTime>$

The expected arrival time.

Example: 11:00:00

$<body.minCountExpected>$

The minimum number of files we are waiting for at the expected time.

Example: 5

$<body.nbTransfer>$

The number of files we have received at the expected time.

Example: 2

$<body.minCountReached>$

Boolean value indicating if we have received the number of file as expected.

Example: False

$<body.account>$

Account name.

Example: Amy

$<body.punctualityId>$

Account File Check identifier.

Example: Amy-RECEIVED-11:00:00


Examples of template files: 

Hello,
The punctuality status of the file check "$<body.punctualityId>$" is "$<body.punctualityStatus>$".
$<body.minCountExpected>$ file(s) expected at "$<body.expectedArrivalTime>$".
<strong>Punctuality Status Check</strong>
<br>
<table border="1">
<tr>
<th border="1" align="left"> Punctuality Status </th>
<th border="1" align="left"> Expected Arrival Time </th>
<th border="1" align="left"> Number of file expected </th>
<th border="1" align="left"> Number of file </th>
<th border="1" align="left"> Account </th>
</tr>
<tr>
<td border="1" align="right">$<body.punctualityStatus>$</td>
<td border="1" align="right">$<body.expectedArrivalTime>$</td>
<td border="1" align="right">$<body.minCountExpected>$</td>
<td border="1" align="right">$<body.nbTransfer>$</td>
<td border="1" align="right">$<body.account>$</td>
</tr>
</table>

Email account configuration

The punctuality alert is sent via email. To be able to send an alert, make sure you have an email account to use to send the email and for which you can specify the following information:  

  • Smtp server host
  • Loging
  • Password

SNMP Trap

Customize the SNMP Trap notification content

As for the email, you can customize the content of the alert using a template file. A template file is an xml file where you can add OID (object identifier) and the values of the file transfer attributes to enrich the notification. 

If you need more information on SNMP xml message, see the SNMP component documentation.

Indicate the location of the template file in the property PUNCTUALITY_ALERT _ SNMP_TEMPLATE   (see table below). 

If you do not specify an absolute path for the file location, Decision Insight will search for the file in the " var" folder within Decision Insight's installation folder.


The following table lists the attributes you can use in your message template to enrich the notification content:

Attribute Description
$<body.punctualityStatus>$

The punctuality status.

Example: Missing

$<body.expectedArrivalTime>$

The expected arrival time.

Example: 11:00:00

$<body.minCountExpected>$

The minimum number of files we are waiting for at the expected time.

Example: 5

$<body.nbTransfer>$

The number of files we have received at the expected time.

Example: 2

$<body.minCountReached>$

Boolean value indicating if we have received the number of file as expected.

Example: False

$<body.account>$

Account name.

Example: Amy

$<body.punctualityId>$

Account File Check identifier.

Example: Amy-RECEIVED-11:00:00


Example

As an example, to send a single SNMP trap message of string type, we use the below template file.

This template example uses a single object identifier (OID).

<snmp version="1">
  <entry>
    <oid>1.3.6.1.2.1.25.3.2.1.5.10</oid>
    <value>The punctuality status of the file check "$<body.punctualityId>$" is "$<body.punctualityStatus>$". $<body.minCountExpected>$ file(s) expected at "$<body.expectedArrivalTime>$". $<body.nbTransfer>$ file(s) received.</value>
  </entry>
</snmp>

SNMP configuration

To send alert sent via SNMP Trap version 2c, you need to specify the following information:

  • SNMP server host
  • SNMP server port

If you need to use an other SNMP protocol version, see the SNMP component documentation.

Snooze a notification

You may need to disable alert notifications for a specific period of time (for example, because of maintenance operations), so as to avoid flooding users with irrelevant notifications.

A snooze mode is therefore available by setting the property SNOOZE to 'true' (see table below).

Alerting related properties


property description location default value
PUNCTUALITY_ALERT_DT This is the routing logic configuration file path. Data Integration > Properties > In space 04-ST-Integration dtPunctualityAlert.txt
PUNCTUALITY_ALERT_EMAIL_TEMPLATE This is the Email content configuration file path. Data Integration > Properties > In space 04-ST-Integration emailTemplatePunctualityAlert.txt
PUNCTUALITY_ALERT_SNMP_TEMPLATE This is the SNMP Trap content configuration file path. Data Integration > Properties > In space 04-ST-Integration snmpTemplatePunctualityAlert.xml
SMTP_HOST Smtp server host Data Integration > Properties > In space 04-ST-Integration
SMTP_LOGIN Credential login Data Integration > Properties > In space 04-ST-Integration
SMTP_PASSWORD Credential password Data Integration > Properties > In space 04-ST-Integration
SNMP_HOST SNMP server host Data Integration > Properties > In space 04-ST-Integration
SNMP_PORT SNMP server port Data Integration > Properties > In space 04-ST-Integration 162
SNOOZE Boolean property to snooze the notification (snooze mode if 'true') Data Integration > Properties > In space 04-ST-Integration 'false'

Related Links