Map Editor Release Notes 1.0.29.0 December, 2010 Innovative Solutions
COPYRIGHT NOTICE 2010 Genetec Inc. All rights reserved. Genetec Inc. distributes this document with software that includes an end user license agreement and is furnished under license and may be used only in accordance with the terms of the license agreement. The contents of this document are protected under copyright law. The contents of this guide are furnished for informational use only and are subject to change without notice. Genetec Inc. assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide. This publication may not be copied, modified, or reproduced in any form or for any purpose, nor can any derivative works be created therefrom without Genetec Inc. s prior written consent. Genetec Inc. reserves the right to revise and improve its products as it sees fit. This document describes the state of a product at the time of document s last revision, and may not reflect the product at all times in the future. In no event shall Genetec Inc. be liable to any person or entity with respect to any loss or damage that is incidental to or consequential upon the instructions found in this document or the computer software and hardware products described herein. The use of this document is subject to the disclaimer of liability found in the end user license agreement. "Genetec", "Omnicast", "Synergis", "AutoVu", "Federation", the Genetec stylized "G" and the Omnicast, Synergis and AutoVu logos are trademarks of Genetec Inc., either registered or pending registration in several jurisdictions. "Security Center" and the Security Center logo are trademarks of Genetec Inc. Other trade names used in this document may be trademarks or registered trademarks of the manufacturers or vendors of the respective products. All specifications are subject to change without notice. PRIVACY RIGHTS NOTICE Video recording, access control and automated licence plate reading solutions are tools that provide the ability to record the images, whereabouts and activities of individuals. As such, these tools are powerful security and law enforcement aids and are meant to be used in a manner that does not infringe the privacy rights of individuals or organizations. Users are cautioned to make sure they are aware of the particular privacy laws of their respective countries and to use Genetec products accordingly. Document Title: Omnicast Map Editor Release Notes Documentation Number: EN.102.001-V1.0.29.0 Date: December, 2010 2
Table of Contents 1 Introduction 5 2 Contacting Customer Support 5 3 About the Map Editor 6 4 System Requirements 6 5 Feature Highlights 7 6 Installing the Map Editor 7 6.1 Prerequisites 7 6.2 Installation 8 7 Using the Map Editor 8 7.1 Basic Concepts 8 7.1.1 Projects and Maps 8 7.1.2 Operating mode 9 7.2 Adding Buttons to the Map 10 7.3 Entity Buttons 11 7.3.1 Camera 11 7.3.2 Camera sequence 12 7.3.3 Output relay 12 7.3.4 Digital input 12 7.3.5 Alarm 12 7.3.6 Macro 13 7.3.7 Analog monitor 13 7.4 Buttons 13 7.4.1 Bookmark 13 7.4.2 Link 14 7.4.3 PTZ manual operation 14 7.4.4 PTZ operation 15 7.4.5 PTZ stop operation 15 7.4.6 Recording states 15 7.5 Saving the Project 16 7.6 Generating the Maps 16 3
8 Fixed Issues 17 9 Limitations 17 9.1 Troubleshooting 17 9.2 Known Issues 17 4
1 Introduction These release notes highlight features that have been added or changed in Genetec Omnicast Map Editor Version 1.0.29.0. For more details about HTML maps you can also refer to the Maps section in the Omnicast Administrator Guide. 2 Contacting Customer Support For more information or support, you can contact the Genetec s Technical Assistance Center (GTAC) in the following ways: Genetec s Technical Assistance Portal (GTAP): For in-depth product technical information and assistance, customers can log in to the at gtap.genetec.com. Email: support@genetec.com Telephone: 1-514-856-7100. Toll Free (USA & Canada): 1-866-338-2988 Europe: +800 01818200 (Please visit gtap.genetec.com for a list of covered territories.) Fax: 1-514-332-1692 from Monday to Friday, 8:00 AM to 8:00 PM (Eastern time, GMT -5h) No matter how you contact us, it s a good idea to have all relevant product information available, including System ID and product version information. 5
3 About the Map Editor The Map Editor is a tool designed to help Omnicast users create interactive HTML maps that can be used with Omnicast Live Viewer. Using this tool, users without any HTML knowledge can easily create highly interactive maps using a simple point and click interface. 4 System Requirements Intel Pentium D 2.8 GHz, 2 MB Cache, 800 MHz FSB Microsoft Windows XP Pro SP2 32-bit/64-bit Microsoft Windows Vista SP1 Business or Ultimate 32-bit/64-bit Microsoft Windows 7 32-bit/64-bit 1.0 GB of RAM 80 GB of storage or more 256 MB ATI Radeon X600 dual-head, or equivalent 1024 x 768 or higher screen resolution 10/100 Ethernet Network Interface Card 16x DVD+/-RW drive Sound card 6
5 Feature Highlights The Map Editor performs the following functions: Generates interactive HTML maps for viewing in Omnicast Live Viewer. Operates in standalone mode or when connected to an Omnicast Directory. Displays the Logical view of the entity tree (when connected to a directory) and allows the user to drag and drop entities on the map (drawing board) as clickable buttons. The supported entities are: Camera Camera sequence Output relay Digital input Alarm Macro Analog monitor Supports other standard clickable buttons such as: Bookmark Link to another Web page PTZ manual operation: pan (left/right), tilt (up/down), zoom (in/out) PTZ operation: (run preset/pattern) PTZ stop operation Recording states Allows for map size to be fixed or follow the size of the viewing tile. Allows for button size to be fixed or follow the size of the map. Lets you customize button images and tooltips. Multiple maps (HTML documents) can be grouped as a single project for easy management. Supports "undo" and "redo" commands up to twenty steps. 6 Installing the Map Editor 6.1 Prerequisites Omnicast Map Editor works with Omnicast 4.1 or later. Before installing the Map Editor, make sure that the appropriate version of Omnicast SDK runtime is installed. 7
6.2 Installation To install the Omnicast Map Editor, simply start the install program and follow the instructions. You may run the program immediately after installation. There is no need to restart your system. 7 Using the Map Editor To start the Map Editor, choose Start > All Programs > Genetec Omnicast 4.x > Tools. 7.1 Basic Concepts 7.1.1 Projects and Maps The Map Editor works with projects. A project is a collection of maps. When you run the Map Editor for the first time, you start with a blank project and an untitled map. 8
Each map is defined in a separate page of the project. To open the map properties dialog box, right-click on the page and select Properties. Each map must be defined by a name and a picture file (bmp, gif, jpg, or jpeg). The picture file is used to define the size of the map and is also used for the background image. Select the Resizable option if you always want the map to fit the size of the viewing tile. If you want to add a new map, select Map > Add, or right-click on the current map and select Add page. 7.1.2 Operating mode The Map Editor can operate in standalone or connected mode. To connect the Map Editor to a Directory, click on the Connect button and proceed like any other Omnicast client application. The Map Editor works best when connected to a Directory because it will show the entity tree on the left pane. You can then add clickable buttons to the map by dragging the entities from the tree and placing them on the map. 9
If you are not connected to a Directory, you can create the same buttons on the map by picking them from the Tool pane. The difference is you have to enter the logical ID that associates your button to the system entity in the field. 7.2 Adding Buttons to the Map To add a button to your map, you can either drag an entity from the entity tree (if you are connected to a Directory) or pick a generic entity from the Tool pane and place it on the drawing board (the map). There are two types of button: Entity buttons and buttons. 10
All buttons can be moved around on the drawing board showing the map. To edit a button s properties, select it from the drawing board. The following properties are common to all buttons. Layout Height Width X coordinate Y coordinate Picture file Resizable Height of button icon in pixels. Width of the button icon in pixels. X position of the button icon on the map in pixels. The extreme left of the map is 0. Y position of the button icon on the map in pixels. The top of the map is 0. Logical ID of the entity the button is supposed to control. Path to the picture file representing the button. You may replace the default image provided by the Map Editor with your own. True or False. True means that the size of the button should always be kept proportionally the same to the size of the map. of button (cannot be changed). 7.3 Entity Buttons The following buttons can be created either by dragging the desired entity from the entity tree (connected mode) or by dragging the entity button from the Entity tab in the Tool pane (standalone mode). In the standalone mode, you will need to initialize the yourself. 7.3.1 Camera This button has the same behavior as a camera entity. Double-click it or drag it to a tile to view the live video. The tooltip shows the camera name. Logical ID of the camera entity. Cam 11
7.3.2 Camera sequence This button has the same behavior as a camera sequence entity. Double-click it or drag it to a tile to view the live video. The tooltip shows the camera sequence name. 7.3.3 Output relay Logical ID of the camera sequence entity. Seq In the Live Viewer, right-click this button to display the contextual menu of the corresponding video unit. Some custom programming is necessary to give the button the desired behavior. The tooltip shows the name of the output relay. 7.3.4 Digital input Logical ID of the output relay entity. Output In the Live Viewer, right-click this button to display the contextual menu of the corresponding video unit. Some custom programming is necessary to give the button the desired behavior. The tooltip shows the name of the digital input. 7.3.5 Alarm Logical ID of the digital input entity. Output Use this button to trigger the associated alarm. The tooltip shows the alarm name. Logical ID of the associated alarm entity. Alarm 12
7.3.6 Macro Use this button to execute the associated macro. The tooltip shows the macro name. Logical ID of the associated macro entity. Macro 7.3.7 Analog monitor Use this button to enable the connection between camera and analog monitor. Dragging a camera to the monitor icon in the map will display the camera on this monitor. The tooltip shows the analog monitor name. Logical ID of the analog monitor entity. Analog monitor 7.4 Buttons The following buttons are not available from the entity tree. You must pick them from the Tool pane. 7.4.1 Bookmark Use this button to add a bookmark to the associated camera. You must specify the tooltip yourself. Properties Tooltip message Logical ID of the associated camera. Bookmark Desired tooltip. 13
7.4.2 Link Use this button to jump to another HTML page. Properties Link type Text Tooltip message URL n/a Link Appearance of the link button. You have three choices: Text Shows an underlined text Button Shows a rectangular button with text inside. Image Shows the icon specified in Picture file. Text displayed if you chose the "Text" or the "Button" appearance. Tooltip displayed if you chose to represent the button with an image. The URL to jump to (e.g. http://www.google.ca). If you are jumping to another map within the same project, simply use the map name followed by ".html". For example, if the map you wish to jump to is called "Second floor", then the URL for that map is "Second floor.html". This simplification is due to the fact that all maps belonging to the same project are stored in the same folder. 7.4.3 PTZ manual operation Use this tool to create one of the six manual PTZ control buttons, Pan (left/right), Tilt (up/down), or Zoom (in/out). See PTZ operation under Properties. Properties PTZ operation Speed Tooltip message Logical ID of the camera the PTZ is supposed to control. PTZ Manual Operation You have six choices of PTZ operation. The displayed icon varies according to your selection. Select the reaction speed of the PTZ. Desired tooltip. 14
7.4.4 PTZ operation Use this button go to a PTZ preset or to run a PTZ pattern. Properties Operation number PTZ operation Tooltip message Logical ID of the camera the PTZ is supposed to control. PTZ operation Either the preset number or the pattern number. You have two choices: RunPreset or RunPattern. Desired tooltip. 7.4.5 PTZ stop operation Use this button to stop all operations on a PTZ. Mainly used to stop a PTZ pattern. Properties Tooltip message Logical ID of the camera the PTZ is supposed to control. PTZ Stop Operation Desired tooltip. 7.4.6 Recording states Creates a non-clickable button that shows the recording state of the specified camera. This button will behave exactly like the recording button found in the camera control toolbar of each tile, without the manual recording function. Logical ID of the camera. Recording states 15
7.5 Saving the Project To save your project, 1. Select Project > Save As. 2. In the Save As dialog box, navigate to the folder where you want to save your project. 3. Use a file name that best describes the entire project (e.g. "FloorMaps"), since your project may contain several maps. The Map Editor will create an XML document in the folder you selected. This document contains all the information necessary to generate the maps you defined in your project. 7.6 Generating the Maps To generate the maps, 1. Select Project > Generate Maps. 2. In the Browse for folder dialog box, select a folder where you want the Map Editor to generate the HTML maps. 3. Click Make New Folder to create a new folder with the same name as your project (e.g. "FloorMaps"). This is a recommendation, not a necessity. 4. Click OK to finish. The Map Editor will create one HTML file for every map defined in your project. The file name is simply the map name with the ".html" extension. In the same folder, you will also find four Java scripts (with.js extension) and an "\images" subfolder. The "\images" subfolder contains all the image files required by your maps and buttons. Note If you need to copy or move the maps to another location, you must copy or move the entire project folder, simply moving an HTML file will not work. 16
8 Fixed Issues 2733 Map Editor requires SDK connection in license. 3513 Map Editor is version dependant. 9 Limitations 9.1 Troubleshooting None. 9.2 Known Issues 10513 You may experience an error if you try to load a map file that has a hyphen or dash in the filename. To avoid this problem, do not use hyphens or dashes when naming your map files. 17