Siemens MM8000 Quick setup guide

Building Technologies
Fire Safety & Security Product
DMS8000 MP4.40
Generic DVR
Integration Guide

Data and design subject to change without notice. / Supply subject to availability.
© 2011 Copyright by
Siemens Building Technologies AG
We reserve all rights in this document and in the subject thereof. By acceptance of the document the recipient acknowledges these rights
and undertakes not to publish the document nor the subject thereof in full or in part, nor to make them available to any third party without our
prior express written authorization, nor to use it for any purpose other than for which it was delivered to him.

I
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
About this document...............................................................................................2
1Introduction.............................................................................................4
2Integrating a DVR....................................................................................4
2.1 Understanding the Generic DVR ST.........................................................5
2.2 Generic DVR models................................................................................5
2.3 3rd Party DVR Integration Concept ..........................................................6
2.4 XML definition file......................................................................................6
2.4.1 DVR settings (XML node TYPE 1)............................................................7
2.4.1.1Video viewer ..................................................................................7
2.4.1.2Invocation Line Parameters...........................................................8
2.4.2 Folders (XML node TYPE 20, 30, 50, 60)...............................................10
2.4.3 I/O nodes (XML node TYPE 21, 31, 51, 61)...........................................11
2.4.4 Examples of XML file ..............................................................................12
2.4.4.1Windows application viewer.........................................................12
2.4.4.2Web-based viewer type 1 ............................................................14
2.4.4.3Web-based viewer type 2 ............................................................15
33rd Party Application Requirements....................................................16
3.1 Technical Requirements for Windows Application Viewer .....................16
3.2 Reference tables.....................................................................................17
3.2.1 Timeouts .................................................................................................17
3.2.2 Event Logs..............................................................................................17
3.2.3 Windows control messages....................................................................18
4Creating an MM8000 Add-on distribution package...........................19
4.1 Generic DVR add-on creation.................................................................19

Introduction
2
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
About this document
Purpose of this document
This manual is a guide to the development procedures for the integration of 3rd par-
ty video recorders in MM8000 systems.
This guide is en extension to the general DMS8000 documentation set that in-
cludes the Composer Technical Manual, the DMS8000 Connectivity Guides (main-
ly the Video and OPC guides, but also Network/Fire/Intrusion and Access), and the
MM8000 Installation, Configuration, and Commissioning manual (ICC).
Target audience
This documentation is intended for the following users:
- Project Managers
- External System Engineers and Developers
Individuals performing the operations described in this manual are expected to be
familiar with the video units to integrate and with the XML markup language.
Documentation resource information
The DMS8000 Documentation Resource Information and Glossary Guide assem-
bles important information regarding documentation resources. This document
contains the following:
– Comprehensive definitions of the target audiences for Siemens FS DMS
documents
– Training program information including the Siemens intranet link
– A complete list of all available DMS8000 documents
– Instructions for how to obtain a document via the Siemens intranet using the
Siemens Asset Portal
– A map of relevant documents for each target audience group
– Customer Support links & resources
– A glossary containing definitions of all terms and acronyms used in
DMS8000 documentation
To access the DMS8000 Documentation Resource Information and Glossary
Guide (document no. A6V10089056), go to the link and follow the document
search instructions below:
http://assetportal.bt.siemens.com/portal/index.html
1. In the Search column on the left, set:
– Segment: 04 Fire -3F
– Document Type: All
– Image Type: All
– Advanced search criterias: Select Brochure No. and enter the document
number to search for (e.g. A6V10062415). Alternatively, select Title and enter
the product name (e.g. MM8000).
2. Click Search to start.
3. In the resulting area on the right, select the document type (e.g. Contacts, Data
Sheet, etc).

Introduction
3
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
For more information such as Siemens news and announcements, visit the STEP
Web portal at:
https://workspace.sbt.siemens.com/content/00001123/default.aspx
Liability disclaimer for damage or injuries
Before products are delivered, they are tested to ensure they function correctly
when used properly. Siemens disclaims all liability for damage or injuries caused
by the incorrect application of the instructions, or the disregard of danger adviso-
ries. This disclaimer applies in particular to personal injuries or damage caused by:
– Improper and/or incorrect use.
– Disregard of safety instructions in the documentation or on the product.
– Poor maintenance or a lack of maintenance.
We have checked the contents of this manual for agreement with the hardware and
software described. Since deviations cannot be precluded entirely, we cannot
guarantee full agreement. However, the data in this manual are reviewed regularly
and any necessary corrections included in subsequent editions. Suggestions for
improvement are welcome.
Modification index
Version Date Notes
A6V10331273_a_en 06.2011 Corresponds with DMS8000 MP4.40

Introduction
4
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
1 Introduction
This is a technical guide to the integration of a DVR unit in MM8000. It provides the
technical information that enables you to instruct MM8000 to handle a 3rd party
video device for both video image display and status reporting.
2 Integrating a DVR
This chapter describes the MM8000 features that allows for integrating a 3rd party
Digital Video Recorder (DVR).
Integrating a Digital Video Recorder in MM8000
The MM8000 systems MM8000 can support the connection to 3rd party DVRs in
two different ways:
Light video integration: uncontrolled video viewer
This type of integration allows for starting a video viewer (a Windows application
or a local HTML page) and then manually selecting the video sources that can-
not be selected automatically depending on the MM8000 conditions. No status
diagnostic can be provided.
This solution does not require any special development and is fully de-
scribed in the DMS8000 Connectivity Guides Video (doc.no. A6V10062457).
Please refer to the Light-integration device section.
Generic DVR integration: controlled video viewer and OPC DA connection
This second type of integration, requiring the technical development described
in this guide, permits to configure a customized DVR, including video and alarm
I/O, and start the associated video viewer (a Windows application or a web
page) with appropriate parameters when invoked. Depending on the viewer
characteristics, the parameters can be used e.g. to select a video source or ac-
tivate other options. The list of parameters includes MM8000 conditions as well
as user-defined options that can be configured on site, thus supporting a large
number of integration scenarios.
This solution requires the development of an XML file that contains the cus-
tomized model of the DVR (video and alarm inputs /outputs) and the viewer
invocation parameters. Once the file is prepared and installed, the DVR units
can be easily configured as described in the DMS8000 Connectivity Guides
Video (doc.no. A6V10062457).
The DVR can also provide status reporting and receive control commands over
an OPC DA connection. MM8000 can act as OPC DA client to acquire diagnos-
tic information and transmit control commands.
The OPC connectivity is described in the DMS8000 Connectivity Guides
OPC (doc.no. A6V10065253).
Generic DVR add-on distribution
This guide also discusses how to prepare a distribution package (MM8000 Add-on)
of the files required for the Generic DVR integration. Refer to section 4 on p.19.

Integrating a DVR
5
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
2.1 Understanding the Generic DVR ST
Composer environment
Composer is the common configuration tool environment that implements the DMS
Engineering.
When an MM8000 station is installed at a site, it needs to be configured for the
specific facility. The Composer software is developed for this purpose. It is a Win-
dows application that provides the general services and a multi-area user interface
as follows:
The user interface and common functionality to configure a system
The configuration environment that hosts Subsystem Tool plug-ins
Subsystem Tools
The specific functions of configuring the system components are implemented by
software modules called Subsystem Tools (STs). Composer provides for an exten-
sion interface for adding and integrating plug-in modules.
The subsystem tools can be plugged into Composer to form an environment de-
voted to the configuration of the control units of a system. Depending on the num-
ber and kind of subsystem tools, this environment allows configuration of a single
control unit up to a large security system including several control units of different
disciplines.
The end user perceives a single application for the configuration activities; however
the system is made up of different pieces of software: the Composer infrastructure
and the subsystem tools, as illustrated by the following picture.
Generic DVR ST
Unlike standard STs that are specialized for supporting a single control unit type,
the Generic DVR ST is a special subsystem tool (or meta-tool) that allows for sup-
porting multiple, customized DVR unit models. The configured models can then be
used for an easier configuration of DVR unit instances that fit one of the defined
models.
The Generic DVR ST is therefore an open tool that supports multiple application
models. This enables the engineer working with Composer to create DVR units (in-
stances of a model) with the required set of parameters.
2.2 Generic DVR models
As discussed above, the Generic DVR ST can handle multiple DVR models. The
corresponding files must exist in the folder:
<installation folder>\Composer\Configuration Data\Generic DVR Configu-
ration Data\...

Integrating a DVR
6
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
with < installation folder> being for example C:\Program Files\DMS8000 (in English
editions of Windows).
DVR modelling types
Three types of DVR can be modelled depending on the type of video viewer.
Namely:
Windows application viewer: the video viewer is an installable Windows applica-
tion.
Web-based viewer type 1: the DVR provides a web server with a single URL
and camera selection parameters.
Web-based viewer type 2: the DVR provides a web server with multiple ad-
dresses corresponding with camera pages.
Contact customer support for application examples:
DVR parameter files
Each valid DVR model comprises two files with the same name:
The XML file described below (.XML)
A standard icon file (.ICO, including sizes 16x16, 32x32 and 48x48 pixels)
All valid GENERIC DVR files that exist in the folder will be available as GENERIC
DVR model in the Composer configuration environment (refer to the DMS8000
Connectivity Guides Video, doc.no. A6V10062457).
Tip: in defining a new model, start from en existing profile and modify it as necessary.
2.3 3rd Party DVR Integration Concept
The generic DVR integration is based on the following approach:
The controlled activation (with parameters) of the 3rd party video viewer in the
MM8000 environment. The viewer can be:
– A Windows application (EXE file) providing the display functions. The techni-
cal requirements that this application must match are detailed in chapter 3 at
p.16.
– A web page (or pages) providing the display functions.
The viewer characteristics must be defined in the XML definition file (see 2.4
below).
The OPC DA data exchange of diagnostic reporting and control commands.
The 3r party DVR operates as OPC DA server. Data points representing the di-
agnostic information must be defined in the XML definition file (see 2.4 below).
The OPC connectivity to data points must be defined using the standard
MM8000 OPC client configuration.
2.4 XML definition file
The XML file defining the DVR model contains the following information:

Integrating a DVR
7
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
The control information about the viewer and the related invocation parameters,
which are necessary to select the appropriate video source depending on the
condition in the management station. Three types of scenarios are foreseen:
– The viewer is a Windows application that can handle in-line command pa-
rameters, e.g.:
C:\ProgramFiles\VGMaker\VGViewer.exe -s1 -c12
– The DVR provides a web server to access video images that is invoked us-
ing a general URL with sub-paths that can select a specific video source,
e.g.:
http://www.intranet1/vgmaker/vg.aspx#?page=viewer&camera=112
– The DVR provides a web server to access video images that is invoked us-
ing a specific URL for each video source, e.g.:
rtsp://www.intranet1/vgmaker/vg/cam112dome/video.gci
The maximum number (0-256) of Alarm Inputs, Alarm Outputs, Video Inputs,
and Video Outputs. Zero means that no inputs of that type are foreseen.
The DVR datapoint structure to be inserted in Composer, including folders for
the configurable inputs and outputs.
The XML file can include the following node structures (XML node classes):
DVR (mandatory, including viewer and limits) … Node TYPE 1
VideoIn Folder …..…..…..…..…..…..…..…..……. Node TYPE 20
VideoIn (predefined video inputs) …..…..…..…… Node TYPE 21
VideoOut Folder …..…..…..…..…..…..…..…..….. Node TYPE 30
VideoOut (predefined video outputs) …..…..….... Node TYPE 31
AlarmInput Folder …..…..…..…..…..…..…..…..… Node TYPE 50
AlarmInput (predefined alarm inputs) …..…..…….Node TYPE 51
AlarmOutput Folder ..............................................Node TYPE 60
AlarmOutput (predefined alarm outputs) ..…..….. Node TYPE 61
2.4.1 DVR settings (XML node TYPE 1)
Model name
The XML file must define the name of the DVR used in Composer to select the cor-
responding model. The XML structure is the following:
<!— DRV description ->
<property ID="CustomerText">
<item VAL="DVR model XYZ" />
</property>
<property ID="TechText">
<item VAL="DVR model for MM8000 developed on … by …" />
</property>
According to the Composer requirements, both a Customer Text and a Technical
Text must be specified.
2.4.1.1 Video viewer
Windows application or web page
The XML file must define whether the viewer is a Windows application or a web
page. Optionally, a version can also be indicated.

Integrating a DVR
8
Building Technologies 048_DMS_DMS8000_Generic_DVR_Integration_Guide_MP4.40_A6V10331273_a_en.doc
Fire Safety & Security Products 06.2011
The corresponding XML structure is the following (Windows Application V1.0 in the
example):
<property ID="ParametersList">
<!-- Mandatory field: 1 = Application - 2 = Web -->
<Type Value="1"></Type>
<Version Value="1.0"></Version>
Application name
In case of Windows application, the command must include the application path-
name, e.g.:
C:\Program Files\VGMaker\VGViewer.exe
The corresponding XML structure is the following (editable in Composer with a help
note thanks to the RW Screen Attribute and to the Note attribute):
<!-- Mandatory fields for Application Integration -->
<Application ScreenAttribute="RW"DefaultValue="C:\Program
Files\VGMaker\VGViewer.exe"Note="Please enter the
application pathname"> </Application>
Web page
In case of web server, note the WebAddressType: 1 means that a single web ad-
dress is available, whereas 2 means that each video input requires a different web
address (see section 2.4.3 at p.4). The XML structure for type 1 is the following
(visible in Composer with a help note thanks to the R Screen Attribute and to the
Note attribute):
<!-- Mandatory fields for Web Integration -->
<WebAddressType Type="1" Note="1 - Main address with parame-
ter 2 - Custom Address for each Video Input" />
<WebAddress ScreenAttribute="R" Val-
ue="http://www.intranet1/vdmaker/vd.aspx#?page=viewer&camera=
%%VIDEOIN_NO%%)%% Note="Web Address depending on selected
video input." />
ScreenAttribute and Note XML attributes
In the example above, note the ScreenAttribute option that can be:
“H” = Hidden, not visible in the Composer page.
“R” = Read, visible in the Composer page.
“W” = Write, editable in the Composer page.
The Note attribute is used to provide a description of the field. In case the
ScreenAttribute option “R” or “RW” is selected, the Note field is also available in
the Composer configuration page.
2.4.1.2 Invocation Line Parameters
The invocation line can include parameters that appear in the command line or in
the URL. The parameter list must be defined according to the viewer requirements.
Parameters can be defined as fixed or variable text. For instance, a parameter
such as -Cnn that indicates the camera number (for example “–C12”) can include
the fixed prefix -C and a variable part that defines the actual video input number
(see VIDEOIN_NO below) according to the selection in the runtime software.