7.0

OPC Server User Guide

Lenel OnGuard® 7.0 OPC Server User GuideThis guide is item number DOC-910, revision 4.008, June 2014Copyright © 1995-2014 Lenel Systems International, Inc. Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Lenel Systems International, Inc.Non-English versions of Lenel documents are offered as a service to our global audiences. We have attempted to provide an accurate translation of the text, but the official text is the English text, and any differences in the translation are not binding and have no legal effect.The software described in this document is furnished under a license agreement and may only be used in accordance with the terms of that agreement. Lenel and OnGuard are registered trademarks of Lenel Systems International, Inc. Microsoft, Windows, and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Integral and FlashPoint are trademarks of Integral Technologies, Inc. Crystal Reports for Windows is a trademark of Crystal Computer Services, Inc. Oracle is a registered trademark of Oracle Corporation. Other product names mentioned in this User Guide may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. Portions of this product were created using LEADTOOLS © 1991-2014 LEAD Technologies, Inc. ALL RIGHTS RESERVED.OnGuard includes ImageStream® Graphic Filters. Copyright © 1991-2014 Inso Corporation. All rights reserved. ImageStream Graphic Filters and ImageStream are registered trademarks of Inso Corporation.

Table of Contents

CHAPTER 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5Data Access Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5OPC Alarms and Events Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5Definitions, Acronyms, Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

CHAPTER 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7Communication Set up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

OPC Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8Setting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8Single Sign-On Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

How to Configure Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

CHAPTER 3 Using the OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11OPC Alarms and Events Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Subscriptions to Event Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Event Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Events filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

OPC Data Access Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14Device Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Device Status and Device Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

OPC Server User Guide 3

Table of Contents

4 OPC Server User Guide

CHAPTER 1 Introduction

The OPC Server is an application (LnlOPCServer.EXE) that supports the open architecture concept by integrating OnGuard with existing third party OPC Clients. The purpose of the server is to allow OPC Clients to subscribe for OnGuard data in the format defined by the OPC industry standards.

For the purposes of this manual, a server is a program that awaits and fulfills requests from client programs on the same computer or from a different computer.

The OnGuard OPC Server consists of two servers:

• OPC Data Access server• OPC Alarms and Events server

Note: Historical data access is not supported.

Data Access ServerThe OPC Data Access server maintains information about the system and enables OPC Clients to access (read/write) and communicate to data sources in real time. The OnGuard OPC Data Access Server also supports optional browsing capabilities for OPC Clients to monitor hardware devices such as OnGuard access panels, readers, alarm panels, alarm inputs and alarm outputs.

OPC Alarms and Events ServerThe OPC Alarms and Events server provides event and alarm information at the OPC Client’s request. It also provides services that allow OPC Clients to determine the event types and event sources supported by the OPC Server. For more information, refer to Alarms and Events on page 11.

Because OnGuard already handles all events and alarms available in the system, the OPC Alarms and Events server acts as a bridge between OnGuard and OPC Clients. This functionality is accomplished by using DataConduIT services.

OPC Server User Guide 5

Introduction

6

Definitions, Acronyms, Abbreviations

APIApplication Program Interface. API is the specific method prescribed by a computer operating system or by an application program which a programmer writing an application program can make requests of.

ATLActive Template Library is the main library used to implement the COM server functionality.

BSTRBasic string or binary string. BSTR is a pointer to a wide character string used by Automation data manipulation functions. BSTRs are wide, double-byte (Unicode) strings on 32-bit Windows platforms.

COMComponent Object Model. A software architecture developed by Microsoft that allows the components made by different software vendors to be combined into and used by a variety of applications. COM can be seen as a software bus ensuring plug and play capabilities between software modules.

DCOMDistributed Component Object Model. DCOM is a set of Microsoft concepts and program interfaces in which client program objects can request services from server program objects on other computers in a network.

LDAPis an acronym for Lightweight Directory Access Protocol.

OLE AutomationAn industry standard used by applications to expose objects to development tools and other applications. Allows you to control objects from OLE servers using Visual Basic controls and code.

OLEObject Linking and Embedding. Microsoft’s framework for a compound document technology. A compound document is like a display desktop that can contain visual and information objects (text, sound, motion, etc.). Each desktop object is an independent program entity that can interact with a user and also communicate with other objects on the desktop.

OPCOLE for Process Control. OPC is a communication standard based on the OLE/COM technology. This technology is the information exchange medium recommended by Microsoft for use between Microsoft Windows applications.

Out-of-process serverCOM object(s) that run in their own process and address space.

Note: For more information about OPC refer to the OPC Foundation http://www.opcfoundation.org/.

OPC Server User Guide

CHAPTER 2 Getting Started

The OnGuard OPC Server provides an interface that enables the OPC Client to:

• Connect to the OPC Alarms and Events and OPC Data Access objects of the OPC Server.• Browse and manage OPC groups.• Determine the types of events the OPC Server supports.• Subscribe for a specified subset of events via filters.• Subscribe for OPC Server status notifications (e.g. server shutting down).

Communication Set upThe OnGuard OPC Server can be used locally (from a client application located on the same machine) or remotely by means of DCOM (from a client application located on another machine connected by the network). Refer to the following guidelines for connecting/disconnecting OPC Clients.

OPC Clients• OPC Clients connect to the server using standard COM object installation routines.• Clients set up two-way communication using connection point interfaces. This communication

can be turned off by clients at any time.• Clients disconnect from the server by releasing all the server COM objects, which manage their

own lifetime through reference counting as required by COM specification.

Note: Performance when communicating with external systems is highly dependent on network conditions, external system performance and the usefulness of external server APIs.

OPC ServerThe Communication Server, Linkage Server and DataConduIT must be running.

OPC Server User Guide 7

Getting Started

8

Starting OnGuard ServicesRefer to the following procedures to start the OnGuard services.

1. Open the Windows Control Panel and select Administrative Tools > Services.2. Right-click LS DataConduIT Service and select Start.3. Right-click LS Communication Server and select Start.4. Right-click LS Linkage Server and select Start.

In System Administration > Administration > System Options, “Linkage server host” must be configured before LS Linkage Server can be started.

LicensingIn addition to the OnGuard DataConduIT license, both the OPC Alarms and Events server and OPC Data Access server require separate licenses.

Note: In order to configure OPC connections in System Administration (System Administration > Additional Hardware > OPC Connections), make sure that “OPC Client Support (SWG-1465)” is set to True in the Access Control Options in License Administration.

Setting PermissionsSeparate permissions are not required to run the OPC Server. Both OPC Alarms and Events and OPC Data Access servers can authenticate a current/logged on user and perform all operations using their credentials. However, you need permission to run DataConduIT as a service.

Note: If the user does not have access to a particular segment, s/he will not be notified about the events from this segment.

OPC Server User Guide

Single Sign-On Overview

Single Sign-On OverviewSingle sign-on is required for users to connect to the OPC Server.

How to Configure Single Sign-OnBy default, all user accounts log into OnGuard without using single sign-on. Therefore, single sign-on must be configured for each OPC user. When single sign-on is used, a user can automatically log into OnGuard using a Windows domain account or LDAP user name and password for authentication.

To configure single sign-on:

1. Add the directory that you wish to use. For more information please refer to “Add a Directory” in the Directories folder chapter of the System Administration or ID CredentialCenter User Guide.

2. Link the user account that you want to use automatic single sign-on to a directory account. For more information please refer to “Link a User Account to a Directory Account” in the Users folder chapter of the System Administration or ID CredentialCenter User Guide.

Note: If you are using single sign-on, ensure that the directory account is properly linked to the user account.

OPC Server User Guide 9

Getting Started

10

OPC Server User Guide

CHAPTER 3 Using the OPC Server

Starting the OPC Server does not require any manual intervention at the workstation where the server is located (other than making sure DataConduIT, the Communication Server and the Linkage Server are running). The underlying COM technology automates the start upon the initial request from a client application.

After launching, the presence of the server is shown only in the Windows Task Manager. The OPC Server does not have a graphical interface.

OPC Alarms and Events ServerThe OPC Alarms and Events Server object is the primary entry point for an OPC Alarms and Events client. It provides functions for browsing the server’s event space and manages settings common to all the COM objects accessed by a client: the current status of the server, the error messages and the locale settings (e.g. language to be used).

Subscriptions to Event NotificationsIn order to receive and view event notifications, OPC Clients must subscribe to them. A subscription is entered with the OPC Server by requesting it to create a subscription object. An OPC Client may have one or more subscriptions active with a single OPC Server.

Alarms and EventsThe OPC Alarms and Events Server supports all OnGuard events and alarms. In order to provide this functionality, the server uses two-way communication with DataConduIT.

Each event of an OPC Alarms and Events Server belongs to one of two possible events types:

• Simple events - This event type includes all OnGuard events.• Condition-related events (Alarms) - This event type includes OnGuard alarms where the

“Active alarm” attribute check box is selected in System Administration > Monitoring > Alarms.

OPC Server User Guide 11

Using the OPC Server

12

The table that follows shows the set of standard OPC event and alarm attributes and how these attributes are mapped to OnGuard event and alarm data. An attribute describes a single value, which can be supplied along with the event. It contains data describing the event.

Event CategoriesOPC event categories are used for grouping events supported by an OPC Server. All the events within a category must be of the same type (simple or condition related) and have the same attributes. The

OPC event attribute Description OnGuard event attribute

Source The object which generated the event notification.

Combination of panel name and device name

Time The time the event occurred. Event time

Type The type of the event (OPC specific types). For example: condition-related, tracking-related, or simple.

“Simple” for all OnGuard events“Condition” for all OnGuard alarms where the “active alarm” attribute is TRUE

Event Category The category to which this event belongs. Event typeFor more information, refer to Event Categories on page 12.

Severity The urgency of the event. Alarm priority

Message Text which describes the event. Event description

Condition Name The name of the condition/alarm. Alarm description

Acknowledging required

Indicates whether acknowledging is required.

Alarm attribute “Must Restore”

Quality The current quality of the data. Not applicable

Vendor-Specific In addition to the standard attributes described above, System Administrators may choose to provide additional attributes with event notifications.

Not applicable

OPC Server User Guide

OPC Alarms and Events Server

OnGuard event types supported as an event category by the OPC Alarms and Events Server include:

Category Attribute ID Attribute Name Attribute Type

Access Granted (0)Access Denied (1)

101 Panel ID VT_I4

102 Device ID VT_I4

103 Secondary Device ID VT_I4

104 Segment ID VT_I4

105 Event Text VT_BSTR

106 Badge ID VT_BSTR

107 Facility Code VT_I4

108 Area Entered ID VT_I4

109 Area Exited ID VT_I4

110 Asset ID VT_I4

111 Elevator Floor VT_I4

Intercom (10) 101 Panel ID VT_14

102 Device ID VT_14

104 Segment ID VT_14

105 Event Text VT_BSTR

1001 Intercom Data VT_14

Video (11) 101 Panel ID VT_14

102 Device ID VT_14

104 Segment ID VT_14

105 Event Text VT_BSTR

1101 Start Time VT_DATE

1102 End Time VT_DATE

Transmitter (12) 101 Panel ID VT_14

102 Device ID VT_14

104 Segment ID VT_14

105 Event Text VT_BSTR

1201 Transmitter ID VT_DATE

1202 Transmitter Input ID VT_DATE

OPC Server User Guide 13

Using the OPC Server

14

AreasAlarms and events available in the server are organized within one or more process areas. In order to support “monitor zone” functionality, the OPC Alarms and Events Server maps OnGuard monitoring zones to OPC areas. OPC Clients can see what monitoring zones are available in the system and browse the devices (controllers only) within each monitoring zone.

Events filteringEvents may be filtered using the following criteria:

• OPC Event Type (Simple, Condition)• Event Category (Access Granted, Access Denied, System, etc.)• Area (Monitoring Zone)• Event source (Panel from which the event originated)

OPC Data Access ServerThe OPC Data Access Server object is the primary entry point for an OPC Client and performs the following functions:

• Manages settings common to all the COM objects accessed by a client. These settings include: the current status of the server, the error messages and the locale settings (e.g. language to be used).

• Offers functions for browsing the server’s namespace.• Implements the group management functions. Using these functions, a client can create and

delete groups as well as create public groups that can be used by other clients.

Duress (2)AreaAPB (3)System (4)Asset (5)Fire (7)Trouble (19)Burglary (21)Temperature (22)Gas (23)Relay/Sounder (24)Medical (25)Water (26)C900 (27)Open/Close (28)Muster (29)Generic (30)

101 Panel ID VT_14

102 Device ID VT_14

103 Secondary Device ID VT_14

104 Segment ID VT_14

105 Event Text VT_BSTR

Category Attribute ID Attribute Name Attribute Type

OPC Server User Guide

OPC Data Access Server

Device MonitoringThe OPC Data Access Server enables OPC Clients to browse the available OnGuard hardware devices which are organized in a hierarchical address space (e.g. system tree).

The following OnGuard hardware devices can be monitored by the OPC Data Access Server:

• Access Panels• Readers• Alarm Panels• Alarm Inputs• Alarm Outputs• Fire Panels• Fire Inputs/Outputs

IMPORTANT: When the OPC connection displays in Alarm Monitoring as online, it means the OPC Client is online with the OPC Server. This does NOT mean the OPC Client is necessarily online with the actual hardware panel.

Device Status and Device PropertiesOPC Clients can monitor the current status of the devices (items). The rate this status is updated is based on the rate provided by OPC Clients. The update rate is the most important criterion for grouping the items.

Each device (item) contains the following properties:

ID Data Type Description

1 VT_I2 “Item Canonical Data Type”BSTR is used in order to present the device status as “Online/Offline”.

2 <Varies> “Item Value” (VARIANT)

Note: The type of value returned is as indicated by the “Item Canonical Data Type” above and depends on the item.

3 VT_I2 “Item Quality”

4 VT_DATE “Item Timestamp”

OPC Server User Guide 15

Using the OPC Server

16

OPC Server User Guide

Index

AAcronyms and abbreviations ........................... 6Areas ................................................................. 14

CCommunication set up ..................................... 7

DData Access server ............................................ 5Definitions .......................................................... 6Device monitoring .......................................... 15Device status and device properties ............. 15

EEvent categories .............................................. 12Events and alarms ........................................... 11Events filtering ................................................ 14

GGetting started ................................................... 7

IIntroduction ........................................................ 5

LLicensing ............................................................ 8

OOPC Alarms and Events Server .............. 5, 11OPC Clients ....................................................... 7OPC Data Access server ................................ 14OPC Server ........................................................ 7

SSetting permissions ........................................... 8Single sign-on

how to configure ...................................... 9overview ................................................... 9

Starting OnGuard services .............................. 8Subscriptions to event notifications ............. 11

OPC Server User Guide 17

Lenel Systems International, Inc.1212 Pittsford-Victor RoadPittsford, New York 14534 USATel 866.788.5095 Fax 585.248.9185www.lenel.comdocfeedback@lenel.com