Blame | Last modification | View Log | Download
******************************************************************************* Copyright Tecnomatix Technologies Ltd. All Rights Reserved.******************************************************************************* - NOTICE -** The information contained herein is confidential information of* Tecnomatix Technologies Ltd, a Delaware corporation, and is protected by* United States copyright and trade secret law and international treaties.* This information is not to be disclosed, used or copied by or transferred* to any individual, corporation, company or other person without the* express written permission of Tecnomatix Technologies Ltd.******************************************************************************** File: AL_FMT.MLT (used to generate AL_FMT.TXT)* Purpose: Define formats used for viewing and logging alarms.** Change Log:* DATE WHO SPR DESCRIPTION* 04/05/99 knc SPR8678 Added tokens for Event alarm support* 02/15/99 knc SPR8229 Updated documentation for tokens* 07/25/97 knc SPR5180 Added formats for ASCII logfiles******************************************************************************* ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++* SECTION 1: ALARM FORMATS** PURPOSE:* The formats in this section are used to control the appearance of alarm* messages as they appear in various locations (Viewer display, print device,* database, etc.).** DESCRIPTION:* The formats defined in this section may contain a mixture of regular text* and tokens. The tokens will be replaced when the message is formatted. A* brief description of the tokens and their syntax rules are given below.* For more complete information, please see the FactoryLink documentation.** RECOGNIZED TOKENS:* The following tokens are recognized by the Distributed Alarm Task.** Token : Replaced With...* ----- : ----------------* AID : Unique Alarm ID Number* TAG : Alarm TAG Name* STS : Alarm Status (INI|ACK|NRM)* DAT : Initial Date --See (*1) below* TIM : Initial Time --See (*3) below* ADT : Acknowledge Date --See (*1) below* ATM : Acknowledge Time --See (*2) below* OPR : Acknowledge Operator* NDT : Normal Date --See (*1) below* NTM : Normal Time --See (*2) below* GMS : Group Message* MSG : Alarm Message* VA1 : Variable 1* VA2 : Variable 2* VA3 : Variable 3* VA4 : Variable 4* GRP : Group Name* ARE : Area Name* PRI : Alarm Priority* LOG : Logbook Entry Indicator* Exclamation mark '!' indicates a logbook entry, blank otherwise* ACK : Acknowledgement Indicator* Asterix '*' indicates alarm is unacknowledged, blank otherwise* LAN : LAN station ID alarm origin** The following tokens are available in FL6.5 and later:* SEQ : Alarm Sequence ID* DUR : Alarm Duration (NTM - TIM) --See (*2) below** NOTES:* (*1) The output of the tokens DAT|ADT|NDT are controlled by the DATE* keyword defined later in this file.** (*2) The output of the tokens ATM|NTM|DUR are controlled by the TIME* keyword defined later in this file.** (*3) The output of the TIM token is controlled by the HSTIME* keyword defined later in this file.** SYNTAX RULES:* * Each token must be surrounded by dollar-signs ($).* Example: $MSG$** * A length specifier may be added to force replacement text to be* a specific number of characters. If the text is longer, it is* truncated. If the text is shorter, it will be padded with blanks.* Example: $MSG40$ (truncates or pads data to exactly 40 characters)** * There must be at least one space between two tokens* Example: $DAT$ $TIM$ will work* $DAT$$TIM$ will NOT work** ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++* ***************************************************************************** ALARM VIEWER FORMATS* Purpose: These formats are used to display alarms on the Viewer.* FLCM Panel: "Alarm View Control" panel, "Line Format" column** View Format 1VIEW_1 $DAT$ $TIM$ $LOG$ $ACK$ $GMS$ $MSG$** View Format 2VIEW_2 $TIM$ $TAG16$ $GMS$ $MSG$** View Format 3VIEW_3 $DAT$ $TIM$ $LOG$ $AID5$ $STS8$ $GMS$ $MSG$** View Format 4VIEW_4 $LOG$ $OPR8$ $TIM$ $TAG16$ $GMS$ $MSG$** View Format 5VIEW_5 $LAN$ $TIM$ $LOG$ $STS4$ $GMS$ $MSG$** View Format 6VIEW_6 $TIM$ $LOG$ $GMS$ $MSG$** View Format 7VIEW_7 $TIM$ #$LAN$ $OPR8$ $TIM$ $TAG16$ $GMS$ $MSG$** View Format 8VIEW_8 $LOG$ $OPR8$ $TIM$ $TAG16$ $GMS$ $MSG$** View Format 9VIEW_9 #$LAN3$-$AID4$ at $TIM$ : $GMS$ $MSG$** Old (Pre-FL4.4) View Format Defintions* VIEW_1 $DAT$ $TIM$ $LOG$ $TAG16$ $ACK$ $GMS$ $MSG$* VIEW_5 $TIM$ : $STS8$ : $GMS$ $TAG16$* VIEW_6 $TIM$ : $OPR8$ : $AID4$ $GMS$ $MSG$* ***************************************************************************** ALARM PRINT DEVICE FORMATS* Purpose: These formats are used to print alarms on the print device* FLCM Panel: "Alarm Group Control" panel, "Active Stat Print Dev" column** Initial Alarm OccurrancePRTINI $DAT$ $TIM12$ $TAG16$ $GMS$ $MSG$** Alarm AcknowledgementPRTACK $ADT$ $ATM12$ $TAG16$ Acknowledged by: $OPR$** Alarm Return-To-NormalPRTNRM $NDT$ $NTM12$ $TAG16$ Normal Status** Alarm "Unknown State" FormatPRTUNK $DAT$ $TIM12$ $STS$ $AID$ UNKNOWN STATUS $GMS$ $MSG$ $OPR$** Event OccurancePRTEVT $DAT$ $TIM12$ EVENT $TAG16$ $GMS$ $MSG$* ***************************************************************************** ALARM PRINT ACTIVE FORMATS* Purpose: These formats are used to print active alarms on the print device* when the "Print Active" tag is triggered* FLCM Panel: "General Alarm Setup Control" panel, "Print Active Alarms Tag" col* "General Alarm Setup Control" panel, "Active List Print Device"** Active Alarm FormatPRTACT $DAT$ $TIM12$ $TAG16$ $STS$ $GMS$ $MSG$ $OPR$** Logbook Entry Format (Part 1: Operator Name)PRTOPR "\tLogbook Message from operator %s\n"** Logbook Entry Format (Part 2: Logbook Text)PRTLOG "\t%s\n"* ***************************************************************************** ALARM ASCII LOGFILE FORMATS* Purpose: These formats are used to log alarms to an ASCII text file* when the "Log Method" is set to "FILE".* They are similar to the PRTINI, PRTACK, and PRTNRM formats* FLCM Panel: "Alarm Group Control" panel, "Log" column* "Alarm Group Control" panel, "Log Method Tag" column** Initial Alarm OccurranceALFINI $DAT$ $TIM12$ $LOG$ $ACK$ $AID$ ACTIVE $GMS$ $MSG$** Alarm AcknowledgementALFACK $ADT$ $ATM12$ $LOG$ $ACK$ $AID$ Acknowledged by: $OPR$** Alarm Return-To-NormalALFNRM $NDT$ $NTM12$ $LOG$ $ACK$ $AID$ Normal Status** Alarm "Unknown State" FormatALFUNK $DAT$ $TIM12$ $LOG$ $STS$ $AID$ UNKNOWN STATUS $GMS$ $MSG$ $OPR$** Alarm "Event" OccuranceALFEVT $DAT$ $TIM12$ $AID$ EVENT: $GMS$ $MSG$* ***************************************************************************** ALARM REMOTE NOTIFICATION FORMATS* Purpose: These formats are used to send alarms to a remote notification agent* such as to email alarms to cell-phones.* Similar to the above formats, but more brief** Initial Alarm OccurranceRMTINI $TIM$ ACTIVE $GMS$ $MSG$** Alarm Acknowledgement (placeholder - currently not used)RMTACK $ATM$ ACKed by: $OPR$ ($MSG$)** Alarm Return-To-NormalRMTNRM $NTM$ Normal Status (Was: $MSG$)** ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++* SECTION 2: DATE AND TIME FORMATS** PURPOSE:* The formats in this section are used to control the appearance of date* and time stamps placed on alarms. The tokens in this section should NOT* be directly entered into any alarm format definitions in Section 1.** DESCRIPTION:* The formats defined in this section may contain a mixture of regular text and* tokens. The tokens will be replaced when the message is formatted. A brief* description of the tokens and their syntax rules are given below.* For more complete information, please see the FactoryLink documentation.** RECOGNIZED TOKENS:* The following tokens are recognized by the Distributed Alarm Task.** year: four digit year example: 1999* yr : two digit year example: 99* mo : two digit month (01 .. 12)* mon: three letter month (jan .. dec)* dy : two digit day (01 .. 31)* hr : two digit hour (00 .. 23) 24-hour clock* ah : two digit hour (01 .. 12) 12-hour clock* ap : AM/PM indicator (AM for hr < 12, PM for hr >= 12 )* mi : two digit minutes (00 .. 59)* sc : two digit seconds (00 .. 59)* mse : three digit milliseconds (000 .. 999)** NOTES:* These tokens are CASE sensitive: YR != yr** SYNTAX RULES:* No spaces are required between tokens.** ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++* ***************************************************************************** TIMESTAMP FORMATS* Purpose: These formats are used to format the time-related tokens* listed in Section 1.* FLCM Panel: "Alarm Definition Information" panel, "Time Stamp Format" column** Standard USA formatUSA yrmodyhrmisc** Standard European formatEUROPE dymoyrhrmisc*** "High Speed" USA format (with milliseconds)USA_HS yrmodyhrmiscmse** "High Speed" European format (with milliseconds)EUR_HS dymoyrhrmiscmse*** "Long" USA format (with separators)USA_L yr:mo:dy:hr:mi:sc** "Long" European format (with separators)EUR_L dy:mo:yr:hr:mi:sc*** "High Speed, Long" USA format (with milliseconds and separators)USA_HSL yr:mo:dy:hr:mi:sc.mse** "High Speed, Long" European format (with milliseconds and separators)EUR_HSL dy:mo:yr:hr:mi:sc.mse* "High Speed, Long" ISO 8601 format (with milliseconds and separators)ISO8601 year-mo-dyThr:mi:sc.mse* ***************************************************************************** VIEW DATE FORMATS* Purpose: These formats are used to format the time-related tokens* listed in Section 1.* These tokens will not be recognized if they are used directly* in an alarm view format string.** DATE FORMAT* (controls format of DAT|ADT|NDT tokens defined in Section 1)DATE mo/dy/yr** ACK/NORMAL TIME FORMAT* (controls format of ATM|NTM|DUR tokens defined in Section 1)TIME hr:mi:sc** INITIAL TIME FORMAT* (controls format of TIM token defined in Section 1)HSTIME hr:mi:sc** INITIAL TIME FORMAT (alternate defintion -- includes milliseconds)* (controls format of TIM token defined in Section 1)* To use this alternate format, comment out HSTIME above* and uncomment this version**EN HSTIME hr:mi:sc.mse**FR HSTIME hr:mi:sc.mse**DE HSTIME hr:mi:sc.mse* ***************************************************************************** DATABASE DATE FORMATS* Purpose: These formats are used to format the date and time when* logging alarms to the ALARMS database.* These tokens will not be recognized if they are used directly* in an alarm view format string.** ACK/NORMAL DATABASE TIME FORMAT* (controls format of Ack and Return-to-Normal Alarm Times in ALARM database)LOGTIME yearmodyhrmisc** INITIAL DATABASE TIME FORMAT* (controls format of Initial Alarm Time in ALARM database)LOGHSTIME yearmodyhrmisc.mse** DATABASE DATE FIELD TYPE FORMAT* (controls the formatting of the datetime string passed to the historian* for logging into a DATE type DB field. This must match the format expected* by the historian to be correctly parsed and stored. Users should normally* NOT edit this format.).DBTIMESTAMP yearmodyhrmiscmse* ***************************************************************************** MISCELLANEOUS DATE FORMATS* Purpose: These are miscellaneous formats used by the Alarm Logger Task** NAME OF ARCHIVE ALARM FILE* Used to create archive filename for the ALARMLOG.TXT file* (Archive file will be named al{ARCDATE}.txt)ARCDATE yrmody** TECNOMATIX DEBUG TIME FORMAT* (controls format of Initial Alarm Time in task debug logs)DATETIME mo/dy/year hr:mi:sc* ***************************************************************************** APPLICATION-SPECIFIC DIGITAL TAG TEXT* Purpose: These formats are used with the "%3B" format specifier to allow* application-specific text for digital tag values. If the tag* value is zero, the DIGOFF string is printed; otherwise, the* DIGON string is printed.* FLCM Panel: "Alarm Definition Information" panel, "Message Text" column*DIGON On*DIGOFF Off* ***************************************************************************** EVENT KEYWORD* This text is logged into the "Acknowledging Operator" field ('OPR') of* the alarms database. It is used to easily extract EVENT records from the* database.EVENT EVENT* ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++* SECTION 3: STANDARD TRANSLATION TOKENS* Tokens in this section are not likely to change* ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++* ***************************************************************************** TAG DATA FORMAT* Purpose: These formats are used to format data from tags listed in the* "Variable 1 Tag" .. "Variable 4 Tag" columns.* FLCM Panel: "Alarm Definition Information" panel, "Variable N Tag" columns** Digital TagDIGFMT "%1B"** Analog TagANAFMT "%d"** Float TagFLTFMT "%.3f"** Long Analog TagLANAFMT "%ld"** Message TagMSGFMT "%s"* ***************************************************************************** ALARM STATUS TEXT* Purpose: These are standard FL translation tokens for the Alarm State.** Alarm Status is NORMAL (tag value does not meet alarm condition)NORMAL Normal** Alarm Status is ACTIVE (tag value meets alarm condition)ACTIVE Active** Alarm Status is ACKNOWLEDGED (operator has acknowledged alarm)ACK Ack* ***************************************************************************** MONTH NAMES (THREE-LETTER ABBREVIATIONS)* Purpose: These are standard FL translation tokens for month names.*JAN JanFEB FebMAR MarAPR AprMAY MayJUN JunJUL JulAUG AugSEP SepOCT OctNOV NovDEC Dec