Home

User Manual

Contents

1. CERTIFICATE cas db text tmcclure cer URL http pphost PORT 8085 KEEP_ALIVE TRUE Table 3 eifevtmgr cfg Chapter 1 Configuring EIF Parameter Definition Required Default PORT Defines the port on which the eifevtmgr listens Yes Define a single port or a range such as 8085 8100 KEEP ALIVE Indicates whether the socket connection is closed No True immediately after receiving a request on the listening socket CLIENT AUTH True or False turns client authentication on or off No False MESSAGE TRACE Causes the eifevtmgr to log the contents of each XML No False message sent to the EIF client This should be used with caution as the messages are verbose and may fill up the log if left on for an extended period of time Request Manager Configuration File eifreqmgr cfg Type the following command cat cas db text eifreqmgr cfg and output similar to the following displays Copyright Tb db Gb db db db db dt db db db db db db db db db C 2002 2004 GE Security All Rights Reserved eifreqmgr cfg eifreqmgr cfg 1 0 12 12 02 Supported Property Examples Non SSL connection PROTOCOL HTTP SSL connection PROTOCOL HTTPS PORT 8088 KEEP ALIVE TRUE SESSION TIMEOUT 10 MESSAGE TRACE TRUE 5 Picture Perfect External Interface User Manual RANDOM frozen pp1 70 cas src eif random pem KEYFILE cas db text facilitycommanderaix pem H PROTOCOL HTTP PORT 8088 KE
2. issssssssssssssssssssss I een 15 Alarm Process State Change Event Thostnome Droceses lormbrocesetoiel usus 17 Alarm Refresh Event Array Ihostnome Drocess lormbeirech 0 000 c cece cee ete n cence ees 18 Badge Event hostname processBadge 22 cece cece ete eee rete ete nen 21 Input Event hostname processlnputActivity 00 eee cee cece ete mene 24 Operator Event hostname processOperActivity 0 2 ccc cece eee cnet ne 24 Popup Event hostname procesSPOPUP 2 0 6 e tet e eee 25 PPRS Mode Change Event Ihostnome Drocessbpchocdechongel eee n ence es 26 Single Alarm Refresh Event hostname processSingleAlarmRefresh 00 00 c cece cence neces 26 Tour Event hostname processTourActivity 02 0 eect n I e mee 29 Event Response Object 2 535232 SNE Ee 30 EIF COMMONS TEE 30 Command Protocols EE 31 Activate Output picture activateOutput 0 cence tenn e eee 31 Force Alarm Refresh picture alarmRefresh sisse nen 32 Change Mode picture changeMode ssssssssssssssssssssssssssse ss e e esee 33 Check or Add Port picture checkAddPort 0 2 0 c cece eee e cece eee e eee e ete e 34 Disable Input Group on Micro picture disablelngrp csse 34 pisableInpuat pict re disablelriptit ut oe ET ed nee a aaa ana EEA 35 Enable Input Group Joicture enobleingorgn e 36 Enable Input Joicture engobleinput e EE cent eee E 36 Lock Door picture lockDoor
3. Picture Perfect 4 0 External Interface ii en gem KAA a 8 I E IVICVT f eu S V IM wi Ad wes wu Copyright Disclaimer Trademarks and patents Intended use Copyright O 2006 GE Security Inc All rights reserved This document may not be copied or otherwise reproduced in whole or in part except as specifically permitted under US and international copyright law without the prior written consent from GE Document number 460588003A March 2006 THE INFORMATION IN THIS DOCUMENT IS SUBJECT TO CHANGE WITHOUT NOTICE GE ASSUMES NO RESPONSIBILITY FOR INACCURACIES OR OMISSIONS AND SPECIFICALLY DISCLAIMS ANY LIABILITIES LOSSES OR RISKS PERSONAL OR OTHERWISE INCURRED AS A CONSEQUENCE DIRECTLY OR INDIRECTLY OF THE USE OR APPLICATION OF ANY OF THE CONTENTS OF THIS DOCUMENT FOR THE LATEST DOCUMENTATION CONTACT YOUR LOCAL SUPPLIER OR VISIT US ONLINE AT WWW GESECURITY COM This publication may contain examples of screen captures and reports used in daily operations Examples may include fictitious names of individuals and companies Any similarity to names and addresses of actual businesses or persons is entirely coincidental GE and the GE monogram are registered trademarks of General Electric Picture Perfect product and logo are trademarks of GE Security Other trade names used in this document may be trademarks or registered trademarks of the manufacturers or vendors of the respective products Use this
4. Tour Activity Event hostname processTourActivity Object containing all information concerning a tour transaction that has occurred Event Protocol The protocol for properly receiving Events from an EIF client requires that upon receipt of each Event the EIF client must transmit an Event Response back to Picture Perfect External Interface This is necessary to avoid the resending of Eve nts to the EIF client Ping Event hostname ping The Ping Event Object contains information concerning the state of the Picture Perfect system and EIF version Table 8 Ping Event Field Name Field Description Data Type HOST ID ID of the Picture Perfect host int PP REFRESH Flag if the alarms need to be refreshed due to a communication failure or restart boolean TPS MODE1 In a Redundant system the Primary installed machine s tps mode int 0 Standalone 1 Primary 2 Backup TPS_MODE2 In a Redundant system the Backup installed machine s tps mode int 0 Standalone 1 Primary 2 Backup VERSION Interface version string Chapter 2 Using EIF Ping Example Message lt methodCall gt lt methodName gt ppmerlin ping lt methodName gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt PP_REFRESH lt name gt lt value gt lt boolean gt 0 lt boolean gt lt value gt lt member gt lt member gt lt name gt VERSION lt name gt lt value gt lt string gt v0 5 3 lt stri
5. lt member gt lt name gt LOC_ID lt name gt lt value gt lt int gt 1793 lt int gt lt value gt lt member gt lt member gt lt name gt LOC_ST_DESC lt name gt lt value gt lt string gt STATE lt string gt lt value gt lt member gt lt member gt lt name gt LOC_DESC lt name gt lt value gt lt string gt 160 1 0 DOOR lt string gt lt value gt lt member gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 27 lt int gt lt value gt lt member gt lt member gt lt name gt LOGICAL ST _ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt PHYS_ST_ID lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt PROC_ST_ID lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt FACILTY DESC lt string gt lt value gt lt member gt lt member gt lt name gt TIMESTAMP lt name gt lt value gt lt int gt 1049568016 lt int gt lt value gt lt member gt lt member gt lt name gt SET COUNT lt name gt lt value gt lt int gt 9 lt int gt lt value gt lt member gt lt member gt lt name gt RESET_COUNT lt name gt lt value gt lt int gt 9 lt int gt lt value gt lt member gt lt struct gt lt value gt lt
6. D ID of the operator record int TIMEZONE Default time zone of the operator record int LOGIN DATE Date the operator most recently logged on int Format is in YYYYMMDD LOGIN TIME Time the operator most recently logged on int Format is in HHMMSS Get Operators Logged In Example Message lt methodCall gt lt methodName gt picture getOperatorsLoggedIn lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt SESSION lt name gt lt value gt lt string gt JH3SJ93801 lt string gt lt value gt lt member gt lt member gt lt name gt USER_ID lt name gt lt value gt lt string gt install lt string gt lt value gt lt member gt lt member gt lt name gt ADDRESS lt name gt lt value gt lt string gt 192 168 2 10 lt string gt lt value gt lt member gt lt member gt lt name gt PORT lt name gt lt value gt lt int gt 8085 lt int gt lt value gt lt member gt lt member gt lt name gt ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt TIMEZONE lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt LOGIN DATE lt name gt lt value gt lt int gt 20041215 lt int gt lt value gt lt member
7. lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt RESPONSE lt name gt lt value gt lt string gt LOCAL POLICE CALLED lt string gt lt value gt lt member gt lt member gt lt name gt USER_ID lt name gt lt value gt lt string gt jsnyder lt string gt lt value gt lt member gt lt member gt lt name gt DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member gt lt name gt HOST TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member gt lt name gt TZ lt name gt lt value gt lt string gt EDT lt string gt lt value gt lt member gt lt member gt lt name gt TIMESTAMP lt name gt lt value gt lt int gt 1049569267 lt int gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt meth
8. params addElement SESSION ID Invoke the queryOperators method on the host System out println Querying operators Vector result2 Vector server execute picture queryOperators params Print out our result for int n 0 n result2 size n System out println Operator n result2 get n Build the parameter list containing a unique session identifier only params new Vector params addElement SESSION ID final Hashtable h2 new Hashtable h2 put UTC TIME 20041215113015 Now in UTC TIME params addElement h2 Invoke the logout method on the host System out println Logging out result Hashtable server execute picture logout params Fetch the result from the RCP result set final Object logoutResult result get RESULT if logoutResult null amp amp logoutResult instanceof Boolean amp amp Boolean logoutResult booleanValue System out println Successfully logged out else System out println Logout unsuccessful eise System out println Login unsuccessful catch XmlRpcException exception System err println EifClient XML RPC Fault Integer toString exception code exception toString catch Exception exception System err println EifClient exception toString Chapter 3 Examples Sample EIF XML RPC Server in Java The following sample EIF
9. picture queryFacilities Query for all facilities on the host Query Input Groups icture queryInputGroups Query for all input groups on the host Query Inputs icture queryInputs Query for all inputs on the host Query Micro State icture queryMicroState Query for the state of the specified micro Query Modes icture queryModes Query for all modes on the host Query Operators icture queryOperators Query for all operators on the host Query Outputs H H p H p H icture queryOutputs Query for all outputs on the host Query Port State picture queryPortState Query for the state of the specified port Query Status picture queryStatus Query for status from micro 53 Picture Perfect External Interface User Manual Request Protocol If an EIF request is successfully executed Picture Perfect 4 0 returns a boolean value along with additional information in the form of an object or an array of objects Convert Date and Time picture convertDateTime This request converts the specified date and time in the specified time zone into HOST TIME Table 68 Convert Date and Time Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string N A Source date in YYYYMMDD format int N A Source time in HHMMSS format int N A Source time zone ID int Table 69 Convert Date and
10. In this chapter DRM ee ee ie EEEN ER 12 ho nasus ee een 12 XML RPC Data Types and Parameter Parsing 22222 13 SIE FU EE 13 EE 30 EEN 53 12 Picture Perfect External Interface User Manual Overview The Picture Perfect External Interface relies on XML RPC as the protocol for information transport between Picture Perfect and EIF clients XML RPC is a specification and a set of implementations that allow software running on disparate operating systems running in different environments to make procedure calls over the Internet XML RPC is basically remote procedure calling using HTTP as the transport and XML as the encoding It is designed to be as simple as possible while allowing complex data structures to be transmitted processed and returned For further information regarding XML RPC please visit http www xmlrpc com The Picture Perfect External Interface application programming interface API is divided into three areas Events Commands and Data Requests In this chapter you will find the protocol and XML RPC tag based formatting of each Picture Perfect EIF Event Command and Data Request Naming Conventions When invoking receiving EIF Events Commands or Data Requests the Picture Perfect EIF package uses the following naming conventions To receive EIF Events The object name hostname is always the name of the host running your EIF Server not necessarily the Picture Perfect server The hostname is alw
11. int O default 1 indefinite 0 number of seconds Table 24 Activate Output Output Parameters Field Name Field Description RESULT True if the command was processed successfully boolean 31 32 Picture Perfect External Interface User Manual Activate Output Example Message lt methodCall gt lt methodName gt picture activateOutput lt methodName gt lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt OUTPUT_ID lt name gt lt value gt lt int gt 897 lt int gt lt value gt lt member gt lt member gt lt name gt ACTIVATION TIME lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Force Alarm Refresh picture alarmRefresh This command forces a refresh of all alarms in the Picture Perfect buffer to be sent to the client by a subsequent hostname processAlarmRefresh EJF Event Table 25 Force Alarm Refresh Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login s
12. int Operator Event hostname processOperActivity The Operator Event Object contains information concerning an operator transaction Table 15 Operator Event Field Name Field Description Data Type DATE Date of the operator transaction in OPERATOR TIME Format in YYYYMMDD int EMP NUM Employee number of the operator that generated this transaction string FIELD ID Field ID description of record affected by the operator string HOST DATE Date of the operator transaction in HOST TIME Format in YYYYMMDD int HOST TIME Time of the operator transaction in HOST TIME Format in HHMMSS int Chapter 2 Using EIF Table 15 Operator Event continued Field Name Field Description Data Type LOGIN ID Login ID of the operator that generated this transaction string RECORD DESCRIPTION Description of the record affected by the operator string TABLE ID Table ID of the record affected by the operator string TIME Time of the operator transaction in OPERATOR TIME Format in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TRANSACTION TYPE Type of operator transaction int 1 LOGIN 2 LOGOUT 3 UPDATE 4 DELETE 5 QUERY 6 COMMAND 7 STATUS 8 SHUTDOWN 9 INSERT 10 UNKNOWN TZ Time zone that correlates to the timestamp string UTC DATE Date of the operator transaction in UTC time Format in YYYYMMDD int UTC TIME Time of the operator transaction in UTC time Form
13. name gt lt value gt lt string gt 152000125454 lt string gt lt value gt lt member gt lt member gt lt name gt ACC_RGHT_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt ACC_RGHT DESC lt name gt lt value gt lt string gt CATEGORY DESC lt string gt lt value gt lt member gt lt member gt lt name gt PID lt name gt lt value gt lt string gt 152000125454 lt string gt lt value gt lt member gt lt member gt lt name gt FNAME lt name gt lt value gt lt string gt Duke lt string gt lt value gt lt member gt lt member gt lt name gt LNAME lt name gt lt value gt lt string gt Nukem lt string gt lt value gt lt member gt lt member gt lt name gt INITS lt name gt lt value gt lt string gt DN lt string gt lt value gt lt member gt lt member gt lt name gt EMP_NUM lt name gt lt value gt lt string gt 1234 lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt FACILITY DESC lt string gt lt value gt lt member gt lt member gt lt name gt TIMESTAMP lt name gt lt value gt lt int gt 1049566233 lt int gt lt value gt lt member gt lt member gt lt name gt CREATE TIME lt name gt lt value gt lt int gt 1877507792 lt int gt lt value gt lt member gt lt member gt lt name gt SW
14. param gt lt params gt methodCall Chapter 2 Using EIF Alarm Process State Change Event hostname processAlarmProcessState The Alarm Process State Change Event Object contains all of the information concerning the change in state of an alarm including the operator s response and the alarm state Table 10 Alarm Process State Change Event Field Name Field Description Data Type ALARM ID ID of the alarm int DATE Date of alarm processing Format in YYYYMMDD int HOST DATE Date of the alarm processing in HOST TIME Format in YYYYMMDD int HOST DESC Description of the host that processed the alarm not supported string HOST ID ID of the host that processed the alarm int HOST TIME Time of the alarm processing in HOST TIME Format in HHMMSS int NGRP ID ID of the alarm s input group int LOC ID Location ID of the alarm point int PROC ST ID ID of the alarm s process state int O active 1 bumped 2 notified nan 3 notified ran 4 pending 5 completed 6 removed 7 purged RESPONSE Operator response for process state change string TABLE ID Table ID of the alarm location int TIME Time of the alarm processing Format in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone of the Picture Perfect system string USER ID Login name of operator processing alarm string UTC DATE Date of the alarm processing in UTC time For
15. param gt lt params gt lt methodResponse gt 46 Picture Perfect External Interface User Manual Set Diagnostics picture setDiagnostics This command enables or disables the specific diagnostics Table 55 Set Diagnostics Input Parameters Field Name SESSION ID Field Description Session ID used from the login Data Type string DIAGNOSTICS Long decimal value that contains all of the bitwise diagnostics flags that are to be enabled or disabled The bitwise diagnostic flags are as follows mumgr 1073741824 eifreqmgr 536870912 eifevtmgr 268435456 eflash 134217728 ucs 67 108864 evimgr 33554432 keymgr 16777216 cfgmgr 8388608 nwmdrv 4194304 pcsrvd 2097152 tracer 1048576 tcmgr 524288 mrtmgr 262144 tourmgr 131072 timer 65536 log 32768 schmgr 16384 stsmgr 8192 mreset 4096 rsndmgr 2048 snddrv 1024 revdrv 512 moddrv 256 oprmgr 128 almmgr 64 bdgmgr 32 prmgr 16 dbmgr 8 sndmgr 4 rcvmgr 2 main 1 string ENABLED Flag to determine whether the DIAGNOSTICS specified should be enabled or disabled nt LEVEL Target diagnostics level 0 9 int Chapter 2 47 Using EIF Table 56 Set Diagnostics Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Set Diagnostics Example Message lt methodCall gt lt methodName gt picture setDiagnostics lt methodName gt lt params gt lt param
16. string gt lt value gt lt member gt lt member gt lt name gt FLASH STATUS lt name gt lt value gt lt string gt INDETERMINATE lt string gt lt value gt lt member gt lt member gt lt name gt PACKETS LEFT lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt PACKETS QUEUED lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt lt params gt lt methodResponse gt Chapter 2 81 Using EIF Query Modes picture queryModes This request is a query for all modes on the host Table 108 Query Modes Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 109 Query Modes Output Parameters Field Name Field Description Data Type MODE ID ID of the mode record int MODE DESC Description of the mode record string Query Modes Example Message lt methodCall gt lt methodName gt picture queryModes lt methodName gt lt params gt lt param gt lt value gt ICYCONJ8FS lt value gt lt param gt lt params gt methodCall methodResponse params lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt MODE_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt
17. 16 lt int gt lt value gt lt member gt lt member gt lt name gt ALARM DESC lt name gt lt value gt lt string gt DOOR FORCED OPEN lt string gt lt value gt lt member gt lt member gt lt name gt DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt TIME lt name gt lt value gt lt int gt 134016 lt int gt lt value gt lt member gt lt member gt lt name gt HOST TIME lt name gt lt value gt lt int gt 134016 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt int gt 134016 lt int gt lt value gt lt member gt lt member gt lt name gt TZ lt name gt lt value gt lt string gt EDT lt string gt lt value gt lt member gt lt member gt lt name gt TABLE ID lt name gt lt value gt lt int gt 16 lt int gt lt value gt lt member gt lt member gt lt name gt PRIOR _LVL lt name gt lt value gt lt int gt 10 lt int gt lt value gt lt member gt lt member gt lt name gt HOST ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DESC lt name gt lt value gt lt string gt Host Name lt string gt lt value gt lt member gt
18. Commands Data Requests and Events properly Therefore before attempting to utilize the EIF API it is first necessary to understand the creation longevity and the removal of active sessions Session Life cycle The only way to create an active session is by using the picture loginEIF EIF Request with valid operator information and a unique SESSION ID Please be aware of the following restrictions on SESSION ID creation Table 5 Session ID Restrictions Restrictions on SESSION ID The SESSION ID cannot exceed 128 characters in length The SESSION ID must contain only alphanumeric characters An active session exists as soon as the picture loginEIF EIF Request returns a RESULT of TRUE The session will remain active from that point until either the Picture Perfect host is shutdown or the picture logout EIF Command is executed with the same SESSION ID whichever happens first Once the SESSION ID has been used to create an active session all subsequent EIF Commands and Data Requests can be invoked by passing the SESSION ID that is currently active If an invalid SESSION ID is provided then each EIF Command or Data Request will fail with a RESULT of FALSE In addition to having the ability to invoke EIF Commands and Data Requests the existence of an active session allows for the receipt of real time asynchronous EIF Events such as those that represent alarm and badge transactions that occur in a Picture Perfect system The E
19. Couldn t start HTTP server Chapter 4 Contacting technical support This chapter provides information to contact technical support in case you need assistance with your GE equipment In this chapter Contacting technical Support SEENEN EE as 98 98 Picture Perfect External Interface User Manual Contacting technical support For assistance installing operating maintaining and troubleshooting this product refer to this document and any other documentation provided If you still have questions you may contact technical support during normal business hours Monday through Friday 8 a m to 7 p m Eastern Time Protection plans are available for extended coverage Table 118 Sales and support contact information Pre sales Technical support Phone 800 428 2733 888 GESECURITY 888 437 3287 Outside the toll free area 503 885 5700 E mail None rs bctsupport ge com Fax 561 998 6160 561 998 6224 available 24 hours a day Note Be ready at the equipment before calling for technical support Online publication library Another great resource for assistance with your GE product is our online publication library available to all of our customers To access the library go to our website at the following location http www gesecurity com In the Tools area at the top click the Publication Library link After you register and log on you may search through our online library for the documentation yo
20. ERE UE MA EE KR Ra E MES 88 Java Implementation Examples ehh hh 88 Saimple EIFXME RPC Clientin Ne DEE 88 Sample EIF XML RPC Server in Java e e e e e e e eee 91 Perl Implementation Examples n ehh heh nnn 93 Sample ElF AML RPG Client Ini EE ER Sample EIF XML RPC Server in Perl sss ENEE REESEN REENEN 95 Contacting technical support i i VE ENN ar ry ar RR REV 97 Contacting technical support 98 Online publication library 0 cece cece III Hh HI hh hh 98 LACES ROTEL eege 99 vi Picture Perfect External Interface User Manual vii Preface This manual is intended for systems integrators and or network programmers seeking methods for integrating into the Picture Perfect platform using XML RPC as the communications protocol This manual provides information for a knowledgeable XML RPC programmer to interface external programs to the Picture Perfect system It is not intended as a tutorial on XML RPC programming If you need additional information on XML RPC please contact your GE Customer Support Representative for a list of recommended sources For additional information on XML RPC please visit Attp www xmlrpc com on the web Read these instructions and all ancillary documentation entirely before installing or operating this product The most current versions of this and related documentation may be found on our website Refer to Online publication library on page 98 for instructions on accessing our online publication li
21. Format is YYYYMMDD MICRO_TIME Current time in the specified time zone int Format is HHMMSS Get Micro Time Example Message methodCall lt methodName gt picture microTime lt methodName gt lt params gt lt param gt lt value gt lt string gt 0VCFZRFNJIN lt string gt lt value gt lt value gt lt int gt 1 lt int gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt MICRO DATE lt name gt lt value gt lt int gt 20041125 lt int gt lt value gt lt member gt lt member gt lt name gt MICRO TIME lt name gt lt value gt lt int gt 123015 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 67 Using EIF Get Operators Logged In picture getOperatorsLoggedin This request displays the session details for each operator currently logged on Table 88 Get Operators Logged In Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 89 Get Operators Logged In Output Parameters Field Name Field Description Data Type SESSION Session ID used by the operator s login string USER ID User ID of the operator string ADDRESS IP address of the operator s client string PORT Port number of the operator s client int
22. ID of the alarm int DATE Date of the alarm Format in YYYYMMDD int FACILITY DESC Description of the facility of the alarm location not supported string FACILITY ID ID of the facility of the alarm location int HOST DATE Date of the alarm in HOST TIME Format in YYYYMMDD int HOST DESC Description of host that processed the alarm not supported string HOST ID ID of the host that processed the alarm int HOST TIME Time of the alarm in the HOST TIME format in HHMMSS int NGRP ID ID of the alarm s input group int LOC DESC Location description of the alarm point string LOC ID Location ID of the alarm point int LOGICAL ST DESC Description of the alarm s logical state string LOGICAL ST ID ID indicating the alarm s logical state int 1 set 2 reset 3 tamper Chapter 2 Using EIF Table 18 Single Alarm Refresh Event continued Field Name Field Description Data Type PHYS ST ID ID of the alarm s physical state int 1 short 2 cut 3 open 4 closed PRIOR_LVL Priority level of the alarm int PROC ST ID ID of the alarm s process state int O active 1 bumped 2 notified 3 remote 4 pending 5 completed 6 removed 7 purged REMOVE_SET Flag that indicates if the alarm can be removed boolean REQUESTOR_ID Unique identifier that was issued in the force alarm refresh request int that is tagged to this event so that the appropriate entity receives this event RESET_COUNT Cou
23. Logout Example Message methodCall lt methodName gt picture logout lt methodName gt lt params gt lt param gt lt value gt BKTT9R32XU lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt string gt 20041215113000 lt string gt lt value gt lt member gt lt member gt lt name gt OPERATOR TIME lt name gt lt value gt lt string gt 20041215113000 lt string gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 39 Using EIF Create Operator History picture operatorHistory This command generates the specified operator history transaction writes it to operator history and causes the appropriate hostname processOperActivity EIF Events to be transmitted to all active sessions Table 43 Create Operator History Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string UTC TIME Date and Time in UTC TIME Format in YYYYMMDDHHMMSS string Ex 20041215113000 December 15th 2004 11 30AM OPERATOR_TIME Date and Time i
24. NO PASSAGE 33 DBL BDG DOOR LOCKED 34 VALID_TOGGLE 35 VALID_NOT_UNLOCK 36 TOUR_BDG 37 VALID_NO_DOOR 38 SWIPE_AND_SHOW 39 VALID_FLOOR 40 INVALID_FLOOR 42 VALID_TIMED_APB_IN 43 INVALID_TIMED_APB_IN 44 VALID_TIMED_APB_OUT 45 INVALID TIMED APB OUT Data Type CREATE TIME not supported int DATE Date the badge was read Format in YYYYMMDD int EMP NUM Employee number of the badge owner string FACILITY DESC Description of the facility where the badge was read not supported string FACILITY ID ID of the facility where the badge read occurred int FNAME First name of the badge owner string HOST DATE Date the badge was read in HOST TIME Format in YYYYMMDD int HOST DESC Description of host that processed the badge read not supported string HOST ID ID of the host that processed the badge read int HOST TIME Time the badge was read in HOST TIME Format in HHMMSS int NITS Initials of the badge owner string LNAME Last name of the badge owner string LOC DESC Location description of the device that read the badge string Chapter 2 Using EIF Table 13 Badge Event continued Field Name Field Description Data Type LOC ID Location ID of the device that read the badge int ORIG DESC Origination description of the device reading the badge string not s
25. Name Field Description Data Type SESSION ID Session ID used from the login string Table 101 Query Facilties Output Parameters Field Name Field Description FACILITY ID Facility record ID int FACILITY DESC Facility record description string Query Facilities Example Message lt methodCall gt lt methodName gt picture queryFacilities lt methodName gt lt params gt lt param gt lt value gt UC7QD2S9Q7 lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt BOCA RATON lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 5 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt CHICAGO lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt DALLAS lt string gt lt value
26. RESULT public Hashtable processAlarm Hashtable arguments System out println processAlarm arguments return RESULT public Hashtable processAlarmProcessState Hashtable arguments System out println processAlarmProcessState arguments return RESULT public Hashtable processAlarmRefresh Hashtable arguments System out println processAlarmRefresh arguments return RESULT public Hashtable processBadge Hashtable arguments System out println processBadge arguments return RESULT public static void main String args try Invoke me as lt http localhost 8080 RPC2 gt WebServer server new WebServer PORT Add a handle for the RPC OBJECT The methods defined in this class are exposed to the host S Sserver addHandler RPC OBJECT new EifServer Start the service server start catch Exception exception System err println EifServer exception toString Chapter 3 93 Examples Perl Implementation Examples In order to execute the sample Perl EIF client Server a third party XML RPC module for Perl must first be installed Please visit Attp www xmlrpc com for more information regarding XML RPC for Perl Please visit http search cpan org dist Frontier RPC to obtain the Frontier RPC Perl module that is required to execute our examples Sample EIF XML RPC Client in Perl The following sample EIF client logs in and creates a v
27. Server will accept incoming EIF Events from an EIF Event Manager and display the contents of each event that is received Notice that the EifServer class provides methods that correlate to the EIF Event methods Whenever this server receives an EIF Event the corresponding method is invoked In this example the EIF Event Manager on the Picture Perfect host should be configured with a URL set to http lt hostname gt and PORT set to 8085 In this example hostname is bct tux Note The URL should refer to the hostname of the machine running the Java EIF Server which may or may not necessarily be the Picture Perfect hostname package eifserver Copyright c 2003 2004 GE Security All Rights Reserved EifServer 1 0 5 14 2003 x import java util Hashtable import java util Vector import org apache xmlrpc public class EifServer Canned result set for RPC private final static Hashtable RESULT new Hashtable Name of the RPC object This should be the hostname of the connecting Picture Perfect host serving the events private final static String RPC OBJECT bcttux Port to run the service on private final static int PORT 8085 Static initializer for default RPC result static RESULT put RESULT Boolean TRUE 92 Picture Perfect External Interface User Manual public Hashtable ping Hashtable arguments return
28. enables the specified input Table 37 Enable Input Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string INPUT ID ID of the input being enabled int Table 38 Enable Input Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Chapter 2 37 Using EIF Enable Input Example Message lt methodCall gt lt methodName gt picture enableInput lt methodName gt lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt INPUT_ID lt name gt lt value gt lt int gt 1796 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Lock Door picture lockDoor This command locks the specified door Table 39 Lock Door Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string DOOR ID Door being locked int Table 40 Lock Door Output Parameters Field Name Field Description Data Type RESULT True if the comman
29. facilities Multiple Facilities Validate Printer picture printerqueue Validates the specified printer queue Queue Reset Micro picture resetMicro Resets the specified micro Reset Output picture resetOutput Resets an output Reset Timed APB picture resetTimedAPB Resets the Timed APB status of the specified badges Set Diagnostics picture setDiagnostics Enables or disables the specified diagnostics Set Ping Interval picture setPingInterval Sets the ping interval Tour Functions picture tourFunctions Performs the specified Guard Tours function Validate TTY picture ttyValidate Validates the specified tty port Unlock Door picture unlockDoor Unlocks a door Process Alarm picture updateAlarmProcessingState Responds to an alarm in the Picture Perfect alarm buffer Command Protocol Picture Perfect 4 0 EIF Commands always return a boolean success value and nothing more The success value explains whether or not the command was executed This differs from EIF Requests in that a request will return a boolean success value along with additional information Activate Output picture activateOutput This command activates the specified output for the specified activation time Table 23 Activate Output Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string OUTPUT ID ID of the output being activated int ACTIVATION TIME Amount of time for which to activate the output
30. gt lt member gt lt name gt LOGIN TIME lt name gt lt value gt lt int gt 123015 lt int gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt SESSION lt name gt lt value gt lt string gt AN28DJ1083 lt string gt lt value gt lt member gt lt member gt lt name gt USER_ID lt name gt lt value gt lt string gt ehartman lt string gt lt value gt lt member gt lt member gt lt name gt ADDRESS lt name gt lt value gt lt string gt 192 168 2 155 lt string gt lt value gt lt member gt lt member gt lt name gt PORT lt name gt lt value gt lt int gt 8087 lt int gt lt value gt lt member gt lt member gt lt name gt ID lt name gt lt value gt lt int gt 5 lt int gt lt value gt lt member gt lt member gt lt name gt TIMEZONE lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt LOGIN DATE lt name gt lt value gt lt int gt 20041215 lt int gt lt value gt lt member gt lt member gt lt name gt LOGIN TIME lt name gt lt value gt lt int gt 101257 lt int gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Get Host Time picture hostTime This request displays the host date and time Table 90 Get Host Time Input Parameters Field Name Field Description
31. gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 83 Using EIF Query Outputs picture queryOutputs This request is a query for all outputs on the host Table 112 Query Outputs Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 115 Query Outputs Output Parameters Field Name Field Description Data Type OUTPUT ID Output record ID int OUTPUT DESC Output record description string FACILITY ID Output facility record ID int FACILITY DESC Output facility record description string Query Outputs Example Message lt methodCall gt lt methodName gt picture queryOutputs lt methodName gt lt params gt lt param gt lt value gt 4X76LAAK3I lt value gt lt param gt lt params gt methodCall methodResponse params lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt OUTPUT_ID lt name gt lt value gt lt int gt 1795 lt int gt lt value gt lt member gt lt member gt lt name gt 0UTPUT_DESC lt name gt lt value gt lt string gt 169 1 31 OUTPUT 1 lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt GLOBAL lt string gt lt value gt lt memb
32. gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt GLOBAL lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt LOS ANGELES lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 2 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt NEW YORK lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Query Input Groups picture queryInputGroups This request is a query for all input groups on the host Table 102 Query Input Groups Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 103 Query Input Groups Output Parameters Field Name Field Description Data Type IN
33. gt lt member gt lt member gt lt name gt DBPORT lt name gt lt value gt lt int gt 1960 lt int gt lt value gt lt member gt lt member gt lt name gt DBHOST lt name gt lt value gt lt string gt pphost lt string gt lt value gt lt member gt lt member gt lt name gt DBCSM lt name gt lt value gt lt string gt lt string gt lt value gt lt member gt lt member gt lt name gt DBPASS lt name gt lt value gt lt string gt ximrofni lt string gt lt value gt lt member gt member name TERM ID lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_TYPE lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt NET_HOST_NAME lt name gt lt value gt lt string gt NETHOSTNAME lt string gt lt value gt lt member gt lt member gt lt name gt IMAGING SERVER lt name gt lt value gt lt string gt SERVER lt string gt lt value gt lt member gt lt member gt lt name gt RELEASE NUMBER lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt BUILD NUMBER lt name gt lt value gt lt int gt 232 lt int gt lt value gt lt member gt lt member gt lt name gt BUILD DATE lt name gt lt value gt lt string gt 12 08 2004 lt string gt lt value gt lt member gt lt member gt lt name gt INSTALL_OS lt name gt lt value gt lt string gt Linux lt string gt lt value gt lt me
34. gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt DIAGNOSTICS lt name gt lt value gt lt string gt 64 lt string gt lt value gt lt member gt lt member gt lt name gt ENABLED lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt LEVEL lt name gt lt value gt lt int gt 9 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt 48 Picture Perfect External Interface User Manual Set Ping Interval picture setPingInterval This command sets the specified ping interval Table 57 Set Ping Interval Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string PING INTERVAL Number of seconds to set the ping interval O disabled int VERSION Version of the interface string Table 58 Set Ping Interval Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Set Ping Interval Example Message methodCall lt methodName gt picture
35. lt int gt lt value gt lt member gt lt member gt lt name gt TABLE ID lt name gt lt value gt lt int gt 22 lt int gt lt value gt lt member gt lt member gt lt name gt BID lt name gt lt value gt lt string gt lt string gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt STATUS LINE lt name gt lt value gt lt string gt Application Part 5 lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt STATUS LINE lt name gt lt value gt lt string gt Application Reserved 0 lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt STATUS LINE lt name gt lt value gt lt string gt Application Date 20041215 lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt STATUS LINE lt name gt lt value gt lt string gt Application Time 1706 lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt STATUS_LINE lt name gt lt value gt lt string gt Application Number 299 lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt stru
36. lt member gt lt struct gt lt value gt lt param gt lt param gt lt value gt description lt value gt lt param gt lt param gt lt value gt 1 lt value gt lt param gt lt param gt lt value gt 1 lt value gt lt param gt lt param gt lt value gt 2 lt value gt lt param gt lt param gt lt value gt MASTER EOF lt value gt lt param gt lt params gt methodCall lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Validate Printer Queue picture printerqueue This command validates the specified printer queue Table 47 Validate Printer Queue Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string N A Name of the printer queue to validate string Table 48 Validate Printer Queue Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Validate Printer Queue Example Message methodCall lt methodName gt picture printerqueue lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt np1200 lt value gt lt param gt lt para
37. lt param gt lt param gt lt value gt facility lt value gt lt param gt lt param gt lt value gt 1 lt value gt lt param gt lt param gt lt value gt MASTER EOF lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 41 Using EIF Change Modes picture ppChangeMode This command changes the mode for all micros in the specified facilities and logs appropriate operator history Table 45 Change Modes Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string MODE ID ID of the mode to change to int OVERRIDE Whether or not to set the TP OVERRIDE AUTO MODE bit in the UCM message to be sent boolean to each micro 1 Setthe TP OVERRIDE AUTO MODE bit 2 Do not UTC TIME Date and Time in UTC TIME Format in YYYY MMDDHHMMSS string Ex 20041215113000 December 15th 2004 11 30AM OPERATOR TIME Date and Time in OPERATOR TIME Format in YYYY MMDDHHMMSS string Ex 20041215113000 December 15th 2004 11 30AM OPERATOR_ID ID of the operator that is changing the mode int EMPLOYEE_ID Employee ID of the operator that is changing the mode string LOGIN ID Login ID of the
38. product only for the purpose it was designed for refer to the data sheet and user documentation For the latest product information contact your local supplier or visit us online at www gesecurity com Contents Chapter 1 dip HEUTE vii Conventions used in this documents nn ese exscr oO DO EE SNE vii Safety ellene vii L ele RIF Lassalle EA ER Boon dU ebd EPOR 1 OVEIVICW n 2 External Interface Programs eesuieel i ee rere mr nennen nn 3 Picture Perfect Event Manager see ee e e e e he e eee 3 Picture Perfect Request Marndger sceau ser inean aE E ibescucpoP EE 3 ie inue Lm 4 Event Manager Configuration te 4 Request Manager Config rdaton FIle ue oet RR or e REPE Dee SEDE EE DURER Fa Ya deine 5 Diagnostics resesi rany E PETS A e wu Veneti mE VIE Hawes E ME tee head vase ede e NETTE pe e 7 Veritying EIF Is Ttlning a sseese oe ecc oS SCC AE pA UI I pU E DERE IPIE 7 Verifying Eelere VE 7 SESSION SE e MUT TTT 8 Session tee 8 iv Picture Perfect External Interface User Manual Chapter 2 USING RTE 11 OVGIVICW 12 Naming Conventions oso tisis DR re eee P E Ee El Herne Mabe eee eee tees 12 XML RPC Data Types and Parameter Parsing ehh 13 EIF EE 13 ruis 14 Pirig Eventlihostnarmie pihg ee oo lr rrr t asien Raabe 14 Alarm Event hostname processAlarm
39. ssssssssssssssssssssssssssss Ie mes e e enn 37 Logout picture lago use eta uro iu ea ee 38 Create Operator History picture operatorHistory en 39 Change Modes picture ppChangeMode ssssssssssssssssssssssss ss e essen 41 Validate Printer Queue picture printerqueue 2 ccc nen e 42 Reset Micro picture resetMicro 0 06k e em ese enne 43 Reset Output picture resetOutput eee eben e ee eene 44 Reset Timed APB picture resetTIMedAPB onna nannu cnc cence cnet e been e e en 45 Set Diagnostics picture setDiagnostics 6c cence een 46 Set Ping Interval picture setPingInterval 0 n 48 Tour Functions picture tourFunctions 0 0 00 cence s e een 49 TTY Validate picture ttyValidate iisssssssssssssssssssssssss eI eese 50 Unlock Door picture unlockDoor sssssssssssssssssssss I e e eene 51 Process Alarm picture updateAlarmProcessingState 0 2 6 cece naene eet e eee eee eh 52 EIF Data Requests He De nee 53 EIF Data Requests Method Table 53 REQUEST Protocol RETE 54 Chapter 3 Chapter 4 Convert Date and Time picture convertDateTime sss 54 Directory Listing picture directoryListing 0 cence e 55 Get Alarm Status picture getAlarmStatus 0 0 ee 56 Get Configured Devices Ipicture getConfiguredDevices sss 57 Get Diagnostics picture getDiagnostics cece cence eet b eee 58 Get History Counts Jpicture getis
40. value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt 50 Picture Perfect External Interface User Manual TTY Validate picture ttyValidate This command validates the specified tty port Table 61 TTY Validate Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string TTY NAME Name of the TTY port string MODEM TYPE Modem type the ID of the appropriate modem record in the modem table int Table 62 TTY Validate Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean TTY Validate Example Message methodCall lt methodName gt picture TTYvalidate lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt dev ttyD001 lt value gt lt param gt lt param gt lt value gt 1 lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 l
41. D int FACILITY DESC Description of the facility of the alarm location not supported string FACILITY ID ID of the facility of the alarm location int HOST DATE Date of the alarm in HOST TIME Format in YYYYMMDD int HOST DESC Description of the host that processed the badge read string not supported HOST ID ID of the host that processed the alarm int HOST TIME Time of the alarm in HOST TIME Format in HHMMSS int NGRP ID ID of the alarm s input group int LOC DESC Location description of the alarm point string LOC ID Location ID of the alarm point int LOGICAL ST DESC Description of the alarm s logical state string LOGICAL ST ID ID indicating the alarm s logical state int 1 set 2 reset 3 tamper PHYS ST ID ID of the alarm s physical state int 1 short 2 cut 3 open 4 closed PRIOR_LVL Priority level of the alarm int Chapter 2 Using EIF Table 11 Alarm Refresh Event Array continued Field Name Field Description Data Type PROC ST ID ID of the alarm s process state O active not accurate if existing alarm int REMOVE SET Flag that indicates if the alarm can be removed while in a set condition boolean RESET COUNT Number of times this alarm has been reset int RESPONSE LIST Responses for this alarm array SET COUNT Number of times this alarm has been set int TABLE ID Table ID of the alarm location int TIME Time of the alarm Format in H
42. D OPEN lt string gt lt value gt lt member gt lt member gt lt name gt DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt TIME lt name gt lt value gt lt int gt 135827 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_TIME lt name gt lt value gt lt int gt 135827 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt int gt 135827 lt int gt lt value gt lt member gt lt member gt lt name gt TZ lt name gt lt value gt lt string gt EDT lt string gt lt value gt lt member gt lt member gt lt name gt TABLE ID lt name gt lt value gt lt int gt 16 lt int gt lt value gt lt member gt lt member gt lt name gt PRIOR_LVL lt name gt lt value gt lt int gt 10 lt int gt lt value gt lt member gt lt member gt lt name gt HOST ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DESC lt name gt lt value gt lt string gt ppmerlin lt string gt lt value gt lt member gt lt member gt lt name gt LOC_ID lt name gt lt value gt lt int gt 1793 lt int gt lt value gt lt member gt lt member gt lt
43. Data Type SESSION ID Session ID used from the login string Table 91 Get Host Time Output Parameters Field Name Field Description Data Type HOST DATE Current date in HOST TIME int Format is YYYYMMDD HOST TIME Current time in HOST TIME int Format is HHMMSS Get Host Time Example Message methodCall lt methodName gt picture hostTime lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt HOST DATE lt name gt lt value gt lt int gt 20041125 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_ TIME lt name gt lt value gt lt int gt 123015 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 69 Using EIF Login picture loginEIF This request authenticates a user ID and password and creates a valid session based on the SESSION ID specified If successful subsequent EIF Events will be transmitted to the ADDRESS and PORT specified Table 92 Login Input Parameters Field Name Field Description Data Type SESSION ID Session ID to be assigned to the user ID if login is successful string USER ID User ID string PASSWORD SHA 1 digested password This must mat
44. ECEIVER PANASONIC 550 PANASONIC PROTEUS PELCO PELCOB PPRS RAN SIEBE CBAS SIMPLEX STENTOFON 9600 STENTOFON SUBHOST UCS UNIVERSAL INTRUSION VICON VIPER VISITOR Data Type array RESULT Success or failure of this request for licensing information boolean Get License Information Example Message lt methodCall gt lt methodName gt picture getLicenseInformation lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt REASON lt name gt lt value gt lt string gt VALID lt string gt lt value gt lt member gt lt member gt lt name gt EXPIRES lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt READER LIMIT lt name gt lt value gt lt int gt 256 lt int gt lt value gt lt member gt lt member gt lt name gt TERMINAL LIMIT lt name gt lt value gt lt int gt 10 lt int gt lt value gt lt member gt lt member gt lt name gt IMAGE TERMINAL LIMIT lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt CUSTOMER CODE lt name gt lt value gt lt string gt 593EGA3EJD lt string gt lt value gt lt member gt lt member gt lt name gt LICENSE KEY lt name gt lt value gt lt string gt S13H16FK UFEXVFFC 1F78S
45. ED Baud rate of the port that can be one of the following int 300 1200 2400 4800 9600 19200 38400 PARITY Parity of the port that can be one of the following string ODD EVEN NONE DATA BITS Number of data bits of the port which can be one of the following int 5 6 7 8 STOP BITS Number of stop bits of the port which can be one of the following int 1 2 INITIALIZED Initialization state of the port which can be one of the following string YES NO SND Send state of the port which can be one of the following string YES NO RCV Receive state of the port which can be one of the following string YES NO DIALING Dialing state of the port which can be one of the following string YES NO Chapter 2 85 Using EIF Table 115 Query Port State Output Parameters Field Name Field Description Data Type CONNECTED Connected state of the port which can be one of the following string YES NO Query Port State Example Message lt methodCall gt lt methodName gt picture queryPortState lt methodName gt lt params gt lt param gt lt value gt OVCFZRFNJN lt value gt lt value gt lt struct gt lt member gt lt name gt PORT ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struc
46. EP_ALIVE TRUE Table 3 eifreqmgr cfg Parameter Definition Required Default PROTOCOL Designates either HTTP or HTTPS secured protocol Yes HTTP PORT Defines the port on which the eifreqmgr listens Yes 8043 KEEP_ALIVE Indicates whether the socket connection is closed immediately after No True receiving a request on the listening socket MESSAGE TRACE Causes the eifreqmgr to log the contents of each XML message sent No False tothe EIF client This should be used with caution as the messages are verbose and may fill up the log if left on for an extended period of time Chapter 1 Configuring EIF Diagnostics When attempting to diagnose or debug issues with the EIF package there are two levels of diagnostics available to the systems integrator First Picture Perfect supports diagnostic logging through the setdiag utility command There are two flags that support each of the new EIF Programs Table A Diagnostics Action Command Turn on diags for eifevtmgr setdiag eifevtmg Turn on diags for eifreqmgr setdiag eifreqmg Turn off diags for eifevtmgr setdiag eifevtmg Turn off diags for eifreqmgr setdiag eifreqmg Second the EIF Event and Request Managers configuration files support a parameter called MESSAGE TRACE When this is set to True the Picture Perfect log file cas log log MMDD will contain the complete text of each XML RPC message being transmitted and received by the EI
47. F Event and Request Managers This can be helpful when diagnosing XML RPC message syntax issues with EIF Events Commands and Requests Verifying EIF is running When the system is running log in as root and verify that EIF is running by typing at the prompt ps ef grep eif You should get output similar to the following root 12579 17148 0 10 19 36 pts 0 0 00 eifevtmgr root 12500 17148 0 10 19 36 pts 0 0 00 eifreqmgr Verifying sessions are active There is a utility that can be used to list the active sessions that currently exist on a running Picture Perfect system This utility is called smut1 When the system is running log in as root and run smut1 as follows by typing at the prompt smutl o 1 You should get output similar to the following for each session currently logged in Dump all operators operator 0 session C3EALQF421 7 8 Picture Perfect External Interface User Manual operator 0 user id install operator 0 address 3 112 49 75 operator 0 port 8090 operator 0 id 1 operator 0 time zone 0 operator 0 login date 12 21 2004 operator 0 login time 15 53 33 operator 0 terminal 0 operator 0 facility list Total facilities 0 Number of operators currently in shared memory 1 Sessions All External Interface interactions between a client and a Picture Perfect host happen within the context of an active session Having an active session is a prerequisite to using EIF
48. GRP ID Input group record ID int INGRP DESC Input group record description string FACILITY ID Input group facility record ID int FACILITY DESC Input group facility record description int Query Input Groups Example Message methodCall lt methodName gt picture queryInputGroups lt methodName gt lt params gt lt param gt lt value gt 4X76LAAK3I lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt INGRP_DESC lt name gt lt value gt lt string gt CHECK cas log chkfs log lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt GLOBAL lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 2 lt int gt lt value gt lt member gt lt member gt lt name gt INGRP_DESC lt name gt lt value gt lt string gt CHECK cas log chkdbspace log lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int
49. HMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone of the Picture Perfect system string UTC DATE Date of the alarm in UTC time Format in YYYYMMDD int UTC TIME Time of the alarm in UTC time Format in HHMMSS int Table 12 Alarm Refresh Response Array Field Name Field Description Data Type DATE Date of alarm processing Formatted in YYYYMMDD int HOST DATE Date of the alarm in HOST DATE Formatted in YYYYMMDD int HOST TIME Time of the alarm in HOST TIME Formatted in HHMMSS int RESPONSE Operator response for process state change string TIME Time of alarm processing Formatted in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone of the Picture Perfect system string USER ID Login name of operator processing alarm string UTC DATE Date of the alarm in UTC time Formatted in YYYYMMDD int UTC TIME Time of the alarm in UTC time Formatted in HHMMSS int 19 Picture Perfect External Interface User Manual ALarm Refresh Event Array Example XML RPC lt methodCall gt lt methodName gt ppmerlin processAlarmRefresh lt methodName gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt ALARM ID lt name gt lt value gt lt int gt 16 lt int gt lt value gt lt member gt lt member gt lt name gt ALARM DESC lt name gt lt value gt lt string gt DOOR FORCE
50. IF Events will always be transmitted via XML RPC to the IP address and port number specified by the ADDRESS and PORT parameters of the picture loginEIF EIF Request that created the active session Note The EIF Events transmitted to a client have already had routing rules applied to them A client will only receive EIF Events if they have at least been setup to be routed to MONITOR It is the responsibility of the client to enforce any Facility filtering that is desired By design EIF Events from all facilities are transmitted to the client Chapter 1 9 Configuring EIF When a session is no longer needed the picture 1ogout EIF Command can be used to terminate an active session Afterwards subsequent EIF Commands and Data Requests will no longer be possible using the terminated SESSION ID Also EIF Events will no longer be transmitted to the client The following diagram displays an example sequence of events required create an active session exercise EIF Commands Data Requests and Events and terminate an active session Figure 1 EIF Session Usage Sequence Diagram EIF Session Usage Sequence Diagram Client eifevtmgr eifregmgr T T The login method registers a valid SESSION ID on the Picture Perfect host i i This allows subsequent EIF Commands and Data Requests to be invoked 1 using the same SESSION ID This also allows for the asynchronous receipt
51. IPE SHOW ACTION lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt params gt lt methodCall gt 23 24 Picture Perfect External Interface User Manual Input Event hostname processInputActivity The Input Event Object contains information concerning an input transaction Table 14 Input Event Field Name Field Description Data Type ACTIVITY_TYPE Type of input transaction int O INPUT CREATE_TIME Creation time of the input event int DATE Date of the input transaction Format in YYYYMMDD int FACILITY_ID Facility of the input transaction int HOST_DATE Date of the input transaction in HOST TIME Format in YYYYMMDD int HOST_TIME Time of the input transaction in HOST TIME Format in HHMMSS int IN_STATE Input state of the input transaction int IN STATE amp 0x03 0x01 SHORT IN STATE amp 0x03 0x02 GROUND IN STATE amp 0x03 0x03 ERROR IN STATE amp 0x04 OxO4 OPEN IN STATE amp 0x04 0x04 CLOSED RECORD DESCRIPTION Description of the input string TIME Time of the input transaction Format in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone that correlates to the timestamp string UTC DATE Date of the input transaction in UTC time Format in YYYYMMDD int UTC TIME Time of the input transaction in UTC time Format in HHMMSS
52. JN lt value gt lt value gt lt struct gt lt member gt lt name gt MICRO_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt ONLINE lt name gt lt value gt lt string gt YES lt string gt lt value gt lt member gt lt member gt lt name gt TRACE lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt PRIMARY CHANNEL lt name gt lt value gt lt string gt YES lt string gt lt value gt lt member gt lt member gt lt name gt SECONDARY CHANNEL lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt ALARM lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt RESETTING lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt ERROR lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt ACK_PENDING lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt DIAL NOW lt name gt lt value gt lt string gt lt string gt lt value gt lt member gt lt member gt lt
53. ML RPC for Java Please visit http xml apache org dist xmlrpc release v1 2 b1 to obtain the xmlrpc 1 2 b1 jar file that is required to execute our examples Sample EIF XML RPC Client in Java The following sample EIF client logs in and creates a valid session to Picture Perfect EIF queries for a list of all Picture Perfect operators and logs out It makes use of the EIF Commands picture loginEIF and picture logout It also makes uses of the EIF Data Request picture queryOperators This example attempts to connect to an EIF Request Manager on a Picture Perfect host named bct tux using port 8088 package client Title EifClient java Description Sample EIF Client For Java Copyright Copyright c 2003 2004 Company GE Security Gauthor version 1 0 import java util Vector import java util Hashtable import java lang Object import java lang Exception import org apache xmlrpc public class EifClient Session ID to use when connecting with the host private final static String SESSION ID F30350FE1B696988BOEF6E50EFB4FO7F Picture perfect host to connect to Port must match the value specified in cas db text eifreqmgr cfg Replace the hostname with the appropriate hostname private final static String SERVER URL http bcttux 8088 public static void main String args try Create an object to represent our server XmlRpcCl
54. MSS int Single Alarm Refresh Event Example XML RPC methodCall lt methodName gt ppmerlin ProcessSingleAlarmRefresh lt methodName gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt ALARM ID lt name gt lt value gt lt int gt 16 lt int gt lt value gt lt member gt lt member gt lt name gt ALARM DESC lt name gt lt value gt lt string gt DOOR FORCED OPEN lt string gt lt value gt lt member gt lt member gt lt name gt DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt TIME lt name gt lt value gt lt int gt 135827 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_TIME lt name gt lt value gt lt int gt 135827 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt int gt 135827 lt int gt lt value gt lt member gt lt member gt lt name gt TZ lt name gt lt value gt lt string gt EDT lt string gt lt value gt lt member gt lt member gt lt name gt TABLE ID lt name gt lt value gt lt int gt 16 lt int gt lt value gt lt member gt lt member gt lt name gt PRIOR_LVL lt name gt lt value gt lt in
55. Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string ALARM ID Alarm record ID int Table 97 Query Alarm Intructions Output Parameters Field Name Field Description Data Type INSTRUCTION Array of alarm instructions string Query Alarm Instructions Example Message lt methodCall gt lt methodName gt picture queryAlarmInstructions lt methodName gt lt params gt lt param gt lt value gt WRF0Z188NQ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt ALARM ID lt name gt lt value gt lt int gt 7 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt INSTRUCTION lt name gt lt value gt lt string gt VIEW CAMERA lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt INSTRUCTION lt name gt lt value gt lt string gt CALL 911 lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt 74 Picture Perfect External Interface User Manual Query Alarm Responses picture queryAlarmResponses This request is a query for all alarm responses on the h
56. QFS XFQVFBUH FCEPF lt string gt lt value gt lt member gt lt member gt lt name gt PRODUCT LIST name value lt array gt data lt value gt lt struct gt lt member gt lt name gt PRODUCT_NAME lt name gt lt value gt lt string gt BASE lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt PRODUCT_NAME lt name gt lt value gt lt string gt EIF lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt PRODUCT_NAME lt name gt lt value gt lt string gt IMAGING lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt member gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt value gt lt struct gt lt param gt lt params gt lt methodResponse gt Chapter 2 Using EIF 65 Picture Perfect External Interface User Manual Get Micro Time picture microTime This request displays the date and time for a micro in the specified time zone Table 86 Get Micro Time Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string N A ID of a time zone int Table 87 Get Micro Time Output Parameters Field Name Field Description Data Type MICRO DATE Current date in the specified time zone int
57. Time Output Parameters Field Name Field Description Data Type CONVERTED DATE Converted date in HOST TIME Format is YYYYMMDD int CONVERTED TIME Converted time in HOST TIME Format is HHMMSS int Convert Date and Time Example Message lt methodName gt picture convertDateTime lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt value gt 20041215 lt value gt lt value gt 123000 lt value gt lt value gt 5 lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt CONVERTED DATE lt name gt lt value gt lt int gt 20041215 lt int gt lt value gt lt member gt lt member gt lt name gt CONVERTED TIME lt name gt lt value gt lt int gt 73000 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 55 Using EIF Directory Listing picture directoryListing This request lists the contents of the specified directory on the host Table 70 Directory Listing Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string PATH Fully qualified path for which the directory listing should be done string Table 71 Directory Listing Output Parameters Field Name Field Description Data Type FILE Name of a file located in the sp
58. _CODE ID of the exception code for this tour function string TOUR_COMMENT Comment for this tour function string Table 60 Tour Functions Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Tour Functions Example Message lt methodCall gt lt methodName gt picture tourFunctions lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt string gt 19382712 lt string gt lt value gt lt member gt lt member gt lt name gt LOGIN ID lt name gt lt value gt string gt install lt string gt lt value gt lt member gt lt member gt lt name gt TOUR_ID lt name gt lt value gt string gt 1 lt string gt lt value gt lt member gt lt member gt lt name gt TOUR_ACTION lt name gt lt value gt string gt START lt string gt lt value gt lt member gt lt member gt lt name gt BID lt name gt lt value gt string gt 1542736879921 lt string gt lt value gt lt member gt lt member gt lt name gt TOUR_SUSPEND_TIME lt name gt lt value gt string gt 20 lt string gt lt value gt lt member gt member name TOUR EXCEPTION CODE lt name gt lt value gt string gt 4 lt string gt lt value gt lt member gt lt member gt lt name gt TOUR_COMMENT lt name gt lt value gt string gt beginning it lt string gt lt
59. alid session to Picture Perfect EIF queries for a list of all Picture Perfect operators and logs out It makes use of the EIF Commands picture loginEIF and picture logout It also makes uses of the EIF Data Request picture queryOperators This example attempts to connect to an EIF Request Manager on a Picture Perfect host named bct tux using port 8088 usr bin perl Copyright c 2003 2004 GE Security eifclient pl Sample Picture Perfect EIF Client Created 05 14 03 dk db db db FH db db db H use Frontier Client Setup the hostname port of the Picture Perfect host with EIF installed server url http bcttux 8088 session id F30350FE1B696988BOEF6E50EFBA4FO07F Setup user authentication information for a Picture Perfect Operator authentication input USER ID install PASSWORD install Make an object to represent the XML RPC server server Frontier Client new url server url debug 0 Call the remote server and get our result result server call picture loginEIF session id authentication input 1ogin successful result RESULT value if 10gin successful eq 0 print Login Failed n else print Login Successful n Query for some operators 94 Picture Perfect External Interface User Manual result server gt call picture queryOperators session id count 0 Print out every key value pair stored in t
60. ame gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 27 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DESC lt name gt lt value gt lt string gt Host Name lt string gt lt value gt lt member gt lt member gt lt name gt LOC_ID lt name gt lt value gt lt int gt 1793 lt int gt lt value gt lt member gt lt member gt lt name gt PROC_ST_ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt RESPONSE lt name gt lt value gt lt string gt LOCAL POLICE CALLED lt string gt lt value gt lt member gt lt member gt lt name gt USER_ID lt name gt lt value gt lt string gt install lt string gt lt value gt lt member gt lt member gt lt name gt TIMESTAMP lt name gt lt value gt lt int gt 1049569267 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt Alarm Refresh Event Array hostname processAlarmRefresh The Alarm Refresh Event Array Object is an array of objects containing all information concerning every existing alarm in the Picture Perfect alarm buffer Table 11 Alarm Refresh Event Array Field Name Field Description Data Type ALARM DESC Description of the alarm string ALARM ID ID of the alarm int DATE Date of the alarm Format in YYYYMMD
61. amp in the format HH int LAST COMM MINUTE Minute of the last communication timestamp in the format MM int LAST COMM SECOND Second of the last communication timestamp in the format SS int RESEND COUNT Number of packets on the resend list for the specified micro int MICRO ID ID of the micro int MICRO ADDRESS Address of the micro int UPSTREAM The ID of the upstream micro of this micro or one of the following 1 NONE 2 HOST int DOWNSTREAM ID of the downstream micro of this micro or one of the following 1 NONE 2 HOST int TYPE Type of micro which will be one of the following DIALUP NETWORK NETWORK_DIALUP DOWNSTREAM_DIALUP DIRECT_CONNECT string FLASH_STATUS Flash status of the micro which will be one of the following INDETERMINATE SCHEDULED FLASHING_COMPLETE TERMINATED REQUIRE_OPERATOR REQUEST_CRC_MSG START_BLOCK_MSG DATA_BLOCK_MSG DOWNLOAD_COMPLETE_MSG MICRO_RESET RELOAD_BADGE string PACKETS_LEFT Number of eFlash packets left to be transmitted for this micro to complete a flash int PACKETS_QUEUED Number of eFlash packets queued in total to complete a flash int 79 Picture Perfect External Interface User Manual Query Micro State Example Message methodCall lt methodName gt picture queryMicroState lt methodName gt lt params gt lt param gt lt value gt OVCFZRFN
62. ams gt lt param gt lt value gt AKE74UNUSQ lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt USER_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt NAME lt name gt lt value gt lt string gt system administrator lt string gt lt value gt lt member gt lt member gt lt name gt USERNAME lt name gt lt value gt lt string gt install lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt USER_ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt NAME lt name gt lt value gt lt string gt guardli lt string gt lt value gt lt member gt lt member gt lt name gt USERNAME lt name gt lt value gt lt string gt guard1l lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt USER_ID lt name gt lt value gt lt int gt 5 lt int gt lt value gt lt member gt lt member gt lt name gt NAME lt name gt lt value gt lt string gt guard2 lt string gt lt value gt lt member gt lt member gt lt name gt USERNAME lt name gt lt value gt lt string gt guard2 lt string gt lt value gt lt member gt lt struct gt lt value gt lt data
63. aram gt lt param gt lt value gt lt struct gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 234 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Disable Input picture disablelnput This command disables the specified input Table 33 Disable Input Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string INPUT ID ID of the input being disabled int Table 34 Disable Input Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Disable Input Example Message lt methodCall gt lt methodName gt picture disableInput lt methodName gt lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt INPUT_ID lt name gt lt value gt lt int gt 1796 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt l
64. at in HHMMSS int VALUE Value of the change to the record affected by the operator string Popup Event hostname processPopup The Popup Event Object contains information concerning an informational popup that displays to an operator with Receive System Notifications enabled Table 16 Popup Event Field Name Field Description Data Type MESSAGE CONTENT Content of a popup message string MESSAGE TYPE Type of popup message int O WARNING 1 ERROR 2 INFO 3 MESSAGE 4 QUESTION 5 WORKING 25 Picture Perfect External Interface User Manual PPRS Mode Change Event hostname processPPRSModeChange The PPRS Mode Change Event Object contains the new state of the Picture Perfect server either Primary or Backup It is generated when the server changes its state Table 17 PPRS Mode Change Event Field Name Field Description Data Type PPRS MODE New state of the Picture Perfect host int 1 PRIMARY 2 BACKUP Single Alarm Refresh Event hostname processSingleAlarmRefresh The Single Alarm Refresh Event Object contains information concerning the state of a single Picture Perfect alarm buffer entry This message is transmitted to an operator when this alarm becomes routed to an operator when it previously was not being routed Table 18 Single Alarm Refresh Event Field Name Field Description Data Type ALARM DESC Description of the alarm string ALARM ID
65. ays referenced in the URL parameter of cas db text eifevtmgr cfg When invoking EIF Events the Picture Perfect EIF package uses the following naming conventions methodCall lt methodName gt hostname method lt methodName gt lt methodCall gt For example when receiving an EIF Alarm Event the methodName would be methodCall lt methodName gt hostname processAlarm lt methodName gt lt methodCall gt EIF Commands or Data Requests The object name picture is always referenced when invoking EIF Command or Data Request methods Do not use any object name other than picture for handling EIF Commands or Data Requests When invoking EIF Commands or Data Requests the Picture Perfect EIF package uses the following naming conventions methodCall methodName picture method methodName lt methodCall gt For example to invoke the EIF Login command the methodName would be methodCall lt methodName gt picture loginEIF lt methodName gt methodCall Chapter 2 13 Using EIF XML RPC Data Types and Parameter Parsing The following data types are supported by XML RPC and used by the Picture Perfect External Interface Table 6 XML RPC Data Types Data Type Description int A signed 32 bit integer string An ASCII string that may contain NULL bytes boolean Either true or false double A double precision floating point number Accuracy may be limited in some impleme
66. brary Note A qualified service person complying with all applicable codes should perform all required hardware installation Conventions used in this document The following conventions are used in this document Bold Menu items and buttons Italic Emphasis of an instruction or point special terms File names path names windows panes tabs fields variables and other GUI elements Titles of books and various documents Blue italic Electronic version Hyperlinks to cross references related topics and URL addresses Monospace Text that displays on the computer screen Programming or coding sequences Safety terms and symbols These terms may appear in this manual A CAUTION Cautions identify conditions or practices that may result in damage to the equipment or other property A WARNING Warnings identify conditions or practices that could result in equipment damage or serious personal injury viii Picture Perfect External Interface User Manual Chapter 1 Configuring EIF This section covers the information needed to configure the Picture Perfect External Interface software In this chapter DENE elu oe pre cR he Gt pe ba ede dud External Interfoce PROB PAINS eese ger Ree ttm t RU Eig e aine COPANO consecr en ad dare oiu CR tiga eas ENEE ecd ees oes odes REE oe RU a nos Picture Perfect External Interface User Manual Overview The Picture Perfect External In
67. ch identically to the password of the string operator record in the database ADDRESS IP address of the client that is logging in string PORT Port number from which the client that is logging in will receive EIF Events from the int Picture Perfect host UTC TIME Used for logging operator history string Date and Time in UTC TIME Format YYYYMMDDHHMMSS Example 20041215113000 December 15th 2004 11 30AM OPERATOR TIME Used for logging operator history string Date and Time in OPERATOR TIME Format YYYYMMDDHHMMSS Example 20041215113000 December 15th 2004 11 30AM Table 93 Login Output Parameters Field Name Field Description Data Type RESULT True if the login was successful boolean REASON Reason for the login s RESULT which must be one of the following string VALID Credentials are valid INVALID ACCOUNT Credentials are invalid OPERATOR LIMITZNo operator license available CAS FULL The cas filesystem is full TMP FULL The tmp filesystem is full POPEN FAILED A popen failure has occurred UKNOWN An unknown error has occurred DBHOST The Informix database hostname string DBPORT nformix database port number that clients should use for making database int connections DBCSM nformix database encryption protocol information string Optional this is only populated if database encryption is enabled DBPASS nformix database password that clients should use for making database string connections Picture Perfect External Inter
68. ct gt lt member gt lt name gt STATUS_LINE lt name gt lt value gt lt string gt 0S Part 0 lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 3 Examples This section provides several examples of Picture Perfect EIF XML RPC compatible clients and servers in the Java and Perl programming languages In this chapter OEFPIBML AER pem c e oe eh gra Lod AE UES AN 88 Java Implementation Example su ume Rr Reg es 88 Perl Implementation Examples 0 ccc eens 93 88 Picture Perfect External Interface User Manual Overview The examples in this chapter successfully communicate with the Picture Perfect EIF Event and Request Managers using XML RPC You may use these examples as a starting point or guide when building your own Picture Perfect EIF clients Servers When implementing an EIF client or Server in a particular programming language it is likely that a third party XML RPC package will need to be used to facilitate communications with the Picture Perfect EIF Event and Request managers using XML RPC The following examples use XMLRPC for Java and Frontier RPC for Perl Java Implementation Examples In order to execute the sample Java EIF client Server a third party XML RPC package for Java must be accessible to your Java compiler Please visit http xml apache org for more information regarding X
69. d Description Data Type RESULT True if the port already existed False if the port was added boolean Check or Add Port Example Message lt methodCall gt lt methodName gt picture checkAddPort lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt 6202 lt value gt lt param gt lt param gt lt value gt picture lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Disable Input Group on Micro picture disableingrp This command disables the specified input group Table 31 Disable Input Group on Micro Input Parameters Field Name Field Description Data Type SESSION_ID Session ID used from the login string INGRP_ID ID ofthe input group being disabled int Table 32 Disable Input Group on Micro Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Chapter 2 35 Using EIF Disable Input Group on Micro Example Message lt methodCall gt lt methodName gt picture disableIngrp lt methodName gt lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt p
70. d was processed successfully boolean Lock Door Example Message lt methodCall gt methodName picture lockDoor methodName lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt DOOR_ID lt name gt lt value gt lt int gt 897 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt 38 Picture Perfect External Interface User Manual Logout picture logout This command terminates the specified SESSION ID Table 41 Logout Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string UTC TIME Used for logging operator history Date and Time in UTC TIME Format in string YYYYMMDDHHMMSS Ex 20041215113000 December 15th 2004 11 30AM OPERATOR_TIME Used for logging operator history Date and Time in OPERATOR TIME string Format in YYYYMMDDHHMMSS Ex 20041215113000 December 15th 2004 11 30AM Table 42 Logout Output Parameters Field Name Field Description Data Type RESULT True if the logout was successful boolean
71. e gt lt string gt NO lt string gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt 62 Picture Perfect External Interface User Manual Get Host ID picture getHostld This request displays the host ID Table 82 Get Host ID Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 83 Get Host ID Output Parameters Field Name Field Description Data Type HOST ID Database host ID of the server int Get Host ID Example Message methodCall lt methodName gt picture getHostId lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt lt name gt HOST ID name value boolean 1 boolean value member lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Get License Information picture getLicenselnformation This request retrieves the license information for all licensed packages Table 84 Get License Information Input Parameters Chapter 2 Using EIF Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 85 Get License Information Output Parameters Field Name Field Description Data Type REASON S
72. e gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt 52 Picture Perfect External Interface User Manual Process Alarm picture updateAlarmProcessingState This command responds to the alarm specified by the alarm ID input group ID and the input ID in the Picture Perfect alarm buffer Table 65 Process Alarm Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string RESPONSE Operator response string USER ID Operator login name string HOST ID Alarm host record ID int INGRP ID Alarm input group ID int LOC ID Location Input record ID int PROC ST ID Processing state ID int 4 acknowledge 5 remove 7 purge ALARM ID Alarm record ID int Table 66 Process Alarm Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Process Alarm Example Message lt methodCall gt lt methodName gt picture updateAlarmProcessingState lt methodName gt lt params gt lt param gt lt value gt LSIPOTAPWW lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESPONSE lt name gt lt value gt AREA IS FLOODED lt value gt lt member gt lt member gt lt name gt USER_ID lt name
73. ecified PATH The Directory Listing string request will return an array of FILE key value parts one for each file in the specified PATH Directory Listing Example Message lt methodName gt picture directoryListing lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt value gt lt struct gt lt member gt lt name gt PATH lt name gt lt value gt lt string gt cas db backup lt string gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt FILE lt name gt lt value gt lt string gt backup 1216 lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt FILE lt name gt lt value gt lt string gt backup 1217 lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt FILE lt name gt lt value gt lt string gt backup 1218 lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Get Alarm Status picture getAlarmStatus This request retrieves the general alarm status information of the alarm buffer Table 72 Get A
74. ent Response Object Force Alarm Refresh ea 32 ENEE EE 56 Get Configured DEVICES iiir etgin 57 Get BIE EAO LO oo eris oii Pe HORE EE 58 Get History Counts Get History Flags e Get Host Di un reto rer t PR Buer D ride P Re ia oe de PUER RR e ERR QE Get Host BE Get License Information esee eint renti in ere nenn Get Micro Time nao aee mitten riri ee E TE E Get Operators Logged In Loek DOOP 37 Eege dereen TE TAE 3 69 Ium 3 38 Operator Event Object entrent eter tenere ete 24 Ping Event Ee Popup Event Object iss PPRS Mode Change Event Obiect cece ees ceseeseeseesceeeeeteeeesseeeenes 26 DDESCHIO EE 4 ESCHEID PR geet AAA ee ersteren 4 100 Picture Perfect Import Export User Manual E vii Process Ali essen 52 publication MDLALY EE 98 Query ACCESS dui m 72 Query Alarm Instructions seseseseeseeeeeen eee enn 73 Query Alarm Responses 74 Query Eaciliti S e ined reete erar ree Ra e Ug ue Pe e o inge 3 75 Query Input Groups riter Feed retroceso 76 Query Inputs ied tite e Ge rr end n sat P Oe PUR e a RE Hed TI Query Micro State csiis ie Breed 78 Query Modes Query Operators see rre EES 3 82 EE LCE 83 Query Pot State TEE 84 QUEL YES TALUS cioe eege Pe Pavo Fede 86 Te E 4 TE E 4 remote clients ano eere ro ee EUR E HERRERA RE eo 2 Request Protocol u u u eto eet atre repere deer 54 Re
75. er gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt OUTPUT_ID lt name gt lt value gt lt int gt 1796 lt int gt lt value gt lt member gt lt member gt lt name gt 0UTPUT_DESC lt name gt lt value gt lt string gt 169 1 32 OUTPUT 2 lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt BOCA RATON lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt 84 Picture Perfect External Interface User Manual Query Port State picture queryPortState This request is a query for the state of the specified port Table 114 Query Port State Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string PORT ID ID of the port whose state should be queried If you specify 1 then the state of all int ports will be returned Table 115 Query Port State Output Parameters Field Name Field Description Data Type PORT ID ID of the port int PORT NAME Name of the port string FILE HANDLE File handle of the port int FIRST MICRO ID ID of the first micro on this port int MODEM TYPE Type of modem on this port int SPE
76. er gt lt name gt TIME lt name gt lt value gt lt int gt 131033 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_TIME lt name gt lt value gt lt int gt 131033 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt int gt 131033 lt int gt lt value gt lt member gt lt member gt lt name gt TZ lt name gt lt value gt lt string gt EDT lt string gt lt value gt lt member gt lt member gt lt name gt ACTIVITY_TYPE lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt CLASSIFICATION TYPE lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt CLASSIFICATION DESC lt name gt lt value gt lt string gt OPEN lt string gt lt value gt lt member gt lt member gt lt name gt HOST_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_DESC lt name gt lt value gt lt string gt HOST DESC lt string gt lt value gt lt member gt lt member gt lt name gt LOC_ID lt name gt lt value gt lt int gt 897 lt int gt lt value gt lt member gt lt member gt lt name gt LOC_DESC lt name gt lt value gt lt string gt 160 1 0 DOOR lt string gt lt value gt lt member gt lt member gt lt name gt AREA_DESC lt name gt lt value gt lt string gt AREA_DESC lt string gt lt value gt lt member gt lt member gt lt name gt BID lt
77. essage lt methodCall gt lt methodName gt picture changeMode lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt MODE ID lt name gt lt value gt lt int gt 5 lt int gt lt value gt lt member gt lt member gt lt name gt OVERRIDE lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt 34 Picture Perfect External Interface User Manual Check or Add Port picture checkAddPort This command checks for the existence of the specified port and adds it to the etc services file if it does not already exist Table 29 Change Mode Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string N A Port to be checked or added string N A Hostname upon which the port should be checked or added string Table 30 Change Mode Output Parameters Field Name Fiel
78. face User Manual Table 93 Login Output Parameters continued Field Name Field Description Data Type int TERM ID Imaging terminal ID terminal record that corresponds to this client according to the IP address provided using the ADDRESS parameter HOST TYPE Type of Picture Perfect system the client is connecting to which will be one of the int following 1 STANDALONE 2 PRIMARY 3 BACKUP 4 NETHOST 5 SUBHOST NET HOST NAME Hostname of the network host string Optional this is only populated if connecting to a subhost in a Picture Perfect Enterprise System IMAGING SERVER Hostname of the imaging server string Optional this is only populated if connecting to a host that uses a remote imaging server to provide its image database RELEASE NUMBER Picture Perfect host s release level int BUILD NUMBER Picture Perfect host s build level int BUILD DATE Picture Perfect host s buld date string INSTALL OS Picture Perfect host s operating system type string PACKAGE COUNT Number of Picture Perfect packages installed int PACKAGE LIST Array of objects that contain the PACKAGE NAME and PATCH LEVEL pairs of array information for every Picture Perfect package installed PACKAGE NAME Name of a Picture Perfect package that is installed string PATCH LEVEL Patch level of a Picture Perfect package that is installed int Login Example Message methodCall methodName pict
79. gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt BOCA RATON lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 Using EIF Query Inputs picture queryInputs This request is a query for all inputs on the host Table 104 Query Inputs Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 105 Query Inputs Output Parameters Field Name Field Description Data Type INPUT ID Input record ID int INPUT DESC Input record description string FACILITY ID Input facility record ID int FACILITY DESC Input facility record description int Query Inputs Example Message lt methodCall gt lt methodName gt picture queryInputs lt methodName gt lt params gt lt param gt lt value gt 4X76LAAK3I lt value gt lt param gt lt params gt methodCall methodResponse params lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt INPUT_ID lt name gt lt value gt lt int gt 1795 lt int gt lt value gt lt member gt lt member gt lt name gt INPUT_DESC lt name gt lt value gt lt string gt 169 1 16 INPUT 1 lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt
80. gt lt name gt UTC_TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member gt lt name gt TZ lt name gt lt value gt lt string gt EDT lt string gt lt value gt lt member gt lt member gt lt name gt TIMESTAMP lt name gt lt value gt lt int gt 1049569267 lt int gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt Tour Event hostname processTourActivity The Tour Event Object contains information concerning a tour transaction Table 20 Tour Event Chapter 2 Using EIF Field Name Field Description Data Type AREA DESC Description of the area string CREATE TIME Creation time of the tour event int DATE Date of the tour transaction Format in YYYYMMDD int EMP NUM Employee number of the individual performing the tour string FACILITY ID Facility of the tour transaction int HOST DATE Date of the tour transaction in HOST TIME Format in YYYYMMDD int HOST TIME Time of the tour transaction in HOST TIME Format in HHMMSS int IN STATE nput state of the tour transaction int N STATE amp 0x03 0x01 SHORT N STATE amp 0x03 0x022 GROUND N STATE amp 0x03 0x03 ERROR N STATE amp 0x04 0x04 OPEN N STATE amp 0x04 0x04 CLOSED INITS nitials of the individual
81. gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt STATUS REQUEST lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt MODEM lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Get Diagnostics picture getDiagnostics This request displays the diagnostics that are currently enabled Table 76 Get Diagnostics Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 77 Get Diagnostics Output Parameters Field Name Field Description Data Type DIAGNOSTICS Long decimal value that contains all of the bitwise diagnostics flags that are to be string enabled or disabled The bitwise diagnostic flags are as follows mumgr 1073741824 eifreqmgr 536870912 eifevtmgr 268435456 eflash 134217728 ucs 67108864 evimgr 33554432 keymgr 16777216 cfgmgr 8388608 nwmdrv 4194304 pcsrvd 2097152 tracer 1048576 tcmgr 524288 mrtmgr 262144 tourmgr 131072 timer 65536 log 32768 schmgr 16384 stsmgr 8192 mreset 4096 rsndmgr 2048 snddrv 1024 revdrv 512 moddrv 256 oprmgr 128 almmgr 64 bdgmgr 32 prmgr 16 dbmgr 8 sndmgr 4 rcvmgr 2 main 1 LEVEL Current diagnostics level 0 9 int Chapter 2 59 Using EIF Get Diagno
82. gt lt value gt admin lt value gt lt member gt lt member gt lt name gt HOST ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 17 lt int gt lt value gt lt member gt lt member gt lt name gt LOC ID lt name gt lt value gt lt int gt 200 lt int gt lt value gt lt member gt lt member gt lt name gt PROC ST ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt ALARM ID lt name gt lt value gt lt int gt 7 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt EIF Data Requests Chapter 2 Using EIF This section describes the data requests supported by the API EIF Data Requests Method Table Table 67 EIF Data Requests Method Command Name Convert Date and Time Method Name icture convertDateTime Command Description Converts the specified date time timezone into HOST TIME Directory Listing icture directoryListing Lists the contents of the specified directory on the host Get Alarm Status ict
83. he result my count result while count ne my count pointer result count foreach i keys pointer printf 25s s n i pointer i printf n count count 1 Logout of the remote server result server gt call picture logout session id 1ogout successful result gt RESULT gt value if 1ogout successful eq 0 print Logout Failed n else print Logout Successful n end of Successful Login Chapter 3 Examples Sample EIF XML RPC Server in Perl The following sample EIF Server will accept incoming EIF Events from an EIF Event Manager and display the contents of each event that is received Notice that the methods hash table contains a correlation between EIF Event methods and Perl subroutines Whenever this server receives an EIF Event the corresponding method s subroutine is invoked In this example the EIF Event Manager on the Picture Perfect host should be configured with a URL set to http lt hostname gt RPC2 and PORT set to 8085 In this example hostname is bcttux Note The URL should refer to the hostname of the machine running the Perl EIF Server which may or may not necessarily be the Picture Perfect hostname usr bin perl Copyright c 2003 2004 GE Security eifserver pl Sample Picture Perfect EIF Server Created 05 14 03 dk db db db db db db H use Frontier Daemon F
84. ient server new XmlRpcClient SERVER URL Build a hash table containing arguments to the login RPC method about to be invoked on the host final Hashtable h new Hashtable h put USER ID install Picture Perfect username h put PASSWORD 89fb5llffe93ee7826661cale3bb468dclad0ff2 Password h put ADDRESS 192 168 2 10 IP Address of client h put PORT new Integer 8085 Port of client to receive EIF Events h put UTC TIME 20041215113015 Now in UTC TIME h put OPERATOR TIME 20041215113015 Now in OPERATOR TIME Build the parameter list containging a unique session identifier and the argument block just constructed above Vector params new Vector params addElement SESSION ID params addElement h Invoke the loginEIF method on the host System out printlin Executing loginEIF Hashtable result Hashtable server execute picture loginEIF params Fetch the result from the RCP result set final Object loginResult result get RESULT if loginResult null amp amp loginResult instanceof Boolean amp amp Boolean loginResult booleanValue System out println Successfully logged in Chapter 3 Examples 89 90 Picture Perfect External Interface User Manual Build the parameter list containing a unique session identifier only K params new Vector
85. ine state of the micro which will be one of the following string YES NO PENDING ONLINE PENDING OFFLINE TRACE Trace state of the micro which will be one of the following string YES or NO PRIMARY CHANNEL Primary channel state of the micro which will be one of the following string YES or NO SECONDARY CHANNEL Secondary channel state of the micro which will be one of the following string YES or NO ALARM Slarm state of the micro which will be one of the following string YES or NO RESETTING Reset state of the micro which will be one of the following string YES or NO ERROR Error state of the micro which will be one of the following string YES or NO ACK PENDING Ack pending state of the micro which will be one of the following string YES or NO DIAL NOW Dial now state of the micro will be one of the following string YES or NO state not yet initialized DIALING Dialing state of the micro will be one of the following string YES or NO state not yet initialized CONNECTED Connection state of the micro which will be one of the following string YES or NO LAST COMM MONTH Month of the last communication timestamp in the format MM int Table 107 Query Micro State Output Parameters continued Field Name LAST COMM DAY Field Description Day of the last communication timestamp in the format DD Data Type int Chapter 2 Using EIF LAST COMM HOUR Hour of the last communication timest
86. istoryCounts lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt ALARM HISTORY lt name gt lt value gt lt int gt 1203 lt int gt lt value gt lt member gt lt member gt lt name gt BADGE HISTORY lt name gt lt value gt lt int gt 52823 lt int gt lt value gt lt member gt lt member gt lt name gt EVENT HISTORY lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt OPERATOR HISTORY lt name gt lt value gt lt int gt 892 lt int gt lt value gt lt member gt lt member gt lt name gt TOUR_HISTORY lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt SYSTEM HISTORY lt name gt lt value gt lt int gt 7628 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 61 Using EIF Get History Flags picture getHistoryFlags This request displays the history time to archive flags Table 80 Get History Counts Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 81 Get History Counts Output Parameters Field Name Field Description Data Type ALARM HISTORY State indicating if it is time to archive ala
87. larm Status Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 73 Get Alarm Status Output Parameters Field Name Field Description LAST INPUT ID ID of the last alarm input int LAST ALARM ID ID of the last alarm int NUMBER ACTIVE Total number of active alarms in the buffer int NUMBER PENDING Total number of pending alarms in the buffer int Get Alarm Status Example Message lt methodName gt picture getAlarmStatus lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt LAST INPUT _ID lt name gt lt value gt lt int gt 31 lt int gt lt value gt lt member gt lt member gt lt name gt LAST ALARM ID lt name gt lt value gt lt int gt 15 lt int gt lt value gt lt member gt lt member gt lt name gt NUMBER_ACTIVE lt name gt lt value gt lt int gt 77 lt int gt lt value gt lt member gt lt member gt lt name gt NUMBER_PENDING lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 57 Using EIF Get Configured Devices picture getConfiguredDevices This request displays the counts of configured devices on the system Tab
88. le 74 Get Configured Devices Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 75 Get Configured Devices Output Parameters Field Name Field Description Data Type MICRO Number of micros configured on the system int PORT Number of ports configured on the system int OPERATOR Number of operators configured on the system int HOST Number of hosts configured on the system int TAPE DRIVE Number of tape drives configured on the system int STATUS REQUEST Number of status requests on the system int MODEM Number of modems configured on the system int Get Configured Devices Example Message lt methodName gt picture getConfiguredDevices lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt MICRO lt name gt lt value gt lt int gt 15 lt int gt lt value gt lt member gt lt member gt lt name gt PORT lt name gt lt value gt lt int gt 17 lt int gt lt value gt lt member gt lt member gt lt name gt OPERATOR lt name gt lt value gt lt int gt 32 lt int gt lt value gt lt member gt lt member gt lt name gt HOST lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt TAPE DRIVE lt name
89. lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Reset Output picture resetOutput This command resets the specified output Table 51 Reset Output Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string OUTPUT ID ID of the output being reset int Table 52 Reset Output Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Reset Output Example Message methodCall lt methodName gt picture resetOutput lt methodName gt lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt OUTPUT_ID lt name gt lt value gt lt int gt 897 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 l
90. lue gt lt member gt lt member gt lt name gt REQUESTOR_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt TIMESTAMP lt name gt lt value gt lt int gt 1049569107 lt int gt lt value gt lt member gt lt member gt lt name gt SET_COUNT lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt RESET_COUNT lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt RESPONSE LIST lt name gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt RESPONSE lt name gt lt value gt lt string gt LOCAL POLICE CALLED lt string gt lt value gt lt member gt lt member gt lt name gt USER_ID lt name gt lt value gt lt string gt jsnyder lt string gt lt value gt lt member gt lt member gt lt name gt DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member gt lt name gt HOST TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member
91. m gt lt param gt lt value gt lt struct gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt string gt 20041215113000 lt string gt lt value gt lt member gt lt member gt lt name gt OPERATOR TIME lt name gt lt value gt lt string gt 20041215113000 lt string gt lt value gt lt member gt lt member gt lt name gt OPERATOR ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt EMPLOYEE ID lt name gt lt value gt lt string gt E30 lt string gt lt value gt lt member gt lt member gt lt name gt LOGIN ID lt name gt lt value gt lt string gt install lt string gt lt value gt lt member gt lt member gt lt name gt TERMINAL ID lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt TRANSACTION TYPE lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt TABLE ID lt name gt lt value gt lt string gt 43 lt string gt lt value gt lt member gt lt member gt lt name gt RECORD DESCRIPTION lt name gt lt value gt lt string gt 1 1 0 LOBBY DOOR lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt string gt 1 lt string gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt param gt lt value gt description lt value gt lt param gt lt param gt lt value gt 1 1 0 WEST LOBBY DOOR lt value gt
92. m s logical state string LOGICAL ST ID ID indicating the alarm s logical state int 1 set 2 reset 3 tamper PHYS_ST_ID ID of the alarm s physical state int 1 short 2 cut 3 open 4 closed PRIOR_LVL Priority level of the alarm int 15 16 Picture Perfect External Interface User Manual Table9 Alarm Event continued Field Name Field Description Data Type PROC ST ID ID of the alarm s process state int O active 1 bumped 2 notified 3 remote 4 pending 5 completed 6 removed 7 purged REMOVE_SET Flag that indicates if the alarm can be removed while in a set condition boolean RESET COUNT Count of the number of times this alarm has been reset in the Picture int Perfect alarm buffer SET COUNT Count of the number of times this alarm has been set in the Picture int Perfect alarm buffer TABLE ID Table ID of the alarm location int TIME Time of the alarm Format in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone of the Picture Perfect system string UTC DATE Date of the alarm in UTC time Format in YYYYMMDD int UTC TIME Time of the alarm in UTC time Format in HHMMSS int ALarm Event Example XML RPC methodCall lt methodName gt ppmerlin processAlarm lt methodName gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt ALARM ID lt name gt lt value gt lt int gt
93. mat in YYYYMMDD int UTC TIME Time of the alarm processing in UTC time Format in HHMMSS int Alarm Process State Change Event Example XML RPC lt methodCall gt lt methodName gt ppmerlin processAlarmProcessState lt methodName gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt ALARM ID lt name gt lt value gt lt int gt 16 lt int gt lt value gt lt member gt lt member gt lt name gt DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt 17 18 Picture Perfect External Interface User Manual lt member gt lt name gt UTC_TIME lt name gt lt value gt lt int gt 140107 lt int gt lt value gt lt member gt lt member gt lt name gt TZ lt name gt lt value gt lt string gt EDT lt string gt lt value gt lt member gt lt member gt lt name gt TABLE ID lt name gt lt value gt lt int gt 16 lt int gt lt value gt lt member gt lt member gt lt name gt HOST ID lt n
94. mber gt lt member gt lt name gt PACKAGE COUNT lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt PACKAGE LIST lt name gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt PACKAGE NAME lt name gt lt value gt lt string gt base lt string gt lt value gt lt member gt name PATCH LEVEL lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt 72 Picture Perfect External Interface User Manual Query Access Points picture queryAccessPoints This request is a query for all access points on the host Table 94 Query Access Points Input Parameters Field Name Field Description Data Type SESSION ID session ID used from the login string Table 95 Query Access Points Output Parameters Field Name Field Description Data Type DOOR ID Door record ID int DOOR DESC Door record description string SENSOR ID Door input sensor record ID int REX ID Door exit request input ID int STRIKE ID Door strike output ID int READER ID Reader ID associated with door int DOOR FORCED INGRP ID Door forced input group record ID int DOOR HELD INGRP ID Door held input group record ID int PREALARM INGRP ID Doo
95. member gt lt name gt DOOR FORCED INGRP_ID lt name gt lt value gt lt int gt 27 lt int gt lt value gt lt member gt lt member gt lt name gt DOOR HELD INGRP_ID lt name gt lt value gt lt int gt 26 lt int gt lt value gt lt member gt lt member gt lt name gt PREALARM INGRP_ID lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt Chapter 2 73 Using EIF lt member gt lt name gt INVALID BADGE INGRP_ID lt name gt lt value gt lt int gt 19 lt int gt lt value gt lt member gt lt member gt lt name gt LOST BADGE INGRP_ID lt name gt lt value gt lt int gt 20 lt int gt lt value gt lt member gt lt member gt lt name gt SUSPENDED BADGE INGRP_ID lt name gt lt value gt lt int gt 21 lt int gt lt value gt lt member gt lt member gt lt name gt UNKNOWN BADGE INGRP_ID lt name gt lt value gt lt int gt 22 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt BOCA RATON lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Query Alarm Instructions picture queryAlarminstructions This request is a query for all alarm instructions for a particular alarm on the host Table 96 Query Alarm Instructions Input
96. member gt lt name gt MODE DESC lt name gt lt value gt lt string gt NORMAL lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt MODE ID lt name gt lt value gt lt int gt 2 lt int gt lt value gt lt member gt lt member gt lt name gt MODE DESC lt name gt lt value gt lt string gt HOLIDAY lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt MODE ID lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt MODE DESC lt name gt lt value gt lt string gt NORMAL lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt 82 Picture Perfect External Interface User Manual Query Operators picture queryOperators This request is a query for all operators on the host Table 110 Query Operator Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 111 Query Operator Output Parameters Field Name Field Description Data Type USER ID Operator record ID int NAME Name of operator string USERNAME Operator login name string Query Operator Example Message lt methodCall gt lt methodName gt picture queryOperators lt methodName gt lt par
97. ms gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 43 Using EIF Reset Micro picture resetMicro This command resets the specified micro Table 49 Reset Micro Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string MICRO ID ID of the micro being reset int CLEAR Expert Use Only Determines whether or not all of the badge records int known to this micro should be cleared from the micro relation table Unless told otherwise always set this to 0 Must be one of the following O nothing 1 clear badge records from micro_relation table Table 50 Reset Micro Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Reset Micro Example Message lt methodCall gt lt methodName gt picture resetMicro lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt MICRO_ID lt name gt lt value gt lt int gt 13 lt int gt lt value gt lt member gt lt member gt lt name gt CLEAR lt name gt lt value gt
98. n OPERATOR TIME Format in YYYYMMDDHHMMSS string Ex 20041215113000 December 15th 2004 11 30AM OPERATOR_ID ID of the operator that is generating this transaction int EMPLOYEE_ID ID of the employee that is generating this transaction string LOGIN_ID Login ID of the operator that is generating this transaction string TERMINAL ID ID of the terminal to which this operator transaction is associated int TRANSACTION TYPE Type of operator transaction int 1 LOGIN 2 LOGOUT 3 UPDATE 4 DELETE 5 QUERY 6 COMMAND 7 STATUS 8 SHUTDOWN 9 INSERT 10 UNKNOWN TABLE_ID Table ID of the record affected by the operator string RECORD_DESCRIPTIO Description of the record affected by the operator string N FACILITY_ID ID of the facility to which this operator transaction will belong string N A The name of the field that has been changed as a string immediately followed string string by the value it was changed to as a string This pair of data can be repeated for field value pairs The end of the list is denoted by a field name of MASTER EOF Table 44 Create Operator History Output Parameters Field Name Field Description Data Type RESULT True if the command was successful boolean Picture Perfect External Interface User Manual Create Operator History Example Message methodCall lt methodName gt picture operatorHistory lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt para
99. name gt DIALING lt name gt lt value gt lt string gt lt string gt lt value gt lt member gt lt member gt lt name gt CONNECTED lt name gt lt value gt lt string gt YES lt string gt lt value gt lt member gt lt member gt lt name gt LAST COMM MONTH lt name gt lt value gt lt int gt 12 lt int gt lt value gt lt member gt lt member gt lt name gt LAST COMM DAY lt name gt lt value gt lt int gt 15 lt int gt lt value gt lt member gt lt member gt lt name gt LAST COMM HOUR lt name gt lt value gt lt int gt 9 lt int gt lt value gt lt member gt lt member gt lt name gt LAST COMM MINUTE lt name gt lt value gt lt int gt 30 lt int gt lt value gt lt member gt lt member gt lt name gt LAST COMM SECOND lt name gt lt value gt lt int gt 15 lt int gt lt value gt lt member gt lt member gt lt name gt RESENT_ COUNT lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt member name MICRO ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt MICRO ADDRESS lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt UPSTREAM lt name gt lt value gt lt int gt 2 lt int gt lt value gt lt member gt lt member gt lt name gt DOWNSTREAM lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt TYPE lt name gt lt value gt lt string gt NETWORK lt
100. name gt LOC_DESC lt name gt lt value gt lt string gt 160 1 0 DOOR lt string gt lt value gt lt member gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 27 lt int gt lt value gt lt member gt lt member gt lt name gt LOGICAL_ST_DESC lt name gt lt value gt lt string gt STATE lt string gt lt value gt lt member gt lt member gt lt name gt LOGICAL_ST_ID lt name gt lt value gt lt int gt 2 lt int gt lt value gt lt member gt lt member gt lt name gt PHYS ST ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt member name PROC ST ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt FACILTY DESC lt string gt lt value gt lt member gt lt member gt lt name gt REMOVE_SET lt name gt lt value gt lt boolean gt 0 lt boolean gt lt value gt lt member gt lt member gt lt name gt TIMESTAMP lt name gt lt value gt lt int gt 1049569107 lt int gt lt value gt lt member gt lt member gt lt name gt SET COUNT lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt RESET_COUNT lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt RESPONSE LIST lt name gt
101. ng gt lt value gt lt member gt lt member gt lt name gt HOST_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt TPS MODE1 lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt TPS MODE2 lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt Alarm Event hostname processAlarm The Alarm Event Object contains all of the information relevant to an alarm transaction that has occurred on the Picture Perfect system Table 9 Alarm Event Field Name Field Description Data Type ALARM DESC Description of the alarm string ALARM ID ID of the alarm int DATE Date of the alarm Format in YYYYMMDD int FACILITY DESC Description of the facility of the alarm location not supported string FACILITY ID ID of the facility of the alarm location int HOST DATE Date of the alarm in HOST TIME Format in YYYYMMDD int HOST DESC Description of the host that processed the badge read not supported string HOST ID ID of the host that processed the alarm int HOST TIME Time of the alarm in HOST TIME Format in HHMMSS int NGRP ID ID of the alarm s input group int LOC DESC Location description of the alarm point string LOC ID Location ID of the alarm point int LOGICAL ST DESC Description of the alar
102. nt of the number of times this alarm has been reset in the Picture int Perfect alarm buffer SET COUNT Count of the number of times this alarm has been set in the Picture int Perfect alarm buffer TABLE ID Table ID of the alarm location int TIME Time of the alarm Format in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone of the Picture Perfect system string UTC DATE Date of the alarm in UTC time Format in YYYYMMDD int UTC TIME Time of the alarm in UTC time Format in HHMMSS int Table 19 Single Alarm Refresh Response Array Field Name Field Description Data Type DATE Date of alarm processing Formatted in YYYYMMDD int HOST DATE Date of alarm processing in HOST TIME Formatted in YYYYMMDD int HOST TIME Time of alarm processing in HOST TIME Formatted in HHMMSS int 27 28 Picture Perfect External Interface User Manual Table 19 Single Alarm Refresh Response Array Field Name Field Description Data Type RESPONSE Operator response for process state change string TIME Time of alarm processing Formatted in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone of the Picture Perfect system string USER ID Login name of operator processing alarm string UTC DATE Date of the alarm processing in UTC time Formatted in YYYYMMDD int UTC TIME Time of the alarm processing in UTC time Formatted in HHM
103. ntations base64 Raw binary data of any length encoded using Base64 array A one dimensional array of values Individual values may be of any type struct A collection of key value pairs The keys are strings the values may be of any type It is important to note that various XML RPC packages handle method parameters in different ways In Java and Perl the XmIRpc and Frontier RPC packages respectively parse method parameters into hash tables that are keyed by parameter name to determine the parameter value Some data types such as boolean and base64 may not be automatically translated into a native type in a particular programming language Please refer to your XML RPC package documentation for information regarding the handling and parsing of method parameters EIF Events This section describes the EIF Events supported by the API The name of the Event and all of its fields are listed Table 7 EIF Events Method Event Name Method Name Event Description Ping Event hostname ping Object containing information concerning the state of the Picture Perfect system and EIF version Alarm Event hostname processAlarm Object containing all information concerning an alarm transaction that has occurred Alarm Process State hostname processAlarmProcessState Object containing all information concerning the change Change Event in state of an alarm including the operator s response and the alarm state Alarm Refresh Event Array h
104. odCall gt Chapter 2 Using EIF Badge Event hostname processBadge The Badge Event Object contains all of the information relevant to a badge transaction that has occurred on the Picture Perfect system Table 13 Badge Event Field Name Field Description Data Type ACC RGHT DESC Description of the badge owner s access right category not supported string ACC RGHT ID ID of the badge owner s access rights category int ACTIVITY TYPE Identical to CLASSIFICATION TYPE int AREA DESC Ddescription of the area in which the badge was read string BID Unique ID of the badge read string CLASSIFICATION DESC Description of the type of badge read string CLASSIFICATION TYPE Type of badge read int 0 VALID_NORMAL 0 1 READER_UNKNOWN 2 READER_OFFLINE 3 UNKNOWN_READERTYPE 4 AREA_UNKNOWN 5 AREA_OFFLINE 6 NO_CATEGORY_MATCH 7 INVALID_APB_IN 8 INVALID_APB_OUT 9 INVALID_PIN 10 BADGE_UNKNOWN 11 BADGE_LOST 12 BADGE_SUSPENDED 13 BADGE_DELETED 14 LEARN_TIMEOUT 15 INVALID_TA_IN 16 INVALID_TA_OUT 17 INVALID_SHUNT 18 BADGE_EXPIRED 19 VALID_APB_IN 20 VALID_APB_OUT 21 VALID_TA_IN 22 VALID_TA_OUT 22 Picture Perfect External Interface User Manual Table 13 Badge Event continued Field Name Field Description 235 PASSIVE APB IN 24 PASSIVE APB OUT 25 INVALID FUNC CODE 26 KP INVALID BDG 27 KP INVALID OPEN DOOR 28 KP DISABLED 29 INCOMPLETE VALIDATE 3O0 DEGRADED OPEN 31 USAGE EXHAUSTED 32 VALID
105. of EIF Events picture loginEIF 4 gt RESULT TRUE Bieser i i N 1 While using the SESSION ID that was validated by the login method I i EIF Commands such as picture lockDoor can be invoked picture lockDoor i gt RESULT TRUE Bee Sie ee ee eke nose tot a het ae e Nd f While using the SESSION ID that was validated by the login method Y 1 EIF Data Requests such as picture queryOperators can be invoked 1 picture queryOperators 1 gt ARRAY OF OPERATORS HR Fu nm i i i hostname processAlarm RESULT TRUE While the SESSION ID is active EIF Events such as hostname processAlarm or hostname processBadge are asynchronously sent to the ADDRESS and PORT specified as parameters to the picture loginEIF method hostname processBadge RESULT TRUE i picture logout RESULT TRUE T Dee Ee The logout method unregisters a valid SESSION ID on the Picture Perfect host N This prevents subsequent EIF Commands and Data Requests from being invoked using the same SESSION ID This also prevents the asynchronous receipt of EIF Events I I i i i i i i i i 10 Picture Perfect External Interface User Manual Chapter 2 Using EIF This section covers the protocol and XML RPC tag based formatting of each Picture Perfect EIF Event Command and Data Request
106. operator that is generating this transaction string N A Individual facility Ids whose modes should be changed See Change Modes Example int Message on page 1 41 The end of the llist is denoted by a fieldname of MASTER EOF Table 46 Change Modes Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Change Modes Example Message lt methodCall gt lt methodName gt picture ppChangeMode lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt MODE ID lt name gt lt value gt lt int gt 5 lt int gt lt value gt lt member gt lt member gt lt name gt OVERRIDE lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt string gt 200412151130 lt string gt lt value gt lt member gt lt member gt lt name gt OPERATOR TIME lt name gt lt value gt lt string gt 200412151130 lt string gt lt value gt lt member gt lt member gt lt name gt OPERATOR ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt EMPLOYEE ID lt name gt lt value gt lt string gt E230 lt string gt lt value gt lt member gt lt member gt lt name gt LOGIN_ID lt name gt lt value gt lt string gt install lt string gt lt value gt
107. ost Table 98 Query Alarm Responses Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 99 Query Alarm Responses Output Parameters Field Name Field Description RESPONSE Array of alarm responses string Query Alarm Responses Example Message methodCall lt methodName gt picture queryAlarmResponses lt methodName gt lt params gt lt param gt lt value gt ICYCONJ8FS lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt lt member gt lt name gt RESPONSE lt name gt lt value gt lt string gt AREA FLOODED lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt RESPONSE lt name gt lt value gt lt string gt AREA IS FLOODED lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt RESPONSE lt name gt lt value gt lt string gt AREA IS SECURE lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 75 Using EIF Query Facilities picture queryFacilities This request is a query for all facilities on the host Table 100 Query Facilities Input Parameters Field
108. ostname processAlarmRefresh An array of objects containing all information concerning every existing alarm in the Picture Perfect alarm buffer Badge Event hostname processBadge Object containing all information concerning a badge transaction that has occurred Event Activity Event hostname processEventActivity Object containing all information concerning an event transaction that has occurred 14 Picture Perfect External User Manual Interface Table 7 EIF Events Method continued Event Name Input Activity Event Method Name hostname processinputActivity Event Description Object containing all information concerning an input transaction that has occurred Operator Activity Event hostname processOperActivity Object containing all information concerning an operator transaction that has occurred Popup Event hostname processPopup Object containing the text of informational popup messages that are displayed to operators when Receive System Notifications is enabled PPRS Mode Change Event hostname processPPRSModeChange Event that is sent when there is a change in Primary Backup state of a server in a Redundant system Single Alarm Refresh Event hostname processSingleAlarmRefresh Object containing information concerning a single alarm in the Picture Perfect alarm buffer Only transmitted when an operator changes the alarm from not being routed to being routed
109. performing the tour string LNAME Last name of the individual performing the tour string TIME Time of the tour transaction Format in HHMMSS int TOUR DESC Description of the tour string TOUR POINT DESC Description of the tour point string TOUR STATUS Status of the tour int TOUR SUSPEND TIME Suspend duration of the tour int TOUR TYPE Type of tour transaction int 5 Digital Input 6 Badge Input 7 Automatically End 8 Start 9 Stop 10 Suspended 11 Resumed 12 Automatically Resumed UTC_DATE Date of the tour transaction in UTC time Format in YYYYMMDD int UTC_TIME Time of the tour transaction in UTC time Format in HHMMSS int 29 30 Picture Perfect External Interface User Manual Event Response Object All events sent from the eifevtmgr expect a response object containing a boolean result Table 21 Event Response Field Name RESULT Field Description Success flag of event call Data Type boolean Event Response Example Message lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt EIF Commands For each of the commands that call into Picture Perfect the session is treated as one parameter and the rest of the fields are treated as an object All results a
110. r prealarm input group record ID int INVALID BADGE INGRP ID Door area input group record ID int SUSPENDED BADGE INGRP ID Door area input group record ID int LOST BADGE INGRP ID Door area input group record ID int UNKNOWN BADGE INGRP ID Door area input group record int FACILITY ID Door facility record ID int FACILITY DESC Door facility record description string Query Access Points Example Message lt methodCall gt lt methodName gt picture queryAccessPoints lt methodName gt lt params gt lt param gt lt value gt 4X76LAAK3I lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt array gt lt data gt lt value gt lt struct gt member name DOOR ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt DOOR DESC lt name gt lt value gt lt string gt 100100 BOCA LOBBY EAST lt string gt lt value gt lt member gt lt member gt lt name gt SENSOR_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt REX ID lt name gt lt value gt lt int gt 2 lt int gt lt value gt lt member gt lt member gt lt name gt STRIKE ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt READER_ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt
111. re returned either as an object or an array of objects This section describes the Commands supported by the API The name of the Command and all of its input and output fields are listed Table 22 EIF Commands Method Command Name Activate Output Method Name picture activateOutput Command Description Activates an output Force Alarm Refresh picture alarmRefresh Forces a refresh of all alarms in the Picture Perfect alarm buffer Change Mode picture changeMode Changes the mode for all micros in the given facility Check or Add Port picture checkAddPort Checks the existence of the specified port and adds it to the etc services if it does not already exist Disable Input Group on Micro picture disablelngrp Disables an input group Disable Input picture disablelnput Disables an input Enable Input Group on Micro picture enablelngrp Enables an input group Enable Input picture enablelnput Enables an input Logout picture logout Terminates a login session by making a session ID invalid Lock Door picture lockDoor Locks a door Create Operator History picture operatorHistory Generates an operator history transaction Chapter 2 Using EIF Table 22 EIF Commands Method continued Command Name Method Name Command Description Change Mode of picture ppChangeMode Changes the mode for all micros in the given
112. rm history string Must be one of the following YES or NO BADGE HISTORY State indicating if it is time to archive badge history string Must be one of the following YES or NO EVENT HISTORY State indicating if it is time to archive event history records string Must be one of the following YES or NO OPERATOR HISTORY State indicating if it is time to archive operator history string Must be one of the following YES or NO TOUR HISTORY State indicating if it is time to archive tour history string Must be one of the following YES or NO Get History Flags Example Message lt methodCall gt lt methodName gt picture getHistoryFlags lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt ALARM HISTORY lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt BADGE HISTORY lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt EVENT_HISTORY lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt OPERATOR _HISTORY lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt TOUR_HISTORY lt name gt lt valu
113. s all EIF Data Requests including Query Operators and Query Facilities Picture Perfect External Interface User Manual Configuration Two files are used to configure the communications between the Event Request Managers and the EIF client These files are located in cas db text There is a configuration file for the Event Manager eifevtmgr cfg and one for the Request Manager eifreqmgr cfg These files contain configuration parameters such as port numbers used for communicating with EIF clients It is important to note that if you change any parameters then Picture Perfect must be restarted Reminder Table 1 Starting and Stopping Picture Perfect Picture Perfect System Stop Stort Standalone and Enterprise editions rc pperf k rc pperf Redundant pprsemd stop pprsemd start Event Manager Configuration File eifevtmgr cfg Type the following command cat cas db text eifevtmgr cfg and output similar to the following displays HHH db db db db db db db db db db db db db db db db db dt Copyright C 2002 2004 GE Security All Rights Reserved eifevtmgr cfg eifevtmgr cfg 1 0 12 12 02 Supported Property Examples URL http hostname FacilityCommander servlet net casi app AppHttpServlet PORT 8085 KEEP_ALIVE TRUE MESSAGE TRACE FALSE RESEND BUFFER SIZE 256 Default SSL port PORT 8443 KEEP_ALIVE FALSE MESSAGE TRACE TRUE RESEND BUFFER SIZE 256 RANDOM frozen pp1 70 cas src eif random pem
114. set E i ioa ete P RR EO NERONI EDA eie 43 Reset OUtPUt P 44 Reset Timed APB 4 ete nene tee eios etr repe viens 45 S safety terms and symbols esses vii Set KEE EE 46 Det TO 48 Single Alarm Refresh Event Object sese 26 Ee E E Te EE 5 6 A 2 technical SUpport m 98 Mrdnuidel d X 29 Tour Functions sr erret reor eret rr De eet banal 49 yu cce 3 TPS CACIMONS RT DH 3 ECY Validate d 50 Unlock Dog 51 Validate Printer AE 42 KEE 5 EE H Title of this book Picture Perfect 4 0 External Interface User Manual My overall rating of this book Excellent Very good Good What liked most about this book Satisfactory Fair Poor What I would change add delete etc in future editions of this book Please return this form to Attn Technical Writing GE Security 791 Park of Commerce Blvd Suite 100 Boca Raton FL 33487 or e mail your comments to bctdocs ge com
115. setPingInterval lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt PING INTERVAL lt name gt lt value gt lt int gt 5 lt int gt lt value gt lt member gt lt member gt lt name gt VERSION lt name gt lt value gt v0 5 5 lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 49 Using EIF Tour Functions picture tourFunctions This command performs the specified Guard Tours function Table 59 Tour Functions Input Parameters Field Name Field Description Data Type SESSION_ID Session ID used from the login string UTC_TIME Epoch time in seconds UTC string LOGIN_ID Login ID of the guard performing the tour function string TOUR_ID ID of the tour for which the function is being performed string TOUR_ACTION Action being performed for the tour which must be one of the following string START STOP SUSPEND RESUME BID Badge encode number of the badge involved in this tour string TOUR_SUSPEND_TIME Suspend time for this tour string TOUR_EXCEPTION
116. sible for handling all outbound Events and the Picture Perfect Request Manager which is responsible for handling all incoming Commands and Data Requests These daemons communicate with all EIF clients using XML RPC to transmit Events Commands and Data Requests as well as any necessary responses All communications between EIF clients and the Picture Perfect system enforce user authentication Optionally the use of SSL encryption for communications can be set up to provide an additional layer of security Chapter 1 Configuring EIF External Interface Programs The Picture Perfect External Interface is primarily comprised of two programs an Event Manager daemon that publishes Events to an EIF client and a Request Manager daemon that services Commands and Data Requests from an EIF client These daemons are spawned by TPS and listed in the tps daemons table Picture Perfect Event Manager The Picture Perfect Event Manager is a UNIX daemon spawned by TPS It is responsible for receiving Events from various Picture Perfect processes and publishing them to the EIF client The Event Manager handles all EIF Events including Badge and Alarm Events Picture Perfect Request Manager The Picture Perfect Request Manager is a UNIX daemon spawned by TPS It is responsible for receiving Commands and Data Requests from EIF clients and returning the appropriate result set The Request Manager handles all EIF Commands including Login and Logout It also handle
117. stics Example Message lt methodCall gt lt methodName gt picture getDiagnostics lt methodName gt lt params gt lt param gt lt value gt 0VCFZRFNJN lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt DIAGNOSTICS lt name gt lt value gt lt string gt 0 lt string gt lt value gt lt member gt lt member gt lt name gt LEVEL lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Get History Counts picture getHistoryCounts This request displays the history counts Table 78 Get History Counts Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string Table 79 Get History Counts Output Parameters Field Name Field Description Data Type ALARM HISTORY Total number of alarm history records int BADGE HISTORY Total number of badge history records int EVENT HISTORY Total number of event history records int OPERATOR HISTORY Total number of operator history records int TOUR HISTORY Total number of tour history records int SYSTEM HISTORY Total number of system history records int Get History Counts Example Message methodCall lt methodName gt picture getH
118. t boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 51 Using EIF Unlock Door picture unlockDoor This command unlocks the specified door for the specified amount of time Table 63 Unlock Door Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string OUTPUT ID Output of the door being unlocked int UNLOCK TIME Amount of time to unlock the door for int O default 1 indefinite 0 number of seconds DOOR ID Door being unlocked int Table 64 Unlock Door Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Unlock Door Example Message lt methodCall gt lt methodName gt picture unlockDoor lt methodName gt lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt OUTPUT_ID lt name gt lt value gt lt int gt 897 lt int gt lt value gt lt member gt lt member gt lt name gt UNLOCK TIME lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt DOOR_ID lt name gt lt value gt lt int gt 897 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params param lt valu
119. t boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 45 Using EIF Reset Timed APB picture resetTimedAPB This command resets the timed APB status of the specified badges Table 53 Reset Timed APB Input Parameters Field Name Field Description Data Type SESSION_ID Session ID used from the login string N A ID of the badge record as an integer immediately followed by the badge encode number of int string the badge records as a string This pair of data can be repeated for multiple badges Table 54 Reset Timed APB Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Reset Timed APB Example Message lt methodCall gt lt methodName gt picture resetTimedAPB lt methodName gt lt params gt lt param gt lt value gt L8DN087B2C lt value gt lt param gt lt param gt lt value gt 5301 lt value gt lt param gt lt param gt lt value gt 154020397467 lt value gt lt param gt lt param gt lt value gt 908 lt value gt lt param gt lt param gt lt value gt 155273691823 lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt
120. t string gt lt value gt lt member gt lt member gt lt name gt CONNECTED lt name gt lt value gt lt string gt YES lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt 86 Picture Perfect External Interface User Manual Query Status picture queryStatus This request is a query for status information from micros Table 116 Query Status Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string STATUS FLAG Type of status request to be performed int STATUS BY MICRO O0 STATUS BY AREA 1 ID ID of the micro or area for which status is being requested int TABLE ID ID of the table for which status is being requested int BID Badge encode number of the badge for which status is being requested string Table 117 Query Status Output Parameters Field Name Field Description Data Type STATUS LINE Line of status information for the requested status string Query Status Example Message lt methodCall gt lt methodName gt picture queryStatus lt methodName gt lt params gt lt param gt lt value gt OVCFZRFNJN lt value gt lt value gt lt struct gt lt member gt lt name gt STATUS_FLAG lt name gt lt value gt lt int gt 0 lt int gt lt value gt lt member gt lt member gt lt name gt ID lt name gt lt value gt lt int gt 8
121. t gt lt member gt lt name gt PORT ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt member name PORT NAME lt name gt lt value gt lt string gt dev ttyD001 lt string gt lt value gt lt member gt lt member gt lt name gt FILE HANDLE lt name gt lt value gt lt int gt 65 lt int gt lt value gt lt member gt lt member gt lt name gt FIRST MICRO ID lt name gt lt value gt lt int gt 3 lt int gt lt value gt lt member gt lt member gt lt name gt MODEM TYPE lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt SPEED lt name gt lt value gt lt int gt 9600 lt int gt lt value gt lt member gt lt member gt lt name gt PARITY lt name gt lt value gt lt string gt ODD lt string gt lt value gt lt member gt member name DATA BITS lt name gt lt value gt lt int gt 7 lt int gt lt value gt lt member gt lt member gt lt name gt STOP_BITS lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt INITIALIZED lt name gt lt value gt lt string gt YES lt string gt lt value gt lt member gt lt member gt lt name gt SND lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt RCV lt name gt lt value gt lt string gt NO lt string gt lt value gt lt member gt lt member gt lt name gt DIALING lt name gt lt value gt lt string gt NO l
122. t gt 10 lt int gt lt value gt lt member gt lt member gt lt name gt HOST ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt HOST DESC lt name gt lt value gt lt string gt ppmerlin lt string gt lt value gt lt member gt lt member gt lt name gt LOC_ID lt name gt lt value gt lt int gt 1793 lt int gt lt value gt lt member gt lt member gt lt name gt LOC_DESC lt name gt lt value gt lt string gt 160 1 0 DOOR lt string gt lt value gt lt member gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 27 lt int gt lt value gt lt member gt lt member gt lt name gt LOGICAL_ST_DESC lt name gt lt value gt lt string gt STATE lt string gt lt value gt lt member gt lt member gt lt name gt LOGICAL ST_ID lt name gt lt value gt lt int gt 2 lt int gt lt value gt lt member gt lt member gt lt name gt PHYS ST ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt PROC_ ST ID lt name gt lt value gt lt int gt 4 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt FACILTY DESC lt string gt lt value gt lt member gt lt member gt lt name gt REMOVE_SET lt name gt lt value gt lt boolean gt 0 lt boolean gt lt va
123. t name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Picture Perfect External Interface User Manual Enable Input Group picture enablelngrp This command enables the specified input group Table 35 Enable Input Group on Micro Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string INGRP_ID ID of the input group being enabled int Table 36 Enable Input Group on Micro Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Enable Input Group Example Message methodCall lt methodName gt picture enableIngrp lt methodName gt lt params gt lt param gt lt value gt RU65IRPSWZ lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt INGRP_ID lt name gt lt value gt lt int gt 234 lt int gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt methodCall methodResponse params param lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Enable Input picture enablelnput This command
124. tate of the BASE license key which must be one of the following int VALID A fatal error occurred attempting to verify your key Unable to access your key Sorry you have an invalid key EXPIRES Indicates if your key has an expiration date Must be one of the following YES or string NO EXPIRATION YEAR only applicable if EXPIRES YES int Expiration year EXPIRATION MONTH only applicable if EXPIRES YES int Expiration month EXPIRATION DAY only applicable if EXPIRES YES int Expiration day READER LIMIT Maximum reader capacity int TERMINAL LIMIT Maximum concurrent operator capacity int IMAGE TERMINAL LIMIT Maximum concurrent imaging workstation capacity int CUSTOMER CODE Customer code by which licensing is applied string LICENSE KEY License key currently installed string PRODUCT LIST Array of PRODUCT NAME key value pairs array 63 64 Picture Perfect External Interface User Manual Table 85 Get License Information Output Parameters continued Field Name PRODUCT NAME Field Description Product that is licensed Multiple PRODUCT NAME key value pairs can exist in an array one per each licensable product The valid product names are as follows ALPHACOM AMERICAN DYNAMICS BASE BURLE ALLEGIANT BURLE ALLPLEX CENTRAL STATION COMMEND DMP SCS EDICON EIF EST FIRESINE GRUNDIG GUARD TOURS IMAGING IMPORT EXPORT JAVELIN KALATEL MAXPRO NETLAN NOTIFIER OSBOURNE HOFFMAN R
125. terface EIF is a package that enables the publishing of events to remote clients remote access to native access control functions and remote access to data stored in the Informix database This provides an open and standardized way of integrating Picture Perfect access control systems with external systems via XML RPC The EIF package effectively exposes Picture Perfect functionality in the form of an XML object that can be manipulated using XML RPC When using the EIF package a great deal of Picture Perfect functionality is immediately exposed for manipulation by systems integrators This functionality can logically be divided into three areas Events Commands and Data Requests Events are the means in which an EIF client can receive Picture Perfect badge and alarm activity Commands are the means in which an EIF client can manipulate Picture Perfect access control functions such as the locking unlocking of doors activation of inputs outputs and remote responses to alarms Data Requests provide the means by which an EIF client can obtain database records for hosts operators facilities access points and others For a complete listing of all Events Command and Data Requests that EIF provides please refer to Chapter 2 Using EIF In order to enable communication with EIF clients the EIF package provides two Picture Perfect daemons to handle Events Commands and Data Requests These daemons are the Picture Perfect Event Manager which is respon
126. torvCountsl e een 60 Get History Flags picture getHistoryFlags 0 2 cece cece cece ete I e tenn ene eens 61 Get HostlD fpict re getHostld eorr rapa Ren HE ERE el 62 Get License Information Ipicture getLicenselnformation sess 63 Get Micro Time picture microTime 20 teen een eee e mee 66 Get Operators Logged In picture getOperatorsLoggedIn 0 cece cence cece een eens 67 Get Host Time picture hostTirne Ne ee awe cee err I TEE VERR E auaa 68 Login pict relogin EE 69 Query Access Points picture queryAccessPoints sisse 72 Query Alarm Instructions picture queryAlarmlnstructions 0200 00 0 ete nen I e e ne 73 Query Alarm Responses picture queryAlarmResponses 6 cee cence cece teen ee 74 Query Facilities picture queryFacilities 0 0 0 ccc cnc I teen eens 75 Query Input Groups picture queryINDUtGrOUPS 2 ccc n rete ete n tenes 76 Query Inputs picture queryInputs sssssssssssssssssssssss I e e eene 77 Query Micro State picture queryMicroState 20 0 0 ccc cence een ene e 78 Query Modes picture queryModes 2 0 0 cence cence e e ee 81 Query Operators picture queryOperators isses n 82 Query Outputs picture queryOutputs sssssssssssssssssssssssses em e eee ER Query Port State picture queryPortState 0 0 0 ccc m eee 84 Query Status Jpoiciure ouervtotusl e e e ren 86 ERR anreisen 87 OVetrvIeW en ERANT RUE DERE ose hit POKER RR
127. tring Table 26 Force Alarm Refresh Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfully boolean Force Alarm Refresh Example Message methodCall lt methodName gt picture alarmRefresh lt methodName gt lt params gt lt param gt lt value gt I65DTVAWED lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodResponse gt Chapter 2 Using EIF Change Mode picture changeMode This command changes the mode for all micros in the specified facility to the specified mode Table 27 Change Mode Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string FACILITY ID ID of the facility for which all micros should have their mode changed int MODE ID ID of the mode to change to int OVERRIDE Whether or not to set the TP OVERRIDE AUTO MODE bit in the UCM message to be sent to each boolean micro 1 Setthe TP OVERRIDE AUTO MODE bit 2 Do not Table 28 Change Mode Output Parameters Field Name Field Description Data Type RESULT True if the command was processed successfull y boolean Change Mode Example M
128. u need 1 Many GE documents are provided as PDFs portable document format To read these documents you will need Adobe Acrobat Reader which can be downloaded free from Adobe s website at www adobe com Index Zril M 32 Alarm Event Object 15 PACnBDnTIg c 3 Alarm Process State Change Event Object sss 17 Alarm Refresh Event Array Obiect sss 18 authentication ecce oh rim rte ae i Ue rh ce ee PEPPER ET gan 2 Badge Event Object eh sr e rr feeder niece Eege 21 Badge Eeer et EP ele ae 3 CAS AD TER GE 4 Change Modena scisccsisssssvicscsyscavssintccceconsurstessosssseascegbecstavasecoxessesbescsddesesss 33 Change Modes eet 41 Check or qu M 34 client authentication ng se een heissen 5 Commands A P nen 2 conventions vii Convert Date and Time eret thereon Aata FATEN bene xen aen an 54 Create Operator History sn 39 D e EE 2 3 Data dq HE 2 12 Directory E 55 Disable Input Disable Input Group on Micro 35 DR E 3 EIF Commands erticcsties eite eto te abe ee eoe rem redire lee ex 12 30 EIFEYENIS EE 12 13 BIE SSEVGES Greene eege 3 EENHEETEN 4 5 MLE GI BL ei EDI TE 4 5 Enable Input iot tiec edere ep Het FO ECT 36 Enable Input Group tertie re repertae eset Ui rir Rb ribera evo 36 encryption Ioui c SOEKE 14 Ev
129. unctions sub sub process badge my m hash print n Received Badge Event Wn foreach i keys my hash printf 25s s n i my_hash i return RESULT gt 1 sub sub process alarm my m hash print n Received Alarm Event Wn foreach i keys my hash printf 25s s n i my_hash i return RESULT gt 1 95 96 Picture Perfect External Interface User Manual sub sub process ping my m hash print n Received Ping Event Mn foreach i keys my hash printf 25s s n i my hash i return RESULT gt 1 sub sub process alarm process my m hash print n Received Alarm Process State Change Event n foreach i keys my hash printf 25s s n i my_hash i return RESULT 1 sub sub process alarm refresh my m hash print n Received Alarm Refresh Event Wn foreach i keys my hash printf 25s s n i my_hash i return RESULT 1 methods H bcttux processBadge gt amp sub process badge bcttux processAlarm gt amp sub process alarm bcttux ping gt amp sub process ping bcttux processAlarmProcessState gt amp sub process alarm process bcttux processAlarmRefresh gt amp sub process alarm refresh w new Frontier Daemon LocalPort gt 8085 methods gt methods or die
130. upported ORIG ID Origination ID of device reading the badge int PID ID of the person to whom the badge belongs same as bid in Picture string SWIPE SHOW ACTION Swipe and show action that has taken place int OzNO ACTION No action for swipe and show 1 PHOTO DOOR photo with door control 2 PHOTO NO DOOR photo without door control TIME Time the badge was read Format in HHMMSS int TIMESTAMP Event timestamp formatted in number of seconds since Jan 1 1970 int TZ Time zone of the Picture Perfect system string UTC DATE Date the badge was read in UTC time Format in YYYYMMDD int UTC TIME Time the badge was read in UTC time Format in HHMMSS int Badge Event Example XML RPC lt m ethodCall gt lt methodName gt ppmerlin processBadge lt methodName gt lt params gt lt lt param gt lt value gt lt struct gt lt member gt lt name gt ORIG ID lt name gt lt value gt lt int gt 169 lt int gt lt value gt lt member gt lt member gt lt name gt ORIG DESC lt name gt lt value gt lt string gt ORIG DESC lt string gt lt value gt lt member gt lt member gt lt name gt DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt HOST_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_DATE lt name gt lt value gt lt int gt 20030405 lt int gt lt value gt lt member gt lt memb
131. ure getAlarmStatus Get the general alarm status information Get Configured Devices Get the counts of configured devices on the system Ge Diagnostics icture getDiagnostics Get the diagnostics that are currently configured Get History Counts icture getHistoryCounts Get the history counts p p p picture getConfiguredDevices p p p p Get History Flags icture getHistoryFlags Get the history time to archive flags Get Host ID icture getHostld Get the host ID Get License Information picture getLicenselnformation Get the license information for all licensed packages Get Operators Logged In picture getOperatorsLoggedin Get the session details of each operator currently logged in Get Time picture getTime Get the current date and time in the specified time zone Get Host Time picture HostTime Get the host date and time Login picture loginEIF Authenticates a user ID and password and creates a valid session Get Micro Time picture microTime Get the date and time for the specified micro Query Access Points picture queryAccessPoints Query for all access points on the host Query Alarm Instructions picture queryAlarminstructions Query for all alarm instructions for a particular alarm on the host Query Alarm Responses picture queryAlarmResponses Query for all alarm responses on the host Query Facilities
132. ure loginEIF methodName params lt param gt lt value gt F30350FE1B lt value gt lt param gt lt param gt lt value gt lt struct gt lt member gt lt name gt USER_ID lt name gt lt value gt lt string gt install lt string gt lt value gt lt member gt lt member gt lt name gt PASSWORD lt name gt lt value gt lt string gt 313afa5189c150b7b0 3e6d39e0fa223 88ec42b lt string gt lt value gt lt member gt lt member gt lt name gt ADDRESS lt name gt lt value gt lt string gt 192 168 2 10 lt string gt lt value gt lt member gt lt member gt lt name gt PORT lt name gt lt value gt lt int gt 8085 lt int gt lt value gt lt member gt lt member gt lt name gt UTC_TIME lt name gt lt value gt lt string gt 20041215113000 lt string gt lt value gt lt member gt lt member gt lt name gt OPERATOR TIME lt name gt lt value gt lt string gt 20041215113000 lt string gt lt value gt lt member gt lt struct gt lt value gt lt param gt lt params gt lt methodCall gt lt methodResponse gt lt params gt lt param gt lt value gt lt struct gt lt member gt lt name gt RESULT lt name gt lt value gt lt boolean gt 1 lt boolean gt lt value gt lt member gt lt member gt lt name gt REASON lt name gt lt value gt lt string gt VALID lt string gt lt value gt lt member gt Chapter 2 Using EIF lt member gt lt name gt DBHOST lt name gt lt value gt lt string gt pphost lt string gt lt value
133. value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt GLOBAL lt string gt lt value gt lt member gt lt struct gt lt value gt lt value gt lt struct gt lt member gt lt name gt INPUT_ID lt name gt lt value gt lt int gt 1796 lt int gt lt value gt lt member gt lt member gt lt name gt INPUT_DESC lt name gt lt value gt lt string gt 169 1 17 INPUT 2 lt string gt lt value gt lt member gt lt member gt lt name gt FACILITY ID lt name gt lt value gt lt int gt 1 lt int gt lt value gt lt member gt lt member gt lt name gt FACILITY DESC lt name gt lt value gt lt string gt BOCA RATON lt string gt lt value gt lt member gt lt struct gt lt value gt lt data gt lt array gt lt value gt lt param gt lt params gt lt methodResponse gt 78 Picture Perfect External Interface User Manual Query Micro State picture queryMicroState This request is a query for the state of the specified micro Table 106 Query Micro State Input Parameters Field Name Field Description Data Type SESSION ID Session ID used from the login string MICRO ID ID of the micro whose state should be queried If you specify 1 then the int state of all micros will be returned Table 107 Query Micro State Output Parameters Field Name Field Description Data Type ONLINE Onl

Download Pdf Manuals

Related Search

Related Contents

Samsung Secadora Tambor  Intel® PRO Network Adapters WMI Provider User's Guide  取扱説明書 - 三菱電機  Pyle PL1090BL  FD-4503 - Shimano  

Copyright © All rights reserved. Failed to retrieve file