Alarm Gateway Object for Wonderware Application
Contents
1. AlarmGateway_LastErrorMessage Last Error Message Read Only AlarmGateway_LastErrorCode Last Error Code No errors 0 Read Only AlarmGateway Restart Trigger if set to True then User restarts Alarm Gateway Consumer Status Current status of Alarm Gateway Read Only Note It is highly recommended to run any Alarm Gateway Object in separate Engine since Alarm Gateway uses scan interval for reading the alarms Recommended Engine scan interval for Alarm Gateway is at least 1000 ms Alarm Gateway Object User Manual Rev 1 3 P185m13 Custom attributes By using custom attributes it is possible to change following alarm data fields in Wonderware alarm system or in UReason alarm system Custom Attribute Alarming system Description SetUser1 Wonderware User defined field number 1 SetUser2 Wonderware User defined field number 2 SetUser3 Wonderware User defined field string setPriority Wonderware Alarm Event Priority setSource UReason Alarm Source setClass UReason Alarm Class Custom attributes can be set from WAS scripts with following command Syntax objectName CustomAttribute Alarm Event name value Alarm Gateway Object User Manual Rev 1 3 P185m13 setPriority Following command sets Wonderware alarming system alarm priority to 10 for alarm Generator _001 Analog_001 Lo AlarmGateway 001 setPriority Me Tagname Analog_001 Lo 10 Test 1 09 27 202. Test 1 Displaying 1 to 4 of 4 alarms Default Query 100 Complete Alarm Gateway Object User Manual Rev 1 3 P185m13 setUser3 Following command sets Wonderware alarming system alarm User 3 field to Test 1 for alarm Generator_001 Analog_001 Lo AlarmGateway_001 setUser3 Me Tagname Analog_001 Lo Test 1 Test 1 09 27 2011 10 38 24 Generator_001 Analog_001 Lo 10 200000 23 299999 09 27 2011 10 38 24 Generator_001 Analog_001 999 0 000000 0 000000 09 27 2011 10 36 16 Generator_001 ScanStateCmd 999 0 000000 0 000000 09 27 2011 10 36 16 Fl ScanStateCmd 0 000000 0 000000 Displaying 1 to 4 of 4 alarms Default Query 100 Complete Alarm Gateway Object User Manual Rev 1 3 P185m13 10 setSource Following command sets UReason alarm parameter Source to SP200 for alarm Generator _001 Analog_001 Lo AlarmGateway_001 setSource Me Tagname Analog_001 Lo SP200 Alarm Gateway Object User Manual Rev 1 3 P185m13 11 setClass Following command sets UReason alarm parameter Class Type to THP Decrease for alarm Generator O001 Analog O001 Lo AlarmGateway_001 setClass Me Tagname Analog_001 Lo THP Decrease OASYS AM Engineering user admin ols Window 2011 27 9 10 32 43 Alarm Gateway Object User Manual Rev 1 3 P185m13 12 UReason gateway Alarm Gateway Object provides functionality to send receive alarms to from Wonderware al
3. 2 ENDIF Alarm Gateway Object User Manual Rev 1 3 16 P185m13 17 Licensing Demo License installation The demo license is for free and provides an unlimited functionality but it is valid only for a limited time period After demo license expiration the Alarm Gateway will stop to provide the alarms The demo license can be obtained by sending inquiry to info wonderware fi To activate the received demo License key you need to set it to object attribute License_DemoKey If demo license is valid correct key is installed attribute License IsLicensed is true and in attribute License DemoExpirationDate is displayed expiration date after that product stops working AttributeReference_ Y Value Timestamp quaty status DemoObject_001 License_CustomerID 2496 7275 8b8b 0991 TOERE 11 46 51 578 CO Good Ok Reference DemoObject_001 License_DemoKey DemoObject_001 License_DemoExpirationDate 6 30 2011 12 00 00 AM 6 3 2011 11 46 51 578 CO Good Ok gt DemoObject 001 License DemoKey 38 FB 6F 63 08 74 7E 39 AD 26 A 6 3 2011 11 46 51 578 CO Good Ok DemoObject_001 License_IsLicensed true 6 3 2011 11 46 51 578 CO Good Ok a E amp GRO AR GEE BE Be AE 48 DemoObject_001 License_ProductID PR00185 100 6 3 2011 11 46 51 578 CO Good Ok DemoObject_001 License_SoftwareKey 6 3 2011 11 46 51 578 CO Good Ok FILE User DefaultUser Alarm Gateway Object User Manual Rev 1 3 P185m13 18 Sof
4. CO Good Ok DemoObject_001 License_5oftwareKey 199f 5cb3 5fda ab6c 6 3 2011 11 09 31 359 CO Good Ok Apply OK Cancel ATTE waten Lista FILE User DefaultUser Mode User 7 Licensing run time attributes Attribute Description Run Time Access License CustomerlD Unigue generated Read Only customer ID License DemoExpirationDate Demo license expiration Read Only date License DemoKey Demo license key User License IsLicensed If True then product is Read Only licensed License ProductlD Product ID Read Only License SoftwareKey Product software key User Alarm Gateway Object User Manual Rev 1 3 P185m13 Jun 2011 Rev 1 0 Jun 2011 Rev 1 1 Sep 2011 Rev 1 2 Sep 2011 Rev 1 3 19 WONDERWARE FINLAND Alarm Gateway Object Revision History First Release Alarm Group Hierarchy XML Associated Attribute and Description changed Custom attributes and UReason gateway added Custom attributes for UReason gateway added Mimic windows functionality added Alarm Gateway Object User Manual Rev 1 3 P185m13
5. Galaxy AlamGateway_001 UReason Mimic Path Consolel IF ELSE AND lt lt ef gt THEN ELSEIF OR J NE al MM MEM OLE bl Alarm Gateway Object User Manual Rev 1 3 P185m13 15 Mimic functionally without UReason alarming system For Alarm Gateway UReason Mimic functionality only for Wonderware alarm system without UReason the following string attributes are needed e AlarmGateway_001 Mimic Alarmname input AlarmName from provider alarms list max length 32 characters Sample SP200 Intake_Pressure_Decrease e AlarmGateway_001 Mimic InTouchWindow returns default WAS object name or user defined set in attribute setSource value e g SP200 Sample script InTouch data change script Galaxy AlarmGateway_001 Mimic InTouchWindow IF Galaxy AlarmGateway_001 Mimic InTouchWindow lt gt THEN LogMessage Show Mimic Intouch window Galaxy AlarmGateway_001 Mimic InTouchWindow Show Galaxy AlarmGateway_001 Mimic InTouchWindow Galaxy AlarmGateway_001 Mimic InTouchWindow Console Console 2 ENDIF Alarm Gateway Object User Manual Rev 1 3 P185m13 2 Edit Data Change Script IF Galaxy AlarmG ateway_001 Mimic InTouchWindow lt gt THEN LogMessage Show Mimic Intouch window Galaxy AlarmGateway_001 Mimic InT ouchWindow Show Galaxy AlarmGateway_001 Mimic InT ouchwindow Galaxy AlamGateway_001 Mimic InTouchwindow Console Console
6. the ending value of the alarm priority range Query Type Consumer QueryType Alarm query type Provider Editor Associated Attribute Description Option Name Provider Name Alarm provider name Alarm Provider AlarmBufSize Alarm buffer size Historical Buffer Size Alarm Provider AlarmHierarch Path to WAS generated Alarm Area hierarchy Group yFile file Hierarchy Default value c Program XML Files ArchestrA Framework Bin GlobalDataCache AreaHierarchy xml Alarm Provider AlarmBackup Alarm Backup XML files Location on disk Backup Location XML Location Alarm Gateway Object User Manual Rev 1 3 P185m13 Run Time Object Attributes All object attributes are grouped into following groups by prefix AlarmGateway defines attributes for Alarm Gateway general configuration and status Provider _ defines attributes for Alarm Provider configuration Consumer _ defines attributes for Alarm Consumer configuration Licence _ defines attributes for licensing Set defines custom attributes see section Custom attributes for more information The following table describes the run time only attributes for the Alarm Gateway Object Note Configurable run time attributes are described in the configuration sections For more information see Configuration section above Attribute Description Run Time Access AlarmGateway Started If true Alarm Gateway is Started Read Only and running
7. 11 10 38 24 Generator_001 4nalog_001 Lo 10 10 200000 23 299999 09 27 2011 10 38 24 Generator_001 Analog_001 999 0 000000 0 000000 09 27 2011 10 36 16 Generator_001 ScanStateCmd 999 0 000000 0 000000 09 27 2011 10 36 16 Fl ScanStateCmd 999 0 000000 0 000000 Displaying 1 to 4 of 4 alarms Default Query 100 Complete Alarm Gateway Object User Manual Rev 1 3 P185m13 setUser1 Following command sets Wonderware alarming system alarm User 1 field to 10 2 for alarm Generator_001 Analog_001 Lo AlarmGateway_001 setUserl Me Tagname Analog_001 Lo 10 2 Test 1 09 27 2011 10 38 24 Generator_001 Analog_001 Lo 10 10 200000 23 299999 09 27 2011 10 38 24 Generator_001 Analog_001 999 0 000000 0 000000 09 27 2011 10 36 16 Generator_001 ScanStateCmd 999 0 000000 0 000000 09 27 2011 10 36 16 F1 ScanStateCmd 999 0 000000 0 000000 Displaying 1 to 4 of 4 alams Default Query 100 Complete Alarm Gateway Object User Manual Rev 1 3 P185m13 setUser2 Following command sets Wonderware alarming system alarm User 2 field to 23 3 for alarm Generator_001 Analog_001 Lo AlarmGateway_001 setUser2 Me Tagname Analog_001 Lo 23 3 09 27 2011 10 38 24 Generator_001 Analog_001 Lo 10 10 200000 23 299999 09 27 2011 10 38 24 Generator _001 Analog_001 999 0 000000 0 000000 09 27 2011 10 36 16 Generator OD1 ScanStateCmd 999 0 000000 0 000000 09 27 2011 10 36 16 Fl ScanStateCmd 999 0 000000 0 000000
8. 999 By using Alarm Gateway it is possible to change the event priority by using the setPriority custom attribute For more information see the Custom attributes section setPriority later in this User Guide Connect to UReason alarming system Alarm Gateway can send alarms events from Wonderware alarming system to UReason alarming system For more information see UReason gateway section later in this User Guide Wonderware alarm providers WAS InTouch Alarm Gateway UReason alarming system Alarm Gateway Object User Manual Rev 1 3 P185m13 Configuration For general information about objects including relationships deployment and alarm distribution see the Wonderware Integrated Development Environment IDE documentation For information on configuration options for object information scripts user defined attributes UDAs or attribute extensions click Extensions Help in the Help file header General Configuration The following section describes the Object Editor options for configuration and the associated attributes Use the General tab to configure and tune the behavior of the Alarm Gateway Object Consumer Editor Option Associated Attribute Description Alarm Query Consumer AlarmQuery Consumer Alarm Query From Priority Consumer FromPriority Enter the starting value of the alarm priority range To Priority Consumer ToPriority Enter
9. Alarm Gateway Object for Wonderware Application Server User Guide Ver 1 x Rev 1 3 PR 00185 WONDERWARE FINLAND P O Box 38 FIN 00371 Helsinki Finland tel int 358 9 5404940 fax int 358 9 5413541 www wonderware fi Table of Contents ltroductiolis EE EN N EE EE EN 1 Config ralo Ee TE ORE THY FO 3 General COmiguration idos 3 R n Time Object A LIDULGS ce yy dd peta 4 Custom suile EE FA 5 Seira EE RE OR AE EE EA 6 SA RA A a emacs 7 BEKER EE OE EE YW 8 SOT SOS AE EE EE FA 9 SEES OIC E ES EE tee ER as 10 BEE MA AR RE EE FFF NE 11 URGason dae N OR EI 12 Alarm gateway UReason Mimic functionality ie see ee ee ee Re nn 18 Mimic functionally without UReason alarming system iss see ese ee ee ee ee ee ee 15 in 17 Deine License installation EE e n a E Se 17 Software key installation ve EE YF ces Sens aca toast tay ANG oe 18 Alarm Gateway Object User Manual Rev 1 3 P185m13 Alarm Gateway Object for Wonderware Application Server Introduction The Alarm Gateway Object Alarm Gateway is a basic component of Wonderware Finland Alarm Extension Pack Standard Edition and provides functionality to create separate configurable Alarm Provider for alarms coming from Wonderware Application Server WAS and or other Alarm Providers compatible with Wonderware Alarm System Alarm Gateway Application Alarm Server Consumers Alarm AlarmClient Provider Control InTouch AlarmViewerCtri Provider other Filtering and setti
10. _Pressure ROCLo AG SP200 2011 22 9 13 40 50 GenAlarms_001 Discrete_001 DSC AG GenAlarms 001 2011 22 9 13 40 47 Analog_001 Lo AG SP200 2011 22 9 13 40 20 Mimic functionality can be used for opening specific InTouch windows that are tied to UReason alarm by the Source value Alarm Gateway Object User Manual Rev 1 3 P185m13 14 Sample InTouch script IF Galaxy AlarmGateway_001 UReason Mimic Path Console1 lt gt THEN Show Galaxy AlarmGateway_001 UReason Mimic Path Console1 Galaxy AlarmGateway_001 UReason Mimic Path Console1 Console Console 1 ENDIF IF Galaxy AlarmGateway_001 UReason Mimic Path Console2 lt gt THEN Show Galaxy AlarmGateway_001 UReason Mimic Path Console2 Galaxy AlarmGateway_001 UReason Mimic Path Console2 Console Console 2 ENDIF r GRPC UREASONSA INTOUCH_ESP re E Yai a MB As LAA De BE 2 TE TT a bx Windows amp Scripts S A amp Serints ain El gt Unassigned MIESE voels EE Windows ne Tagnamelfisld Galaxy AlammGateway O01 UReasonMimicPathCons _ iN O SP200 IF Galaxy AlarmGateway_001 UReason Mimic Path Consolel lt gt THEN E SP201 7 sP202 Show Galaxy AlarmGateway_DD1 UReason Mimic Path Console1 7 Ureason Web Server Access EM Scripts Galaxy AlarmGateway_001 Mimic InTouchWindow Console Console 1 D Galaxy AlarmGateway 001 UReason Mimic Path Console1 ENDIF J Galaxy AlarmGateway DO1 UReason Mimic Path Console2
11. arming system from to UReason alarming system The following functionality is supported 1 Send new and acknowledged alarms to UReason alarm system 2 UReason functionality to show Mimic InTouch windows 3 UReason Shelved alarms functionality 4 Acknowledge Wonderware alarms from UReason alarm system The following configuration is required for UReason gateway functionality AlarmGateway_001 General UReason about Object Information Scripts UDAs Extensions Graphics Enable gateway to UReason alarming system Y ff Alarm server IPAdress 192 168 181 158 SS Port 61616 User UReasonuser Password AAA Remote Name OASYSAM ESPEventPublsher Mimic Path ID1 OASYSAM ESPConsolelRequest DI Mimic Path ID2 OASYSAM ESPConsole2Request Pn ud Local D D p H BE Name NET ESPEventPublisher ao LU Port 61617 EP TE Please refer to UReason documentation for more information about UReason alarming system Alarm Gateway Object User Manual Rev 1 3 P185m13 13 Alarm gateway UReason Mimic functionality Alarm gateway supports UReason Mimic functionality Following object attributes are used for Console1 and Console2 e AlarmGateway_001 UReason Mimic Path Console1 If user selects Show Mimic On Console1 from UReason alarm menu this attribute is changed to UReason Source value for Alarm Analog_001 Lo it is SP200 see picture below e AlarmGateway_001 UReason Mimic Path Console2 If user sel
12. ects Show Mimic On Console2 from UReason alarm menu this attribute is changed to UReason Source value for Alarm Analog_001 Lo it is SP200 see picture below DASYS AM Engineering user admin File Edit Search View Tools window Help elo 2 lt 0o G Query ff ss i aora X 1 Y Acknowledge X Clear Ko Shelve fi Purge G Details six Freeze Mi All ESP Alarms ESP Surveillance 604 Newy X G oy EM Domains Analog_001 Lo AG SP200 2011 27 9 11 19 33 ESP Surveillance Analog_001 Lo AG SP200 Open the selected Item Analog_001 LoLo AG Generator_001 Delete Analog_001 Lo AG SP200 Analog_001 LoLo AG Generator_001 Analog_001 Lo AG SP200 Acknowledge Analog_001 Lo AG Generator_001 Clear Shelve GoTo ad Rule Engine Discharge_Pressure ROCLo AG SP200 GenAlarms_001 Discrete_001 DSC AG GenAlarms_001 Discharge_Pressure ROCLo AG SP200 Run CM Model DP Decrease AG SP200 Show Mimic On Console2 Show Mimic On Consolel 9 13 41 26 Intake P Decrease AG SP200 011 22 Discharge P Increase AG SP200 2011 22 9 13 41 20 Analog_001 Lo AG SP200 2011 22 9 13 41 17 Analog_001 LoLo AG SP201 2011 22 9 13 41 17 Discharge_Pressure ROCLo AG SP200 2011 22 9 13 41 08 Analog_001 HiHi AG SP202 2011 22 9 13 41 08 THP Decrease AG SP200 2011 22 9 13 41 05 Analog_001 Hi AG SP202 2011 22 9 13 41 02 Discharge
13. ng event Priorities Supporting alarm event Custom Properties In case included in Wonderware Finland Alarm Extension Pack UReason Edition the Alarm Gateway Object provides also the functionality to send receive alarms to from Wonderware alarming system from to UReason alarming system The Alarm Gateway can be used to solve the following tasks Avoid alarm loss in high loaded systems WAS Historical alarms and events are stored in a circular buffer where the oldest entries are discarded to make room for new ones so in case there generated a lot of events then important alarms can be lost By using the Alarm Gateway it is possible to store all important alarms in separate Alarm Gateway buffer that can be done by guerying alarms events only with priorities from 1 to 998 Alarm Gateway Object User Manual Rev 1 3 P185m13 Alarm Consumers WAS alarm Alarm gateway WAS provider alarm provider larmCli Control InTouch Alarmylewer Ctrl E En FY FX H Vs Ro WAS alarm buffer Alarm Gateway contains alarms alarm buffer contains and is overloaded only important alarms with priority 1 998 with lot of events that all has priority 999 Note Alarm Gateway alarm buffer can contain about 6000 7000 alarms The total number of stored alarms depends on size of alarms Change the event priority WAS alarming system does not provide possibility to configure event priority all events have built in priority
14. tware key installation The software key enables the Alarm Gateway Object unlimited full time running without any restrictions To get and enable the software key get Product ID from object attribute License ProductID e g PR00185 100 get Customer ID from object attribute License CustomerlD copy paste it to e mail or text file or similar and provide this Customer ID string when ordering the Alarm Gateway Object when product is purchased copy the received Software Key to object attribute License_SoftwareKey If license ket is valid correct key is installed attribute License IsLicensed is set to true and product is ready for use UI vupi HEL ALLE Provider Name AlarmGatewayProvider RestartAlarmGateway false Running true ScanState true al ScanStateCmd true Modify String val xl SecurityGroup Default 3 u ShortDesc Description for AlarmGateway Reference DemoObject_0D1 License_5oftwareKey Tagname DemoObject_001 199f 5cb3 5fda ab6c AttributeReference 7 Value Timestamp Quality Sta DemoObject_001 License_CustomerlD 2496 7275 8b8b 0991 6 3 2011 11 09 31 359 CO Good Ok DemoObject_001 License_DemoExpirationDate 6 3 2011 11 09 31 359 CO Good Ok DemoObject_001 License_DemoKey 6 3 2011 11 09 31 359 CO Good Ok z DemoObject_001 License_IsLicensed true 6 3 2011 11 09 31 359 CO Good Ok DemoObject_001 License_ProductID PROD185 100 6 3 2011 11 09 31 359
Download Pdf Manuals
Related Search