You are on page 1of 271

Honeywell Security Developer Kit

User’s Guide
For HSDK 2.1

Notices and Trademarks
Copyright 2014 by Honeywell International Inc.
Release 7.0 - 2014
While this information is presented in good faith and believed to be accurate, Honeywell disclaims
the implied warranties of merchantability and fitness for a particular purpose and makes no express
warranties except as may be stated in its written agreement with and for its customers. In no event
is Honeywell liable to anyone for any indirect, special or consequential damages. The information
and specifications in this document are subject to change without notice.

Honeywell Access Systems
135 West Forest Hill Avenue
Oak Creek, WI 53154
U.S.A
OFFICE HOURS: 8 AM to 5 PM (CST)
PHONE: 414-766-1700
FAX: 414-766-1798
URL: http://www.honeywellintegrated.com

CONTENTS

Chapter 1

About This Guide

1.1: Scope ............................................................................. 1-1
1.2: Purpose .......................................................................... 1-1
1.3: Release Information ....................................................... 1-1
1.4: Major Changes in HSDK 2.0 (version 2.0.121.0) ............. 1-2
1.5: Major Changes in HSDK 2.1 (version 2.1.36.0) ............... 1-2
1.6: Intended Audience ......................................................... 1-4
1.7: Assumed Knowledge ...................................................... 1-4
1.8: Document Conventions ................................................... 1-4

Chapter 2

Introduction

2.1: HSDK Overview .............................................................. 2-2
2.2: Features of HSDK ........................................................... 2-2
2.3: Block Diagram of HSDK .................................................. 2-3
2.4: System Architecture of HSDK ......................................... 2-5
2.5: HSDK Supported Objects ................................................ 2-8
2.6: HSDK Use Cases Scenarios ............................................. 2-9
2.7: Understanding HSDK Concepts ....................................... 2-11

Chapter 3

Installing HSDK

3.1: Obtaining HSDK .............................................................. 3-1
3.2: Prerequisites .................................................................. 3-2
3.3: System Requirements ..................................................... 3-7
3.4: Installing HSDK .............................................................. 3-8
3.5: Upgrade HSDK ................................................................ 3-15
3.6: Verifying the Installed Component ................................. 3-18
3.7: Installing Another HSDK Instance .................................. 3-26

Honeywell Confidential

i

CONTENTS

3.8: Installing HSDK License ................................................. 3-34
3.9: Repairing HSDK .............................................................. 3-40
3.10: Uninstalling HSDK ........................................................ 3-44

Chapter 4

Configuring HSDK

4.1: Configuring Pro-Watch ................................................... 4-2
4.2: Configuring using Application Module Creator Tool ........ 4-3
4.3: Configuring a Site ........................................................... 4-11
4.4: Configuring an HSDK Channel ......................................... 4-15
4.5: Configuring an HSDK Panel ............................................ 4-19
4.6: Configuring a Third-party Application Module ................ 4-22
4.7: Application Module Interface .......................................... 4-28
4.8: Page Layout ................................................................... 4-29
4.9: Verifying Third-Party Connection ................................... 4-29
4.10: Subscribing to Third-Party Objects ............................... 4-31
4.11: Viewing Published Objects ........................................... 4-37
4.12: Subscribing to Third Party Alarms ................................ 4-38
4.13: Viewing Third Party Alarms .......................................... 4-40
4.14: Mapping Third Party Alarms to Pro-Watch Alarms ........ 4-41
4.15: License Information ..................................................... 4-42
4.16: Outbound Configuration ............................................... 4-44
4.17: Accessing External Devices .......................................... 4-46
4.18: Implementation Details ................................................ 4-50
4.19: HSDK Sequence Diagrams ............................................ 4-61

Chapter 5

HSDK Application Programming Interface

5.1: Lobby ............................................................................. 5-1
5.2: HSDK Objects Types ....................................................... 5-2
5.3: HSDK Configuration ........................................................ 5-18

Chapter 6

HSDK Test Client

6.1: Overview ........................................................................ 6-2
6.2: Obtaining HSDK Test Client ............................................ 6-2

Honeywell Confidential

ii

CONTENTS

6.3: Prerequisites .................................................................. 6-2
6.4: Installing the HSDK Test Client ...................................... 6-2
6.5: HSDK Server Login ......................................................... 6-7
6.6: HSDK Test Client User Interface ..................................... 6-8
6.7: Page Layout ................................................................... 6-9
6.8: Using HSDK Test Client .................................................. 6-10
6.9: Controlling Pro-Watch Doors .......................................... 6-18
6.10: Subscribing for Object Updates .................................... 6-21
6.11: Viewing events from Pro-Watch ................................... 6-26
6.12: Acknowledging/Clearing Pro-Watch Alarms ................. 6-27
6.13: Viewing/Modifying Properties of Pro-Watch Objects .... 6-33
6.14: Additional features of HSDK Test Client ........................ 6-35
6.15: Search Pro-Watch objects capability at Server ............. 6-40

Chapter 7

Using Niagara as Third party application

7.1: Overview ........................................................................ 7-1
7.2: Using Niagara in HSDK ................................................... 7-1
7.3: Configuring Niagara Application Module ......................... 7-2
7.4: Configuring Niagara for HSDK ........................................ 7-5
7.5: Initializing the Station .................................................... 7-8
7.6: Connecting to the Station ............................................... 7-11
7.7: Generating the oBIX Points ............................................ 7-13

Chapter 8

Known Issues

8.1: HSDK Known Issues ....................................................... 8-1
8.2: Pro-Watch Known Issues ............................................... 8-3

Chapter 9

Appendix - Troubleshooting Tips

9.1: During the Installation of HSDK ..................................... 9-1
9.2: Problems and Resolutions .............................................. 9-3

Honeywell Confidential

iii

CONTENTS This page is intentionally left blank Honeywell Confidential iv .

3 Release Information Following table provides the release information about the HSDK User’s Guide.0) page 1-2 Intended Audience page 1-2 Assumed Knowledge page 1-4 Document Conventions page 1-4 1. 1. a high-level architecture.0.1 Scope This chapter provides following information and guidelines for using this document.36.121. Purpose page 1-1 Release Information page 1-1 Major Changes in HSDK 2.2 Purpose The purpose of Honeywell Security Developer Kit (HSDK) User’s Guide is to provide a functional overview of HSDK. and the procedure to configure HSDK for third-party application integration.1 ABOUT THIS GUIDE 1.0 (version 2.1 (version 2. Honeywell Confidential 1-1 .0) page 1-2 Major Changes in HSDK 2.1.

0.0) for the release date of Oct 2014.1.0) Document Name Release Number Release Date HSDK User’s guide 7.1.About This Guide Major Changes in HSDK 2.4 Major Changes in HSDK 2.No Changes 1 HSDK is compatible with Windows Server 2012 and Windows 8. (for example: Main entrance door) But there was no reference to which device (input/output/reader) the event was generated.1 operating system. 2 Support for Providing Pro-Watch Device Status to 3rd party.0) for the release date of April 2013. 2 HSDK is compatible with Microsoft SQL Server 2012.5 Major Changes in HSDK 2.0) Following table provides the major changes in the HSDK 2.121.1 (version 2. Sl.No Changes 1 Better Support for Reader integration – Access Door Object. In this release the device level detail is sent to the 3rd party. 3 Device type information in the Pro-Watch event to the 3rd party – In earlier versions.121.0) Following table provides the major changes in the HSDK 2.0 Oct 2014 1.121.0 (version 2. Honeywell Confidential 1-2 . Sl. 4 Support for new Objects: • Access Doors: • AccessPointExtns • IO Devices • IO Groups 1.0 (version 2.36.1 (version 2.0.0.36.0 (version 2. HSDK used to send the Pro-Watch event with the logical device name upon which the event was generated.

• Now. – such as.0.36. The unified installer package installs HSDK and SAM together. 9 The SALTO Application Module Creator tool automates the process of creating a site. If Pro-Watch server is not reachable or not available.0.1 (version 2. When you configure SAM for the first time. then you can refer to instructions. a notification is sent to the third-party applications indicating that the connection is re-established. a progress indicator is shown in Pro-Watch client UI. then event map file contains SALTO events.0) 3 Earlier.About This Guide Major Changes in HSDK 2. 10 Event map XML file is updated for SALTO and Niagara systems. 11 User experience improvements: • When you subscribe for access doors or alarm feed. If you install HSDK along with SAM. 5 Improvised the Installer UI by moving advanced configurations to a separate section and pre-filling all fields. Honeywell Confidential 1-3 . 4 Pro-Watch reconnect patch: HSDK constantly monitors Pro-Watch. HSDK transmitted all Pro-Watch events and alarms to thirdparty application. panel and application module in Pro-Watch manually. channel.117. • If IIS is not installed.1. If you install HSDK alone. you can view the list of steps to configure SAM on SAM configuration UI. 7 You can upgrade SAM from version 1. Now. HSDK configuration file contains description for each setting. HSDK sends a notification to Pro-Watch server that the connection is lost. except password. only alarms or both alarms and events. you can configure the required information that must be transmitted. which are updated for latest operating system such as Windows Server 2012 to install IIS with accurate settings. • You can restart SAM windows service from the diagnostics page of SAM Configuration UI. HSDK shall connect to Pro-Watch automatically once the Pro-Watch server is up.0. Further. then Niagara events would be mapped. • Now. there is no need to go to Service Manager to restart the service.5 or 2. 6 You can upgrade HSDK from version 1. 8 HSDK and SAM installer are unified.

The application programmers will require the understanding of oBIX development environment to use the HSDK APIs for developing the application module.8 Document Conventions • • • • References Acronyms Terms Symbol Definitions Honeywell Confidential 1-4 .Simple Object Access Protocol Proficiency in high level langauage such as C#.6 Intended Audience The intended audience for HSDK User’s Guide are: • • Application Programmers who will develop the application module to integrate a third-party system with Honeywell Physical Access Control System. start/stop a service) Installing IIS Web Server Installing a Program Application Module Developers: • • • • • oBIX Standards specification XML Processing Communication using HTTP protocol and REST framework SOAP .About This Guide Intended Audience 1.7 Assumed Knowledge It is assumed that you are familiar with the following: System integrators/vendors: • • • • Usage of Pro-Watch Basic System Administration task (for example. Application Users who will use the HSDK application module from Pro-Watch and third-party system.NET / VB. 1.NET / Java / C++ 1.

bacnet.oasis-open. 27 2008) available at www.org/committees/ obix/ Physical Access Control with BACNET White Paper (dated Sep.About This Guide Document Conventions 1.8.1 References The following list identifies the documents which can be source of reference material in this document: • • oBIX 1.0 Specifications available at http://www.2 Acronyms The following table lists the acronyms and their definitions used in HSDK User’s Guide. Acronym Definition HSDK Honeywell Security Developer Kit BMS Building Management System HTTP Hypertext Transfer Protocol IIS Internet Information Services PACS Physical Access Control System SOAP Simple Object Access Protocol SQL Structured Query Language (ANSI and ISO) SSL/TLS Secure Socket Layer / Transport Layer Security TCP/IP Transmission Control Protocol / Internet Protocol XML Extensible Markup Language Honeywell Confidential 1-5 .8. 1.org.

Honeywell Confidential 1-6 .About This Guide Document Conventions 1. Web Services Applications that communicate using SOAP over HTTP(S) protocol.8. Terms Definitions Pro-Watch The advanced Access Control Software from Honeywell that serves the customers in high end market segment. SALTO A third party access control system BACNET Building Automation and Control Networks Communication Protocol (ASHRAE).3 Terms The following table lists the terms and their definitions used in HSDK User’s Guide. oBIX Open Building Information Exchange. REST Representational State Transfer.

4 Symbol Definitions Symbol Meaning ATTENTION: Identifies the information that requires special consideration TIP: Identifies advice or hints for the user. REFERENCE EXTERNAL: Identifies an additional source of information outside the document.8. often in terms of performing tasks REFERENCE INTERNAL: Identifies an additional source of information within the document. Honeywell Confidential 1-7 .About This Guide Document Conventions 1.

About This Guide Document Conventions Honeywell Confidential 1-8 .

2 INTRODUCTION This chapter covers the following topics. HSDK Overview page 2-2 Features of HSDK page 2-2 Block Diagram of HSDK page 2-3 System Architecture of HSDK page 2-5 HSDK Supported Objects page 2-8 HSDK Use Case Scenarios page 2-9 Understanding HSDK Concepts page 2-11 Honeywell Confidential 2-1 .

energy. If the Security and Building Management Systems are integrated. Industry Compliance — HSDK interface is compliant with industry standard oBIX protocol. supervisory. Integrated Solution — HSDK provides an integrated solution for the Security system using which you can control the third-party components (for example.2 Features of HSDK The key features of HSDK include: • • • • • Commercial Security — Honeywell Security Developer Kit is a development tool aimed at creating a commercial security eco-system. Building Management System) as per the data provided from PACS. It enables the centralized monitoring of security and secondary fire at one control center. multiple third-party application modules can associate to a single Pro-Watch server. HSDK provides building blocks to create Application Modules or solutions for integrating the Honeywell Security applications with third-party systems. and supervisory systems and the Security System manages the access to the building. HSDK acts both as oBIX server and an oBIX client. Collaboration — Through HSDK. Honeywell Security Developer Kit (HSDK) acts as a bridging service between Physical Access Control System (PACS) and any other third-party system by using the industry standard Open Building Information Exchange (oBIX) format. the Building Management System (BMS) manages the energy. Centralized Monitoring — HSDK enables centralized monitoring of security and secondary fire at one control center. a fire HSDK Application Module enables Pro-Watch to function as a Honeywell Secondary Fire Notifier monitoring station. Honeywell Confidential 2-2 . and other systems. secondary fire. 2. The HSDK bridging service allows the information transfer from a third-party application to PACS and vice versa. it is possible to have a centralized monitoring station for security.1 HSDK Overview In a multi-storey commercial building scenario.Introduction HSDK Overview 2. life-safety. For example.

Introduction Block Diagram of HSDK 2.3. The public interface is based on Open Building Information Exchange (oBIX) industry standard. An adapter platform is a layer of software that converts the data from the application into a common form acceptable for integration with other applications. Following key components of HSDK are described in this section: Honeywell Confidential 2-3 .1 HSDK Key Components Each HSDK adaptor consists of a public and a private interface. 2.3 Block Diagram of HSDK The following figure displays the HSDK block diagram. HSDK is based on an adaptor platform running as a separate Windows process. The private interface is Honeywell proprietary and connects directly to the target application interface and/or SQL database.

managing and configuring the integrated security policy. Elevator Honeywell Confidential 2-4 . HSDK helps you to develop adaptors which can be used to integrate third-party products with Honeywell Physical Access Control Systems.Introduction Block Diagram of HSDK • • • Host System HSDK Interface Application Module Host System PACS (Physical Access Control System) is responsible for executing. – HSDK Server The HSDK Server connects to Pro-Watch Database (referred as PWNT Database in the system architecture) and provides object or event updates to third-party system (for example. Permission and authorization mechanisms for registering application modules and third-party objects. It provides an integrated solution for the Security System using which you can control the third-party components (for example. Pro-Watch) is an interface for an operator to monitor and control the third-party devices. Selection of objects from a third-party application. Application Module An application module (or HSDK Application Module) is an application developed by application developers to integrate third-party systems (for example. It is also called as Host System in HSDK context. Building management system) as per the information from host system. Alerton. HSDK Interface The HSDK interface consists of HSDK Server and HSDK Client. There can be one instance of HSDK Client service for each application module configured in ProWatch. which are accessible for host consumption through the application module. The host system defines the following: • • • Selection of objects published for external consumption by an application module or third-party application. A host system (for example. – HSDK Client The HSDK Client provides object or event updates to Pro-Watch. Notifier).

It utilizes the REST based oBIX interface of HSDK to enable the different integration scenarios. Third-Party System In HSDK. a third-party system (for example: Alerton or Notifier) refers to any third party application which communicates with Pro-Watch. You can view the details of published and subscribed objects related to that application module in Pro-Watch user interface. An application module is a customized middleware mechanism and acts as a link to the information of the third-party system. through HSDK interface. Honeywell Confidential 2-5 .Introduction System Architecture of HSDK control. For example. etc. BacNet support. HSDK interface.4 System Architecture of HSDK The following figure displays a high-level communication and relationship between Pro-Watch. a Fire HSDK application module enables Pro-Watch to function as a Honeywell secondary fire Notifier monitoring station. 2. and a third-party system through oBIX Request and Response. HVAC integration. An application module created in Pro-Watch. for object or event updates.) with Honeywell Physical Access Control Systems (PACS) through HSDK interface.

4. HSDK Server The HSDK Server connects to Pro-Watch Database (referred as PWNT Database in the system architecture) and provides object or event updates to third-party system (for example. Notifier).1 HSDK Interface The HSDK interface consists of HSDK Server and HSDK Client.Introduction System Architecture of HSDK Following are the key components in the above HSDK system architecture: • • • HSDK Interface Pro-Watch Application Module Web User Interface 2. Alerton. Honeywell Confidential 2-6 .

2. 2-7 . 2.4. The Pro-Watch initiated communication with HSDK to request information from third-party system occurs through PW2HSDKBridge. This resides in the Pro-Watch bin folder.).dll. the HSDK server port is 80 which can be changed during HSDK installation. http:// hsdkserver:80/.4. Stage Description 1 Honeywell Confidential The third-party application access the URL of HSDK Server. This information is available through web pages hosted in HSDK. By default. The following table describes the various stages of communication between ProWatch.3 Application Module Web User Interface An Application Module Web UI is a set of web pages which are shown in Pro-Watch Application Module on different tabs (for example.Introduction System Architecture of HSDK HSDK Client The HSDK Client provides object or event updates to Pro-Watch. licensing. for example. published and subscribed objects with respect to each third-party application is represented in ProWatch as information related to an application module. Published objects / subscribed objects / License etc. The HSDK Client (for each application module) is the owner of the License information. It provides the License data to Pro-Watch / Application module web pages / or HSDK Server whenever requested. The Application Module Web Pages provide Information on configuration. There can be one instance of HSDK Client service for each application module configured in ProWatch. making requests to HSDK Client. HSDK and a third-party system.2 Pro-Watch Pro-Watch is an interface for operator to monitor and control the third-party devices or points.

2. The HSDK Server retrieves information from Pro-Watch (PWNT) database and displays the results in Restful oBix XML format. The PWBridgeService component resides inside HSDK Client service and listens for requests from HSDK Server. Client. This port can be changed in the associated config file located in the HSDK Client folder. readers. or events generated by the connected PACS system. and areas etc. It Honeywell Confidential 2-8 . The Lobby URL configured in the Application Module is the third-party oBIX Server Lobby which is accessed by the Application Module.Introduction HSDK Supported Objects 2 3 4 5 6 The IP address and Port specified for the HSDK Channel communication parameters is the end-point where the HSDK Client listens for requests from Pro-Watch. and Application Module Web UI) is associated for each Application Module configured in Pro-Watch.5 HSDK Supported Objects HSDK can be used to obtain information about the security objects like users. A change of this value will require a change in the config file of the client service.. An instance of HSDK (Server. The Web UI displayed in the Application Module screens are part of the HSDK suite. cards.

The following table provides the list of objects in Pro-Watch that are supported by HSDK: Sl No BACnet Term Pro-Watch object Term Comments 1 Access User Badge Holder 2 AccessCredential Card 3 AccessZone Area 4 AccessPoint Logical Device 5 AccessRight Clearance Code 6 AccessDoor Logical Device New object in HSDK 2.6 HSDK Use Cases Scenarios The following sections provides the generic HSDK use case scenarios: Honeywell Confidential 2-9 .Introduction HSDK Use Cases Scenarios provides information on these objects in the form of an industry standard oBIX format.0 and 1.0 replacing Access Point to represent the logical device(having atleast one reader) 7 AccessPointExtn Reader Reader point of an AccessDoor/ Logical Device For example. Rex Device or Door Position 9 OutputDevices Output Point Output Point of an AccessDoor/ Logical Device For example. Lock or Horn 10 IOGroup Logical Device Represent the logical device having atleast one input point or one output point but no readers. 11 TimeZone Time Zone For backward compatability to support HSDK 1. 8 InputDevices Input Point Input Point of an AccessDoor/ Logical Device For example. Primary or secondary reader of a door.0 2.5 Do not use in HSDK 2.

OLE. The application module then creates an HSDK area object instance for each instance of the third-party area and links the HSDK area name and counter. behavior. The elevator controller API enables the elevator management application module to receive events or alarms from the elevator controller access.2 Elevator Management A third-party application developer creates an HSDK compliant elevator management application module. Once the elevator management application module is created.NET or web services interfaces). In this scenario. A third-party application developer creates an HSDK compliant video analytics system application module. The application module uses the third-party video analytics system API to collect a list of available areas (or objects) indexed by name. The Pro-Watch administrator will perform the following functions: Honeywell Confidential 2-10 . HSDK acts as a integration platform between Physical Access Control System (ProWatch) and the third-party system (Video Analytics System). objects or attitude. a corresponding area is created in Pro-Watch linked to the HSDK area object defined in the application module. thus. 2. The elevator controller includes the equivalent of an access point and provides a highlevel interface accessible via a Windows COM interface (DLL. Each area object includes a name and counter.. The Pro-Watch administrator subscribes to the created HSDK area object. Pro-Watch logs and manages the alarm and access events (including access granted with floor information).Introduction HSDK Use Cases Scenarios 2. The application module exposes an access point to Pro-Watch.6. Once you subscribe for the HSDK area object. An example of video analytics application include counting the number of pedestrians entering a door or geographic region. representing the elevator reader and the floor request mechanism (floor select).6. The elevator management application module interfaces to elevator controller. The video analytics system application module binds to an instance of the Pro-Watch and the third-party video analytics system API. as per the license. the elevator management application module can support two publishable access points to Pro-Watch.1 Video Analytics System Video Analytics Systems provide a technology that is used to analyze video for specific data. You can view and modify the third-party objects through the Pro-Watch User Interface.

Drive HVAC and lighting controls on the basis of area occupancy. Logs and audits events from elevator management application module. Configure and provision the elevator management application module access point in Pro-Watch. The HSDK checks if the elevator management application module has enough licenses to expose one or more access points.Interoperability of Alerton Interface with Pro-Watch through HSDK * Application Modules developed by Application Developers on Niagara Framework.7. 2.7 Understanding HSDK Concepts The section describes HSDK concepts and a generic flow for a third-party application to communicate with HSDK oBIX Server. Interoperability of Fire Alarm Interface (FAI) with Pro-Watch through HSDK.1 Use Case Scenarios • • Notifier.Introduction Understanding HSDK Concepts • • • • Register the elevator management application module in Pro-Watch by creating an oBIX channel. 2. Create Pro-Watch responses to FAI conditions and alarms Enable security operators to perform secondary monitoring of the fire system alarms and events. b. Drive HVAC and lighting controls on the basis of card events/profiles Monitor HVAC system alarms and events in Pro-Watch. Monitor and manage alarms from the elevator management application module. Interoperability of Alerton Interface with Pro-Watch through HSDK. Honeywell Confidential 2-11 .Interoperability of Fire Alarm Interface (FAI) with Pro-Watch through HSDK Alerton. a.

The third party alarms will be mapped to appropriate alarms in Pro-Watch based on the mapping configuration. Subscribe for Pro-Watch Alarms and use third party system as Secondary monitory station for Pro-Watch Alarms.7.2 Usage scenarios Subscribe & Access States of Pro-Watch Objects to control third party systems.Introduction Understanding HSDK Concepts 2. Example • • Add AccessUser/AccessCredentail etc in to Pro-Watch Modify AccessUser/AccessCredential etc in Pro-Watch Honeywell Confidential 2-12 . Bring in third party system objects (Currently support all the oBIX Points) in to Pro-Watch and represent them as Pro-Watch objects (Input/Output devices). Subscribe for third party Alarms and use Pro-Watch Alarm Monitor as a secondary monitoring station for third party alarms. Add/Modify Pro-Watch objects (Act as a Pro-Watch API). Examples: • • • • • Control a lighting point in a room based on the room’s occupancy count.

Also. with the following components: • • • HSDK Installation Setup — Contains HSDK setup and installation files for HSDK Server and Client. HSDK User’s Guide — Provides HSDK installation and configuration details.1 Obtaining HSDK HSDK is available on the CD-ROM.3 INSTALLING HSDK This chapter covers the following topics Obtaining HSDK page 3-1 Pre-requisites page 3-2 System Requirements page 3-7 Installing HSDK page 3-8 Upgrade HSDK page 3-15 Verifying the Installed Components page 3-18 Installing Another HSDK Instance page 3-26 Installing HSDK License page 3-34 Repairing HSDK page 3-40 Uninstalling HSDK page 3-44 3. the setup contains SAM installer for unified installer. Honeywell Confidential 3-1 . HSDK Sample Test Client — Can be used to connect to the HSDK Server.

0 Management Compatibility for IIS 7.2 Prerequisites Before installing HSDK on your system.1 hosted on the Windows Server 2008 R2 and Windows Server 2012. Pro-Watch version 4. Honeywell recommends you to turn off ESC for HSDK 2.2. ensure that the following prerequisites are met: • Supported Operating Systems: – Windows Server 2003 SP2 – Windows Server 2008 – Windows Server 2008 R2 – Windows 7 – Windows 8. turning off IE ESC is safe to access web browser on a server machine.NET Framework 3.0 and later Microsoft.1 – Windows Server 2012 – • • • HSDK supports 32-bit and 64-bit architectures of the above operating systems. For non-adminstrators (users).1 or later. IIS features/components: – ASP. Note Honeywell Confidential 3-2 . To turn off ESC for Windows Server 2008 R2. Pro-Watch can be installed on the same server that deploys HSDK or on a separate computer. 3. connected over a TCP/ IP network to the HSDK.1 Turn off Internet Explorer Enhanced Security Configuration The Internet Explorer Enhanced Security Configuration (IE ESC) configures your server and Internet Explorer to decrease the exposure of your server to potential attacks through web content and application scripts. refer to “To turn off IE ESC for Windows Server 2012“ on page 5. refer to “To turn off IE ESC for Windows Server 2008 R2“ on page 3 and to turn off ESC for Windows Server 2012.NET – Basic Authentication – IIS 6.5 with Service Pack 1 is installed.Installing HSDK Prerequisites 3.

Honeywell Confidential 3-3 . Click Start > Programs > Administrative Tools > Server Manager.Installing HSDK Prerequisites To turn off IE ESC for Windows Server 2008 R2 1. click the Configure IE ESC link in the Security Information section. 2. The Server Manager window appears. Under Server Summary. The Internet Explorer Enhanced Security Configuration dialog box appears.

Now. the status of IE ESC changes to turned off and displayed in the Security Information section. Select the option to turn off IE ESC for Administrators and/or Users. Honeywell Confidential 3-4 .Installing HSDK Prerequisites 3. Click OK. 4.

2. The Server Manager window appears. click Local Server on the left pane. Click against Start menu > Programs > Administrative Tools > Server Manager. 3. Under Server Manager > Dashboard.Installing HSDK Prerequisites To turn off IE ESC for Windows Server 2012 1. Click On against IE Enhanced Security Configuration to change the option. Honeywell Confidential 3-5 . The Properties of the local server appears on the right pane.

6. Select the Off option to turn off IE ESC for Administrators and/or Users. 5. In the Server Manager > Local Server window. Honeywell Confidential refresh icon to view 3-6 . Click OK. click the the updated details. 4.Installing HSDK Prerequisites The Internet Explorer Enhanced Security Configuration window appears.

Component Minimum Recommended Free Hard Disk Space 2 GB 10 GB RAM 4 GB 16 GB or More Honeywell Confidential 3-7 . the status of IE ESC changes to Off 3.3 System Requirements The following table provides the hardware and software requirements for installing HSDK.Installing HSDK System Requirements Now.

32 bit. Windows 7 . Windows Server 2008 .4 Installing HSDK To install the Honeywell Security Developer Kit (HSDK) 1. Windows Server 2008 . Microsoft Windows Server 2003 . Or above IIS 7. Insert the HSDK CD into the CD-ROM drive.32 bit. go to the Setup folder in the CD-ROM and right-click Setup. If the setup does not run.64 bit Windows 7 .NET Framework 3. The Welcome dialog box appears. Honeywell Confidential 3-8 .5 with Service Pack 1 3.64 bit. Or Windows Server 2008 R2 Database SQL Server 2005 with Service Pack3 Or SQL Server 2008 with Service Pack1 SQL Server 2008 R2 SQL Server 2008 with Service Pack1 Or SQL Server 2008 R2 Web Server IIS 6.5.0. The setup runs automatically. Windows Server 2008 64 bit.5 with Service Pack 1 .32 bit.Net .NET Framework 3. Windows Server 2008 R2 .64 bit. Or above . 2003 with Service Pack 2 .64 bit.Installing HSDK Installing HSDK Operating System Microsoft Windows Server.exe and select Run as administrator on the shortcut menu.

3. The License Agreement dialog box appears. Click I accept the terms in the license agreement to accept the license agreement after reading the license agreement. Click Next. Honeywell Confidential 3-9 . 4.Installing HSDK Installing HSDK 2. Click Next.

click Change and choose the folder in which HSDK is to be installed. Under Pro-Watch. Alternatively. 6. For example.The SQL Database Information dialog box appears. Type the Pro-Watch database name in the Pro-Watch Database Name field. Type the instance name of the SQL database server. the Pro-Watch Comm Server name is the name of the computer in which the Pro-Watch Database Server is installed. click Browse and select the HSDK database server from the SQL Server List window as shown below. To change the destination folder. Type the computer host name where Pro-Watch is installed. By default. enter the following details of the HSDK database server and database name to create a new database for HSDK: • Type the name of the computer in which the HSDK Database Server is installed. click Browse and select the Pro-Watch database server from the SQL Server List window as shown below. COMPUTER_NAME\INSTANCE_NAME. 5. Under HSDK. enter the following details of the Pro-Watch database server to which HSDK must connect: • • • Type the name of the computer in which the SQL Database Server is installed. Alternatively. if available. Note 7. Honeywell Confidential 3-10 .

in the SQL Database Information window. in which you must provide the details of the HSDK website to be configured. Under Website Configuration. a. appears. Honeywell Confidential 3-11 . in the Web Site Name field. The Web Site Configuration dialog box. – By default. Type the HSDK database name in the HSDK Database Name field Click Next. the HSDK website name is displayed.Installing HSDK Installing HSDK • 8.

b. • In SSL Port Number. Click Advanced. Under User Credentials. – – Type the Domain Name of HSDK webserver where HSDK application will be hosted. ensure to provide a website name different from the “Default Web Site”. The HSDK Service Configuration Details dialog box appears. Type the User Name and Password to access the HSDK application. under the Website Port Details. b. enter the following: • In TCP Port Number. The default value is 80. The SSL Port Number is the secure port number of the HSDK webserver. you can use the Advanced option to modify the port details. Ensure that there are no spaces while entering the Application Module Name. The default value is 443. Optionally.Installing HSDK Installing HSDK If Pro-Watch web component is installed in the system. a. type the port number. change the TCP and SSL port numbers to unused port numbers. The port numbers Note Honeywell Confidential 3-12 . type the port number. If Pro-Watch web component is installed and website name is different from the “Default Web Site”. In the HSDK Port Details. Note – Note Type the HSDK Application Module Name. This is the port number of the HSDK webserver.

This is HSDK client service port. In the HSDK Port Details. enter the following: • Type the HSDK Service TCP Port Number. By default the Pro-Watch Bridge Service port is updated to 8090. Honeywell Confidential 3-13 . Ensure that the HSDK client and license port numbers are different from the port number provided for the website.Installing HSDK Installing HSDK ranging from 50051 to 50060 can be used for HSDK as these ports are less-used by other applications. c. Click Next. This is HSDK license port number. under the Service Port Details. Note 9. The Ready to Install the Program dialog box appears. • Type the HSDK License TCP Port Number.

11.Installing HSDK Installing HSDK 10. Honeywell Confidential 3-14 . Click Back to check and confirm the values or click Install to continue with the installation. The installation summary is displayed. Click Finish to complete the installation.

Insert the HSDK CD into the CD-ROM drive. Note To upgrade HSDK with a later version 1. The upgrade on earlier versions of HSDK is not tested and qualified. Honeywell Confidential 3-15 .121.0) only. 2.The InstallShield Wizard dialog box appears.Installing HSDK Upgrade HSDK 12.exe and select Run as administrator on the shortcut menu to start the installation. 3.38) and HSDK 2. Click Maintain or Upgrade an existing instance option. Or Right-click the Honeywell Security Developers Kit.0.0.5 (version 1.5 Upgrade HSDK You can upgrade from HSDK 1.0 (version 2.exe. Click Yes to restart your computer for the installation to complete. Navigate to the folder containing Honeywell Security Developers Kit.9.

The Welcome InstallShield Wizard appear. Honeywell Confidential 3-16 .Installing HSDK Upgrade HSDK 3. The installer automatically displays an option to upgrade SAM if the SAM application is already installed on your computer. The Installing Honeywell Security Developers Kit wizard appears and displays the installation progress. Select the required product from list to upgrade and then click Next. Note The InstallShield Wizard displays the progress of windows installer. Click Next. A message box appears click Yes. 4.

Honeywell Confidential 3-17 . Click Finish to complete the upgrade process. Note 5.Installing HSDK Upgrade HSDK If any files that needs to be upgraded are in use. the Files in Use screen appears. Select the required option and then click OK.

The Programs and Features window appears. ensure that the following components are installed. Click Yes to restart immediately. 3. Honeywell Confidential 3-18 . • • HSDK Application Module • Virtual Directory • Certificates • Authentication Method • HSDK URL • HSDK DataBase HSDK Application Module 1. Or Click No to restart the system later manually. Choose Start > Settings > Control Panel. Click Programs and Features.Installing HSDK Verifying the Installed Component A message box appears and prompts you to restart the system. 2. The Control Panel window appears. 6.6 Verifying the Installed Component After successful installation of HSDK.

virtual directory name is the HSDKPNL<Application Module> where <Application Module> is the name of the application module given while installation. Click Administrative Tools. Virtual Directory 1. • Under Uninstall or Change a Program list. select the Honeywell Security Developer Kit Application Module program and verify the installed version of HSDK Interface. The Control Panel window appears. 2. Here. 3. The Internet Information Services Manager window appears. Using the Internet Information Services Manager. The Administrative Tools window appears. check if the virtual directory is created. Ensure the virtual directory name is same as specified during installation. Choose Start > Settings> Control Panel. Honeywell Confidential 3-19 . Click Internet Information Services.Installing HSDK Verifying the Installed Component 3.

Installing HSDK Verifying the Installed Component 4. Under Connections pane. In the Internet Information Services Manager. 3. The Control Panel window appears. Or Run ->inetmgr. ensure that the website points to the folder where you have installed HSDK application module in local machine. view the following Properties for the virtual directory: • • In Virtual Directory tab. The Administrative Tools window appears. The Internet Information Services Manager window appears. the Internet Information Services Manager window appears 4. Honeywell Confidential 3-20 . Click Administrative Tools. Choose Start > Settings> Control Panel. Certificates 1. 2. highlight the IIS server as shown below. Click Internet Information Services.

select the IIS Server.Installing HSDK Verifying the Installed Component 5. Under Server Certificates list. 6. Right-click the IIS Server and then select View as shown below. double-click the Server Certificates element under IIS. In the Feature view pane. 7. Honeywell Confidential 3-21 . The Server Certificates pane appears.

In the Certificate dialog box. 8.Installing HSDK Verifying the Installed Component The Certificate dialog box appears. Honeywell Confidential 3-22 . verify the Certificate Information for the installed application module.

the Internet Information Services Manager window appears 4.Installing HSDK Verifying the Installed Component • Authentication Method 1. The Administrative Tools window appears. Or Run ->inetmgr. The Control Panel window appears. 2. Honeywell Confidential 3-23 . Click Internet Information Services. highlight the HSDKPNLApplicationModule. Under Connections pane. Click Administrative Tools. 3. 5. double-click the Authentication element. The Internet Information Services Manager window appears. In the Feature view pane. Choose Start > Settings> Control Panel.

http://EXCELLENCE:9010/HSDKPNLTPApplicationModule/ You can also access the Lobby by navigating to Start > Programs > HSDK > TPAppicationModule > Lobby. To install a permanent license refer to Installing HSDK License. ensure that the status of Basic Authentication is Enabled.Installing HSDK Verifying the Installed Component 6. • In the Authentication pane. After entering the Lobby URI (which is the HSDK Application Module URL) in the browser. port number is the HSDK Service TCP Port Number. For example. go to Internet Explorer and type the following address: http://<machine name:port number>/<HSDK-ApplicationModule name> Here. To view the HSDK Application Module URL. • • • machine name is the machine name where HSDK application is hosted. The Lobby URI Honeywell Confidential 3-24 . it will ask for username and password to connect to HSDK. The demo license is installed by default for the first instance in a machine. License A different license is required for each application module that is installed. • HSDK URL 1. HSDK-ApplicationModule name is the Application Module Name for the thirdparty application.

2. If the link to PACS works. Honeywell Confidential 3-25 . the Pro-Watch connection is successfully established.Installing HSDK Verifying the Installed Component provides the lists the URIs for other well-known objects defined by the oBIX specification. • Click the PACS link as shown in the above HSDK Application module URL. After you enter the username and password. In the Microsoft SQL Server Management Studio window. HSDK Database 1. Otherwise. verify the PACS connection details specified and modify it. Connect to the SQL Server. 2. the HSDK Application Module web page is displayed. verify if the database name (HSDK) specified during installation appears.

2.exe and select Run as administrator on the shortcut menu.Installing HSDK Installing Another HSDK Instance 3.7 Installing Another HSDK Instance The HSDK installer allows you to install the multiple instances of HSDK. Select Install a New Instance option. Honeywell Confidential 3-26 . Right-click Honeywell Security Developers Kit. To install the HSDK second instance: 1.

3.Installing HSDK Installing Another HSDK Instance The progress bar is displayed while the window installer is being configured. The Welcome dialog box appears Honeywell Confidential 3-27 . Click Next.

Note 4.Installing HSDK Installing Another HSDK Instance Note If you select the Use Previous instance configuration check box the installation uses the previous instance configuration details and installs the HSDK. The License Agreement dialog box appears Honeywell Confidential 3-28 . Click Next. 5. Refer to Using Previous Instance Configuration section. Deselect the Upgrade SALTO Application Module check box. the Upgrade SALTO Application Module check box appears and it is selected by default. When SAM is installed in the system.

7.Installing HSDK Installing Another HSDK Instance 6. The SQL Database Information dialog box appears. Select I accept the terms in the licence agreement option and click Next. To change the destination folder. enter the following details of the Pro-Watch database server to which HSDK must connect: Honeywell Confidential 3-29 . 8. Under Pro-Watch. click Change and choose the folder in which HSDK is to be installed.

Click Next. click Browse and select the Pro-Watch database server from the SQL Server List window as shown below. the Pro-Watch Comm Server name is the name of the computer in which the Pro-Watch Database Server is installed. Honeywell Confidential 3-30 .Installing HSDK Installing Another HSDK Instance • • • Type the name of the computer in which the SQL Database Server is installed. in the SQL Database Information window. Type the instance name of the SQL database server. COMPUTER_NAME\INSTANCE_NAME. For example. Alternatively. enter the following details of the HSDK database server and database name to create a new database for HSDK: • • Type the name of the computer in which the HSDK Database Server is installed. Alternatively. By default. if available. Type the Pro-Watch database name in the Pro-Watch Database Name field. Type the computer host name where Pro-Watch is installed. Note 9. Type the HSDK database name in the HSDK Database Name field 10. click Browse and select the HSDK database server from the SQL Server List window as shown below. Under HSDK.

Installing HSDK Installing Another HSDK Instance The Ready to Install the Program dialog box appears. 11. The installation summary is displayed. Honeywell Confidential 3-31 . Click Back to check and confirm the values or click Install to continue with the installation.

Click Finish to complete the installation.Installing HSDK Installing Another HSDK Instance 12. Honeywell Confidential 3-32 . 13. Click Yes to restart your computer for the installation to complete.

Installing HSDK Installing Another HSDK Instance 3. To install the HSDK using the previous instance configuration.7.1 Using Previous Instance Configuration If you select the Use Previous instance configuration check box a drop-down list of already installed instance is displayed as shown below. After selecting the Use Previous instance Configuration check box. perform the following steps 1. The Installation configuration screen appears. Honeywell Confidential 3-33 . select the required existing configuration from the drop down list and then click Next.

8 Installing HSDK License 3. Type the Password for Service Logon Configuration and then click Next. 3. 2. The Ready to Install screen appears. 3.Installing HSDK Installing HSDK License The installation Configuration screen displays Database Information.8. Honeywell Confidential 3-34 .1 Accessing HSDK License Manager: • To open the HSDK License Manager screen. Repeat step 11 through step 14 of Installing Another HSDK Instance section and complete the installation. go to Start -> Programs -> HSDK -> <App Module> -> LicenseManager. Service Logon Configuration. Web Site Configuration and HSDK Port Details of a previous instance.

3. Rename the XML file to HSDKLicense.8.xml) for that Node ID and sends back to you.8.2 Access Node ID and send it to Honeywell: In HSDK License Manager screen.Installing HSDK Installing HSDK License 3.8. you get the Node ID. Honeywell generates one License file (. You can click on Send by Mail button to open the default email client configured in the system.3 Get the License file: After sending the Node ID to Honeywell. 3. You can copy the Node ID by clicking on Copy to Clipboard button and send it to Honeywell.4 Install the License: After receiving the License file from Honeywell perform the following steps 1.xml. Honeywell Confidential 3-35 .

3. Select the License file (HSDKLicense. Install it by clicking on the Install License button which pops up a dialog box to select the License file.xml) received from Honeywell and click Open.8.5 Verify License Status • Verify that the License Status is Valid in License Info page (Start -> Programs -> HSDK -> <App Module> -> License Info) Honeywell Confidential 3-36 .Installing HSDK Installing HSDK License 2. When the licence is installed successfully the following message appears. 3.

Honeywell Confidential 3-37 .6 Enable Grace Period Grace period should be enabled only if the license status in License Info page (Start -> Programs -> HSDK -> <App Module> -> License Info) is shown as one of the following status: a) InvalidNodeId b) IrretrievableNodeId In any other condition.8. Note To enable the grace period. Grace period should not be enabled.Installing HSDK Installing HSDK License 3. perform the following steps: 1. Click on Enable Grace Period button in HSDK License Manager window and click Yes when asked for confirmation.

Honeywell Confidential 3-38 .7 HSDK Trace HSDK trace is a special feature in HSDK where you can see the XML’s coming in and going out of the HSDK Server. Grace Period Successfully Enforced message will appear as shown below. 3.8.Installing HSDK Installing HSDK License 2.

and modify the Log Level to change the value to 4 as shown below.config file in a text editor like Notepad. you need to modify the configuration file.exe. and modify the Log Level to change the value to 4 as shown below. • To enable HSDK Trace for HSDK Server. <add key="logLevel" value="4"/> Honeywell Confidential 3-39 .Installing HSDK Installing HSDK License Enabling HSDKTrace To get all the XMLs in the HSDK trace. open HSDK Server\web. <add key="logLevel" value="4"/> • To enable HSDKTrace for HSDK Client.config file in a text editor like Notepad. open HSDK Client\HSDKObixClientService.

9 Repairing HSDK To repair HSDK perform the following steps: 1. Insert the HSDK CD into the CD-ROM drive. In the InstallShield Wizard. Functions of HSDK Trace • • Double click on bottom left corner of the window to Suspend / Resume the trace. Double click on bottom right corner of the window to Clear the trace. go to Start -> Programs -> HSDK -> <App Module> -> HSDKTrace.The InstallShield Wizard window appears. 3. Honeywell Confidential 3-40 . Navigate to the folder containing Honeywell Security Developers Kit. 2.Installing HSDK Repairing HSDK Accessing HSDK Trace To open the HSDK Trace window. click Maintain or upgrade an existing instance.exe.

Installing HSDK Repairing HSDK 3. In the InstallShield Wizard. Under Product Name. 4. click Next. select the HSDK instance which you want to repair and then click Next. Honeywell Confidential 3-41 .

click Repair and then click Next. click Install to repair the HSDK system. Honeywell Confidential 3-42 . 6. If you want to review or change any settings.Installing HSDK Repairing HSDK Note 5. click Back. In the Ready to Repair the Program window. In the Program Maintenance window.

appears.. Honeywell Confidential 3-43 . Click Finish to complete the installation. prompting you to restart.Installing HSDK Repairing HSDK The installation status is displayed. 7. A message box.

Click Yes to restart immediately. Select Honeywell Security Developers Kit . The Program list is populated. Go to Start > Settings > Control Panel > Add/ Remove Programs.10 Uninstalling HSDK To remove HSDK from the machine perform the following steps: 1. Select the HSDK instance which you want to uninstall and click Next. Honeywell Confidential 3-44 . Or Click No. 3. 2.[Application Module Name] and click Remove.Installing HSDK Uninstalling HSDK 8. 3. The progress bar for install shield wizard is displayed. Click Maintain or upgrade an existing instance. 4.

Note Click Next.Installing HSDK Uninstalling HSDK 5. Honeywell Confidential 3-45 . Click Remove and then click Next. If you want to review or change any settings. Click Remove to completely remove the HSDK Application Module from the system. 6. 7. click Back.

If you uninstall HSDK. Note Honeywell Confidential 3-46 . the website will not get deleted which is created during installation.Installing HSDK Uninstalling HSDK The progress bar is displayed while the uninstallation is taking place. 8. Click Finish to complete the uninstallation.

Installing HSDK Uninstalling HSDK Note You must restart the system for the changes to take effect. Honeywell Confidential 3-47 .

CONFIGURING HSDK 4 This chapter covers the following topics Configuring Pro-Watch page 4-2 Configuring using Application Module Creator Tool page 4-3 Configuring a Site page 4-11 Configuring an HSDK Channel page 4-15 Configuring an HSDK Panel page 4-19 Configuring a Third-party Application Module page 4-22 Application Module Interface page 4-28 Page Layout page 4-29 Verifying Third-Party Connection page 4-29 Subscribing to Third-Party Objects page 4-31 Viewing Published Objects page 4-37 Subscribing to Third Party Alarms page 4-38 Viewing Third Party Alarms page 4-40 Mapping Third Party Alarms to ProWatch Alarms page 4-41 License Information page 4-42 Outbound Configuration page 4-44 Accessing External Devices page 4-46 Implementation Details page 4-50 HSDK Sequence Diagrams page 4-61 Honeywell Confidential 4-1 .

Specifically. respectively. This section describes following sections to configure Pro-Watch to utilize the HSDK functionalities: Honeywell Confidential 4-2 . Pro-Watch as a host system integrates with HSDK to execute. Access rights.Configuring HSDK Configuring Pro-Watch 4. The third-party application is represented in Pro-Watch as a virtual panel called oBIX Panel and all the third-party objects are represented as input or output objects (or points) under oBIX groups. Access credentials. enabling distributed innovation. and Access doors). Access Zones. Publish events from all sources. Access Users. Pro-Watch operations can be invoked from third-party application Subscribe to third-party objects from Pro-Watch (currently only oBIX points are supported). To invoke third-party operations from Pro-Watch. Publish all BACNET Access Objects (Access points. Every HSDK application connected to Pro-Watch is represented as a separate application module. The values of BACNET objects and alarms can be viewed in Pro-Watch event monitor. Pro-Watch publishes and subscribes to third-party objects through the third-party application module defined in Pro-Watch. and configure the integrated security policy. configure Pro-Watch and create the application module in Pro-Watch. Once HSDK installation is complete.1 Configuring Pro-Watch Pro-Watch is an advanced Access Control Software from Honeywell that serves the customers in high-end market segment. Subscribe to third-party alarms from Pro-Watch. manage. HSDK is a strategic sales and marketing enabler that allows global teams to rapidly integrate new products to Honeywell Security platforms such as Pro-Watch. HSDK acts as the interface between a third-party application and Pro-Watch. HSDK provides the required information to third-party application by interacting with Pro-Watch and at the same time receives the information from the third-party application and provides it to Pro-Watch. Pro-Watch interfaces with HSDK to service the following requests: • • • • • • • Publish logical devices for external consumption (such as BACNET objects). This will allow you to discover BACNET (or third-party) objects or alarms and subscribe to it. thus. HSDK provides tools to develop adaptors that can be used to integrate third-party products.

type a description in the Application module description field. To configure Application Module Creator 1. a shortcut-key is created on the desktop. 2. Poll Interval Time: The poll interval sets the number of seconds that elapses between each poll by the host computer. The Create SALTO Application Module dialog box appears. During HSDK and SAM installation. Channel Name: You can retain the default name or type a name for the channel. c. panel and application module in Pro-Watch client UI. A channel name allows upto 100 characters but not slash characters (\ and /). Site Name: You can retain the default name or type a name for the site.Configuring HSDK Configuring using Application Module Creator • • • Configuring a Site Configuring an HSDK Channel Configuring an HSDK Panel 4. d. A panel name allows upto 100 characters. Right -click the Application Module Creator application on the desktop and select Run as administrator. a HSDK channel. a. Workstation is the machine where Pro-Watch is installed so that events could be received.2 Configuring using Application Module Creator Tool The SALTO Application Module Creator tool is available only if HSDK and SAM are installed together. A description allows upto 100 characters. A site name allows upto 14 characters and accepts underscore but not spaces and special characters. b. Note The Application Module Creator tool enables you to automatically create a Site. Panel Name: You can retain the default name or type a name for the panel. Under Create SALTO Application Module. You can also provide a different name. Under Pro-Watch provide the following: 3. e. Pro-Watch workstation name: Type the host name of the computer where Pro-Watch is installed. Honeywell Confidential 4-3 .

Click Submit. Click OK and then click Restart Pro-Watch Service to restart the pro-watch service. The progress bar is displayed to start the service in the system. appears. A message box. 5. Honeywell Confidential 4-4 . The SALTO Application module is created successfully.Configuring HSDK Configuring using Application Module Creator Tool 4. indicating successful Application Module creation.

The Pro-Watch application window appears.Configuring HSDK Configuring using Application Module Creator 6. 7. Honeywell Confidential 4-5 . Click Close and restart the system to view the application module. Click Start > Programs > Pro-Watch > Pro-Watch.

Double click the SALTO Integration Module. click Database Configuration > Application Module. appears. The SALTO Integration Module appears.Configuring HSDK Configuring using Application Module Creator Tool 8. On the left pane. 9. Honeywell Confidential 4-6 . The Edit Application Module dialog box along with Windows Security window.

The login credentials details are saved. provide the administrator login credentials. In the Edit Application Module dialog box. 11.Configuring HSDK Configuring using Application Module Creator 10. In the Windows Security window. click the Information tab. Under Application Module Authentication Parameters. you must type the Username and Password and then click OK. Honeywell Confidential 4-7 . 12.

Click Start > Programs > Pro-Watch > Pro-Watch. channel and panel 1. The Pro-Watch application window appears. Honeywell Confidential 4-8 .Configuring HSDK Configuring using Application Module Creator Tool To view the configured site.

Configuring HSDK Configuring using Application Module Creator 2. On the left pane. click Hardware Configuration.. Honeywell Confidential 4-9 .

The Pro-Watch NT Hardware Configuration tree structure appears. You can now view the Channel and Panel. Honeywell Confidential 4-10 . Click the icon to expand the newly added Site. 3.

3 Configuring a Site A Pro-Watch site is the area of controlled access. You must create a site before creating a channel or a panel. a site could be an airport terminal. Log on to the computer where Pro-Watch is installed. To configure a site in Pro-Watch 1. Honeywell Confidential 4-11 . Click Start > Programs > Pro-Watch > Pro-Watch. 2. The initial screen of ProWatch appears. For example.Configuring HSDK Configuring a Site 4.

The ProWatch NT Hardware Configuration pane will be displayed. click Hardware Configuration. In the Viewers pane of Pro-Watch. In the Pro-Watch NT Hardware Configuration display pane. right-click and select New > Site.Configuring HSDK Configuring a Site 3. Honeywell Confidential 4-12 .

Honeywell Confidential 4-13 .Configuring HSDK Configuring a Site The Add Sites dialog box appears.

The 4-14 . click Workstations dialog box 4. 3. In the Primary Workstation. Similarly repeat steps 3 and 4 to define the Secondary Workstation. A Site Id is a unique name that identifies the site. Honeywell Confidential and select Define option.Configuring HSDK Configuring a Site In Define Site Information pane: 1. 5. DOC1). Type the Description (for example NewHSDK) for the new site. Type the Site Id (for example. Workstation is the machine where Pro-Watch is installed so that events could be received. Select a workstation from the Workstations dialog box and click OK. 2.

To configure an HSDK Channel in Pro-Watch 1.4 Configuring an HSDK Channel A Pro-Watch channel is a communication path between the host and the panel. 4.Configuring HSDK Configuring an HSDK Channel 6. Click OK in the Add Sites dialog box to add a new site. The newly added site (NewHSDK) will appear in the Pro-Watch NT Hardware Configuration display panel. In the Pro-Watch Hardware Configuration display pane. right-click the site created for HSDK and select New > Channel. You must create a channel before adding a panel. An HSDK channel is required to communicate between the Pro-Watch Server and HSDK Server. Honeywell Confidential 4-15 .

Configuring HSDK Configuring an HSDK Channel The Create a Channel dialog box appears. In Pick New Channel Type and Options pane: Honeywell Confidential 4-16 . 2.

In the Delay field. Note Select the HSDK Channel from the Channel Type drop-down list. Check the Installed option for the configured channel to be installed and operational. e. enter the number of panel timeouts that must occur before the Pro-Watch Server determines that the panel is not operational. In the Comm Break field. 4. 3. From the Time Zone drop-down list. Click OK. d. In Define Channel Information pane: a. In the Attempts field.Configuring HSDK Configuring an HSDK Channel a. enter the maximum number times the Pro-Watch Server will poll a panel before determining a panel time out. Honeywell Confidential 4-17 . The details for the manufacturer appear in the Manufacturer field automatically after you select the Channel Type. b. The Define Channel Information dialog box appears. enter the Pro-Watch Server-to-panel poll interval in milliseconds. The HSDK Channel will appear only if Pro-Watch is licensed for HSDK. for example. b. select the time zone where HSDK Server is installed. Type the Description for the channel. HSDK Channel. f. c.

Specify Poll Interval (if required). 5. c. b. The retry time sets the number of seconds that must elapse before a communications retry will be attempted. Type the IP Address of the HSDK Server and the HSDK Service TCP Port Number. The Web Service field is read-only and will always display a value” \HSDKPanel”. 6. Select Port Type as TCP/IP specifies that the channel is a network connection. Select the Port Type as TCP/IP for the HSDK communication. The poll interval sets the number of seconds that elapses between each poll by the host computer. A warning appears reminding you that no events on this channel can be reported until you add the channel to the Honeywell Confidential 4-18 . d. Specify Retry Time (if required). Note In Primary pane: a. Click Next. click Add to add the partition to which the channel will be assigned. If you are using Pro-Watch partitions.Configuring HSDK Configuring an HSDK Channel g. Click Next. 7. The Partitions dialog box appears. The Communication Parameters dialog box appears. The spool files temporarily reside in this directory during a download. The communications Spool Directory is automatically created within the Pro-Watch directory.

Configuring HSDK Configuring an HSDK Panel appropriate Routing Group in Database Configuration. If you are not using Routing Groups. Pro-Watch adds the channel to the default routing group automatically. Once you complete creating a channel. 4.5 Configuring an HSDK Panel When a third-party application requests for some information from Pro-Watch. Specifically. 8. Click Finish. the corresponding channel appears in the channel list. an HSDK panel is not a Honeywell Confidential 4-19 . Subscription to HSDK servers is accomplished by controlling the HSDK panel. HSDK acts as a server. HSDK acts as a client when it interacts with other panels which are represented as HSDK panel in Pro-Watch.

To configure an HSDK Panel 1. An HSDK panel contains all the logical devices (BACNET objects. The Pro-Watch Control Manager dialog box appears. The new devices and their event types are defined in Pro-Watch. it leverages HSDK to connect to specific hardware through the HSDK interface. In Pro-Watch NT Hardware Configuration display pane. and then select New > Panel.Configuring HSDK Configuring an HSDK Panel virtual panel. Honeywell Confidential 4-20 . right-click the respective channel. collection of points grouped as logical devices in Pro-Watch) of the application module.

In the Panel Settings tab Honeywell Confidential 4-21 . select the channel you have created for this panel from the drop-down list. The Add HSDK Panel Dialog box will appear. In Channel Description. Click Next. 4. 3. HSDK Channel. for example.Configuring HSDK Configuring an HSDK Panel 2.

Type the Location which identifies the location of the panel. c. Once you complete creating a panel. The details of published and subscribed objects related to that Application Module are stored in Pro-Watch and can be viewed in Pro-Watch UI.Configuring HSDK Configuring a Third-party Application Module 5. Select the Installed check box for the configured panel to be installed and operational. a. An application module created in Pro-Watch is a link to the information of a thirdparty system. The changes in property of any device can be triggered by Pro-Watch.6 Configuring a Third-party Application Module An third-party application module is an application developed to integrate the thirdparty system with HSDK to achieve the integrated security system. 4. Click OK. b. the corresponding panel will appear in the list of panels under the HSDK site. Honeywell Confidential 4-22 . It can access the existing devices and their event types in Pro-Watch. there should be one instance of HSDK configured in ProWatch. All the published objects of the application module are represented as logical devices in Pro-Watch. For each thirdparty application module. Type the Panel Description which is the description of the panel.

click Database Configuration. Honeywell Confidential 4-23 . In the Viewers pane of Pro-Watch.Configuring HSDK Configuring a Third-party Application Module The application module defines the objects depending on the following seven Bacnet objects: • • • • • • Access Points Access Zones Access Credentials Access Rights Access Users Access Doors To create and configure an application module 1. The ProWatch NT Databasccce Configuration pane is displayed.

Honeywell Confidential 4-24 . right-click the Application Module and select New Application Module. In the Pro-Watch NT Database Configuration display pane.Configuring HSDK Configuring a Third-party Application Module 2.

4. In Channel. for example. Honeywell Confidential 4-25 . Click Next. select the channel created for HSDK from the list of channels. After you select the channel. OBIX Channel. The Pro-Watch Application Module Manager dialog box appears.Configuring HSDK Configuring a Third-party Application Module The Pro-Watch Application Module Manager dialog box appears. 3. the Channel Type and Panel details appear automatically.

Application Module. Note 6. Type the GUI URI which is the URI of the third-party application user interface.Configuring HSDK Configuring a Third-party Application Module 5. The Published URI is the URI of page which lists the published objects of thirdparty application. type the Name of the application module. Type the HSDK Port which is the HSDK website TCP port number. 8.sensitive. In the Attributes pane. 7. 11.The Lobby URL is case. 10. Type the Description of the application module. for example. For more details. Honeywell Confidential 4-26 . 9. refer to Installing HSDK section. Type the Lobby URI which is the URI of the lobby of third-party application. The Information URI is the URI of the About page of the third-party application. Application Module. The Name of the application module must be same as Application Module Name defined while doing the Web Site Configuration. The Subscribed URI is the URI of page which lists the subscribed objects of third-party application. for example. 12.

Honeywell Confidential 4-27 . In Authentication Parameters. type the User Name and Password of the thirdparty application lobby. 14. Application Module) appears in the Pro-Watch NT Database Configuration display pane. Click Finish. The application module (for example.Configuring HSDK Configuring a Third-party Application Module 13.

Configuring HSDK Application Module Interface 4.7 Application Module Interface An application module provides a tab based interface to perform the following functions: • • • • View the third-party application information View the subscribed and published objects License information Outbound Configuration The following figure displays the main page layout of the third-party application module. Honeywell Confidential 4-28 .

the connection between HSDK and thirdparty application is established.Configuring HSDK Page Layout 4. The License Information tab shows the features and permissions for the HSDK License. The Published Objects tab displays the Pro-Watch objects that are currently subscribed by the third party. The Outbound Configuration tab allows you to configure which Pro-Watch objects are exposed to the HSDK Server.9 Verifying Third-Party Connection Once the application module is configured. Tabs Description The Information tab shows the About information of the thirdparty application. Honeywell Confidential 4-29 . The following table lists the tabs and the tasks that you can perform using each tab. 4. The Subscribed Objects tab allows you to discover and subscribe to third party objects.8 Page Layout The application module interface provides various tabs to access the third-party application. The Partitions tab allows you to assign partitions to the current Application Module.

Configuring HSDK
Verifying Third-Party Connection

To verify the connection between HSDK and third-party application
1.

In the Pro-Watch NT Database Configuration display pane, double-click the
Application Module (for example, Application Module).
The Edit Application Module dialog box appears.

2.

On prompt of user name and password, enter the Username and Password of
the HSDK Server.

3.

Click the Information tab, which shows the application module attributes. The
About information of the third-party application appears.

The Lobby URI is an attribute of the application module. The HSDK Client connects
to this URL of the external system’s oBIX Server. The HSDK Client retrieves the
information in the Lobby and displays the same as About information.
The GUI URI will be opened in the web browser when GO button is clicked.

Honeywell Confidential

4-30

Configuring HSDK
Subscribing to Third-Party Objects

The display of About information confirms that a connection between third-party
application has been successfully established.

4.10 Subscribing to Third-Party Objects
To subscribe to an object alarm and display in Pro-Watch Event Viewer:
1.

In the Pro-Watch NT Database Configuration display pane, double-click the
Application Module (for example, Application Module).
The Edit Application Module dialog box appears.

2.

On prompt of user name and password, enter the Username and Password of
the HSDK Server.

3.

Click Subscribed Objects tab. You can discover and subscribe to third party
objects and alarms from here.

Honeywell Confidential

4-31

Configuring HSDK
Subscribing to Third-Party Objects

4.10.1 Subscribing to an Object
To subscribe to a third-party object
1.

In Discover and Subscribe Published Object pane, click Discover to view the
third-party objects.
The Lobby of the third-party objects appears in the oBIX Tree tab. The data from
an external system is represented in oBIX format, in an Hierarchial form. The
hierarchial form is created for a unique URI for each object in the hierarchy. This
hierarchy is represented as a tree, which makes it easier for navigation.

Honeywell Confidential

4-32

Configuring HSDK
Subscribing to Third-Party Objects

2.

In the oBIX Tree tab, click Lobby to expand the Lobby to view the published
third-party objects.

Honeywell Confidential

4-33

Configuring HSDK
Subscribing to Third-Party Objects

3.

In the Obix tree, select an object (for example, Entrance 1 and Entrance 2) you
want to subscribe and click Import to select the hardware template for the
object.

For subscription, you can select upto maximum of 200 objects at a time. If you wish to
subscribe more objects, you can subscribe in batches and choose 200 objects(maximum) per
batch.

Note

Note

4.

Select hardware template from the drop down boxes. You can choose to select
individual hardware templates or apply a common template to all.

5.

Select Create New from the Logical Devices drop-down list.

6.

Select the required Hardware Template from the drop-down list.

Select the I/ODevices option only for input and output objects, but not Accesspoint.

7.

Select the required Hardware Class from the drop-down list.

Honeywell Confidential

4-34

0. Honeywell Confidential 4-35 .Configuring HSDK Subscribing to Third-Party Objects If you select the Default Logical Devices from the list then the Hardware Template and the Hardware Class is assigned automatically and the drop-down list is disabled. OBIX with Reader Control hardware template is also supported. Note 8. click the Subscribe button. Note Once you subscribe to a third-party object. but from HSDK 1.38 onwards.9. only OBIX with Input and Output Control hardware templates were allowed to subscribe points. In previous HSDK versions. the subscribed object appears in the Subscribed Objects pane. After selection.

You can search for a specific object by name or by specifying the URI. 2. click Search tab.Configuring HSDK Subscribing to Third-Party Objects 4. Honeywell Confidential 4-36 .2 Searching for an Object The Search feature searches for an object or alarm feed in all the sub-branches starting from the specified URI. 4. The Search Objects pane appears. In the Start from URI field. You can type the Lobby URI also to search for the entire oBIX tree. In Discover and Subscribe Published Object pane. 3. Type the name of the object or alarm to be searched in Find field. To search for an object 1.10. type the URI of the object to be searched. Click Search to search for the specified object.

you can select the object URI from the search result and click Subscribe to create a logical device. The list of Pro-Watch objects and alarms which the third party has subscribed for is displayed. In the Edit Application Module dialog box. double-click the Application Module (for example. TPApplicationModule). 2.Configuring HSDK Viewing Published Objects The search results will appear in the Edit Href to Subscribe field. In the Pro-Watch NT Database Configuration display pane. The Edit Application Module dialog box appears. If required. as shown in the below screenshot.11 Viewing Published Objects To view the list of Pro-Watch published objects: 1. Honeywell Confidential 4-37 . click the Published Objects tab. 4.

select Alarms and click Import to subscribe for an alarm feed in Pro-Watch. In the Obix tree. Honeywell Confidential 4-38 .12 Subscribing to Third Party Alarms 1.Configuring HSDK Subscribing to Third Party Alarms 4.

Note The user can subscribe only to the default alarm class.Configuring HSDK Subscribing to Third Party Alarms Once you subscribe to a third-party alarm. the subscribed alarm/feed is listed in the Subscribed Feeds pane. Honeywell Confidential 4-39 .

In Pro-Watch Viewer pane.1 Viewing Alarms in Pro-Watch Event Viewer In Pro-Watch. 4.13. The Alarm Monitor icon is 4-40 .Configuring HSDK Viewing Third Party Alarms 4. Double-click the Alarm Monitor icon. click File > Event Viewer to view Pro-Watch event viewer.13.2 Viewing Alarms in Pro-Watch Alarm Monitor 1. 2. The Pro-Watch Alarms window is displayed.13 Viewing Third Party Alarms 4. click displayed on the right pane. Honeywell Confidential icon.

14. This is to leverage Pro-Watch event infrastructure (triggers and procedures).1 Editing individual rules Each rule is a template that can be edited to achieve the mapping.xml file (\Honeywell\HSDK\<app module name>\HSDK Client\HSDK-EventMap. 4. The XML file is a set of rules and the image shown below is one such rule.14 Mapping Third Party Alarms to Pro-Watch Alarms You need to map third party alarms to appropriate Pro-Watch logical device alarms. The modified rule is shown below: Honeywell Confidential 4-41 . To map the alarms. you need to edit the. For example we can replace “pattern4” with the actual alarm message text that was configured in the third party.xml). 901 etc). We can then replace the value “504” with required Pro-Watch alarm address (eg.Configuring HSDK Mapping Third Party Alarms to Pro-Watch Alarms 4. 900.

15 License Information To view the HSDK license information 1. The license information in the License tab appears Honeywell Confidential 4-42 . In the Edit Application Module dialog box. click License tab.Configuring HSDK License Information 4.

It is enforced by the HSDK when information is requested by a third-party from Pro-Watch or vice versa. and the license status of the computer where the HSDK is installed. Application Module Information — The Application Module Information provides the name of the application module and details of the client certificate which is used to validate for connecting a third-party application.Configuring HSDK License Information The License tab in the application Module UI reads the license file and displays the features and permissions as enforced. the Node ID. The HSDK License is issued as per the application module. Following is the information as displayed in the License tab: • • License Information — License Information provides the date and time at which the License was generated. Honeywell Confidential 4-43 . the expiration date.

Configuring HSDK Outbound Configuration • • • Allowed Regions — The Allowed Regions indicate the range of GMT time zones that are licensed. 4. Also if the alarms or events from third. Access Zones. The outbound information appears The HSDK license issued for an application module restricts the number of ProWatch objects which can be exposed by the HSDK Server. The values for these objects can be NONE.16 Outbound Configuration To view the Outbound Configuration information 1. Honeywell Confidential 4-44 . It is enforced through a check on the current system regional settings. Inbound — The Inbound pane displays the number of third-party points which can be subscribed to Pro-Watch. In the Edit Application Module dialog box. click Outbound Configuration tab. Access Doors. The Pro-Watch objects for which license can be issued are Access Users. This also displays if the option to subscribe to events or create a watch on the objects is available. Output Devices and Time Zones. UNLIMITED or a <SPECIFIC_NUMBER>. Access Rights. Outbound — The Outbound pane displays the number of access objects which can be published by Pro-Watch for consumption by the third-party application. Access Points. Input Devices.party application are shown on the Pro-Watch event viewer.

Note By default the Automatic option is enabled and the objects are moved to Outbound list. This selection must be done in OutBound Configuration tab. then only 20 badge-holders of the 100 are exposed to the third party. Or Click the Add and Remove button to move the objects to Outbound list. To select and move the Objects to Outbound list • Click Automatic option. Honeywell Confidential 4-45 . out of which if 100 badge holders are selected in the OutBound tab.Configuring HSDK Outbound Configuration For example. If ProWatch has 1000 badge holders. a license states that only 20 badge holders can be exposed.

Click the required class folder to list the subscribed third-party objects. 3. Honeywell Confidential 4-46 . Once the third-party objects are subscribed by Pro-Watch. 2.Configuring HSDK Accessing External Devices 4. you can view the properties of the selected third-party object. Double-click the logical device. In the Edit Logical Devices dialog box. The Edit Logical Devices dialog box appears. they are listed as logical devices.17 Accessing External Devices To view the properties of the third-party objects 1. The subscribed third-party objects appears in the Hardware Class selected during subscription under the respective HSDK site.

2. HSDK Panel). Double-click the panel for the selected site (for example. HSDK Panel) for the selected panel appears. Honeywell Confidential 4-47 .Configuring HSDK Accessing External Devices To view the value and properties in the panel 1. Click Panels under the respective HSDK site. The HSDK panel (for example.

Honeywell Confidential 4-48 . There will be two type of points. StringWritable-OBIX Input). and the description of the associated panel. Note Select a third-party object (for example. In the Input Page tab. In the Input Properties tab. a. Input and Output points. b. you can view the Description of the object.Configuring HSDK Accessing External Devices The Edit HSDK Panel Dialog box appears and displays the subscribed thirdparty objects 3. Location of the object. you can view the Value of the selected device.

Each object which is exposed in the subscribed point is available in the Pro-Watch for invocation. The actions of the third party are exposed as oBIX Operations (using of element).Configuring HSDK Accessing External Devices 4.17. HSDK Actions menu is enabled for the subscribed objects which are available in the Pro-Watch.1 Invoke Operations The invoke operation functionality is used to show the operations exposed by third party in Pro-Watch. Honeywell Confidential 4-49 .

then wrap them into a single object using a contract as the signature.18 Implementation Details In oBIX op element represents an operation. If you are using more than one parameter then only first parameter value can be set. the invoke request is send to HSDK for actual operation invocation using the PWToHSDKBridge. In case of Pro-Watch it supports invoking operations with a single parameter. In case you need multiple input or output parameters. Honeywell Confidential 4-50 . HSDK invokes the action on the third party by doing an HTTP POST (oBIX Standard) to the action URL and response of the invoke operation is send back to Pro-Watch.Configuring HSDK Implementation Details 4. The in and out attributes define the contract list for the input and output objects. All operations take one object as a parameter and return exactly one object as a result. When the operation is invoked from the Pro-Watch user interface.

Right click on the on the required logical device and select HSDK Actions. Click icon in the Pro-Watch window. a logical device is created in Pro-Watch representing the third party point. The actions which are allowed for this point are stored in the PWNT database. To perform the invoke operation from the logical devices perform the following steps. 1. The HSDK Actions List dialog-box is displayed.1 Invoke actions from the Logical Device list view Pro-Watch uses Application module user interface to discover and to subscribe to a third party. 2.Configuring HSDK Implementation Details 4. Honeywell Confidential 4-51 .18. Click the required class folder to list the subscribed third-party objects. 3. After subscribing.

5. Enter the new value of the parameter and click Invoke. Select the required Action and then click Set Value to set the parameter value. The current value of the parameter is displayed in the Value field in the Set dialogbox. Honeywell Confidential 4-52 . 6. Select the required Device from the drop-down list.Configuring HSDK Implementation Details 4. On clicking the Set Value the corresponding action dialog-box is displayed. The status of the invoke as Invoke is Success or Invoke is Failure is shown at the bottom of screen.

Configuring HSDK Implementation Details In case invoke operation is successful.2 Invoke actions from the Alarm Monitor view Pro-Watch uses Application module user interface to discover and to subscribe to a third party alarm feed. To perform the invoke operation from the alarms perform the following steps. 4. the changes are reflected in both Pro-Watch and Niagara. The HSDK Actions menu is enabled for both Ack and Non Ack alarms. Right-click on the alarm and select HSDK Actions. Third party alarm feed is displayed in the Pro-Watch monitor. 1.18. Honeywell Confidential 4-53 .

Honeywell Confidential 4-54 . 2. On clicking the Set Value the Set dialog-box is displayed. The current value of the parameter is displayed in the val field in the Set dialog-box. Enter the new value of the parameter and click Invoke. Select the required action and click Set Value to set the parameter value. 3.Configuring HSDK Implementation Details The HSDK Actions List dialog-box is displayed.

click the Event Procedure node. 4. The Add Event Procedure dialog appears.Configuring HSDK Implementation Details The status of the invoke as Invoke is Success or Invoke is Failure is shown at the bottom of screen. 2.3 Performing HSDK Actions using Event Procedure To perform a HSDK action using Event Procedure: 1. the changes are reflected in both Pro-Watch and Niagara. On the right pane. right-click and then select New Event Procedure. In Pro-WatchNT Database Configuration. Notes • • Actions that require multiple parameters are not supported.18. In case invoke operation is successful. Actions should be tied with Pro-Watch operator permissions. Honeywell Confidential 4-55 .

Type the description in the box provided and then click the Add button. Honeywell Confidential 4-56 . The Define Event Procedure dialog appears.Configuring HSDK Implementation Details 3. Select HSDK Actions from the Command drop-down list. 4. The Origin drop-down is set to Logical Device option and it is disabled as shown below.

The Logical Devices dialog appears displaying the list of logical devices. 5.Configuring HSDK Implementation Details Note The display of Origin drop-down list depends on the selection of Command. Honeywell Confidential 4-57 . Click and then select Define to define the logical devices.

Honeywell Confidential 4-58 . Select the required logical device and then click OK. The Actions drop-down list displays the operations that can be performed on the selected Devices.Configuring HSDK Implementation Details 6.The selected device is updated in Logical Device drop-down box and displays the Devices and Actions drop-down list as shown below.

The corresponding actions are displayed in the Actions drop-down list 8. For the selected action the parameters are displayed in Action Parameters table as shown below.Configuring HSDK Implementation Details 7. Select the required device from the Devices drop-down list. Select the required action from the Actions drop-down list. Honeywell Confidential 4-59 .

Click OK. based on the Logical Devices and the Actions selected. Note 9. the selected actions is added in Add Event Procedures dialog as shown below.Configuring HSDK Implementation Details The Value drop-down box is displayed.. Honeywell Confidential 4-60 .

Click OK to save the changes. Similarly you can add multiple functions in the Event Procedure. 4.19 HSDK Sequence Diagrams This sections provides the HSDK Sequence Diagrams for the following: • • • • • Watch on Pro-Watch Objects Events From Pro-Watch to Niagara Subscribing Niagara Points in Pro-Watch Events from Niagara to Pro-Watch Controlling Niagara points from Pro-Watch Honeywell Confidential 4-61 .Configuring HSDK HSDK Sequence Diagrams 10.

Configuring HSDK HSDK Sequence Diagrams Honeywell Confidential 4-62 .

Configuring HSDK HSDK Sequence Diagrams Honeywell Confidential 4-63 .

Configuring HSDK HSDK Sequence Diagrams Honeywell Confidential 4-64 .

Configuring HSDK HSDK Sequence Diagrams Honeywell Confidential 4-65 .

Configuring HSDK HSDK Sequence Diagrams Honeywell Confidential 4-66 .

You can discover the About URI directly from the Lobby.1 Lobby The Lobby object serves as the central entry point into the HSDK Server. It lists the URIs for other well-known objects defined as per the oBIX specification.1 Components of Lobby 5. To address this.1.2 About The About object is the standardized list of summary information about the HSDK Server.1. 5. It covers the following topics: Lobby page 5-1 HSDK Object type page 5-2 HSDK Configuration page 5-18 5. oBIX provides a model for client polled Honeywell Confidential 5-1 .1.3 Watch Service A key requirement of oBIX is access to the real-time information to efficiently receive the rapidly changing data.h 5 HSDK APPLICATION PROGRAMMING INTERFACE This chapter provides details of the supported HSDK APIs in REST XML format. The third-party application interacts with the HSDK interface using the APIs exposed by HSDK. 5.

The watchService URI is available directly from the Lobby object. etc).4 PACS The PACS object contains all the exposed objects of Pro-Watch (for example. Access Users. Access Zones. A Watch object is used to manage a set of objects which are subscribed and periodically polled by clients to receive the latest events.HSDK Application Programming Interface HSDK Objects Types event known as watches. The watchService object provides a URI as the factory for creating new watches. Access Credentials.1. Objects Read Create Modify Delete Access Users Access Credentials Access Rights Access Points Access Zones Time Zone Access Doors IO Devices Honeywell Confidential 5-2 . Table below displays the read/write privileges for each object. 5. 5.2 HSDK Objects Types HSDK supports read and write privileges for the following BACNET objects.

for example. Access Users (Example) Honeywell Confidential 5-3 . The relationship among Access Users are supported to model hierarchical organizations comprising. It is used for informational purpose and may hold references to other systems. The Access Users object is not directly involved in Authentication and Authorization.1 Access Users The Access Users object represents the Badge Holders of Pro-Watch. The object type Access Users represents a single person. although for some applications it may be useful.2. departments. PACS implementations are not generally required to support this object type. an organizational entity or an asset. or groups of any kind. companies.HSDK Application Programming Interface HSDK Objects Types IO Groups Access Point Extenstions Alarms 5. or to model ownership of assets.

card and biometric). The authentication factors in a credential can physically exist on the same media. Authentication Factors are grouped in a single container when each factor has identical access right and when one or more authentication factors are used in multi-factor authentication (for example.0"> <str name="Version" href="Version/" val="1.0 /hsdk/xsd" name="AccessUser0x002931424639373535392D343032452D3439" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessUsers/0x002931424639373535392D343032452D3439/" is="/HSDKPNLApplicationModule1/def/accessUser" displayName="AccessUser0x002931424639373535392D343032452D3439" xmlns="http://obix.org/ns/schema/1.xsl'?> <obj xmlns:xsi="http://www.org/ns/schema/1.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix. such as a smart card (including FIPS-201 card).2. etc.HSDK Application Programming Interface HSDK Objects Types <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.0. Honeywell Confidential 5-4 . PIN.0" /> <str name="ID" href="ID/" val="0x002931424639373535392D343032452D3439" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="WILLIAMSCONRAD" /> <str name="Description" href="Description/" val="BACnet Access User-WILLIAMSCONRAD" /> <str name="Type" href="Type/" val="AccessUser" /> <enum name="User_Type" href="User_Type/" val="PERSON" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/nums/BacnetAccessUserType/" /> <str name="FNAME" href="FNAME/" val="WILLIAMS" /> <str name="LNAME" href="LNAME/" val="CONRAD" /> <str name="MI" href="MI/" val="" /> <enum name="BADGE_STATUS" href="BADGE_STATUS/" val="" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BADGESTATUS" /> <enum name="BADGE_TYPE" href="BADGE_TYPE/" val="Contractor" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BADGETYPE" /> <abstime name="ISSUE_DATE" href="ISSUE_DATE/" val="2012-07-18T00:00:00-07:00" /> <abstime name="EXPIRE_DATE" href="EXPIRE_DATE/" val="2012-09-29T00:00:00-07:00" /> <obj name="customFields" href="customFields/"> <str name="BADGE_ADDRESS2" val="" /> <abstime name="BADGE_BIRTHDATE" val="1974-12-31T15:00:00-08:00" /> <str name="BADGE_EYECOLOR" val="" /> <str name="BADGE_COUNTRY" val="" /> <str name="BADGE_EMERADDRESS2" val="" /> <str name="BADGE_SSN" val="" /> <int name="BADGE_AGE" val="0" /> <str name="BADGE_HAIRCOLOR" val="" /> <str name="BADGE_DISPPHOTO" val="" /> <abstime name="BADGE_STARTDATE" val="1974-12-31T15:00:00-08:00" /> <str name="BADGE_EMERPHONE" val="" /> <str name="BADGE_SUPERVISOR" val="" /> <str name="BADGE_ZIP" val="" /> <enum name="BADGE_EMPLOYER" val="" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/Company" /> <str name="BADGE_BUILDING" val="" /> <str name="BADGE_HOMEPHONE" val="" /> <str name="BADGE_CITY" val="" /> <str name="BADGE_STATE" val="" /> <str name="BADGE_EMERCONTACT" val="" /> <str name="BADGE_EXTENSION" val="" /> <str name="BADGE_ADDRESS1" val="" /> <str name="BADGE_DISPSIGNATURE" val="" /> <str name="BADGE_HEIGHT" val="" /> <str name="BADGE_EMERADDRESS1" val="" /> <str name="BADGE_DEPARTMENT" val="" /> <str name="BADGE_BADGENUMBER" val="" /> <int name="BADGE_WEIGHT" val="0" /> <str name="BADGE_OFFICEPHONE" val="" /> <str name="BADGE_FLOOR" val="" /> <str name="BADGE_TITLE" val="" /> </obj> <list name="Credentials" href="Credentials/"> <ref name="3" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessCredentials/3/" /> </list> <list name="Memberof" href="Memberof/" /> <list name="Members" href="Members/" /> <list name="AssociatedAssets" href="AssociatedAssets/" /> <list name="AssociatedUsers" href="AssociatedUsers/" /> <str name="AdditionInfoUri" href="AdditionInfoUri/" val="" /> <str name="StatusDescription" href="StatusDescription/" val="" /> <int name="UpdatePeriod" href="UpdatePeriod/" val="0" /> <list name="ExtendedObjInformation" /> </obj> 5.w3. The Access Credentials object represents a container of related Authentication Factors such as card.2 Access Credentials The Access Credentials object represents the Badges of Pro-Watch. or as physically separate entities. biometric.

org/ns/schema/1. <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.w3.0"> <str name="Version" href="Version/" val="1.527-07:00" /> <abstime name="Expiry_Time" href="Expiry_Time/" val="2013-07-18T03:41:37.0 /hsdk/xsd" name="AccessCredential2" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessCredentials/2/" is="/HSDKPNLApplicationModule1/def/accessCredential" displayName="Access Credential" xmlns="http://obix. Access Credentials (Example) The example of Access Credentials object XML is provided below.HSDK Application Programming Interface HSDK Objects Types such as a card and PIN.37-07:00" /> <enum name="Reason_For_Disable" val="NONE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetAccessCredentialDisableReason" /> <bool name="PrivacyEnable" href="PrivacyEnable/" val="false" /> <list name="Authentication_Factors" href="Authentication_Factors/"> <str name="AccessCredentialID" val="2" /> <str name="PIN" val="7050" /> </list> <ref name="Belongs_To" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessUsers/0x002946364246463439412D444145412D3444/" /> <ref name="Last_Access_Point_Extn" /> <list name="Assigned_Access_Rights" href="Assigned_Access_Rights/"> <ref name="0x0047729E6EB68D9311D4A45600508BC86902" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessRights/0x0047729E6EB68D9311D4A45600508BC86902/" /> </list> <enum name="Credential_Status" val="ACTIVE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetAccessCredentialStatus" /> <abstime name="Last_Use_Time" href="Last_Use_Time/" val="1974-12-31T15:00:00-08:00" /> <enum name="Company" val="NexWatch" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/Company" /> <int name="Uses_Remaining" href="Uses_Remaining/" val="0" /> <int name="Extended_Time_Enable" href="Extended_Time_Enable/" val="0" /> <list name="ExtendedObjInformation" /> </obj> Honeywell Confidential 5-5 . The Access Credentials object can be assigned to an Access User.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.0.org/ns/schema/1.0" /> <str name="ID" href="ID/" val="2" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="0x002946364246463439412D444145412D3444" /> <str name="Description" href="Description/" val="2 BACNETAccessCredential" /> <str name="Type" href="Type/" val="BACNETAccessCredential" /> <bool name="Escort_Flag" href="Escort_Flag/" val="false" /> <ref name="Accompanied" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessUsers/" /> <bool name="Trace_Flag" href="Trace_Flag/" val="false" /> <bool name="Passback_Exempt" href="MidnightForgive/" val="false" /> <bool name="MidnightForgive" val="false" /> <abstime name="AntiPassbackResetTime" href="AntiPassbackResetTime/" val="0001-01-01T00:00:00-08:00" /> <bool name="OfficeModeFlag" href="OfficeModeFlag/" val="false" /> <bool name="OccupancyCountExemption" href="OccupancyCountExemption/" val="false" /> <bool name="AuditOpenings" href="AuditOpenings/" val="false" /> <bool name="AuditRejections" href="AuditRejections/" val="false" /> <int name="MaxNumberOfDays" href="MaxNumberOfDays/" val="0" /> <int name="NumberOfDaysUsed" href="NumberOfDaysUsed/" val="0" /> <int name="NumberOfTimesUsed" href="NumberOfTimesUsed/" val="0" /> <int name="NumberOfDaysNotUsed" href="NumberOfDaysNotUsed/" val="0" /> <int name="DaysRemaining" href="DaysRemaining/" val="0" /> <int name="AbsenteeLimit" href="AbsenteeLimit/" val="0" /> <int name="Threat_Level" href="Threat_Level/" val="0" /> <reltime name="ExtendedTimeUnlock" href="ExtendedTimeUnlock/" val="PT0S" /> <abstime name="Activation_Time" href="Activation_Time/" val="2012-07-18T03:41:25. Access Rights are assigned to an Access Credential object.xsl'?> <obj xmlns:xsi="http://www.

2. which is an assignment of access rights to the Access Credentials object. An Access Rights object is referenced from Access Credentials object. The Access Rights object defines a set of negative and positive access rules. If an access rule is found which is enabled and matches location and current time of the request to access. Honeywell Confidential 5-6 . Multiple Access Credential objects can refer to the same Access Rights object. Server Room at nightshift. Each access rule specifies the criteria where the access must be denied or granted at a geographical location. etc. The access rules of Access Rights object assigned to an Access Credentials are evaluated for authorization. for example.3 Access Rights The Access Rights object represents the Clearance Codes of Pro-Watch. Access Rights (Example) The example of Access Rights object XML is provided below. which Access Users can take within an organization. then the validation step of checking access rights is successful.HSDK Application Programming Interface HSDK Objects Types 5. Negative access rules take precedence over positive access rules. Access Rights objects can also be used as profiles. Office Area at office times. then the access request is finally denied. If a negative access rule is found which is enabled and matches location and current time of the request to access. Access Rights objects facilitate to model the access rights of ‘roles’.

gate. In case of adjacent zones.w3. turnstile.0 /hsdk/xsd" name="AccessRight0x0047729E6EB68D9311D4A45600508BC86902" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessRights/0x0047729E6EB68D9311D4A45600508BC86902/" is="/HSDKPNLApplicationModule1/def/accessRightsPages" displayName="Access Right" xmlns="http://obix. In a simple access control system. Access through this point is directional in that it represents access in one direction only.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.0.0x0047729E6EB68D9311D4A45600508BC86902" /> <str name="Type" href="Type/" val="Access Rights" /> <list name="Positive_Access_Rules" href="Positive_Access_Rules/"> <obj> <ref name="Time-Range" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/timeZones/0x000E4DB976AD4D7D4AAFA3CBF12C2B7DA7F6" /> <ref name="Location" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessPoints/0x006F97BD76868E3011D4A45600508BC86902" /> <bool name="Enable" href="Enable/" val="true" /> </obj> <obj> <ref name="Time-Range" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/timeZones/0x000E4DB976AD4D7D4AAFA3CBF12C2B7DA7F6" /> <ref name="Location" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessPoints/0x006F97BD76938E3011D4A45600508BC86902" /> <bool name="Enable" href="Enable/" val="true" /> </obj> </list> <list name="Negative_Access_Rules" href="Negative_Access_Rules/" /> <bool name="Enable" href="Enable/" val="true" /> <list name="ExtendedObjInformation" /> </obj> 5. A door in which access is controlled in both directions leads to two separate Access Points objects.0" /> <str name="ID" href="ID/" val="0x0047729E6EB68D9311D4A45600508BC86902" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="Demo Clearance Code" /> <str name="Description" href="Description/" val="Demo Clearance Code . Note Access Points (Example) The example of Access Points object XML is provided below. the Access Point is an Entry Access Point for one zone and an Exit Access Point for the other zone at the same time. the Access Points controls entry into a zone (Entry Access Point) or exit from a zone (Exit Access Point).xsl'?> <obj xmlns:xsi="http://www.4 Access Points The Access Points object represents the Logical Devices of Pro-Watch. In a sophisticated system. Currently Access Points use Inputs. door. Honeywell Confidential 5-7 . It is highly recommended to Application Module Developers to use only Readers. etc).org/ns/schema/1.0"> <str name="Version" href="Version/" val="1. The Access Points object represents the authentication and authorization process at a specific geographic access controlled point (for example. the Access Points controls access through a secured door.2. Outputs and Readers.org/ns/schema/1.HSDK Application Programming Interface HSDK Objects Types <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.

Simple systems may model the Honeywell Confidential 5-8 .org/ns/schema/1.0x006F97BD76938E3011D4A45600508BC86902" /> <enum name="Status_Flags" val="IN_ALARM" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetStatusFlags" /> <enum name="Event_State" val="NORMAL" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetEventState" /> <enum name="Reliability" val="NO_FAULT_DETECTED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetReliability" /> <bool name="Out_Of_Service" href="Out_Of_Service/" val="false" /> <enum name="Authorization_Mode" val="GRANT_ACTIVE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetAuthorizationMode" /> <bool name="Lockdown" href="Lockdown/" val="false" /> <bool name="Occupancy_Upper_Limit_Enforced" href="Occupancy_Upper_Limit_Enforced/" val="false" /> <bool name="Occupancy_Lower_Limit_Enforced" href="Occupancy_Lower_Limit_Enforced/" val="false" /> <int name="Threat_Level" href="Threat_Level/" val="0" /> <ref name="Zone_To" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessZones/" /> <ref name="Zone_From" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessZones/0x0063046F814A666C4DFBABB6A16892B90685" /> <ref name="Last_Card" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessCredentials/" /> <abstime name="Access_Event_Time" href="Access_Event_Time/" val="1974-12-31T15:00:00-08:00" /> <bool name="Muster_Point" href="Muster_Point/" val="false" /> <op name="Mask" href="Mask/" in="/HSDKPNLApplicationModule1/def/MaskContract" out="obix:obj" /> <op name="MaskInput" href="MaskInput/" in="obix:obj" out="obix:obj" /> <op name="UnMask" href="UnMask/" in="/HSDKPNLApplicationModule1/def/UnMaskContract" out="obix:obj" /> <op name="UnMaskInput" href="UnMaskInput/" in="obix:obj" out="obix:obj" /> <op name="TimedMask" href="TimedMask/" in="/HSDKPNLApplicationModule1/def/TimedMaskContract" out="obix:obj" /> <op name="TimedMaskInput" href="TimedMaskInput/" in="obix:obj" out="obix:obj" /> <op name="Activate" href="Activate/" in="/HSDKPNLApplicationModule1/def/ActivateContract" out="obix:obj" /> <op name="ActivateOutput" href="ActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="DeActivate" href="DeActivate/" in="/HSDKPNLApplicationModule1/def/DeActivateContract" out="obix:obj" /> <op name="DeActivateOutput" href="DeActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="Toggle" href="Toggle/" in="/HSDKPNLApplicationModule1/def/ToggleContract" out="obix:obj" /> <op name="ToggleOutput" href="ToggleOutput/" in="obix:obj" out="obix:obj" /> <op name="ActivateAllofType" href="ActivateAllofType/" in="/HSDKPNLApplicationModule1/def/ActivateAllofTypeContract" out="obix:obj" /> <op name="ActivateAllofTypeOutput" href="ActivateAllofTypeOutput/" in="obix:obj" out="obix:obj" /> <op name="DeActivateAllofType" href="DeActivateAllofType/" in="/HSDKPNLApplicationModule1/def/DeActivateAllofTypeContract" out="obix:obj" /> <op name="DeActivateAllofTypeOutput" href="DeActivateAllofTypeOutput/" in="obix:obj" out="obix:obj" /> <op name="Pulse" href="Pulse/" in="/HSDKPNLApplicationModule1/def/PulseContract" out="obix:obj" /> <op name="PulseOutput" href="PulseOutput/" in="obix:obj" out="obix:obj" /> <op name="TimeActivate" href="TimeActivate/" in="/HSDKPNLApplicationModule1/def/TimeActivateContract" out="obix:obj" /> <op name="TimeActivateOutput" href="TimeActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="ReturnToTimeZone" href="ReturnToTimeZone/" in="/HSDKPNLApplicationModule1/def/ReturnToTimeZoneContract" out="obix:obj" /> <op name="ReturnToTimeZoneOutput" href="ReturnToTimeZoneOutput/" in="obix:obj" out="obix:obj" /> <op name="Lock" href="Lock/" in="/HSDKPNLApplicationModule1/def/LockContract" out="obix:obj" /> <op name="LockReader" href="LockReader/" in="obix:obj" out="obix:obj" /> <op name="MomentaryUnLock" href="MomentaryUnLock/" in="/HSDKPNLApplicationModule1/def/MomentaryUnLockContract" out="obix:obj" /> <op name="MomentaryUnLockReader" href="MomentaryUnLockReader/" in="obix:obj" out="obix:obj" /> <op name="ReEnable" href="ReEnable/" in="/HSDKPNLApplicationModule1/def/ReEnableContract" out="obix:obj" /> <op name="ReEnableReader" href="ReEnableReader/" in="obix:obj" out="obix:obj" /> <op name="TimeOverride" href="TimeOverride/" in="/HSDKPNLApplicationModule1/def/TimeOverrideContract" out="obix:obj" /> <op name="TimeOverrideReader" href="TimeOverrideReader/" in="obix:obj" out="obix:obj" /> <op name="UnLock" href="UnLock/" in="/HSDKPNLApplicationModule1/def/UnLockContract" out="obix:obj" /> <op name="UnLockReader" href="UnLockReader/" in="obix:obj" out="obix:obj" /> <op name="MaskTamperAlarm" href="MaskTamperAlarm/" in="/HSDKPNLApplicationModule1/def/MaskTamperAlarmContract" out="obix:obj" /> <op name="MaskTamperAlarmReader" href="MaskTamperAlarmReader/" in="obix:obj" out="obix:obj" /> <op name="UnMaskTamperAlarm" href="UnMaskTamperAlarm/" in="/HSDKPNLApplicationModule1/def/UnMaskTamperAlarmContract" out="obix:obj" /> <op name="UnMaskTamperAlarmReader" href="UnMaskTamperAlarmReader/" in="obix:obj" out="obix:obj" /> <op name="EnterCypher" href="EnterCypher/" in="/HSDKPNLApplicationModule1/def/EnterCypherContract" out="obix:obj" /> <op name="EnterCypherReader" href="EnterCypherReader/" in="obix:obj" out="obix:obj" /> <op name="ExitCypher" href="ExitCypher/" in="/HSDKPNLApplicationModule1/def/ExitCypherContract" out="obix:obj" /> <op name="ExitCypherReader" href="ExitCypherReader/" in="obix:obj" out="obix:obj" /> </obj> 5.HSDK Application Programming Interface HSDK Objects Types <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.5 Access Zones The Access Zones object represents the Area of Pro-Watch.2.org/ns/schema/1.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.0"> <str name="Name" href="Name/" val="Entrance 2" /> <str name="ID" href="ID/" val="0x006F97BD76938E3011D4A45600508BC86902" /> <str name="Type" href="Type/" val="Access Point" /> <str name="Description" href="Description/" val="Entrance 2 .0 /hsdk/xsd" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessPoints/0x006F97BD76938E3011D4A45600508BC86902/" is="/HSDKPNLApplicationModule1/def/accessPoint" xmlns="http://obix. A secured zone is represented by an Access Zones object.w3.xsl'?> <obj xmlns:xsi="http://www.

(Database Configuration -> Timezone) Honeywell Confidential 5-9 .xsl'?> <obj xmlns:xsi="http://www.0" /> <str name="ID" href="ID/" val="0x0063046F814A666C4DFBABB6A16892B90685" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="Honeywell" /> <str name="Description" href="Description/" val="Honeywell 0x0063046F814A666C4DFBABB6A16892B90685" /> <str name="Type" href="Type/" val="Access Zone" /> <bool name="OccupancyCountEnable" href="OccupancyCountEnable/" val="true" /> <enum name="OccupancyState" val="NORMAL" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetAccessZoneOccupancyState" /> <int name="Occupancy_Count" href="Occupancy_Count/" val="0" /> <int name="AdjustValue" href="AdjustValue/" val="0" /> <bool name="Two_Person_Control" href="Two_Person_Control/" val="false" /> <int name="Occupancy_Lower_Limit" href="Occupancy_Lower_Limit/" val="0" /> <int name="Occupancy_Upper_Limit" href="Occupancy_Upper_Limit/" val="0" /> <bool name="IsPassbackAllowed" href="IsPassbackAllowed/" val="false" /> <bool name="IsPassbackForgive" href="IsPassbackForgive/" val="false" /> <int name="Pass_back" href="Pass_back/" val="1" /> <list name="ZonesContained" href="ZonesContained" /> <ref name="ParentZone" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessZones/" /> <list name="Entry_Points" href="Entry_Points"> <ref name="Generic__05010005000800" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessPointExtns/Generic__05010005000800" /> </list> <list name="Exit_Points" href="Exit_Points"> <ref name="Generic__05010005000801" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessPointExtns/Generic__05010005000801" /> </list> <list name="InputPoint" href="InputPoint"> <ref name="0x006F7A310D308E3611D4A45600508BC86902" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IOGroups0x006F7A310D308E3611D4A45600508BC86902" /> </list> <list name="OutputPoint" href="OutputPoint" /> <abstime name="MaskTime" href="MaskTime/" val="0001-01-01T00:00:00-08:00" /> <enum name="MaskMode" val="NONE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/MaskMode" /> <bool name="IsFreeZone" href="IsFreeZone/" val="false" /> <bool name="Out_Of_Service" href="Out_Of_Service/" val="true" /> <enum name="Reliability" val="NO_FAULT_DETECTED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetReliability" /> <enum name="CurrentEventState" val="NORMAL" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/CurrentEventState" /> <list name="Credentials_In_Zone" href="Credentials_In_Zone" /> <bool name="Locked" href="Locked/" val="false" /> <list name="ExtendedObjInformation" /> </obj> 5. The Access Zone's Occupancy_State property indicates the current occupancy state.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix. <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix. if the functionality this object represents is not exposed at the interface.HSDK Application Programming Interface HSDK Objects Types Authorization and Authentication Interface without using this object.0"> <str name="Version" href="Version/" val="1.w3. Event Enrollment objects can be configured to watch Access Zones properties. Intrinsic alarming is on Occupancy_State using the existing CHANGE_OF_STATE algorithm. Access Zones (Example) The sample Zone object XML is provided below.6 Timezone The Time zone object represents the actual time zone of Pro-Watch.0.2.org/ns/schema/1.org/ns/schema/1.0 /hsdk/xsd" name="AccessZone0x0063046F814A666C4DFBABB6A16892B90685" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessZones/0x0063046F814A666C4DFBABB6A16892B90685/" is="/HSDKPNLApplicationModule1/def/accessZone" displayName="Access Zone" xmlns="http://obix.

0"> <str name="Name" href="Name/" val="1st shift 7-4:00pm M-F" /> <str name="ID" href="ID/" val="0x000ED40949ED8D5F11D4A45600508BC86902" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Type" href="Type/" val="Time Zone" /> <str name="Description" href="Description/" val="1st shift 7-4:00pm M-F .w3.org/ns/schema/1. <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.org/ns/schema/1.0x000ED40949ED8D5F11D4A45600508BC86902" /> <abstime name="StartDate" href="StartDate/" val="0001-01-01T00:00:00-08:00" /> <abstime name="EndDate" href="EndDate/" val="9999-12-31T23:59:59.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.0 /hsdk/xsd" name="TimeZone0x000ED40949ED8D5F11D4A45600508BC86902" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/timeZones/0x000ED40949ED8D5F11D4A45600508BC86902/" is="/HSDKPNLApplicationModule1/def/timeZone" displayName="Time Zone" xmlns="http://obix.xsl'?> <obj xmlns:xsi="http://www.HSDK Application Programming Interface HSDK Objects Types Timezone (Example) The sample Timezone object XML is provided below.9999999-08:00" /> <list name="Schedules" href="Schedules/"> <obj> <abstime name="startTime" val="1999-01-01T07:00:00-08:00" /> <abstime name="stopTime" val="1999-01-01T16:00:00-08:00" /> <bool name="enable" val="true" /> <str name="days" val="YYYYYNNYYY" /> </obj> </list> </obj> Honeywell Confidential 5-10 .

It can be additionally associated with one or more input/output/inputoutput devices. Honeywell Confidential 5-11 . For example a door can consist of: • • • • "One or more readers (represented as access points in the model) "REX button "LED "Magnetic strike door control PW logical device having at least one reader is represented as Access Door in HSDK.2.7 Access Doors The Access door is a logical collection of devices and provides entry to a zone or exit from zone.HSDK Application Programming Interface HSDK Objects Types 5. Access Doors (Example) The sample Access Doors object XML is provided below.

0" /> <str name="ID" href="ID/" val="0x006F97BD76868E3011D4A45600508BC86902" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="Entrance 1" /> <str name="Description" href="Description/" val="Entrance 1 .Lock" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005001000/" /> </obj> <obj> <str name="Type" val="Output" /> <ref name="Entrance 1 .<?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.Rex Device" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005000901/" /> </obj> <obj> <str name="Type" val="Output" /> <ref name="Entrance 1 .xsl'?> <obj xmlns:xsi="http://www.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.Horn" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005001001/" /> </obj> </list> <list name="accessPointExtns" href="accessPointExtns/"> <obj> <str name="Type" val="Reader" /> <ref name="Entrance 1 .Reader" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessPointExtns/Generic__05010005000800/" /> </obj> </list> <list name="ExtendedObjInformation" /> <bool name="InAlarm" href="InAlarm/" val="false" /> <bool name="Out_Of_Service" href="Out_Of_Service/" val="false" /> <enum name="Reliability" val="NO_FAULT_DETECTED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetReliability" /> <enum name="Door_Status" val="CLOSED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/DoorStatus" /> <enum name="Lock_Status" val="LOCKED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/LockStatus" /> <enum name="Secured_Status" val="SECURED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/Secured_Status" /> <enum name="Present_Value" val="LOCK" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetPresentValue" /> <int name="Door_Pulse_Time" val="0" /> <op name="Mask" href="Mask/" in="/HSDKPNLApplicationModule1/def/MaskContract" out="obix:obj" /> <op name="MaskInput" href="MaskInput/" in="obix:obj" out="obix:obj" /> <op name="UnMask" href="UnMask/" in="/HSDKPNLApplicationModule1/def/UnMaskContract" out="obix:obj" /> <op name="UnMaskInput" href="UnMaskInput/" in="obix:obj" out="obix:obj" /> <op name="TimedMask" href="TimedMask/" in="/HSDKPNLApplicationModule1/def/TimedMaskContract" out="obix:obj" /> <op name="TimedMaskInput" href="TimedMaskInput/" in="obix:obj" out="obix:obj" /> <op name="Activate" href="Activate/" in="/HSDKPNLApplicationModule1/def/ActivateContract" out="obix:obj" /> <op name="ActivateOutput" href="ActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="DeActivate" href="DeActivate/" in="/HSDKPNLApplicationModule1/def/DeActivateContract" out="obix:obj" /> <op name="DeActivateOutput" href="DeActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="Toggle" href="Toggle/" in="/HSDKPNLApplicationModule1/def/ToggleContract" out="obix:obj" /> <op name="ToggleOutput" href="ToggleOutput/" in="obix:obj" out="obix:obj" /> <op name="ActivateAllofType" href="ActivateAllofType/" in="/HSDKPNLApplicationModule1/def/ActivateAllofTypeContract" out="obix:obj" /> <op name="ActivateAllofTypeOutput" href="ActivateAllofTypeOutput/" in="obix:obj" out="obix:obj" /> <op name="DeActivateAllofType" href="DeActivateAllofType/" in="/HSDKPNLApplicationModule1/def/DeActivateAllofTypeContract" out="obix:obj" /> <op name="DeActivateAllofTypeOutput" href="DeActivateAllofTypeOutput/" in="obix:obj" out="obix:obj" /> <op name="Pulse" href="Pulse/" in="/HSDKPNLApplicationModule1/def/PulseContract" out="obix:obj" /> <op name="PulseOutput" href="PulseOutput/" in="obix:obj" out="obix:obj" /> <op name="TimeActivate" href="TimeActivate/" in="/HSDKPNLApplicationModule1/def/TimeActivateContract" out="obix:obj" /> <op name="TimeActivateOutput" href="TimeActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="ReturnToTimeZone" href="ReturnToTimeZone/" in="/HSDKPNLApplicationModule1/def/ReturnToTimeZoneContract" out="obix:obj" /> <op name="ReturnToTimeZoneOutput" href="ReturnToTimeZoneOutput/" in="obix:obj" out="obix:obj" /> <op name="Lock" href="Lock/" in="/HSDKPNLApplicationModule1/def/LockContract" out="obix:obj" /> <op name="LockReader" href="LockReader/" in="obix:obj" out="obix:obj" /> <op name="MomentaryUnLock" href="MomentaryUnLock/" in="/HSDKPNLApplicationModule1/def/MomentaryUnLockContract" out="obix:obj" /> <op name="MomentaryUnLockReader" href="MomentaryUnLockReader/" in="obix:obj" out="obix:obj" /> <op name="ReEnable" href="ReEnable/" in="/HSDKPNLApplicationModule1/def/ReEnableContract" out="obix:obj" /> <op name="ReEnableReader" href="ReEnableReader/" in="obix:obj" out="obix:obj" /> <op name="TimeOverride" href="TimeOverride/" in="/HSDKPNLApplicationModule1/def/TimeOverrideContract" out="obix:obj" /> <op name="TimeOverrideReader" href="TimeOverrideReader/" in="obix:obj" out="obix:obj" /> <op name="UnLock" href="UnLock/" in="/HSDKPNLApplicationModule1/def/UnLockContract" out="obix:obj" /> <op name="UnLockReader" href="UnLockReader/" in="obix:obj" out="obix:obj" /> <op name="MaskTamperAlarm" href="MaskTamperAlarm/" in="/HSDKPNLApplicationModule1/def/MaskTamperAlarmContract" out="obix:obj" /> <op name="MaskTamperAlarmReader" href="MaskTamperAlarmReader/" in="obix:obj" out="obix:obj" /> <op name="UnMaskTamperAlarm" href="UnMaskTamperAlarm/" in="/HSDKPNLApplicationModule1/def/UnMaskTamperAlarmContract" out="obix:obj" /> Honeywell Confidential 5-12 .0.org/ns/schema/1.0 /hsdk/xsd" name="Entrance 1" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessDoors/0x006F97BD76868E3011D4A45600508BC86902/" is="/HSDKPNLApplicationModule1/def/accessDoor" displayName="Access Door" xmlns="http://obix.Door Position" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005000900/" /> </obj> <obj> <str name="Type" val="Input" /> <ref name="Entrance 1 .0x006F97BD76868E3011D4A45600508BC86902" /> <str name="Type" href="Type/" val="AccessDoor" /> <int name="Door_Unlock_Delay_Time" val="0" /> <int name="Door_Extended_Pulse_Time" val="0" /> <abstime name="AlarmTimeDelay" href="AlarmTimeDelay/" val="0001-01-01T00:00:00-08:00" /> <enum name="Event_State" val="NORMAL" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetEventState" /> <abstime name="MaskTime" href="MaskTime/" val="0001-01-01T00:00:00-08:00" /> <enum name="MaskMode" val="NONE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/MaskMode" /> <list name="IODevices" href="IODevices/"> <obj> <str name="Type" val="Input" /> <ref name="Entrance 1 .org/ns/schema/1.0"> <str name="Version" href="Version/" val="1.w3.

HSDK Application Programming Interface HSDK Objects Types <op name="UnMaskTamperAlarmReader" href="UnMaskTamperAlarmReader/" in="obix:obj" out="obix:obj" /> <op name="EnterCypher" href="EnterCypher/" in="/HSDKPNLApplicationModule1/def/EnterCypherContract" out="obix:obj" /> <op name="EnterCypherReader" href="EnterCypherReader/" in="obix:obj" out="obix:obj" /> <op name="ExitCypher" href="ExitCypher/" in="/HSDKPNLApplicationModule1/def/ExitCypherContract" out="obix:obj" /> <op name="ExitCypherReader" href="ExitCypherReader/" in="obix:obj" out="obix:obj" /> </obj> 5. AccessPointExtns (Example) The sample Access PointExtns object XML is provided below. Honeywell Confidential 5-13 .8 AccessPointExtns The access point extn is the point of authentication and authorization in the system.2. Pro-Watch access readers are represented as access point extn in HSDK.

org/ns/schema/1.0" /> <str name="ID" href="ID/" val="Generic__05010005000800" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="Entrance 1 .0.Reader .Reader" /> <str name="Description" href="Description/" val="Entrance 1 .0"> <str name="Version" href="Version/" val="1.org/ns/schema/1.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.HSDK Application Programming Interface HSDK Objects Types <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.Generic::05010005000800" /> <str name="Type" href="Type/" val="AccessPointExtn" /> <enum name="AccessPointCategory" val="READER" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/AccessPointCategory" /> <int name="LockDownRelinquishTime" href="LockDownRelinquishTime/" val="0" /> <int name="MaxFailedAttempts" href="MaxFailedAttempts/" val="0" /> <abstime name="FailedAttemptsTime" href="FailedAttemptsTime/" val="0001-01-01T00:00:00-08:00" /> <abstime name="TransientTime" href="TransientTime/" val="0001-01-01T00:00:00-08:00" /> <bool name="Muster_Point" href="Muster_Point/" val="false" /> <bool name="Occupancy_Upper_Limit_Enforced" href="Occupancy_Upper_Limit_Enforced/" val="false" /> <bool name="Occupancy_Lower_Limit_Enforced" href="Occupancy_Lower_Limit_Enforced/" val="false" /> <bool name="IsAntiPassbackAllowed" href="IsAntiPassbackAllowed/" val="false" /> <bool name="IsPassbackForgive" href="IsPassbackForgive/" val="false" /> <abstime name="AntiPassbackDelay" href="AntiPassbackDelay/" val="0001-01-01T00:00:00-08:00" /> <bool name="AuditOnkeys" href="AuditOnkeys/" val="false" /> <int name="Threat_Level" href="Threat_Level/" val="0" /> <int name="NumFailedAttempts" href="NumFailedAttempts/" val="0" /> <int name="ActiveAuthenticationPolicy" href="ActiveAuthenticationPolicy/" val="0" /> <ref name="Belongs_To" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessDoors/0x006F97BD76868E3011D4A45600508BC86902" /> <enum name="Authorization_Mode" val="GRANT_ACTIVE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetAuthorizationMode" /> <ref name="Zone_To" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessZones/0x0063046F814A666C4DFBABB6A16892B90685" /> <ref name="Zone_From" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessZones/0x0063046F814A666C4DFBABB6A16892B90685" /> <list name="ZonesContainedIn" href="ZonesContainedIn/" /> <abstime name="MaskTime" href="MaskTime/" val="0001-01-01T00:00:00-08:00" /> <enum name="MaskMode" val="NONE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/MaskMode" /> <list name="AuthenticationFormats" href="AuthenticationFormats/" /> <bool name="IsActive" href="IsActive/" val="false" /> <bool name="InAlarm" href="InAlarm/" val="false" /> <bool name="Fault" href="Fault/" val="false" /> <bool name="Out_Of_Service" href="Out_Of_Service/" val="false" /> <bool name="Lockdown" href="Lockdown/" val="false" /> <bool name="EnableDuress" href="EnableDuress/" val="false" /> <bool name="DenyDuress" href="DenyDuress/" val="false" /> <enum name="Reliability" val="NO_FAULT_DETECTED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetReliability" /> <enum name="Status_Flags" val="IN_ALARM" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetStatusFlags" /> <enum name="Event_State" val="NORMAL" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/BACnetEventState" /> <ref name="Last_Card" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessCredentials/20443" /> <abstime name="Access_Event_Time" href="Access_Event_Time/" val="9999-12-31T23:59:59.0 /hsdk/xsd" name="AccessPointExtnGeneric__05010005000800" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/accessPointExtns/Generic__05010005000800/" is="/HSDKPNLApplicationModule1/def/accessPointExtn" displayName="AccessPointExtn" xmlns="http://obix.xsl'?> <obj xmlns:xsi="http://www.9999999-08:00" /> <str name="Status" href="Status/" val="NO_RESPONSE" /> <list name="ExtendedObjInformation" /> <op name="Lock" href="Lock/" in="/HSDKPNLApplicationModule1/def/LockContract" out="obix:obj" /> <op name="LockReader" href="LockReader/" in="obix:obj" out="obix:obj" /> <op name="MomentaryUnLock" href="MomentaryUnLock/" in="/HSDKPNLApplicationModule1/def/MomentaryUnLockContract" out="obix:obj" /> <op name="MomentaryUnLockReader" href="MomentaryUnLockReader/" in="obix:obj" out="obix:obj" /> <op name="ReEnable" href="ReEnable/" in="/HSDKPNLApplicationModule1/def/ReEnableContract" out="obix:obj" /> <op name="ReEnableReader" href="ReEnableReader/" in="obix:obj" out="obix:obj" /> <op name="TimeOverride" href="TimeOverride/" in="/HSDKPNLApplicationModule1/def/TimeOverrideContract" out="obix:obj" /> <op name="TimeOverrideReader" href="TimeOverrideReader/" in="obix:obj" out="obix:obj" /> <op name="UnLock" href="UnLock/" in="/HSDKPNLApplicationModule1/def/UnLockContract" out="obix:obj" /> <op name="UnLockReader" href="UnLockReader/" in="obix:obj" out="obix:obj" /> <op name="MaskTamperAlarm" href="MaskTamperAlarm/" in="/HSDKPNLApplicationModule1/def/MaskTamperAlarmContract" out="obix:obj" /> <op name="MaskTamperAlarmReader" href="MaskTamperAlarmReader/" in="obix:obj" out="obix:obj" /> <op name="UnMaskTamperAlarm" href="UnMaskTamperAlarm/" in="/HSDKPNLApplicationModule1/def/UnMaskTamperAlarmContract" out="obix:obj" /> <op name="UnMaskTamperAlarmReader" href="UnMaskTamperAlarmReader/" in="obix:obj" out="obix:obj" /> <op name="EnterCypher" href="EnterCypher/" in="/HSDKPNLApplicationModule1/def/EnterCypherContract" out="obix:obj" /> <op name="EnterCypherReader" href="EnterCypherReader/" in="obix:obj" out="obix:obj" /> <op name="ExitCypher" href="ExitCypher/" in="/HSDKPNLApplicationModule1/def/ExitCypherContract" out="obix:obj" /> <op name="ExitCypherReader" href="ExitCypherReader/" in="obix:obj" out="obix:obj" /> </obj> Honeywell Confidential 5-14 .w3.

Generic::05010005001000" /> <str name="Type" href="Type/" val="IODevice" /> <enum name="Devicetype" val="OUTPUT" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/deviceType" /> <obj name="DeviceDetails" null="true" writable="true"> <str name="Manufacturer" val="" /> <str name="Model" val="" /> </obj> <obj name="CommunicationInformation" null="true" writable="true"> <obj name="NetworkAddress"> <str name="IPAddress" val="" /> <str name="SubnetMask" val="" /> </obj> <obj name="PortInformation"> <str name="PortNumber" val="" /> <list name="SerialPort"> <str name="Name" val="" /> <int name="BaudRate" val="0" /> <str name="EvenParity" val="" /> <str name="OddParity" val="" /> </list> </obj> </obj> <obj name="Location" writable="true"> <str name="LocationId" val="PW-5000 Demo Case" /> <str name="ZoneId" val="" /> </obj> <abstime name="EntryDelay" val="0001-01-01T00:00:00-08:00" /> <abstime name="ExitDelay" val="0001-01-01T00:00:00-08:00" /> <enum name="InputPointMode" val="NORMAL" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/InputPointMode" /> <abstime name="MaskTime" val="0001-01-01T00:00:00-08:00" /> <obj name="AssociatedDevices" null="true" writable="true"> <str name="ParentDeviceId" val="" /> </obj> <enum name="InputDeviceCategory" val="DOOR_POSITION" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/InputDeviceCategory" /> <enum name="OutputDeviceCategory" val="LOCK" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/OutputDeviceCategory" /> <abstime name="ShuntDuration" val="0001-01-01T00:00:00-08:00" /> <int name="DebounceTime" val="0" /> <obj name="TimeZoneConfig" null="true" writable="true"> <obj name="Shunttimezone" href="" /> <obj name="DisableAlarmMessagingtimezone" href="" /> </obj> <enum name="DeviceModeType" val="NORMALLY_OPEN_SUPERVISED" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/DeviceModeType" /> <enum name="OutputPointPulseMode" val="ON" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/OutputPointPulseMode" /> <int name="PulseTimeDelay" val="0" /> <bool name="IsEnabled" val="false" /> <bool name="IsMaintenanceRequired" val="false" /> <enum name="DeviceStatus" val="ACTIVE" range="http://win-3ycrafepf79/HSDKPNLApplicationModule1/def/enums/DeviceStatus" /> <ref name="Belongs_To" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IOGroups/0x006F97BD76868E3011D4A45600508BC86902" /> <str name="Status" href="Status/" val="NO_RESPONSE" /> <list name="ExtendedObjInformation" /> </obj> Honeywell Confidential 5-15 .0" /> <str name="ID" href="ID/" val="Generic__05010005001000" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="Entrance 1 .xsl'?> <obj xmlns:xsi="http://www.org/ns/schema/1.0"> <str name="Version" href="Version/" val="1.org/ns/schema/1.0.Lock" /> <str name="Description" href="Description/" val="Entrance 1 . IODevices (Example) The sample IODevices object XML is provided below.w3.2. Pro-Watch input points and output points are represented as IO Devices in HSDK. <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.0 /hsdk/xsd" name="IODeviceGeneric__05010005001000" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005001000/" is="/HSDKPNLApplicationModule1/def/IODevice" displayName="Input Output Device" xmlns="http://obix.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.Lock .HSDK Application Programming Interface HSDK Objects Types 5.9 IO Devices The input output device is implemented to describe any other devices other than access reader.

10 IO Groups Device group is a logical collection of input -output devices. Pro-Watch logical device which does not have a single reader is represented as IO Group in HSDK. Honeywell Confidential 5-16 . IOGroups (Example) The sample IOGroups object XML is provided below.2.HSDK Application Programming Interface HSDK Objects Types 5.

org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.xsl'?> <obj xmlns:xsi="http://www.HSDK Application Programming Interface HSDK Objects Types <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule1/resources/xsl/obix.0x006F61FB095046E64CFCB4E033400A4D7460" /> <str name="Type" href="Type/" val="IOGroup" /> <list name="IODevices" href="IODevices/"> <obj> <str name="IODevices" val="Input" /> <ref name="Generic__05010005000906" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005000906/" /> </obj> <obj> <str name="IODevices" val="Input" /> <ref name="Generic__05010005010900" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005010900/" /> </obj> <obj> <str name="IODevices" val="Input" /> <ref name="Generic__05010005010901" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005010901/" /> </obj> <obj> <str name="IODevices" val="Output" /> <ref name="Generic__05010005001000" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005001000/" /> </obj> <obj> <str name="IODevices" val="Output" /> <ref name="Generic__05010005001005" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005001005/" /> </obj> <obj> <str name="IODevices" val="Output" /> <ref name="Generic__05010005011000" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005011000/" /> </obj> <obj> <str name="IODevices" val="Output" /> <ref name="Generic__05010005011001" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IODevices/Generic__05010005011001/" /> </obj> </list> <list name="ExtendedObjInformation" /> <op name="Mask" href="Mask/" in="/HSDKPNLApplicationModule1/def/MaskContract" out="obix:obj" /> <op name="MaskInput" href="MaskInput/" in="obix:obj" out="obix:obj" /> <op name="UnMask" href="UnMask/" in="/HSDKPNLApplicationModule1/def/UnMaskContract" out="obix:obj" /> <op name="UnMaskInput" href="UnMaskInput/" in="obix:obj" out="obix:obj" /> <op name="TimedMask" href="TimedMask/" in="/HSDKPNLApplicationModule1/def/TimedMaskContract" out="obix:obj" /> <op name="TimedMaskInput" href="TimedMaskInput/" in="obix:obj" out="obix:obj" /> <op name="Activate" href="Activate/" in="/HSDKPNLApplicationModule1/def/ActivateContract" out="obix:obj" /> <op name="ActivateOutput" href="ActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="DeActivate" href="DeActivate/" in="/HSDKPNLApplicationModule1/def/DeActivateContract" out="obix:obj" /> <op name="DeActivateOutput" href="DeActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="Toggle" href="Toggle/" in="/HSDKPNLApplicationModule1/def/ToggleContract" out="obix:obj" /> <op name="ToggleOutput" href="ToggleOutput/" in="obix:obj" out="obix:obj" /> <op name="ActivateAllofType" href="ActivateAllofType/" in="/HSDKPNLApplicationModule1/def/ActivateAllofTypeContract" out="obix:obj" /> <op name="ActivateAllofTypeOutput" href="ActivateAllofTypeOutput/" in="obix:obj" out="obix:obj" /> <op name="DeActivateAllofType" href="DeActivateAllofType/" in="/HSDKPNLApplicationModule1/def/DeActivateAllofTypeContract" out="obix:obj" /> <op name="DeActivateAllofTypeOutput" href="DeActivateAllofTypeOutput/" in="obix:obj" out="obix:obj" /> <op name="Pulse" href="Pulse/" in="/HSDKPNLApplicationModule1/def/PulseContract" out="obix:obj" /> <op name="PulseOutput" href="PulseOutput/" in="obix:obj" out="obix:obj" /> <op name="TimeActivate" href="TimeActivate/" in="/HSDKPNLApplicationModule1/def/TimeActivateContract" out="obix:obj" /> <op name="TimeActivateOutput" href="TimeActivateOutput/" in="obix:obj" out="obix:obj" /> <op name="ReturnToTimeZone" href="ReturnToTimeZone/" in="/HSDKPNLApplicationModule1/def/ReturnToTimeZoneContract" out="obix:obj" /> <op name="ReturnToTimeZoneOutput" href="ReturnToTimeZoneOutput/" in="obix:obj" out="obix:obj" /> </obj> Honeywell Confidential 5-17 .0 /hsdk/xsd" name="IOGroups0x006F61FB095046E64CFCB4E033400A4D7460" href="http://win-3ycrafepf79/HSDKPNLApplicationModule1/pacs/IOGroups/0x006F61FB095046E64CFCB4E033400A4D7460/" is="/HSDKPNLApplicationModule1/def/accessIOGroup" displayName="IOGroups" xmlns="http://obix.0.0"> <str name="Version" href="Version/" val="1.w3.0" /> <str name="ID" href="ID/" val="0x006F61FB095046E64CFCB4E033400A4D7460" /> <str name="ExternalID" href="ExternalID/" val="" /> <str name="Name" href="Name/" val="Floor1" /> <str name="Description" href="Description/" val="Floor1 .org/ns/schema/1.org/ns/schema/1.

3. Honeywell Confidential 5-18 .config The attributes in the below XML code are Mandatory attributes with value 1 and these are pre-configured in Pro-Watch.1 HSDK Server Configuration HSDK Server Configuration allows you to configure the event attributes.3 HSDK Configuration 5. The Event configuration code is shown below. which is accessible using the path: C:\Program Files\Honeywell\HSDK\<ApplicationModuleName>\HSDK Server\web. An Event attribute contains the information about the event that is executed by Pro-Watch to the third party software. It is recommended not to change the value of Mandatory attributes to 0. The attributes in the below sample XML code are Newly added for Supporting all Event attributes and these attributes are configurable.HSDK Application Programming Interface HSDK Configuration 5.

HSDK Application Programming Interface HSDK Configuration The following sample figure displays all the attributes under Event configuration in Pro-Watch. appSettings Configuration The appSetting configuration is shown below and the description of each event under appSettings is described in the table. Honeywell Confidential 5-19 .

Event Attributes Description eventHistorySize Number of Pro-Watch events received by 3rd party at the time of watch creation. pacsDBName Pro-Watch Database name Honeywell Confidential 5-20 . pacsDBServer The computer /machine name along with the SQL instance name where Pro-Watch Database is installed. pacsCommServer The computer/machine name where Pro-Watch server is installed.HSDK Application Programming Interface HSDK Configuration The description of each event is given below in the table.

For example Computer Format is US english and the Database language is British (Select @@Language). HSDKDBName HSDK Database name Language The current format set in control panel > Regional and language settings. appModuleName Application Module Name Honeywell Confidential 5-21 . MaxSearchResultCount This is the maximum search results that is sent in response XML when 3rd party obix client searches for Pro-Watch objects. appModuleID This is the application module ID and it should not be modified.config file for possible language values. serviceLicensePortNumber The port number where licensing service accepts the request and responds to HSDK Server. MessageQueueName Name of message queue into which the HSDK server writes messages and it is read by the HSDKTrace application.HSDK Application Programming Interface HSDK Configuration HSDKDBServer The computer /machine name along with the SQL instance name where HSDK Database is installed. Refer to section 6. This is required when the computer format and the database language is different. VDirName This is Virtual Directory Name of the HSDK server in IIS. Refer to web. Where: 0: No logging 1: Only Error 2: Only Exception 3: Only Trace 4: All logging PWBridgeServicePort The Port number where PWbridgeservice accepts the request and responds to HSDK server.15 Search Pro-Watch objects capa- bility at Server HSDKLicTimeProcessInterval It is the number of minutes after which HSDK verifies the license information. The possible values are 0 to 4. HSDKTrace Indicates whether to write the messages into MessageQueue logLevel The level of logging required for HSDK server. MaxMessageCount It is the maximum number of messages to be kept in the message queue.

which is accessible using the path: C:\Program Files\Honeywell\HSDK\<ApplicationModuleName>\HSDK Client\HSDKObixClientService. Honeywell Confidential 5-22 .config Below table provides you with the description of each event under HSDK Client Configuration.2 HSDK Client Configuration The sample HSDK Client configuration XML code is shown below.exe.3.HSDK Application Programming Interface HSDK Configuration 5.

LeaseTimeBuffer Used for setting lease time while creating watch Application Module Name Application Module Name objWatchPollInterval Used for setting the poll interval for watches created on objects of third party from Pro-Watch. HSDKDBName HSDK Database name Language The current format set in control panel > Regional and language settings. GetUnackedAlarmsatServiceStart This tells whether the alarms have to be sent out during the restart of the HSDK Service.HSDK Application Programming Interface HSDK Configuration Event Attributes Description pacsCommServer The computer/machine name where Pro-Watch server is installed. This should not be changed. eventWatchPollInterval eventWatchPollInterval not used. pacsDBName Pro-Watch Database name HSDKWatchLeaseTimeProcessorInterval The time interval to check the expired watches for deletion. LicenseFileName The filename of the license file. pacsDBServer The computer /machine name along with the SQL instance name where Pro-Watch Database is installed. MaxMessageCount It is the Maximum number of messages to be kept in the message queue. MessageQueueName Name of message Queue into which the HSDK server writes messages and it is read by the HSDKTrace application.config file for possible language values. This is required when the computer format and the database language is different. HSDKDBServer The computer /machine name along with the SQL instance name where HSDK Database is installed. For example Computer Format is US english and the Database language is British (Select @@Language). as the request for the poll changes comes from Pro-Watch 2 hsdk bridge dll. Honeywell Confidential 5-23 . eventPollInterval Used in pwbridge service for downloading the events of prowatch to hsdk. HSDKLicTimeProcessInterval It is the number of minutes after which HSDK verifies the license information. Refer to web.

config Below table provides you with the description of each event under Application Module Web configuration.3 Application Module Web Configuration The sample Application Module Web configuration XML code is shown below.HSDK Application Programming Interface HSDK Configuration HSDKTrace Indicates whether to write the messages into MessageQueue logLevel The level of logging required for HSDK server. Honeywell Confidential 5-24 . The possible values are 0 to 4. 5. which is accessible using the path: C:\Program Files\Honeywell\HSDK\<ApplicationModuleName>\Application Module Web\web.3. Where: 0: No logging 1: Only Error 2: Only Exception 3: Only Trace 4: All logging AccessReaderContract This is the contract required for subscribing the access reader.

Ex: For an AccessDoorContract. Ex: For an AccessRightContract. Application Module Name Application Module Name AccessUserContract This is the contract used while subscribing the access system object. Honeywell Confidential 5-25 . Ex: For an AccessZoneContract. Ex: For an AccessUserContract. the value in the description tells that the contract specified by the third party application in the AccessCredential object. AccessCredentialContract This is the contract used while subscribing the access system object.HSDK Application Programming Interface HSDK Configuration Event Attributes Description serviceLicensePortNumber The port number where licensing service is listening to the request for servicing the Application Module Web. Ex: For an AccessPointContract. Ex: For an AccessCredentialContract. AccessRightContract This is the contract used while subscribing the access system object. the value in the description tells that the contract specified by the third party application in the AccessPoint object. AccessDoorContract This is the contract used while subscribing the access system object. AccessZoneContract This is the contract used while subscribing the access system object. the value in the description tells that the contract specified by the third party application in the AccessZone object. the value in the description tells that the contract specified by the third party application in the AccessDoor object. AccessPointContract This is the contract used while subscribing the access system object. the value in the description tells that the contract specified by the third party application in the AccessRight object. the value in the description tells that the contract specified by the third party application in the AccessUser object.

HSDK Application Programming Interface HSDK Configuration logLevel Honeywell Confidential The level of logging required for Application Module Web. Where: 0: No logging 1: Only Error 2: Only Exception 3: Only Trace 4: All logging 5-26 . The possible values are 0 to 4.

6 HSDK TEST CLIENT This chapter covers the following topics. Overview page 6-2 Obtaining HSDK Test Client page 6-2 Prerequisites page 6-2 Installing the HSDK Test Client page 6-2 HSDK Server Login page 6-7 HSDK Test Client User Interface page 6-8 Page Layout page 6-9 Using HSDK Test Client page 6-10 Controlling Pro-Watch Doors page 6-18 Subscribing for Object Updates page 6-21 Viewing events from Pro-Watch page 6-26 Acknowledging/Clearing ProWatch Alarms page 6-27 Viewing/Modifying Properties of Pro-Watch Objects page 6-33 Additional features of HSDK Test Client page 6-35 Search Pro-Watch objects capability at Server page 6-40 Honeywell Confidential 6-1 .

the modified object is returned by the HSDK Server to the HSDK Test Client application. Message Queuing is installed on the computer. The HSDK Test Client (or HSDK sample test client application) utilizes the HSDK Server to perform the following functions: 1. 3. through HSDK Server. Create or delete a Watch on any Pro-Watch object. 6.NET Framework 3.1 Overview This chapter describes the procedure and high-level code samples to utilize HSDK Test Client to access Pro-Watch objects. 6.Installing the HSDK Test Client 6. View or change the properties of Pro-Watch objects which are exposed by the HSDK server. Create or delete a Watch on Pro-Watch events. the Pro-Watch events are displayed in HSDK Test Client application. 2. Delete the existing Pro-Watch objects.4 Installing the HSDK Test Client To install the HSDK Test Client Honeywell Confidential 6-2 . ensure that the following prerequisites are met: • • . 4.2 Obtaining HSDK Test Client The sample HSDK Test Client is available as HSDK Test Client Setup on the HSDK CD-ROM.3 Prerequisites Before installing HSDK Test Client on your system.HSDK Test Client Overview 6. 5. Create new Pro-Watch objects. On polling the Watch.5 with Service Pack 1 is installed on the computer.

HSDK Test Client Installing the HSDK Test Client 1.exe. Honeywell Confidential 6-3 . Double-click the HSDK Test Client Setup. Click Next. 2. The Select Installation Folder dialog box appears. Insert the HSDK CD-ROM into the CD-ROM drive. The HSDK Test Client Setup Wizard appears.

HSDK Test Client Installing the HSDK Test Client To change the destination folder. click Browse and choose the folder in which HSDK Test Client is to be installed. Click Next. 3. Honeywell Confidential 6-4 . The Confirm Installation dialog box appears.

HSDK Test Client Installing the HSDK Test Client 4. Honeywell Confidential 6-5 . Click Next to start the installation. The Installing HSDK Test Client window appears showing the status of installation.

Honeywell Confidential 6-6 .HSDK Test Client Installing the HSDK Test Client 5. A HSDK test client application shortcut will be created on the desktop. click Close to complete the installation. After installation is complete.

HSDK Test Client HSDK Server Login 6.5 HSDK Server Login Before working with the HSDK Test Client application. you need to provide the login credentials to connect to the HSDK Server. To provide the HSDK Server Login details 1. The Login dialog box appears. Honeywell Confidential 6-7 . Open the HSDK Test Client application or double-click the HSDK Test Client shortcut on the desktop.

6 HSDK Test Client User Interface HSDK Test Client application provides a tab-based interface to perform the following functions: • • • • View. These login credentials are used by the HSDK Test Client to connect to the HSDK Server. The following figure displays the main page layout of the HSDK Test Client application. refer to HSDK Test Client chapter. In the Login pane: a. Send raw XML to the HSDK Server. c. 6. b. after you click Connect in the HSDK Test Client application interface. Configure the HSDK Test Client application. Type the password in the Password field. Type the Domain and Username of the computer in which the HSDK Server is installed. Honeywell Confidential 6-8 . or invoke the exposed Pro-Watch objects or events. For more details on connecting to HSDK Server. Search for the Pro-Watch objects.HSDK Test Client HSDK Test Client User Interface 2. modify. Click Login.

HSDK Test Client Page Layout 6. Honeywell Confidential 6-9 .7 Page Layout The HSDK Test Client interface provides access to the various tabs of the HSDK sample test client application. The tasks that you can perform using the HSDK Test Client are arranged in the form of tabs. The following table lists the tabs and a brief description about the tasks that you can perform using each tab.

For more information on searching for a Pro-Watch object. The Search Objects tab allows you to search for a Pro-Watch object. The Configuration tab allows you to configure several application behaviors of the HSDK test client application by setting values in the respective fields. refer to Con- figuring application using Configuration Tab section.8 Using HSDK Test Client This section provides the steps for using the sample HSDK Test Client to connect to the HSDK Server and retrieve the information on Pro-Watch objects. 6. The Send XML tab allows you to send raw XML to HSDK Server. The high-level code samples for developing the HSDK Test Client application to communicate with the HSDK Server are also provided.HSDK Test Client Using HSDK Test Client Tab Description The Browse OBIX Tree tab allows you to browse through the Pro-Watch objects after you connect to the HSDK Server. refer to Searching for a Pro-Watch Object section. For more information on configuring the test client application. The About tab shows the version information of the HSDK test client application. refer to Sending Raw XML to HSDK Server section. The relevant sections for using the sample HSDK Test Client application are: • • • • • Connecting to the HSDK Server Creating a Watch Subscribing for Object Updates Viewing events from Pro-Watch Viewing/Modifying Properties of Pro-Watch Objects Honeywell Confidential 6-10 . For more information on sending the draw XML to HSDK Server.

1 Connecting to the HSDK Server You can connect the HSDK Test Client application to the HSDK Server using the HSDK Lobby URI. 2. The HSDK Server returns the list of Pro-Watch objects under the Lobby URI of HSDK. Once you click Connect.HSDK Test Client Using HSDK Test Client • Invoking Pro-Watch Objects 6. you can view the list of Pro-Watch objects under that Lobby URI. In the HSDK Test Client window. Once connected.8. Honeywell Confidential 6-11 . To connect to the HSDK Server 1. Open the HSDK Test Client application or double-click the HSDK Test Client shortcut on the desktop. The HSDK Test Client window appears. type the HSDK Lobby URI as shown in the below figure and click Connect. the HSDK Test Client gets connected to the HSDK Server.

expand the root object (for example.HSDK Test Client Using HSDK Test Client The HSDK Test Client connects to all the objects recursively to create the oBIX data tree which is displayed in the OBIX Data Tree pane. Honeywell Confidential 6-12 . To view the oBIX data tree. obj) created in the OBIX Data Tree panel.

Honeywell Confidential 6-13 . The code segment which sents the endRequest method is provided below. The code samples for HSDK Test Client for connecting to the HSDK Server and retrieving the oBIX Data Tree are provided below.net/projects/obix/. a GET request is send to the HSDK Server to retrieve the Pro-Watch objects. the SendRequest method sends the requests for XML response to HSDK Server to retrieve the Pro-Watch objects. The response XML is parsed by the HSDK Test Client application and represented as the oBIX Data Tree. Sending a GET Request After you click Connect in HSDK Test Client to connect to the HSDK Server.HSDK Test Client Using HSDK Test Client 6. The oBIX Data Tree hierarchy represents the Pro-Watch objects.8.2 Code Samples The necessary code of Obix Java Toolkit can be downloaded from http:// sourceforge. The HSDK Server response to GET request is XML. The code sample for sending the GET request to the HSDK Server and reading the response XML is provided below. SendRequest() In the above code segment.

the GetSoapMessage method returns the request XML in SOAP format.HSDK Test Client Using HSDK Test Client GetSoapMessage() In the SendRequest method. The GetSoapMessage method code segment is provided below. Honeywell Confidential 6-14 .

The PostRequestToURL method is provided below. Honeywell Confidential 6-15 .HSDK Test Client Using HSDK Test Client PostRequestToURL() The PostRequestToURL method (in the SendRequest method code segment) sends the request XML to the specified URL using specified method with the Username and Password provided as parameters.

HSDK Test Client Using HSDK Test Client Honeywell Confidential 6-16 .

The PopulateNodes() method code segment is provided below. The oBIX Data Tree view represents the Pro-Watch objects. This response XML is parsed by PopulateNodes() method to create an oBIX Data Tree view.HSDK Test Client Using HSDK Test Client Reading Response XML The HSDK Server response to GET request is XML in SOAP format. Honeywell Confidential 6-17 .

Note To control Pro-Watch Door: 1. 2.HSDK Test Client Controlling Pro-Watch Doors 6.38 onwards. Input and Output points are also controllable. but from HSDK 1.9.0. only Readers were controllable from HSDK Test Client.9 Controlling Pro-Watch Doors In previous HSDK versions. Right-click on the required door and select Invoke as shown below Honeywell Confidential 6-18 . In the HSDK Test Client application window expand the Page1 node under accessPoints.

HSDK Test Client Controlling Pro-Watch Doors 3. and then click the Invoke button. Invoke Success message is displayed at the bottom of the window as shown below. On the right pane drag the cursor to select the required operation. Honeywell Confidential 6-19 .

HSDK Test Client Controlling Pro-Watch Doors The invoked operation can be seen in Pro-Watch as shown below Honeywell Confidential 6-20 .

In the I want to Create pane: b. To create a new watch 1. Click Create New Watch. 4. 5. Specify the type of Watch. Honeywell Confidential 6-21 . In the Create New Watch pane: a. Right-click on the status bar at bottom of the HSDK Test Client window to create a new watch.10 Subscribing for Object Updates 6. 2.The Create New Watch window appears. Type the name of the watch to be created in Watch Name field. You can create a new Watch and then add objects to the created watch. 3. In the Watch Type pane: a.1 Creating a Watch A Watch allows a third-party application to maintain a real-time cache for the current state of one or more Pro-Watch objects.HSDK Test Client Subscribing for Object Updates 6. Select Object if the Watch has to be created for an object else select Alarm if it must be created for an alarm feed.10. Specify if you want create a Single Watch or Multiple Watches.

HSDK Test Client
Subscribing for Object Updates

6.

b.

Type the Lease Time. The lease time defines the time after which the
watch is expired, if not polled.

c.

Type the Poll Interval. The poll interval sets the number of seconds that
elapses between each poll by the host computer.

Click Create to create a new watch.

6.10.2 Code Samples
Creating a Watch
When you invoke the Make operation of the watchService, the HSDK Server creates
a watch and returns the URI of the newly created watch to the HSDK Test Client
(with the GUID). The URI must be stored and used for subsequent operation on that
watch.
The code segment for creating a watch using SendRequest method and storing the
URI in watchUrl string is provided below.

Setting Lease for the Watch
In the Create New Watch window, the Lease Time is set which defines the time after
which the watch is expired. The code segment below sets the lease time for 300 sec.
The watchUrl is the URI returned by HSDK server when the watch is created.

Honeywell Confidential

6-22

HSDK Test Client
Subscribing for Object Updates

6.10.3 Adding Objects to Watch
To subscribe for a Pro-Watch object update
1.

Right-click on an object and select AddToWatch in the shortcut menu.

The List Watches dialog box appears.The List Watches dialog box lists all the
created watches.
Pro-Watch object can be added to multiple watches and multiple objects can be added to
a watch.

Note

2.

To subscribe the object to watch, select a watch (or multiple watches), for
example, Cards watch in the List Watches dialog box.

3.

Click Add to add the object to the selected watch.

Honeywell Confidential

6-23

HSDK Test Client
Subscribing for Object Updates

6.10.4 Code Samples
Subscribing to Watch
The sample code for subscribing a Pro-Watch object to the created watch is
provided below.

Honeywell Confidential

6-24

HSDK Test Client
Subscribing for Object Updates

Unsubscribing to Watch
If modification details for the subscribed object is not required, that object can be
unsubscribed from the watch. Hence, when the HSDK Server is polled next time,
modifications for unsubscribed object is not returned. The code segment for
unsubscribing to a watch is provided below.

Polling a Watch
The watch needs to be continuously polled to get the modifications for subscribed
objects or events.The code segment which polls the watch for the object updates is
provided below.

In the above code segment, the method pollChanges provides the modified objects
or the recent events. If you want all the objects irrespective of modification or all the
events, use the method pollRefresh.

Deleting a Watch
The code segment below deletes a watch when the watch service is no longer
required.

Honeywell Confidential

6-25

HSDK Test Client
Viewing events from Pro-Watch

6.11 Viewing events from Pro-Watch
To view an event from Pro-Watch
1.

While creating a watch, select Watch Type as Alarm to create a watch to view
Pro-Watch events.

2.

In the Create New Watch pane:
a.

Type the name of the watch to be created in Watch Name field.

b.

Type the Lease Time. The lease time defines the time after which the
watch is expired, if not polled.

c.

Type the Poll Interval. The poll interval sets the number of seconds that
elapses between each poll by the host computer.

3.

Click Create to create a new watch. The Create New Watch window appears.

4.

Click Yes to include the previous events of Pro-Watch.

Honeywell Confidential

6-26

HSDK Test Client Acknowledging/Clearing Pro-Watch Alarms 6. Honeywell Confidential 6-27 . Right-click on the alarm and then select Acknowledge as shown below.12 Acknowledging/Clearing Pro-Watch Alarms To acknowledge/clear Pro-Watch alarm from Test client: 1.

Right-click on the acknowledged alarm that needs to be cleared and then select Clear as shown below. Only acknowledged alarms can be cleared. Honeywell Confidential 6-28 . First acknowledge the Alarm is displayed as shown below. In shortcut menu the Clear All command clears all the alarms from the Test client but not from Pro-Watch. Note Notes • 1.HSDK Test Client Acknowledging/Clearing Pro-Watch Alarms 2. If you try to clear an unacknowledged alarm. an error message Error while acknowledging/Clearing. This clears alarm from Pro-Watch as well as Test client.

The events cannot be acknowledged/cleared. If you try to clear an event. an error message This is an Event and can not be Acknowledged/Cleared is displayed as shown below. Only alarms can be acknowledged and cleared.HSDK Test Client Acknowledging/Clearing Pro-Watch Alarms Notes • 2. Honeywell Confidential 6-29 .

1 Sample Alarm Below is a sample Alarm XML from Pro-Watch to Test Client.12.HSDK Test Client Acknowledging/Clearing Pro-Watch Alarms 6. Honeywell Confidential 6-30 .

strUrl is the href of op tag with name ack as outlined in red color in the above figure.HSDK Test Client Acknowledging/Clearing Pro-Watch Alarms Programmatically acknowledging an alarm A POST method must be used for acknowledging a Pro-Watch alarm. The code segment of POST method is provided below. Honeywell Confidential 6-31 . Programmatically clearing an alarm Once an alarm is acknowledged. it can be cleared from the test client (3rd party application module). A POST method must be used for clearing the Pro-Watch alarm. strUrl is the href of op tag with name clear as outlined in red color in the above figure. The code segment of POST method is provided below.

If the Limit is a negative number. The sample XML to filter the events under pollRefresh operation is given below.12. The 3rd party obix client should post the above XML to HSDK server during the PollRefresh operation. In addition the obix client can also specify the number of event count. Now the 3rd party obix client can POST a time duration to the HSDK Server to get the history events (pollRefresh). End: is the end date time of the filter duration.2 Event Filtering in pollRefresh operation ‘Event Filtering in pollRefresh operation allows you to filter the events with respect to time duration and event count. <obj >href="obix:AlarmFilter"> <int name="limit" null="true" val="10" /> <abstime name="start" null="true" val="2011-11-04T08:30:00+05:30" /> <abstime name="end" null="true" val="2011-11-04T12:30:00+05:30" /> </obj> Where: Limit: is the number of events that the obix client wants to receive. for which the HSDK server responds with those many latest events. The sample PollRefresh URL is given below: http://localhost/HSDKPNLApplicationModule/watchService/ 0x1AA5FDF54BC9844BA2D3FA094E72C497/pollRefresh/ Honeywell Confidential 6-32 . In response the HSDK server provides with all the events occurred during that time of interval.HSDK Test Client Acknowledging/Clearing Pro-Watch Alarms 6. the obix client provides all the alarms between Start and End dates. Start: is the start date time of the filter duration.

HSDK Test Client
Viewing/Modifying Properties of Pro-Watch Ob-

6.13 Viewing/Modifying Properties of Pro-Watch
Objects
To view the properties of Pro-Watch objects from HSDK test client
1.

Right-click on any object in the oBIX Data Tree, and then select Properties in
the shortcut menu.

2.

This connects to the HSDK Server and returns all the properties of the selected
object. The properties are displayed on the right hand side of the test client
window.

To modify the property of an object
In the HSDK Test Client window, click Modify to modify the property of an object.
The success/fail status of the modification is displayed at the bottom left corner of
the test client window.

Honeywell Confidential

6-33

HSDK Test Client
Viewing/Modifying Properties of Pro-Watch Objects

6.13.1 Code Sample
Sending a PUT Request
In the HSDK Test Client, you can click Modify to modify the value of a specific
property of a Pro-Watch object. The request to modify the value is send to the HSDK
Server using the PUT method. The code segment of PUT method is provided below.

6.13.2 Invoking Pro-Watch Objects
1.

Using the invoke feature, you can create a new Pro-Watch object or delete the
existing objects. In HSDK Test Client window, right-click accessUsers object in
the OBIX Data Tree and click Invoke.

2.

Select any of the operations listed in the Invoke pane.

3.

Add the mandatory properties for the object and then click Invoke to add or
delete the object.

Honeywell Confidential

6-34

HSDK Test Client
Additional features of HSDK Test Client

6.13.3 Code Sample
Sending a POST Request
A POST method must be used for invoking an operation such as adding or deleting
any Pro-Watch object. The code segment of POST method is provided below.

6.14 Additional features of HSDK Test Client
The additional features of the HSDK Test Client include:



Searching for a Pro-Watch Object
Configuring application using Configuration Tab
Sending Raw XML to HSDK Server
Tracing Background Information

6.14.1 Searching for a Pro-Watch Object
To search for a Pro-Watch object
1.

Right-click on a Pro-Watch object and click Search Objects tab to start
searching from that object. The Search dialog box appears.

Honeywell Confidential

6-35

HSDK Test Client
Additional features of HSDK Test Client

2.

Following are various methods to search for an object:
a.

Search all Objects under URL: This option is to search for all the objects
under a specific URL.

b.

Search Name: This option is to search for an object with input provided as
name.

c.

Search Value: This option is to search for an object with input provided as
a value of an object.

3.

Enter the URL/Name/Value of an object to be searched and click Search. When
you click Search, the test client searches the tree recursively to find any
matching objects and lists the available objects.

4.

Right-click on any record to Add to Watch, Invoke, or to view the Properties of
that object.

Honeywell Confidential

6-36

HSDK Test Client
Additional features of HSDK Test Client

6.14.2 Configuring application using Configuration Tab
You can configure several application behaviors by setting values in Configuration
tab of the HSDK Test Client interface.

Honeywell Confidential

6-37

else using HTTP. Create Multiple Alarms — If checked. the older events gets deleted. Honeywell Confidential 6-38 . Protocol — HTTP or HTTPS Server Name — HSDK Server name Port. Max Tree Level — Maximum tree level that can be expanded 'at a time'.HSDK Test Client Additional features of HSDK Test Client Following is the description of various fields and options in the Configuration tab: In HSDK Server Configuration pane: SOAP — If checked.HSDK Server port Virtual Dir Name — Name of HSDK virtual directory in IIS. sends all the requests using SOAP protocol to HSDK server. if exceeds. however tree can be expanded to any level. Add Obj To Alarm Watch — checked. allows creating multiple alarm type of watches through test client. allows adding any Pro-Watch object to an alarm type of watch. In Test Client Configuration pane: Max Alarms Maximum number of events to display in the grid.

In Login Credentials pane: Username — Used for authenticating the request sent to HSDK Server. In the URL field. To use the Send XML feature: 1. type the URL of the HSDK Server. Select the request to be sent to HSDK server. The XML Tab window appears. 4. PUT.HSDK Test Client Additional features of HSDK Test Client Show Properties in Tree — checked. Honeywell Confidential 6-39 . click the Send XML tab. enum properties like Badge company are listed in drop-down list else the enum properties will appear in text box. 6. 2. Enter the XML to be send in the text pane below the URL field. POST or GET .3 Sending Raw XML to HSDK Server The Send XML feature allows the user to send raw XML to HSDK Server. In HSDK Test Client.14. else only objects are listed. properties of objects are listed in the oBIX tree. Show Combo For Enum — If checked. when invalid XML is sent. 3. Password — Used for authenticating the request sent to HSDK Server. for example. This feature is mainly used for testing HSDK Server behavior.

3. 6.15 Search Pro-Watch objects capability at Server This feature allows you to search the required objects at server side using XML. If a 3rd party obix client requires information about any objects. The Trace window appears. which logs all the transactions between HSDK Test Client and HSDK Server. the HSDK Test Client makes several recursive calls to HSDK Server for the oBIX tree. 2.14. it has to POST the specific XML to the specific URL at HSDK Server side. For example if a 3rd party obix client needs user name object. To suspend or resume the tracing. Honeywell Confidential 6-40 . it is required to POST the accessUser XML to accessUsers URL to get the results. Double-click Clear to clear the trace in Trace window.4 Tracing Background Information Trace window displays the background information between HSDK Test Client and the HSDK Server. All these trace request/response are available in the text file if LogLevel is set to 4 in test client config file. double-click on the status bar. These requests can be viewed in the trace window along with the response sent by HSDK Server. Double-click the Trace icon on desktop to open the Trace window. After you enter the URL for the lobby and click Connect. To trace the background information: 1.HSDK Test Client Search Pro-Watch objects capability at Server 6.

Honeywell Confidential 6-41 .org/ns/schema/1.xsl'?> <obj> <str name="FNAME" href="FNAME/" val="Jack" /> <str name="LNAME" href="LNAME/" val="Smith" /> <str name="MI" href="MI/" val="" /> <obj name="customFields" href="customFields/"> <str name="BADGE_EMAIL" val="" /> <str name="BADGE_MOBILE_PHONE" val="" /> <str name="BADGE_TITLE" val="" /> </obj> </obj> URL Below is the sample accessUsers URL to which the 3rd obix client is required to POST the above XML.w3.org/ns/ schema/1.0"> <int name="recordSize" val="1" /> <ref name="Jack_Smith_0x00291587F7A939114C42B2FC8317573DBDE9" href="http://win3ycrafepf79/HSDKPNLApplicationModule/pacs/accessUsers/ 0x00291587F7A939114C42B2FC8317573DBDE9" is="/HSDKPNLApplicationModule/def/accessUser" displayName="Jack_Smith" /> </obj> Similarly a 3rd party Obix client can search for the following list of objects and its supported parameters using the above XML tag.HSDK Test Client Search Pro-Watch objects capability at Server XML Tag Below is the sample accessUsers XML tag which can be sent by the 3rd party obix client to the HSDK server.org/2001/XMLSchema-instance" xsi:schemaLocation="http://obix.xsl'?> <obj xmlns:xsi="http://www. http://win-3ycrafepf79/HSDKPNLApplicationModule/pacs/accessUsers Response Below is the reponse from the HSDK Server for the accessUsers request sent by the 3rd party Obix client. <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule/resources/xsl/obix. <?xml-stylesheet type='text/xsl' href='/HSDKPNLApplicationModule/resources/xsl/obix.0 /hsdk/xsd" href="http://win-3ycrafepf79/HSDKPNLApplicationModule/pacs/accessUsers/" is="/ HSDKPNLApplicationModule/def/accessUsersPage" xmlns="http://obix.

HSDK Test Client
Search Pro-Watch objects capability at Server

Objects

Parameters supported

Access User

All Parameters are supported to search.
Note: If more than one card number is provided in cards list, search considers only first
card number.

Access Credential

Credential_Status
Reason_For_Disable
Authentication_Factors - AccessCredentialID
Authentication_Factors - PIN
Activation_Time
Expiry_Time
Trace_Flag
Company
Last_Use_Time
Uses_Remaining
Threat_Level (should be between 0 and 99)
Extended_Time_Enable (should be 0 or 1)
Passback_Exempt "

Access Right

Name

Access Point

Name

Access Zone

Name

If the value of <int> is 0 or the value of <bool> is false, search returns the records of
NULL value in DB. If the value is NULL in DB the HSDK server returns 0 for numeric and false for
bool.
* If the value is 1975-01-01 or 0001-01-01, search cannot consider the value of <abstime>.
* Unicode characters are supported for search.

Note

Honeywell Confidential

6-42

USING NIAGARA AS THIRD PARTY APPLICATION

The chapter covers the following topics.
Overview

page 7-1

Using Niagara in HSDK

page 7-1

Configuring Niagara
Application Module

page 7-2

Configuring Niagara for
HSDK

page 7-5

Initializing the Station

page 7-8

Connecting to the Station

page 7-11

Generating the oBIX
Points

page 7-13

7.1 Overview
The Niagara Framework is a universal software platform that helps manufacturers
develop Internet-enabled equipment systems and device-to-enterprise applications.
Niagara resolves the challenges associated with open systems, integration and
interoperability by integrating diverse systems and devices-regardless of
manufacturer, or communication protocol - into a unified platform that can be easily
managed and controlled in real-time over the Internet.
Niagara can be used as a third-party application to utilize HSDK functionalities.

7.2 Using Niagara in HSDK
Niagara is used as a Test Server to use the HSDK Client functionalities.

Honeywell Confidential

7-1

7

Using Niagara as Third party application
Configuring Niagara Application Module

7.3 Configuring Niagara Application Module
To create and configure Niagara application module in Pro-Watch
1.

In the Viewers pane of Pro-Watch, click Database Configuration. The ProWatch NT Database Configuration pane is displayed.

2.

In the Pro-Watch NT Database Configuration display pane, right-click the
Application Module and select New Application Module.

Honeywell Confidential

7-2

Using Niagara as Third party application
Configuring Niagara Application Module

The Pro-Watch Application Module Manager dialog box appears.

3.

In Channel, select a channel from the list of channels, for example, oBIX
Channel. The Channel Type and Panel details appears automatically for the
selected channel.

4.

Click Next. The Pro-Watch Application Module Manager dialog box appears.

Honeywell Confidential

7-3

Using Niagara as Third party application
Configuring Niagara Application Module

5.

In the Attributes, type the Name of the application module, for example,
Niagara.

6.

Enter the Description of the application module, for example,
NiagaraApplicationModule.

7.

Enter the HSDK Port which is the web service port number.

8.

Type the Lobby URI which is the URI of the lobby of the Niagara server.

9.

Type the GUI URI which is the URI of the Niagara server.

10. In Authentication Parameters, type the User Name and Password of the
Niagara station.
11. Click Finish.
The Niagara application module appears in the In the Pro-Watch NT Database
Configuration display pane.

Honeywell Confidential

7-4

The Pro-Watch objects are published to third-party (OBIX Client) through the HSDK Server. Open Niagara Workbench. 7. Honeywell Confidential 7-5 .1 Connecting to Niagara Platform To open and connect to Niagara platform 1. To test the HSDK Client. The Vykon Security Workplave AX window appears.4 Configuring Niagara for HSDK HSDK Interface consists of the two components. HSDK Server and HSDK Client. which subscribes to the third-party objects. In NAV tree.Using Niagara as Third party application Configuring Niagara for HSDK 7.4. Go to Niagara's Tools Menu Tools > New Station. right-click My Host icon and select Open Platform. The HSDK Test Client acts as an OBIX Client and is developed to test the HSDK Server Component. The New Station Wizard appears. 2. Niagara is used as an OBIX Server.

The Username and Password authentication details to open the Niagara platform are system username and password (Windows Authentication login details) and not Niagara application credentials. In Open Platform window: 1. Type the Username and Password. 2.Using Niagara as Third party application Configuring Niagara for HSDK The Open Platform window appears. Modify the Port number (if required). The platform options will appear. Honeywell Confidential 7-6 . Click OK to connect to the Platform. Note 3.

Type the name of the station in Station Name (for example. Honeywell Confidential 7-7 . 2. Go to Niagara's Tools Menu Tools > New Station.4.2 Creating a New Station To create a new station 1. HSDKNEW).Using Niagara as Third party application Configuring Niagara for HSDK 7. The New Station Wizard appears. 3. Click Next.

If IIS is installed in the same system. Note 6.5 Initializing the Station To start the newly created station from Niagara Workbench 1. 7. Provide a Fox Port and HTTP Port.Using Niagara as Third party application Initializing the Station 4. Enter the Admin Password (which is the station password) for the new station. 5. Honeywell Confidential 7-8 . Ensure that you provide a unique Fox Port and HTTP Port to avoid confliction with existing stations in the same system. Make sure you provide a port number which is not used by any other process in the system. Click Finish to complete the station creation. Double-click the Station Director in the NAV Tree to open the Station Director window. the user name is admin. Port 80 will be used by IIS Default Website. By default.

Using Niagara as Third party application Initializing the Station The Station Director window appears. Honeywell Confidential 7-9 .

select the newly created station. The status of the station will be displayed as Running. once the station is started successfully. 3. Honeywell Confidential 7-10 .Using Niagara as Third party application Initializing the Station 2. Right-click and click Start to start the new station. In the Station Director window.

Using Niagara as Third party application Connecting to the Station 7.6 Connecting to the Station 1. Right-click the My Host Icon in the NAV Tree and click on the Open Station in the context Menu or double-click the station in the Station Director window. The Open Station dialog box appears. Honeywell Confidential 7-11 .

Type the Password. c. The HSDK connected station appears in the NAV Tree. By default. Type the Username. the Username is Admin. Honeywell Confidential 7-12 . Click OK to connect to the station. b. 3. Modify the Port (if required).Using Niagara as Third party application Connecting to the Station 2. Port is the Fox Port of the station. In the Open Station dialog box: a. which is the password set while creating the station.

7. Click OK. 4. The New dialog box appears. In the Driver Manager window.7 Generating the oBIX Points 7.Using Niagara as Third party application Generating the oBIX Points 7. In the New dialog box: Honeywell Confidential 7-13 .1 Adding the Bacnet Network To add the Bacnet network 1. Double-click the Drivers node to open the Driver Manager. 3. Select Bacnet Network in the Type to Add drop-down list. Once connected to the station. The New dialog box appears. expand the station in the NAV Tree and navigate to Config > Drivers. 6. 2. click the New button to add the BACNET network. 5.

2 Configuring the Bacnet Network To configure the Bacnet network 1. 7. 3. Double-click the Local Device to open the Local Device (Local Bacnet Device) window. Honeywell Confidential 7-14 . a. b. Click OK to add a new Bacnet network. The BacnetNetwork appears under the Drivers option.7. In the Local Device (Local Bacnet Device) window. Select True from the Enabled drop-down list. Provide the network by selecting Bacnet Network from the Type dropdown list or retain the default settings. 10). change the Object Id from 1 to any positive integer (for example. Expand the added BacnetNetwork under Drivers.Using Niagara as Third party application Generating the oBIX Points 7. 2.

6.Using Niagara as Third party application Generating the oBIX Points 4. 5. Honeywell Confidential 7-15 . Expand Bacnet Comm under Drivers and select IP Port under Network option. Right-click the IP Port and select Actions > Enable. Click Save the to save the change in Bacnet Network properties. The Enabled property of the IP Port is set to True.

and objects in the network as required. Now. Honeywell Confidential 7-16 . a Bacnet Device is required in the same subnet as Niagara. Set up the Scada Engine Simulator on a machine in the same subnet as Niagara as per the BACnet Device Simulator User’s Manual. All the devices and all the object types of a device are simulated while the BACnet Device Simulator is running. 7. The BACnet Device Simulator acts as a global simulator which simulates all the devices.7. navigate to SCADA Engine > BACnet Device Simulator > BACnet Device Simulator to start the SCADA BACnet Device Simulator. Click Save the to save the changes. For this purpose. From the Start Menu. The BACnet Device Simulator allows you to create a new network or open an existing network.Using Niagara as Third party application Generating the oBIX Points 7. remove devices. The SCADA Engine BACnet Device Simulator is a client that creates and simulates the BACnet Devices and Objects to test the functionality of the BACnet network.3 Configuring Scada Engine Bacnet Simulator Before discovering the Bacnet device points. the Scada Engine Bacnet Simulator is configured in the network. To configure the Scada Engine Bacnet Simulator: 1. 2. the Bacnet Network is configured to discover any BACnet Device or Points in the network. You can add.

Make the appropriate changes (if required). Note Ensure that the device Status is displayed as {ok}. 2. BACnetDevice1) appears in the Discovered panel. Honeywell Confidential 7-17 . In the NAV Tree. 3. Click Discover at the bottom pane to discover the Bacnet Devices configured using the Bacnet Simulator. navigate to Config > Drivers and double-click the BacnetNetwork option. The Bacnet device (for example.4 Adding Bacnet Objects in Niagara Database To add the Bacnet Devices in the Niagara database 1. Right-click the discovered Bacnet device and click Add.7.Using Niagara as Third party application Generating the oBIX Points 7. The Add dialog box appears.

4. BACNetDEVICE1).Using Niagara as Third party application Generating the oBIX Points The Bacnet Device also gets listed under the Bacnet Network. Honeywell Confidential 7-18 . Expand the added Bacnet device (for example.

Honeywell Confidential 7-19 . 6. Right-click the Points and click Add to add the points to the Niagara Database. Note Select Points under the added bacnet device and click Discover.Using Niagara as Third party application Generating the oBIX Points 5. The Bacnet points will be displayed. Ensure that the point Value is displayed.

7. For details about subscribing third-party objects from Pro-Watch. The Alarm palette appears. Honeywell Confidential 7-20 .Using Niagara as Third party application Generating the oBIX Points Once the above steps are complete. The HSDK Client can subscribe to these third-party or Niagara alarms. Prior to this. 7. Open the palette and select Niagara alarm module. Niagara must be configured to act as an oBIX Server having alarms. you can subscribe the Bacnet Points from the Niagara Application Module created in Pro-Watch.5 Generating the Alarms You can view and subscribe to third-party alarms in Pro-Watch event viewer. To configure Niagara for alarms: 1. refer to Subscribing to Third-Party Objects section.

The Points can be added and discovered in Niagara from the Bacnet Device similarly as described in Adding Bacnet Objects in Niagara Database section. Honeywell Confidential 7-21 . Set the High and Low Level Limits for the Alarm Conditions.Using Niagara as Third party application Generating the oBIX Points 2. From the Palette. drag and drop OutOfRangeAlarmExt under Extensions to any point's property sheet for which you want watch for alarms. Note 3.

Once the Alarms are subscribed from the Niagara Application Module. Honeywell Confidential 7-22 . the Alarms will be displayed under Services-> Alarm Services-> Console Recipient. the same Alarms appear in Pro-Watch Event Viewer as HSDK Generic Alarm. Once the point Value crosses the High or Low limit.Using Niagara as Third party application Generating the oBIX Points 4.

1.4 Badge Field Configuration In Pro-Watch the when you add any configuration then certain fields are mandatory or required and certain fields are Read-Only.8 KNOWN ISSUES 8.3 Subscribe more Points When you import or subscribe more number of points.2 Actual Device Status HSDK sends status as “NO_RESPONSE” when the actual device status is “Normal” 8. then HSDK updates these configurations in Pro-Watch database even if the configuration is READ-ONLY or REQUIRED. 8. the process might be slower. 8. Honeywell Confidential 8-1 .1.1.1 HSDK Known Issues 8. But when you update any configurations in the third party application using HSDK.1. doors. the event “HSDK is connected to Pro-Watch successfully” may come out of order.1 HSDK Connected to Pro-Watch After service recovery when HSDK connected to Pro-Watch.

8 Limitations of HSDK • • • • • In Pro-Watch client UI. The Security settings for HSDK and Pro-Watch web client are different.1. 8. If you are forced to restart the services manually. Otherwise. HSDK does not send door status. 8. lock and reader.1. select that checkbox Automatically Adjust Clock for Daylight Savings. If Pro-Watch and HSDK are installed in different computers. these are send into the pro-watch.5 Holiday Group details The holidays are specified in the Pro-Watch database but these details are not send to the third-party application. follow the below order. ensure that system time of Pro-Watch computer is later than that of the HSDK computer.1. TCP and SSL port numbers for HSDK if Pro-Watch Web Component is installed in the system. If synchronization is not possible. subscribe input points as "I/O Devices" and not as access points. Honeywell Confidential 8-2 . But in case if the older alarms are recalled then the alarms which are already existing in the third party are send again. It should be derived by considering the status of door position switch. Hence the alarms are duplicated. During HSDK installation. enter a different web site name.6 Day Light Saving For timezones using Day Light Savings.7 Existing Alarms and Events Whenever the new alarms are created generated in the channel. ensure that system times are synchronized. – Pro-Watch server – HSDK – SAM (if applicable) • Installation of HSDK needs Administrator password. 8.Known Issues HSDK Known Issues 8.1. The older alarms are not send again. HSDK does not work in that timezone as the license is generated when that option selected.

the username and password should be Administrator username and password.1 Deleting OBIX Channel or Panel Whenever you delete an OBIX Channel or Panel.Known Issues Pro-Watch Known Issues • Even while installing. Consistently happening with all the above scenarios and also it is happening rarely at idle condition.After deleting the event procedures able to start the services and worked fine. When we add more cameras in VMS and synced in Pro-Watch like IP engine cameras When high rate of alarms coming to VMS & Pro-Watch Acknowledging more alarms in the alarm monitor Getting reports from the report viewer.2.3 VMS Issues • • Mic server crashes when we trigger CCTV commands from event procedures. After crash happens it continuously crashing whenever we start the pro-watch services. 8. it gets deleted at that time but when you refresh the page the same channel or panel again appears in the list. 8.2 Hardware Template Issue The templates which do not the belong to particular partition of the Pro-Watch must not appear in that partition.2. Note • Log operation not allowed dialog box comes when we process a report viewer. SQL database disconnection happens in the following scenarios then VMS channel going to offline. In the present application all templates appear in the every partition.2 Pro-Watch Known Issues 8. 8. Honeywell Confidential 8-3 .2.

Known Issues Pro-Watch Known Issues Honeywell Confidential 8-4 .

Known Issues Pro-Watch Known Issues This Page is Intentionally left blank Honeywell Confidential 8-5 .

Known Issues Pro-Watch Known Issues Honeywell Confidential 8-6 .

If ASP. 9. then it should be uninstalled to run HSDK. and other program changed IIS to 64 bit mode. then the other program may stop working.TROUBLESHOOTING TIPS The chapter provides troubleshooting tips and guidelines while developing an application with HSDK. In Windows Server 2008 and Windows 7 64 bit Operating Systems. If HSDK is installed in 32 bit IIS mode.NET 2.1 If the HSDK Client Service Port and License Port is changed in the Client Configuration file • The port configured in the HSDK Channel and the HSDK Client service port (in config file) must be changed.1 During the Installation of HSDK • Note In Windows Server 2003 64 bit Operating System.Net.0 Version) can either be run in 32 bit mode or 64 bit mode.1 is installed. Both cannot work simultaneously. Enable 32 bit ASP.Net. 9. it is not required to enable 32 bit IIS mode.Net. then HSDK stops working. and then install 32 bit ASP. Honeywell Confidential 9-1 9 . Similarly if HSDK is installed in 32 bit mode and some other program is installed in 64 bit mode.Net 1.1.Net. If there are other programs which are running IIS in 64 bit mode and if HSDK is installed in 32 bit mode. Check the IIS mode before installing HSDK and install HSDK in the same IIS mode. • • In Windows Server 2003 64 bit Operating System. HSDK runs only as 32 bit processor in 64 bit machine.APPENDIX . In addition you can also go to internet manager -> Web extensions and click on Allow ASP. Work around is to install all the programs to run in the same IIS mode. then you must uninstall 64 bit ASP. IIS (ASP.

9. The Port Configured in Application Module config file and HSDK Client service port (in config file) must be changed.config file must be changed.9.9.6 page 37 and contact Honeywell support to get the new license IrretrievableNodeId Node Id could not be read from the system Enable Grace Period refer to section 3.Troubleshooting Tips During the Installation of HSDK • • The License port indicated in the HSDK Client config file and the HSDK Server web.1.Appendix . Expired Installed license has been expired Contact Honeywell support to get the new license InvalidNodeId Installed license is not intended for the current HSDK instance Enable Grace Period refer to section 3.6 page 37 and contact Honeywell support InvalidTimeZone The installed license is not licensed for this system timezone Contact Honeywell support Tampered The installed license file has been tampered Contact Honeywell support Error HSDK Service is not started Start the HSDK service IncompatibleLicenseFile The installed license file is intended to the older version of HSDK Contact Honeywell support to get the new license Honeywell Confidential 9-2 .2 License Status License Status Cause Resolution LicenseFileMissing License is not installed Contact Honeywell support to get the new license.

Troubleshooting Tips Problems and Resolutions 9.0.2 Problems and Resolutions 9.8196. Applies To HSDK version 1.73.Appendix . Honeywell Confidential 9-3 .0.2.1 Pro-Watch server is not starting Issue Pro-Watch server is not starting after applying the Pro-Watch 3.7 Patch 3.8. Steps to Resolve Symptom: In Services window the Pro-Watch service does not start as shown below.847.

“String or binary data would be truncated.5 sp1. The statement has been terminated”.2. it fails and the points are not subscribed. 9.Appendix . Steps to Resolve Symptom: In Pro-Watch application module screen the following error is displayed when subscribing to Niagara point.Troubleshooting Tips Problems and Resolutions Resolution: Install pre-requisite.NET framework 3. as shown below: Honeywell Confidential 9-4 .2 Error subscribing to Niagara points Issue When you are Subscribing to Niagara point in Pro-Watch application module. Applies To All versions of HSDK.

In Pro-Watch the maximum number of characters is 42 for Logical device name. Honeywell Confidential 9-5 . you cannot see the generated event in Pro-Watch event viewer. 9.Troubleshooting Tips Problems and Resolutions Resolution: Type the Niagara point name upto 42 characters.3 Niagara events not coming into Pro-Watch Issue The Niagara event feed is subscribed in Pro-Watch application module. When an event is generated in Niagara.2. Avoid hyphen (-) in the name which is translated to "2d$" and exceeds the limit of 42 characters.Appendix .

Symptom 2: The following error is displayed in HSDK Client logs. as shown below: Resolution 2: The problem is Niagara obix client contains Pro-Watch alarms which are coming back to Pro-Watch. • Install the Fix available in obixDriver (version 3. Resolution 1: Attach the Alarm Extension to the point in Niagara.35.Appendix .Troubleshooting Tips Problems and Resolutions Applies To All versions of HSDK.5. Element name ‘str' conflicts with contract element ‘ref‘.3) Symptom 3: The user account under which Pro-Watch server is running is not a valid Pro-Watch operator as shown below in the screen: Honeywell Confidential 9-6 . Steps to Resolve Symptom 1: Verify that the point has alarm extension attached to it and the event is getting generated in Niagara.

When an alarm is generated in Niagara. 9. Applies To All versions of HSDK. it comes as HSDK Generic event in Pro-Watch event viewer but not as configured in “event-mapping” xml.2.Troubleshooting Tips Problems and Resolutions Resolution 3: Add a user as Pro-Watch Operator for Pro-Watch service logon using the Users window.Appendix .4 Niagara alarms coming as HSDK Generic events in ProWatch Issue The Niagara alarm feed is subscribed in Pro-Watch application module. choose Pro-Watch -> Database Configuration -> Users. Steps to Resolve Symptom 1: Niagara station port number is displayed as 80 as shown in the screen: Honeywell Confidential 9-7 . To access the Users window.

Honeywell Confidential 9-8 . Modify the Lobby URL according to Pro-Watch application module screen and then restart the Pro-Watch Server and the PWBridgeService.Appendix . Symptom 2: In Niagara the point on which alarm is being generated is not subscribed in Pro-Watch.Troubleshooting Tips Problems and Resolutions Resolution 1: Change the Niagara station port number other than 80 and then restart the station.

Honeywell Confidential 9-9 .Appendix . subscribe to the alarm generated source point in Pro-Watch. Symptom 3: The URL of subscribed point is different from the URL through which alarm is generated as shown in the below screen: Resolution 3: In Pro-Watch if the point is subscribed from “Exports” folder and in Niagara alarm is generated on source point.Troubleshooting Tips Problems and Resolutions Resolution 2: Discover and Subscribe to the point in Pro-Watch application module screen.

9. Restart Pro-Watch service (micserver). Resolution 1: Restart HSDKPNLApplicationModule service. Steps to Resolve Symptom 1: The above issue can be identified after system restart or Pro-Watch server restart. Or Restart PWBridgeService (if HSDK version is older than 1. Restart HSDKPNLApplicationModule service.0. the HSDKPNLApplicationModule / PWBridgeService should be restarted Note Honeywell Confidential 9-10 .38 (HSDK 1.5)) 9.5)) and ensure “Operator Login” event is generated in Pro-Watch event viewer as shown below. Or Restart PWBridgeService (if HSDK version is older than 1.9. 2.0. Applies To All versions of HSDK. Whenever Pro-Watch server is restarted or the system is restarted.2.Troubleshooting Tips Problems and Resolutions Symptom 4: The above issue is noticed after Lobby URL is changed in Pro-Watch application module screen as shown below: Resolution 4: Perform the following steps: 1.Appendix .5 Unable to invoke actions on Pro-Watch access points Issue The actions on Pro-Watch access points such as Lock/Unlock is not functioning on actual doors however the HSDK response xml displays “Invoke Success”.38 (HSDK 1.

” Resolution 2: HSDK Installation copies the ProWatch Database Server Name to the pacsCommServer name in both hsdk server and client config files as shown below: Honeywell Confidential 9-11 .Appendix .Troubleshooting Tips Problems and Resolutions Symptom 2: The following error is displayed “Invoke Failed: Invalid Uri: The hostname could not be parsed.

C:\Program Files\Honeywell\HSDK\ApplicationModule\HSDK Client\HSDKObixClientService.config b.config 9.Appendix .6 Test Client not starting Issue The HSDK test client does not start and crashes when ever opened.2. Modify the “pacsCommServer” value and provide correct Pro-Watch server name in the following paths: a.exe.Troubleshooting Tips Problems and Resolutions This is an error if sql server has instance name. Honeywell Confidential 9-12 . Applies To All versions of Test Client. C:\Program Files\Honeywell\HSDK\ApplicationModule\HSDK Server\web.

Appendix . the HSDK Test Client crashes and cannot start. Choose Add/Remove programs -> Add/Remove Windows Components to Install MSMQ.Troubleshooting Tips Problems and Resolutions Steps to Resolve Symptom: When you double click the shortcut key on desktop. Resolution: A pre-requisite Microsoft Message Queuing (MSMQ) is not installed on the machine. The Windows Server 2003 Application Server dialog box is displayed below: The Windows Server 2008 Features dialog box is displayed below: Honeywell Confidential 9-13 .

Steps to Resolve Symptoms: HSDK Server displays “License Error” when it is browsed for Pro-Watch objects or if you try to create watch.847.8.Appendix .0.7 Getting frequent “License Error” Issue Application module is displaying frequent “License Error” despite a valid license is installed. Applies To HSDK version 1.2. Resolution: Install "License Error" patch to resolve this issue.Troubleshooting Tips Problems and Resolutions 9. Honeywell Confidential 9-14 .

Troubleshooting Tips Problems and Resolutions 9. the “accessRights” option does not exists as shown below: Honeywell Confidential 9-15 . Applies To All versions of HSDK. Steps to Resolve Symptom: In Pro-Watch application module screen. The discovery fails after “accessCredentials”.Appendix . in Outbound list. The obix point discovery fails when you try to expand the pacs directory from Niagara.8 Not able to discover full pacs oBIX tree in Niagara Issue Not able to discover the HSDK lobby in Niagara.2. click the License tab.

in this case “accessRights” as shown in the below screen: Get a new license from Honeywell support to resolve this issue.Appendix .Troubleshooting Tips Problems and Resolutions Resolution: The installed license does not have permission for the next object in pacs hierarchy. Honeywell Confidential 9-16 .

2.Troubleshooting Tips Problems and Resolutions 9."></err> as shown below.org/ns/schema/1.Appendix .9 Getting error “Invalid object name 'page_size_config” Issue An error is displayed when entering the lobby: <err xsi:schemalocation="http:// obix. Honeywell Confidential 9-17 .0 /hsdk/xsd" display="Invalid object name 'page_size_configr'.

Appendix .Troubleshooting Tips Problems and Resolutions Applies To HSDK version 1. Resolution: Install MSDE 2000 database.0. HSDK supports SQL server 2005 or above.847. Steps to Resolve Symptoms: In HSDK database PAGE_SIZE_CONFIG table does not exists.10 Error after installing the license Issue After installing the HSDK license when you browse License.2.8.aspx webpage an error is displayed. Applies To All versions of HSDK. Honeywell Confidential 9-18 . 9.

8.748 and the license belongs to the version 1.Troubleshooting Tips Problems and Resolutions Steps to Resolve Symptoms: The following error is displayed in License.0. The serialized data is corrupt.2.0 in IIS 7. 9. For example the installed HSDK version is 1.847.0. Install the proper license to resolve.5 Issue After installing HSDK in Windows 7 64bit or Windows Server 2008 R2 64bit.8.Appendix .11 Error 500. Honeywell Confidential 9-19 .” Resolution: Newer version of license is installed for older version of HSDK. the following errors are displayed as shown below.aspx webpage “An error occurred while deserializing the object.

Honeywell Confidential 9-20 . Error 2 When the Lobby URL is pointing to HSDK lobby in Pro-Watch application Module screen.Troubleshooting Tips Problems and Resolutions Error1 : When the HSDK lobby is browsed from Internet Explorer.Appendix .

dll and HSDKUtilities. The IIS window is displayed. Type inetmgr command and then click OK. 2.Troubleshooting Tips Problems and Resolutions Steps to Resolve Perform the following steps to resolve. 4. Navigate to the website node which is displaying the error HSDKPNLNotifierAppModule. double-click the Handler Mapping icon as shown below. The Run window opens 3. Delete HardDriveInfoUtility. In the right-pane. 1.Appendix . Choose Start -> Run. Honeywell Confidential 9-21 . 5.dll from both "HSDK Server\Bin" and "Application Module Web\Bin" folders.

Appendix .Troubleshooting Tips Problems and Resolutions The Handler Mapping page is displayed as shown below: Honeywell Confidential 9-22 .

Honeywell Confidential 9-23 .Appendix . The Add Wildcard Script Map message box is displayed. From the list click Add Wildcard Script Map. Type the required name in the Name box and then click OK. In the Executable box type “C:\Windows\Microsoft.Troubleshooting Tips Problems and Resolutions 6.NET\Framework\v2.50727\aspnet_isapi. 8. The Add Wildcard Script Map dialog box appears. 7.0.dll”.

Appendix . Click No and then restart the IIS. ERROR :-2147467259 as shown below: Honeywell Confidential 9-24 . Issue During HSDK installation the user may get error message or aborts the installation process without displaying any error message which results in unsuccessful installation. Steps to Resolve Symptoms 1: While installing HSDK. 9.12 Not able to install HSDK successfully. it displays an error: Connection with the SQL Server 'localhost" Failed.2.Troubleshooting Tips Problems and Resolutions 9.

If the above steps do not resolve the issue perform the following steps: 1.msc in the command window. For example: (local)\SQLEXPRESS if you have installed SQL with instance name. Honeywell Confidential 9-25 . Otherwise use <Computer Name> or (local) instead of "localhost".Appendix . The services window appears. Click Start > Run and then type the services.Troubleshooting Tips Problems and Resolutions Resolution 1: Provide SQL Server\Instance name.

The SQL Server properties dialog appears. Honeywell Confidential 9-26 . From the list of services. double-click the SQL Server service.Troubleshooting Tips Problems and Resolutions 2.Appendix .

click Honeywell Confidential to restart the service and then re-install HSDK.Troubleshooting Tips Problems and Resolutions 3. Click OK. 4. In Services window. Or Click This account option and then provide the administrator credentials. Under Log on as: • • Click Local System Account option. 6. 9-27 .Appendix . Click the Logon tab. 5.

Get the CertificateCheckUtility tool from your local Honeywell contact. Honeywell Confidential 9-28 .Appendix . double-click CertificateCheckMain.The CertificateCheckUtility folder is displayed. When prompts. 3.exe. 4. It generates a CertificateDetails folder.zip file. Unzip the CertificateCheckUtility. Perform the following steps to confirm: 1. press Enter key. In the CertificateDetails folder. 2.Troubleshooting Tips Problems and Resolutions Symptoms 2: The Installation Wizard interrupts before HSDK is completely installed as shown below: Resolution 2: This symptom is commonly caused due to a SSL certificate with empty Subject name installed on the computer.

cer.log). 2. From the temp window. The Certificate window appears and displays the details of error certificate. In the CertificateDetails folder.Troubleshooting Tips Problems and Resolutions If the CertificateDetails folder contains Certicate.cer and the Errors. The temp window appears. type %temp% and then click OK. perform the following steps: 1. 2. In the Run command window. The Console window appears. Perform the below steps to resolve: Note If the CertificateDetails folder does not contain Certicate. Honeywell Confidential 9-29 .log file to your local Honeywell contact. select the HSDK installation file (HSDK_MSI_Log. 3.txt files.cer and the Errors. double-click on the Certicate. it is confirmed that the symptom mentioned in resolution 2 is valid. Send the HSDK_MSI_Log. Click Start > Run and then type the mmc in the command window.txt files. 1.Appendix .

Appendix .Troubleshooting Tips Problems and Resolutions 3. Honeywell Confidential 9-30 . The Add or Remove Snap-in dialog appears. On the File menu click Add/Remove Snap-in command.

The Next button is enabled in the Certificates Snap-ins dialog. Click My user account option and then click Finish button.Appendix . In the Certificates Snap-ins dialog: a.Troubleshooting Tips Problems and Resolutions 4.The selected snap-in moves under Selected snap-in pane. The Certificates Snap-ins dialog appears. select Certificates and then click Add button. Under Available snap-ins. Click Next and then click Finish to add the snap-ins under Selected snapins pane as shown below. Repeat step 3 and then click the Computer account option. 5. b. Honeywell Confidential 9-31 .

Honeywell Confidential 9-32 .Appendix . In the Add or Remove Snap-ins dialog. click OK. The selected snap-ins are added in the right pane of Console window as shown below.Troubleshooting Tips Problems and Resolutions 6.

Appendix . Select the required Look in Field from the drop-down list and then type the details of the error certificate in Contains text box. right-click the Certificate node and then click Find Certificate. The Find Certificates dialog appears. Click Find Now. Honeywell Confidential 9-33 . The Find Certificates window displays the error certificate in the same window. 9.Troubleshooting Tips Problems and Resolutions 7. 8. In the Console window.

Right-click on the populated certificate and then click Export.Appendix .Troubleshooting Tips Problems and Resolutions 10. Right-click on the populated certificate and then click Delete. The Certificate Export Wizard appears. Click Next in Certificate Export Wizard and follow the instructions to save a copy of the certificate. 12. 11. Honeywell Confidential 9-34 . A confirmation message appears.

Install HSDK. 16. Browse the exported certificate and then right-click to select Install Certificate. Honeywell Confidential 9-35 . 14.Appendix .Troubleshooting Tips Problems and Resolutions 13. Repeat the steps 1 through 4 of the confirmation procedure to ensure there are no more error certificates. 15. Click the Install Certificate button to re-install the certificate. Click OK.cer. the certificate window appears. Or Double-click the Certificate.

Troubleshooting Tips Problems and Resolutions This page is intentionally left blank Honeywell Confidential 9-36 .Appendix .