SOFTWARE HOUSE From Tyco Security Products

SOFTWARE HOUSE From Tyco Security Products C•CURE 9000 Version 2.50 General Purpose Interface Configuration Guide REVISION FO EFTA01224450 C•CURE and Software House are registered trademarks of Tyco Security Products. The trademarks, logos, and service marks displayed on this document are registered in the United State [or other countries]. Any misuse of the trademarks is strictly prohibited and Tyco Security Products will aggressively enforce its intellectual property rights to the fullest extent of the law, including pursuit of criminal prosecution wherever necessary. MI trademarks not owned by Tyco Security Products are the property of their respective owners, and are used with permission or allowed under applicable laws. Product offerings and specifications are subject to change without notice. Actual products may vary from photos. Not all products include all features. Availability varies by region; contact your regional sales manager. Software version: 2.50 Document Number: UM-238 Revision Number: FO Release Date: December 2015 This manual is proprietary information of Software House. Unauthorized reproduction of any portion of this manual is prohibited. The material in this manual is for information purpose only. It is subject to change without notice. Software House assume no responsibility for incorrect information this manual may contain. © 2015 Tyco Security Products. MI rights reserved. EFTA01224451 Table of Contents Preface 7 Finding More Information 8 Conventions 9 Software House Customer Support Center 10 Chapter 1 - Overview 11 Introduction 12 General Purpose Interface 13 Monitoring Point 14 Monitoring Point Message Processing 15 Poll Command 16 Output 16 Chapter 2 - Using the Pane and Folders 19 Using the General Purpose Interface Pane 20 Partitions 21 General Purpose Interface Tasks .23 Creating a New Object in the General Purpose Interface Tree 23 Deleting an Object in the General Purpose Interface Tree 24 Viewing a List of General Purpose Interface Tree Objects 25 Using Drag and Drop in the General Purpose Interface Tree 25 Refreshing the General Purpose Interface Tree 26 General Purpose Interface Folders 28 C•CURE 9000 General Purpose Interface Configuration Guide 3 EFTA01224452 Creating a New General Purpose Folder 28 Renaming a General Purpose Folder 29 Creating and Using a New General Purpose Folder Template 30 Chapter 3 - Configuration 33 Configuration Sequence Overview 34 General Purpose Device Editor 39 Accessing the General Purpose Device Editor 39 General Purpose Device General Tab 40 General Purpose Device General Tab Definitions 41 General Purpose Device Editor Tasks 43 General Purpose Device Port Tab 50 General Purpose Device Communication Protocol Tab 52 General Purpose Device Triggers Tab 53 General Purpose Device Status Tab 58 General Purpose Device State Images Tab 59 General Purpose Message Protocol Editor 61 Accessing the General Purpose Message Protocol Editor 61 General Purpose Message Protocol Editor Definitions 62 General Purpose Message Protocol Tasks 64 Creating a General Purpose Message Protocol 65 Creating a General Purpose Message Protocol Template 65 Configuring/Modifying a General Purpose Message Protocol 66 General Purpose Action Editor 68 Accessing the General Purpose Action Editor 68 General Purpose Action Editor Definitions 69 General Purpose Action Tasks 71 General Purpose Monitoring Point Editor 74 Accessing the General Purpose Monitoring Point Editor 74 General Purpose Monitoring Point Editor Definitions 76 General Purpose Monitoring Point General Tab 77 General Purpose Monitoring Point General Tab Definitions 78 General Purpose Monitoring Point Tasks 79 General Purpose Monitoring Point Triggers Tab 82 General Purpose Monitoring Point Status Tab 83 4 C•CURE 9000 General Purpose interface Configuration Guide EFTA01224453 General Purpose Monitoring Point State Images Tab 83 Using the Virtual Keyboard 85 Virtual Keyboard Definitions 85 Using the Virtual Keyboard To Enter Text into General Purpose Interface Fields 87 ASCII Character Codes Chart 88 Creating Events 90 General Purpose Interface Action 90 General Purpose Interface Dynamic Action 93 C•CURE 9000 General Purpose interface Configuration Guide 5 EFTA01224454 6 C•CURE 9000 General Purpose Interlace Configuration Guide EFTA01224455 Preface The C• CURE 9000 General Pupose Interface Configuration Guide is for new and experienced security system users who want to learn to use this product for the C•CURE 9000 Security Management System. In this preface Finding More Information 8 Conventions 9 Software House Customer Support Center 10 C•CURE 9000 General Purpose Interface Configuration Guide Preface 7 EFTA01224456 Finding More Information Finding More Information You can access C•CURE 9000 manuals and online Help for more information about C•CURE 9000. Manuals C•CURE 9000 software manuals are available in Adobe PDF format on the C•CURE 9000 DVD. You can access the manuals if you copy the appropriate PDF files from the C•CURE 9000 Installation DVD English \ Manuals folder. The available C•CURE 9000 and Software House manuals are listed in the C•CURE 9000 Installation and Upgrade Guide, and appear as hyperlinks in the online.pdf file on the C•CURE 9000 DVD English \ Manuals folder. These manuals are also available from the Software House Member Center website Online Help You can access C•CURE 9000 Help by pressing Fl or clicking Help from the menu bar in the Administration/Monitoring Station applications. 8 Preface C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224457 Conventions Conventions This manual uses the following text formats and symbols. Convention Meaning Bold This font indicates screen elements, and also indicates when you should take a direct action in a procedure. Bold font desates one of the following items: • A oommand or character to type, or • A button or option on the screen to press, or • A key on the keyboard to press • A screen element or name blue cobr text Indicates a hyperlink to a UR L, or a cross-reference to a figure, table, or section in this guide. Regular italic font Indicates a new term. <text> Indicates a variable. The following items are used to indicate important information. NOTE TIP sine Indicates a note. Notes call attention to any item of information that may be of special importance. Indicates an alternate method of performing a task. Indicates a caution. A caution contains information essential to avoid damage to the system. A caution can pertain to hardware or software. Indicates a warning. A warning contains information that advises users that failure to avoid a specific action could result in physical harm to the user or to the hardware. Indicates a danger. A danger contains information that users must know to avoid death or serious injury. C•CURE 9000 General Purpose Interface Configuration Guide Preface 9 EFTA01224458 Software House Customer Support Center Software House Customer Support Center Telephone Technical Support During the period of the Agreement, the following guidelines apply: ■ Software House accepts service calls only from employee of the Systems Integrator of Record for the installation associated with the support inquiry. Before Calling Ensure that you: ■ Are the Dealer of record for this account. ■ Are certified by Software House for this product. ■ Have a valid license and current Software Support Agreement (SSA) for the system. ■ Have your system serial number available. ■ Have your certification number available. Hours Normal Support Hours Monday through Friday, 8:00 to 8:00 , EST. Except holidays. Emergency Support Hours 24 hours/day, seven days a week, 365 days/year. Requires Enhanced SSA"7 x 24- Standby Telephone Support (emergency) provided to Certified Technicians. For another customers. bilabie on time and materials basis. Minimum charges apply- See MSRP. Phone For telephone support contact numbers focal regions, support.aspx. see 10 Preface C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224459 Overview This chapter introduces the General Purpose Interface (GPI) Integration for C•CURE 9000. In this chapter: Introduction 12 General Purpose Interface 13 C•CURE 9000 General Purpose Interface Configuration Guide Chapter 1 11 EFTA01224460 Introduction Introduction The General Purpose Interface provides a general way for C•CURE 9000 to talk to a third-party device. The General Purpose Interface does the following: • Initializes communication between a C•CURE 9000 system and a third-party device. • Maintains a communication channel by polling a third-party device. • Defines General Purpose Actions that send messages to third-party devices using C•CURE 9000 event activation and then support acknowledgement messages from these third-party devices. • Defines General Purpose Monitoring Points that represent monitoring points in third-party devices. • Supports five Activated Status properties for these General Purpose Monitoring Points. • Defines General Purpose incoming message protocols that interpret incoming messages from third-party devices and support acknowledgement for incoming messages. The General Purpose Interface can work with any device that uses ASCII code for communications protocol for event monitoring, such as the following: • Intercom • Programmable Liner Controllers (PLCs) • Burglar/Intrusion • Lighting • Dome control • Refrigeration • EAS • Wireless communication • Elevators • To support secondary alarm annunciation for fire/burglar • Environmental panels • HVAC • As multiple device interfacing (unlimited) • Process Control Equipment 12 Chapter 1 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224461 General Purpose Interface General Purpose Interface The General Purpose Interface is a programmable bi-directional communication protocol that provides a general mode of communication between the General Purpose Interface driver and the third-party device. A third-party device sends pure ASCII messages via a a serial port (RS-232) or remotely via a TCP/IP port (Lantronix or Systech) into the General Purpose Interface driver. C•CURE 9000 interprets messages in two ways: ■ As journal messages recorded into the historical journal. ■ As any of five Monitoring Point status changes configured to trigger a C•CURE 9000 event. The General Purpose Interface supports the following functionality: ■ Input where the input strings are sent from the device through the Serial/Network port to C•CURE 9000. The General Purpose Message Protocol object is used to define and parse the information. ■ Output where the output is an Action and requests a response from the device. ■ Poll: where the poll is an action that requires a response from the device. Figure 1: General Purpose Interface Functionally C•CURE 9000 General Purpose interface Configuration Guide Chapter 1 13 EFTA01224462 General Purpose Interface Figure 2: Linkseethin C•CURE 9000 Monitoring Point Monitoring Points can activate events directly. ■ You can design events to activate any of the various event actions. ■ Monitoring Points can also be enunciated at the Monitoring Station and written to the historical journal. You should configure a message protocol that then parses the received Monitoring Point string. You can also define a header or trailer character in the General Purpose Device Communications Protocol tab, if they are required. 14 Chapter! Figure 3: Monitoring Point C.CURE 9000 C•CURE 9000 General Purpose Interface Con figuration Guide EFTA01224463 General Purpose Interface Monitoring Point Message Processing When the General Purpose driver receives the message from the device, it does the following: • Parses the message and looks for poll or action responses. • If it finds a poll or an action response, it processes the response. • If it does not find a poll or an action response, it continues to parse. • Looks for a message protocol. • If it finds a message protocol, it processes the protocol. • If it does not find a message protocol, it forwards an unknown message signal. NOTE The device can either delimit the message with a header and a trailer or discard the header and a trailer. Figure 4: Monitoring Point Message Processing InconvivOma Mimi we, Hee-tried Vat 040.0 'MS ird Trailer Incoming Data Processing SOW Viitian Lan.40*. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 1 15 EFTA01224464 General Purpose Interface Poll Command The Poll Command, the frequency of polling (Poll Period), and the expected response (Poll Command Acknowledgment) are all defined as part of the configuration of a specific General Purpose Device. Figures: PoiCommand -- I General Purpose Device Editor C•CURE 9000 [ r I Poll Command 7. iSerial Port or Net*ork Port 49-- 1 Output ski IROSPOlt"Third-Party Device Output Output is performed using an Action that is activated by an event and sends a string of characters to the General Purpose Device through the Serial/Network port. The optional expected response (Acknowledgement Message) is also configured as part of the Action. 18 Chapter 1 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224465 General Purpose Interface Figure 6: Output 1 C•CURE 9000 Keypad commands Other event causes Serial Port or Network Port Output sUinig— 1 1 I Response Third-Party Device 0 C•CURE 9000 General Purpose Interface Configuration Guide Chapter 1 17 EFTA01224466 General Purpose Interface 18 Chapter 1 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224467 2 Using the Pane and Folders This chapter explains how to use the C•CURE 9000 General Purpose pane to configure and manage the General Purpose components that are connected to your C•CURE 9000 server. In this chapter Using the General Purpose Interface Pane 20 General Purpose Interface Tasks 23 General Purpose Interface Folders 28 C•CURE 9000 Genera/ Purpose Interface Configuration Guide Chapter 2 19 EFTA01224468 Using the GeneralPurpose Interface Pane Using the General Purpose Interface Pane The General Purpose Interface pane displays a tree structure that shows how the General Purpose Interface configuration on the C•CURE 9000 system. Example: The General Purpose Interface tree shows you General Purpose Actions, General Purpose Message Protocols, General Purpose Devices and General Purpose Monitoring Points configurations. You can use the General Purpose Interface Tree to navigate to General Purpose Interface components you want to view or edit, or to create new General Purpose Interface components, such as a Monitoring Point you want to add to a General Purpose Device. The Company Name folder is the default container for your General Purpose Devices and under the device, your General Purpose Monitoring Points. This folder is re-namable so you can customize the C•CURE 9000 General Purpose Interface Tree to your site's needs. NOTE General Purpose Actions and General Purpose Message Protocols are the only General Purpose Interface objects you create at the root level, and these objects cannot be partitioned. You can do the following with the tree: ■ Create additional General Purpose Interface Folders as needed. ■ Click , I to the left of a folder or object to expand the tree. ■ Select a folder or object in the tree and right-click to display a context menu that shows the actions you can perform on the selected folder/object and the other objects you can create under the selected folder/object. Example: If you right-click the Company Name folder, the context menu shows that you can create a new General Purpose Device object in this folder or a new General Purpose Device template, as shown in Figure 7 on Page 21. 20 Chapter 2 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224469 Using the General Purpose Interface Pane Figure 7: General Purpose Interface Tree Context Menu • Gener4 Purpose Fob. Gown, Popov Inleduse Tors • Gerod Noose letelece Al Senn PuOnie Action al Omni Pupoto Nonage Mama' L Conon Elmo PorinonCiel 40241 lOstglio ottAl I Gott& PI/1:050 Device Options & took Partitions vO. Sonrch Eat 0Oletto Fair. Auk Ito.. Mtn New Teniato If you partition your C•CURE 9000, a new General Purpose folder is created for each Partition you create, and give the same name as the Partition, as shown in Figure 7 on Page 21. You can also create additional General Purpose folders to contain General Purpose Devices if you need to separately group General Purpose Devices to reflect a multi-tenant building, a campus, or a multi-site company, for example. You can use Partitioning and Privileges to control Operator access to each tenant's General Purpose folder(s) if you don't want one tenant to be able to view another tenant's security access General Purpose Devices and personnel. The New Object Partition setting in the Administration Workstation determines the Partition in which an Operator can create objects, in addition to General Purpose Interface Tree objects such as Actions and Message Protocols that reside at the root of the General Purpose Interface Tree. You can use the Privilege Editor to grant or deny an Operator access to a Partition, which affects whether they can view or create objects in that Partition. Example You could create a privilege that has no access to the Partition (and General Purpose folder) called Company A, but with full access to Company B, and assign it to Operators from Company B, so that they can view their configuration but not the configuration for Company A. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 2 21 EFTA01224470 Using the General Purpose Interface Pane For more information about Partitioning and Privileges, see the C•CURE 9000 Software Configuration Guide. You can also drag and drop objects to move them in the General Purpose Interface Tree. Example You can move a General Purpose Device from one General Purpose folder to another. See Using Drag and Drop in the General Purpose Interface Tree on Page 25 for more information. 22 Chapter 2 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224471 GeneralPurpose Interface Tasks General Purpose Interface Tasks ■ Creating a New Object in the General Purpose Interface Tree on Page 23 ■ Deleting an Object in the General Purpose Interface Tree on Page 24 ■ Viewing a List of General Purpose Interface Tree Objects on Page 25 ■ Using Drag and Drop in the General Purpose Interface Tree on Page 25 ■ Refreshing the General Purpose Interface Tree on Page 26 ■ Creating a New General Purpose Folder on Page 28 ■ Creating and Using a New General Purpose Folder Template on Page 30 ■ Creating a New General Purpose Folder on Page 28 ■ Renaming a General Purpose Folder on Page 29 ■ Creating and Using a New General Purpose Folder Template on Page 30 Creating a New Object in the General Purpose Interface Tree Most objects in the General Purpose Interface Tree support a right-click Context Menu that shows you the actions you can perform on that object. The right-click Context Menu for an object has selections for objects that you can create under that object. To Create a New Object in the General Purpose Interface Tree 1. Select the Folder or Object that will contain the object you want to create. Example: If you want to create a General Purpose Device, select the specific Company folder the device is for. 2. Right-click the Folder/Object, then select the object you wish to create from the Context menu, and click New on the sub-menu, as shown in the example in Figure 7 on Page 21. The Editor for the object opens where you can configure the object. (For detailed information, see Configuration Sequence Overview on Page 34.) C•CURE 9000 General Purpose Interface Configuration Guide Chapter 2 23 EFTA01224472 General Purpose Interface Tasks Deleting an Object in the General Purpose Interface Tree You can delete objects from the General Purpose Interface Tree if they are no longer needed. If you delete an object that has a child object below it (such as a Monitor Point on a General Purpose Device), that object is also deleted. To Delete an Object in the General Purpose Interface Tree 1. Select the Folder or Object that you wish to delete. 2. Right-click the object and select Delete. A confirmation dialog box opens to confirm that you want to delete the object. 3. Click Yes to confirm deleting the object or No to cancel the deletion. The object is deleted if you confirm by clicking Yes. A Deleting General Purpose objects dialog box also opens, shown in Figure 8 on Page 24, with one line per deleted object, showing the results of the deletion operation. Figure 8: Deleting General Purpose Objects Dialog Box OSP TeM1 ha been dented tee ire :iekting &reed A 4. Click: • OK to close the dialog box. • Print to print the deletion message. 24 Chapter 2 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224473 General Purpose Interface Tasks • Email to send the deletion message to the email address you have configured in the Customer Support section of the C•CURE 9000 System Variables. Viewing a List of General Purpose Interface Tree Objects You can view a list of any type of General Purpose Interface Tree object. To View a List of General Purpose Interface Tree Objects 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Use the drop-down list in the General Purpose Interface pane to select the object type that you want to list. 3. Click a and a Dynamic View listing the object type opens in the content area. 4. You can filter, sort, group, and add columns to the list. (For more information, see the Dynamic Views chapter in the C•CURE 9000 Data Views Guide.) Using Drag and Drop in the General Purpose Interface Tree You can drag and drop objects to move them in the General Purpose Interface Tree, within certain restrictions. ■ You cannot move Root level objects such as Folders and General Purpose Action and General Purpose Message Protocol. ■ You cannot move objects in General Purpose Interface Folders to the Root level. ■ You cannot move child objects of one General Purpose Device to another General Purpose Device. NOTE You cannot move a non-partitioned object like a General Purpose Action or a General Purpose Message Protocol. To determine if you can drag and drop an object, click on the object and then drag to the right with your mouse. If the rill cursor opens, you can drag and drop the object. If you try to drop the object in an invalid location, the object remains in its original location instead. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 2 25 EFTA01224474 General Purpose Interface Tasks Example: If you tried to drop a General Purpose Device in a General Purpose Action, the object is not moved, and an error message "General Purpose Folder is not found" opens. "MI To Drag and Drop an Object in the General Purpose Interface Tree 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Click an object to select it. The object will be highlighted 6PD'el."Cnn3 3. Drag to the right with your mouse. The drag and drop cursor WI appears. If it does not appear, you cannot drag and drop the object. 4. Drag the object to the location you want and release the mouse button. If the location is valid for the object, the object displays in the new location. Example: If you drag a General Purpose Device to a different General Purpose Folder, the Device and all its child objects, Monitoring Points, are moved to that General Purpose Folder. Refreshing the General Purpose Interface Tree 'I 'o make sure that all your folders and objects in the General Purpose Interface Tree are accurately displayed on the screen, you can refresh the General Purpose Interface Tree. To Refresh the General Purpose Interface Tree 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Right-click General Purpose Interface and select Refresh Tree from the context menu. 26 Chapter 2 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224475 General Purpose Interface Tasks Figure 9: General Purpose Interface Context Menu - Refresh Tree The General Purpose Interface Tree is updated. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 2 27 EFTA01224476 General Purpose Interface Folders General Purpose Interface Folders You can create additional General Purpose Folders if you need to organize your General Purpose Devices into separate folders. When you create a new Partition, a new General Purpose Interface Folder is automatically created to contain objects that reside in that Partition. The tree structure in the General Purpose Interface Folder pane shows how you have configured the General Purpose Interface on the C.CURE 9000 system. Example: The General Purpose Interface tree shows you which General Purpose Devices and Monitor Points are configured for each company folder. You can use the General Purpose Interface Tree to navigate to General Purpose Interface components you want to view or edit, or to create a new General Purpose Interface component, such as a Monitor Point you want to add to a Device. Creating a New General Purpose Folder Perform the following steps to create a new General Purpose Folder. To Create a New General Purpose Folder 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Right-click General Purpose Interface at the top of the tree and select General Purpose Folder>New from the context menu, as shown in Figure 10 on Page 28. Figure 10: General Purpose Interface Context Menu-General Purpose Folder General Purpose Interface a P.Vose Pct.: Gonad RecoDe Inietwe Tay Genera Repose Weds.. Csymel Ripot in ()trace Gwent Appose hider e New TotiCaroavl Cenral Plows° Honor PrOtCCOI • Tcephte I. el TeiCarPn2 General Anon Act= • On Ta' Refresh Tree 28 Chapter 2 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224477 General Purpose Interface Folders [he General Purpose Folder dialog box opens, as shown in Figure 11 on Page 29. Figure 11: General Purpose Folder Dialog Box In General Purpose Folder - L i7,0 and Cbse itjSsve end new aom QesatOon Primo TeoBI 3. Type the name for the new folder into the Name field. 4. Optionally, type a description for the new folder into the Description field. 5. Click Save and Close to save the new folder. Alternatively, if you want to save the folder and then create a new one, click Save and New. The current folder is saved and closed, but the General Purpose Folder dialog box remains open to allow you to create a new folder. The General Purpose Interface Tree automatically updates to display your new folder. If the tree does not display the folder, right-click on General Purpose Interface and select Refresh Tree from the context menu, as described in Refreshing the General Purpose Interface Tree on Page 26. Renaming a General Purpose Folder You can rename a General Purpose Folder to customize it to your site's needs. Typically, you want to rename the default folder, Company Name, with a more suitable name. To Rename a General Purpose Folder 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Right-click the folder that you want to rename, and select Edit from the context menu. The General Purpose Folder dialog box opens, as shown in Figure 11 on Page 29. 3. Type the new name for the folder into the Name field. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 2 29 EFTA01224478 General Purpose Interface Folders 4. Optionally, type a description for the folder into the Description field. 5. Click Save and Close to save the renamed folder. - or - Alternatively, if you want to save the folder and then create a new one, click Save and New. The current folder is saved with your edits and closed, but the General Purpose Folder dialog box remains open to allow you to create a new folder. Creating and Using a New General Purpose Folder Template You can create a General Purpose Folder Template that you can use as a basis for creating additional General Purpose Folders. The field values you enter in the template are then applied when you use that template to create new General Purpose Folders. This allows all your General Purpose Folders to have the same values and simplifies the process of creating new folders. To Create a New General Purpose Folder Template I. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Right-click General Purpose Interface in the tree and select General Purpose Folder>New Template from the context menu, as shown in Figure 10 on Page 28. The General Purpose Folder (Template) dialog box opens, as shown in Figure 12 on Page 30. Figure 12: General Purpose Folder (Template) Dialog Box ■ General Purpose I older ( Imp late) Sere and axe TI Pathen TettDI 3. Type the name for the new folder template into the Name field. 4. Optionally, type a description for the new folder template into the Description field. 5. Click Save and Close to save the new folder template. 30 Chapter 2 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224479 General Purpose Interface Folders To Use a General Purpose Folder Template to Create New General Purpose Folders 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Right-click General Purpose Interface in the tree and select General Purpose Folder from the context menu. The next level menu appears listing the General Purpose Interface Folder Templates you have previously created—under the — Templates category, as shown in Figure 13 on Page 31. Figure 13: General Purpose Interface Context Menu - General Purpose Interface Folder Bawd Pupr,elnetxe Tree • Gereul Repose Idol Gt.ner a Govt.' NSA elIZZF L j Tesituroany r d TesiC • Ifl TeoGyroter Refresh Tree Genevan/rose Message Procccd r Genial Purpose Acts(' !1 Woo angle -- raepwn G•nRuSTIMISIGI 3. Click the specific General Purpose Folder Template you wish to use as the basis for your new General Purpose Folder. A General Purpose Folder dialog box, similar to that shown in Figure 10 on Page 28 opens with the values you entered in the template. 4. As necessary, depending on the values from the template already entered in the Name and Description fields, type or edit: a. The name for the new folder. b. An optional description for the new folder 5. Click Save and Close to save the new folder. - - Alternatively, if you want to save the folder and then create a new one, click Save and New. The current folder is saved and closed, but the General Purpose Folder dialog box remains open (with the same template values) to allow you to create a new folder. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 2 31 EFTA01224480 General Purpose Interface Folders The General Purpose Interface Tree automatically updates to display your new folder. If the bee does not display the folder, right-click on General Purpose Interface and select Refresh Tree from the context menu, as described in Refreshing the General Purpose Interface Tree on Page 26. 32 Chapter 2 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224481 3 Configuration This chapter explains how to configure the General Purpose Interface in C•CURE 9000. In this chapter Configuration Sequence Overview 34 General Purpose Device Editor 39 General Purpose Message Protocol Editor 61 General Purpose Action Editor 68 General Purpose Monitoring Point Editor 74 Using the Virtual Keyboard 85 Creating Events 90 C•CURE 9000 General Purpose Interface Configuration Guide Chapter 3 33 EFTA01224482 Configuration Sequence Overview Configuration Sequence Overview The C•CURE 9000 General Purpose Interface pane and tree provide options that you can use to configure the General Purpose objects. Configure objects in the following general order: Table 1: GPI Basic Configuration Sequence Order of Tasks See... 1. Create a General Purpose Interface device and configure the connection parameters. Enable the device and configure the connection type. • • Creating a General Purpose Device on Page 44 Configuring/Modifying a General Purpose Device on Page 44 2. Create a General Purpose Action to allow the sending of a message to C•CURE 9000 when an event occurs. • • Creating a General Purpose Action on Page 71 Configuring/Modifying a General Purpose Action on Page 72 3. Create an Event that triggersthe sending of the C•CURE 9000 message. • Creating Eventson Page 90 ■ Configure a message ■ Trigger the message ■ Test through the hardware configuration - or - ■ Monitoring point ■ Event to be linked to a General Purpose device and a General Purpose action. You configure the Event object on the Event Editor accessed from the C•CURE 9000 Configuration pane. Table 2 on Page 35 shows the tasks and related C•CURE 9000 Editors you use to create General Purpose Interface Objects. 34 Chapter 3 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224483 Configuration Sequence Overview Table 2: Creating General Purpose Interface Objects Task C•CURE 9000 Editor Configuration Notes Additional Information Configure the General Purpose Device General Purpose Interface>General Purpose Interface Tree>Company Fokler>General Purpose Device>New>Generai Purpose Device Editor and General tab Creates a General Purpose Device and specifies: • Vendor • Poll information • General Purpose Device General Tab on Page 40General Purpose Device General Tab on Page 40 • General Purpose Device Editor Taskson Page 43 • Using the Virtual Keyboard on Page 85 Configure General Purpose Device Port General Purpose Interface>General Purpose Interface Tree>Company Folder>General Purpose Device>New>Generai Purpose Device Editor>Port tab Specifies: • Port type (Serial/Network) • Port numbers • General Purpose Device Port Tab on Page 50 Configure General Purpose Device Communication Protocol Information General Purpose Interface>General Purpose Interface Tree>Company Folder>General Purpose Device>New>General Purpose Device Editor>Communication Protocol tab Specifies • Delay times • Header/Trailer characters in General Purpose message • Retry attempt number • Buffer size • General Purpose Device Communication Protocol Tab on Page 52 C•CURE 9000 General Purpose interface Configuration Guide Chaptur 3 35 EFTA01224484 Configuration Sequence Overview Creating General Purpose Interface Objects (cent nued) Task C•CURE 9000 Editor Configuration Notes Additional Information Configure General Purpose Device Triggers General Purpose Interface>General Purpose Interface Tree>Company Folder>General Purpose Device>New>General Purpose Device Editor>Triggers tab Specifies Event Actions to be activated for General Purpose Device online status. • General Purpose Device Triggers Tab on Page 53 • General Purpose Device Triggers Tab Tasks on Page 55 • Creating Eventson Page 90 Change General Purpose Device State Images General Purpose Interface>General Purpose Interface Tree>Company Folder>General Purpose Device>New>Ge nera. Purpose Device Editor>State Images tab Modifies Images that indicate General Purpose Device states on the Monitoring Station. • General Purpose Device State Images Tab on Page 59 • State Images Tab Taskson Page 60 Configure the General Purpose Message Protocol General Purpose Interface>General Purpose Interface Tree> General Purpose Message Protocol Fokler>New>General Purpose Message Protocol Editor and General tab Creates a General Purpose Message Protocol that interprets incoming messages from third partydevices and supports acknowledgment for these messages. Specifies: • Match criteria • KeyWords • Position • General Purpose Message Protocol Editor on Page 61 • General Purpose Message Protocol Tasks on Page 64 • Using the Virtual Keyboard on Page 85 36 Chapter 3 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224485 Configuration Sequence Overview Creating General Purpose Interface Objects (cant nued) Task C•CURE 9000 Editor Configuration Notes Additional Information Configure the General Purpose Action General Purpose Interface>General Purpose Interface Tree>General Purpose Action Foider>New>General Purpose Action Editor and General tab Creates a General Purpose Action and specifies: • Outgoing messages • Acknowledgment messages • General Purpose Action Editor on Page 68 • General Purpose Action Tasks on Page 71Using the Virtual Keyboard on Page 85 • Using the Virtual Keyboard on Page 85 Configure Monitoring Points for the General Purpose Device General Purpose Interface>General Purpose Interface Tree>Company Folder>Existing General Purpose Device>General Purpose Monitoring Point>New>General Purpose Monitoring Point Editor and General tab Creates a Monitoring Point for a General Purpose Device that activates Events. • General Purpose Monitoring Point Editor on Page 74 • General Purpose Monitoring Point General Tab on Page 77 • General Purpose Monitoring Pont Taskson Page 79 • Using the Virtual Keyboard on Page 85 Configure General Purpose Monitoring Point Triggers General Purpose Interface>General Purpose Interface Tree>Company Foider>Exisung General Purpose Device>General Purpose Monitoring Point>New>General Purpose Monitoring Point Editor>Triggers tab Specifies Event Actions to be activated for General Purpose Monitoring Point Activation status. • General Purpose Monitoring Point Triggers Tab on Page 82 • Creating Eventson Page 90 C•CURE 9000 General Purpose Interface Con figuration Guide ChilpiL'I 3 37 EFTA01224486 Configuration Sequence Overview Creating General Purpose Interface Objects (continued) Task C•CURE 9000 Editor Configuration Notes Additional Information Change General Purpose Modifies Images that indicate • General Purpose Monitoring Point General Interface>General General Purpose Monitoring Point State Images Tab on Page 83 Purpose Purpose Interface states on the Monitoring Station. • State Images Tab Taskson Page Monitoring Tree>Company 60 Point State Foider>Existing Images General Purpose Device>General Purpose Monitoring Point>New>General Purpose Monitoring Point Editor>State Images tab Create Events Configuration • Creating Eventson Page 90 to link to >Event>New>Event • The Events chapter lathe General Editor C•CURE 9000 Software PurpOSO - or - Configuration Guide. Devices and General Edit an existing Event Purpose Actions 38 Chapter 3 C•CURL 9000 General Purpose Inturlacy Conliguration Cindy EFTA01224487 General Purpose Device Editor General Purpose Device Editor The General Purpose Device Editor in C•CURE 9000 lets you create and modify General Purpose Device Objects. The General Purpose Device Editor displays six configuration tabs. Click on the following tabs for more information: ■ General Purpose Device General Tab on Page 40 ■ General Purpose Device Port Tab on Page 50 ■ General Purpose Device Communication Protocol Tab on Page 52 ■ General Purpose Device Triggers Tab on Page 53 ■ General Purpose Device Status Tab on Page 58 ■ General Purpose Device State Images Tab on Page 59 See General Purpose Device Editor Tasks on Page 43. Accessing the General Purpose Device Editor You can access the General Purpose Device Editor from the General Purpose Interface pane. To Access the General Purpose Device Editor 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Right-click the Company Folder for which you want to create the device to open the context menu, click General Purpose Device, and then click New on the sub•menu that appears, as shown in Figure 14 on Page 40. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 3 39 EFTA01224488 General Purpose Device Editor Figure 14: General Purpose Interface Context Menu - General Purpose Device Genveuposelreegface Tree • Getti PuipmeIntalece Al Genoa, Pupon Acim Gernal Pupate Memel Prob:cl Or, click the General Purpose Interface drop-down list and select General Purpose Device. General Purpose Interface Click RIO to open a Dynamic View showing a list of all existing General Purpose Devices, right-click the General Purpose Device you want to change, and click Edit from the context menu that appears. The General Purpose Device Editor opens with the General tab displayed. General Purpose Device General Tab The General Purpose Device General tab, shown in Figure 15 on Page 41, lets you define the vendor and the polling specifics for the General Purpose Device. See the following: • General Purpose Device Editor - General Tab Fields/Buttons on Page 41 • General Purpose Device Editor Tasks on Page 43 40 Chapter 3 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224489 General Purpose Device Editor Figure 15: General Purpose Device Editor General Tab General Purpose Device General Tab Definitions the General Purpose Device General tab buttons and fields are described in Table 3 on Page 41 Table 3: General Purpose Device Editor- General Tab Fields/Buttons Field/Button Description Save and Close Clickthis button when you have completed changes to the General Purpose Device and wish to save those changes. The General Purpose Device Editor doses. C•CURE 9000 General Purpose Interface Configuration Guide Chapter 3 41 EFTA01224490 General Purpose Device Editor General Purpose Device Editor - General Tab F 'olds/Buttons (continued) Field/Sutton Description Save and New Click this button when you have completed any changes to the General Purpose Device and wish to save those changes and also create a new General Purpose Device. The General Purpose Device you were editing is saved, and a new General Purpose Device opens (either blank or including template information if you were using a template to create the new General Purpose Device). Name Enter a unique name. up to 100 characters. to identify the General Purpose Device. Description Enter a description of the General Purpose Device, up to 255 characters. Enabled Select this check box to put the General Purpose Device onbne. NOTE: You cannot edit any fields on either the General. Port. or Communication Protocol ta bs when the General Purpose Device isenabled. Partition A read-only field displaying the name of the Partition to which this General Purpose De via: belongs. (This field is visible only if the C•CURE 9000 system is partitioned.) NOTE: The General Purpose Device derives its Partition from the Company Folder it was created in. If the folder's Partition is changed, then the General Purpose Device's Partition changes accordingly. Hex Format NOTE: This button becomes available for either the Poll Command or Poll Command acknowledgement field only after you enter the command string for the field. Click this button to display the Hex Format dialog box showing the Hex format of the string entered in the Poll Command or Poll Command Acknowledgement field. Device Information NOTE: None of the fieldson this tab can be edited if the General Purpose Device isenabled. Vendor Ignore. Not applicable Poll Period (seconds) Enter the period in seconds that C•CURE 9000 attempts to poll this General Purpose Device. The default value is 10 seconds. 42 Chapter 3 C•CURE 9000 General Purpose Interface Configuration Guide EFTA01224491 General Purpose Device Editor General Purpose Device Editor - General Tab F ieldsiButtons (continued) Field/Sutton Description Poll Command Enter a poll command (the command string) that C•CURE 9000 sends to the General Purpose Device as the poll message. Double-click 41°. , the Keyboard button, to open the Virtual Keyboard that allows you to create and edit text strings for a General Purpose Device. For procedural information, see Using the Virtual Keyboard on Page 85. Poll Command Acknowledgement Enter a poll cam ma nd acknowledgment (the oommand string) that the General Purpose Device sends back to C•CURE 9000 as an acknowledgment of the poll message. Double-click 4P. the Keyboard button, to open the Virtual Keyboard that allows you to create and edit text strings for a General Purpose Device. For procedural information, see Using the Virtual Keyboard on Page 85. Hex Format Click this button to display the Hex Format dialog box showing the Hex format of the string entered in the Poll Command on Page 43 or Poll Command Acknowledgement on Page 43 field. NOTE: This button becomes available for either the Poll Command or Poll Command Acknowledgement only after you enter the command string for the field. Journal Unknown Message Select this option if you want unknown messages received by C•CURE 9000 recorded in the historicaljournal. For information about the Journal, see the "Historical Tracking of System Activity' chapter in the C•CURE 9000 System Maintenance Guide. General Purpose Device Editor Tasks The C•CURE 9000 General Purpose Device Editor allow you to accomplish the following tasks: ■ Creating a General Purpose Device on Page 44 ■ Creating a General Purpose Device Template on Page 45 ■ Configuring/Modifying a General Purpose Device on Page 44 ■ Viewing a List of General Purpose Devices on Page 47 ■ Deleting a General Purpose Device on Page 49 ■ Using Set Property for General Purpose Devices on Page 46 C•CURE 9000 General Purpose interface Configuration Guide Chapter 3 43 EFTA01224492 General Purpose Device Editor Creating a General Purpose Device You can create a new General Purpose Device using the General Purpose Device Editor. To Create a General Purpose Device 1. Click the General Purpose Interface button in the Navigation Pane to open the General Purpose Interface Tree. 2. Right-click the Company Folder for which you want to create the device to open the context menu, click General Purpose Device, and then click New on the sub-menu that appears, as shown in Figure 14 on Page 40. The General Purpose Device Editor opens. (For examples of this Editor and its tabs, see Figure 15 on Page 41, and , Figure 19 on Page 52, Figure 22 on Page 59, and Figure 23 on Page 61.) 3. You can now configure the new General Purpose Device. 4. To save your new General Purpose Device, click Save and Close. Or Alternatively, if you want to save the General Purpose Device and then create a new one, click Save and New. The current General Purpose Device is saved and closed, but the General Purpose Device Editor remains open ready for a new General Purpose Device. Configuring/Modifying a General Purpose Device You can configure a new General Purpose Device or modify an existing one using the General Purpose Device Editor. To Configure a General Purpose Device 1. Create a new General Purpose Device or modify an existing General Purpose Device. The General Purpose Device Editor opens (see Figure 15 on Page 41) for you to edit the General Purpose Device making changes as you wish in the fields on the top of the editor, and on any of the tabs with the following exception: You cannot change any fields on either the General, Port, or Communication Protocol tabs when the General Purpose Device is enabled. So enable the Device after you have finished configuring/editing it. 44 Chapter 3 C•CURE 9000 General Purpose interface Configuration Guide EFTA01224493 General Purpose Device Editor 2. Type a Name and Description for the General Purpose Device that sufficiently identifies this Device and its purpose. 3. Select a Vendor for the General Purpose Device from the drop-down list on the General tab. See Figure 15 on Page 41.) 4. Use the General tab to configure the options that affect the polling of the General Purpose Device and whether or not unknown messages are joumaled. For information about creating the Poll text strings, see Using the Virtual Keyboard To Enter Text into General Purpose Interface Fields on Page 87. 5. Use the Port tab (see Figure 17 on Page 50) to set up the port to which the General Purpose Device is connected, selecting the Port type and then the identifying the specific port. 6. Use the Communication Protocol tab (see Figure 19 on Page 52) to configure the communication options for the Device—delay times, header and trailer message characters, the number of message retry attempts, and the message buffer size. 7. Use the Triggers tab (see Figure 20 on Page 54) to configure triggers that can activate Event Actions when the General Purpose Device's online state has a certain value (is either online or offline). 8. Use the State Images tab (see Figure 22 on Page 59) to change the default images used to indicate states for the General Purpose Device on the Monitoring Station, or to return to the default images. 9. When you have finished configuring/modifying the General Purpose Device, make sure that you select the Enabled check box on the top of the editor to put the Device online. 10. To s