Skip to main content
Version: v4 (Stable)

Instruction File

This dialog box allows you to edit the instruction file that will be transmitted when an alarm is triggered or an user message is sent (manual or programmed call).

Event​

This field displays the reference of the alarm tag whose instruction file you want to edit. If these are instructions attached to a service message, this reference is replaced by "Service Message".

The associated alphanumeric message, previously defined for the alarm tag or for the message to be sent, is recalled in the first edit field. This message is not editable here.

Contextual File​

This option indicates that the edited file can include contextual information (prefixed with "&"), and that this information should be updated automatically when the associated alarm is set (or call is triggered if the file is associated with a service message or programmed call).

File content​

The multi-line editing field allows you to enter the desired text. This text may include tabs and line breaks.

If the "Contextual File" option is checked, the text can contain variable fields which refer to alarm parameters, using the following syntax:

&M: This field will be replaced by the alarm message (long message) defined for the tag.

  • &N: This field will be replaced by the name of the tag.
  • &R: This field will be replaced by the date path of the external variable (DDE/OPC reference or other).
  • &C: This field will be replaced by the alarm code (short message) defined for the tag.
  • &S: This field will be replaced by the name of the station attached to the tag.
  • &L: This field will be replaced by the name of the station attached to the tag only if the station is not the local station.
  • &J: This field will be replaced by the name of the data server of the tag.
  • &A: This field will be replaced by the name of the first call group associated with the tag.
  • &X: This field will be replaced by the location associated with the tag.
  • &O: This field will be replaced by the unique numeric identifier of the tag (Oid).
  • &G: This field will be replaced by the name of the base tag group associated with the tag.
  • &P: This field will be replaced by the value of the priority set for the tag.
  • &U: This field will be replaced by the name of the user who acknowledged the alarm (valid only for acknowledgment processes).
  • &D: This field will be replaced by the date and time of the alarm in the format "DD/MM/YY HH:MM:SS".
  • &V: This field will be replaced by the value of the tag when the alarm was triggered.
  • &(n): This field will be replaced by the value of the tag identified by "n" (object identifier in the tag list), when the alarm was triggered.
  • &[xxx]: This field will be replaced by the value of the tag identified by "xxx" (alphanumeric identifier (*)), when the alarm was triggered.

A field type "&(n)" can be created automatically by clicking on the button and selecting the desired tag on the main screen. It is possible to select any defined tag, even in another data server.

NOTE​

The &D, &V, &(n) fields can be supplemented by a display format shown in brackets. The display format defined here is the same as the format used to define the display format of a tag (see Tag Value). If a display format is defined at the level of the inserted tag, the display format defined here replaces it.

Example: "&V[#.0]" -> the value 12 will be replaced by 12.0

Example: "&D[dd-mm-yy hh:nn:ss]" -> the date value will be replaced by the specified format

Date format type:

  • dd or d : numerical day with or without 0
  • mm or m : numerical month with or without 0
  • yy or yyyy : year with 2 or 4 digits
  • hh or h : hours with or without 0
  • nn or n : minutes with or without 0
  • ss or s : seconds with or without 0

When the file is destined for a fax or an email, it is possible to incorporate one or more bitmaps in the instructions file by inserting at the desired line for each bitmap a line in the following format:

&F<FILE>[,<H>[,<P>]]

with:

<FILE> : Name of bitmap file (relative name or full path).

<H> (optional) : Height of the bitmap in mm, 0 by default to use the original size of the bitmap. When the bitmap is resized in height, its width is corrected in relation.

<P> (optional) : Position of the bitmap on the line: L for left alignment, R for right alignment, centered by default.

Example :

&FTest.BMP : File "Test.BMP" (in data directory of Alert) printed centered in original size

&FTest.BMP, 20, R : File "Test.BMP" (in data directory of Alert) printed right-aligned and resized with a height of 20 mm)

&FC:\Test2.BMP, 0, L : File "C:\Test2.BMP" printed left aligned in original size