SALTO GRAPHICAL MAPPING MANUAL Version 1.0
Historic of changes Version Status Date Author Change description 1.0 Official 28/11/2012 Aitor Apalategi First version of the manual 2
INDEX 1. Introduction... 4 2. Requirements... 4 3. Installation of the Graphical Mapping... 4 4. Set up... 7 5. Configuring the Graphical Mapping... 10 5.1 File menu... 11 5.2 Mode menu... 11 5.3 Tools Menu... 22 6. Monitoring Doors... 26 3
1. Introduction The SALTO Graphical Mapping is a separate software installer that talks to SALTO DB and the SALTO Service. The purpose of this application is to allow monitoring graphical mode of real-time doors operations on screens. This document describes the functionalities and set up process of the software. 2. Requirements The SALTO Graphical Mapping software installation requirements are the following: Supported Operating Systems: Microsoft Windows XP (SP3), Vista, Server 2003, Server 2008 and Windows 7. Both 32-bit and 64-bit. Minimum hardware: 400 MHz CPU, 512 MB RAM, 800x600 256-color display. Recommended hardware: 1.0 GHz or higher CPU, 1 GB or more RAM, 1024x768 high-colour 32-bit display..net Framework 3.5 (SP1). Up to 3 GB of hard disk space may be required, depending on the size of the locking plan. The SALTO Service installation program (setup.exe) requires MS-Windows Installer 3.1. The SALTO Graphical Mapping software works along with the following software packages from SALTO: SALTO Software for Service. This could be the Pro Access for Service or HAMS for Service software. SALTO Service. Please refer to the specific SALTO software and SALTO Service documentation for further installation and set up details for both software packages. IMPORTANT NOTE: Observe always the software version compatibilities among the SALTO software (PA4S or HAMS4S), SALTO Service, and the Graphical Mapping. It is strongly advised to go for the latest software versions in all cases, in order to have all the advantages provided by the latest system features. 3. Installation of the Graphical Mapping Please follow the instructions below for Graphical Mapping installation once the SALTO software and the SALTO Service are installed, and a new database is created. 4
Run the SetupSaltoGraphicalMapping.msi file, and read carefully the instructions appearing in the windows that will pop up. Click on next. Read carefully the License Agreement conditions to understand what it involves, select the I agree option, and click on next. Select the folder where the Graphical Mapping software will be installed, and click on Next. 5
Click on next to proceed with the installation. Once the installation is successfully finished, the installation wizard will warn about it and a blue icon like the one below will be automatically created on the desktop. 6
4. Set up Double click on the blue icon above and the initial application set up options window will pop up. This window contains two tabs that must be correctly set up in order to ensure the correct performance of the application: Database. SALTO Service RW. The Database tab allows configuring the correct information in regards to the location of the SQL Server and database itself. In case any of the information included here is not correct, the Graphical Mapping software will not be able to connect with the SALTO database, and therefore will be unable to show the doors information, nor establish any communication or link with the Service, and of course, the doors. The Server name field must be filled in with the name of the PC and SQL Server name the SALTO database is located in. In case any of the names is mistakenly wrongly written or incomplete, the Graphical Mapping will fail to establish the connections mentioned above. The Database field should contain the correct database name the software should take the information from. Please write the name correctly, and do not use space to separate words that could conform the database name. Underscore (_) must be used instead. 7
The Graphical Mapping, as well as the SALTO Service and certain SALTO client applications (such as the RW Pro Access software) need accessing the Salto DB in order to work correctly. In case the Windows authentication option is selected to log on the server, there are some minimum set of database permissions that must be given to the Windows user: Read/write rights on every single object (mainly tables and views) within the SALTO DB. Right to execute every single stored procedure and user function within the SALTO DB. This log on to the server could be also controlled by a SQL Server authentication. If the user happens to be a member of the SQL Server administrator group, there is no need to take special measure since all the above mentioned DB permissions are inherently granted. The same applies for high-privileged Windows accounts, such as Local System. For the rest of the less privileged Windows users, you need to specifically grant the mentioned permissions: Firstly, create a new log-in session within the SQL server associated to the software user. 8
Secondly, make this login session be a user of the SALTO DB. SALTO Graphical Mapping 1.0 Finally, grant to this new DB user the above mentioned permissions. One simple way to do this is by just making this new DB user be a member of either the db_owner role or the SALTO role. The Test connection option helps to verify the correct communication with the selected SALTO database. The SALTO Service RW tab is used to set up the Service data to receive notifications from the online control units or wireless locks. The location of the SALTO Service must be configured in order to allow the communication between the Graphical Mapping and the SALTO Service itself. In order to do that, the complete name of the PC, where the SALTO Service is installed, must be specified. The same TCP/IP port used in the SALTO Service configuration must be specified in the Port field of this tab. The UDP port the Service uses to communicate with the peripherals connected to it, must be also specified. A range of free and available ports could be selected, so the Service will use one of the ports within the specified range every time it is connected. The same range must be configured in the Graphical Mapping. In case the site does not allow or prefers having just a single UDP port open for this purpose, they should provide an available and free UDP port for the SALTO Service. This same port number should be also used in the Graphical Mapping configuration. 9
Graphical Mapping SALTO Service 5. Configuring the Graphical Mapping Once the software is installed, and the initial communications set up with the Service and the database are configured, allowed PA / HAMS operators will be able to log in, and configure the Graphical Mapping. It is important to highlight that only software operators with the Graphical Mapping options Setup and / or Monitoring enabled will be able to access the software. Once the operator logs in, a globe confirming the connection with the SALTO Service should pop up, and a Graphical Mapping icon will appear in the Task bar. The Graphical Mapping itself will show in every moment the status of the connection with the Service, on the bottom right corner of the software, as shown below. 10
5.1 File menu The File menu includes the following options: Logout: this option allows the system operator to log out of the software. Change Language: This option allows changing the language among all the languages loaded during the installation of the software. Exit: This option quits the software totally. 5.2 Mode menu This menu contains the following options: Setup: this option allows creating the system architecture in a graphical way, in order for the person in charge to use the Graphical Mapping to control in real time all the events occurring on site. Monitoring: This option allows monitoring the events with the graphical environment created in the Setup option. 11
5.2.1 Setup menu As mentioned above, this menu allows creating the graphical interface for the person using the software to monitor everything on a graphical and intuitive way. The tools to create this interface are: Show Doors Add Root node Refresh When the Add Root node option is selected (this option also pops up when clicking with the right button of the mouse in the left side area), the following window is shown: 12
This window allows creating a tree form structure on the left side of the software, in order to navigate throughout the different site layers or maps that could be created. A name for the node to be created could be defined in the Name field, and after that adding a small icon on it to help the operator identify what the node they are using is: The software allows adding building plans or drawings to the node, in order to be able to graphically locate doors and facilitate any further action required. There are three buttons to work over the right hand area or map of the window: Load New Image : A browser will get open to select the required picture. Remove Image : Select this option to delete the already loaded image. Remove all items : In case doors have been added to the picture, the can be removed by clicking on this option. 13
Once the image has been loaded, it could be completed with the doors information, as well as labels that will help identify what the shown pictures represents. The image could be also zoomed in and out, in order to check details. The options for the actions described above could be found in the upper side of the image area, being these options: Drag door to the image area : This option opens another window when dragged to the image area, which allows selecting an existing door of the database to be represented in the image, name it and edit its properties in the Appearance tab, like size and font to be used in the text, its colour, icon to be used and the size of this icon. Drag label to the image area : Select this option to add a text in the image area, and edit it. As well as in the rest of text editing options in the software, the font, font size and style can be configured. 14
Drag navigation link to the image area : Navigation links will allow the system operator to go to any of the other maps added to watch the installation. Destination node, icon and text appearance can be configured. Max Zoom : This option defines the default zoom value that will be used for the displayed alerts automatic navigation. 15
Zoom Out : This option allows zooming out once there has been a zooming in on the image. Zoom In : This option allows zooming in the image. The software also allows selecting and dragging the door from a list located on the right side of this window. Click or just put the mouse over the All Doors tab, and the list will come up: In case the list is too long and it is complicated to find a specific door, type the name of the door and the software will find it or a filter could be set up to find the desired door on the list. Just place the mouse over the Name or Description fields and click over the Filter that will pop up, which will show the doors, but also some filter tools: 16
Note that the same door cannot be used in the same map, but can only be located once. The software will show this door scratched in the doors list, and will not allow adding it again to the map. On the other hand, the same door can be added to different maps, that is to say, could be located in different maps. Once all the elements of a certain map have been added, they are listed on the left side of the map configuration. The list can be extended by clicking on the + signs. A given element (door, label, navigation link) could be individually deleted by selecting it with the right button: Once the node has been defined and designed, child nodes can be added to detail the access control points in different maps or floors of the site, by clicking over the node with the right button of the mouse, and selecting the Add Child Node option: 17
Child Nodes are defined and designed following the same steps explained above. Please refer to them in order to know how to define the different elements on a child node. As many child nodes as necessary can be added to the node, and a tree structure like the one below will be visible on the left side of the software: The software also allows creating multiple nodes or child nodes, just by clicking on them with the right button and selecting the Copy option: 18
A window called Multiple Node Insertion will appear, and this will be the tool to configure how many nodes or child nodes will be inserted. As can be seen on the right side picture above, a root node can be selected. If one of the existing nodes is selected, all the elements that will be created will hang from this node, that is to say, they will be child nodes hanging from a parent node. This selected node could be erased from that field by clicking on the 3 dots button. This tool allows inserting a Prefix to all the nodes to be created, adding a number to differentiate them, and also adding a Suffix in the end of the name. The step between the different nodes to be created can be selected, so odd or even series of numbers, for instance, can be created if necessary. The field on the bottom of the window shows what the result of the elements configured in the upper fields will be. The result would be 4 new Child Nodes hanging from the selected Node: 19
As mentioned before, in case no Root node is selected, new main nodes will be created on the tree structure: The Move option allows the system operator to move a certain node or child node from its current location to another one. In order to move an element to hang from another node or child node, it has to be selected first (0 Floor in the example above) and then select the destination in the Move to window that will appear (Manufacturing Plant in the pictures below): 20
Once all the main nodes and the child nodes are defined, the operator could also navigate through the different nodes and child nodes by double clicking on the navigation links (white arrows within blue circles) and check them: All the created nodes and child nodes will be also available in the upper side of the software, and could be checked and closed by clicking on the corresponding tab: 5.2.2 Monitoring menu Once the set up of the software has been finished, the different operators could monitor what is happening in the different nodes or child nodes created previously. In order to do that, the operator would have to select the Monitoring option within the Mode menu, and will be able to click over the nodes or child nodes to monitor them, or also open different tabs to navigate among them: 21
The system operator could also go directly to each of the child nodes also by clicking on the navigations links created previously. All the different alerts that are declared to be important enough to be shown, and also would direct the software to show the door they happen on, will be listed on the bottom of the software, in the Alerts Panel: The alerts configuration is set up in the Tools menu. Please refer to that section to find out how to set up the alerts. It is important to bear in mind that going into the set up mode of the software will interrupt the communication with the Service, and therefore, the Graphical Mapping will not be able to monitor what is happening on the online control units and/or wireless locks. The software will warn about it with the following warning window: 5.3 Tools Menu The Tools menu allows us to configure what the behaviour of the software will be in terms of alerts to be taken into account. This menu contains an option called Configuration, which also contains two different options for the setting up: 22
Database and SALTO Service RW Configuration. General Options. 5.3.1 Database and SALTO Service RW Configuration This option will allow the operator to be able to check if the previously made database set up is correct, and also if the SALTO Service configuration is correct. It is important to take into account that the operator must be logged out in order to be able to set up the database to be used, as the blue warning icon informs about on the Database tab. The proper connection to the selected database could be also checked by clicking on the Test Connection button. 23
The SALTO Service RW tab will allow the operator to set up the Host name, as well as the Service port for the software to talk to the SALTOS Service and the UDP port or ports range to be used to communicate with the online control units and/or wireless locks. Please refer to the Set Up section for more information. 5.3.2 General Options The General Options menu allows selecting what are the events that require a special treatment, and will be shown in the Alerts Panel of the Graphical Mapping, as explained in the Monitoring Menu Section. There are two different tabs to configure the monitoring of the alerts or events: Events: This is where the events and notification times are set up. Preferences: This is where the automatic navigation through the different maps is configured. The different events to be monitored and that will trigger navigation through the different maps will be configured primarily on the Events tab. As can be seen in the picture below, a Notification Period could be created in order to define which events will pop up in what period of time, just by clicking on the New Notification Period button: 24
Each of the Notification Periods could be named with a descriptive name of the period of time they are monitoring, or the events they will be notifying, just by entering a name in the Subject field. The Start Time and End Time fields will define the period of time itself. Note: Bear in mind that the time filter should be configured on a way that the Start Time must be always smaller than the End Time. The configured Notification Period will pop up when the cursor is placed over the Notification Period cell itself: Once created, the Notification period can be edited or deleted by clicking with the right button over the Notification Period, as can be seen on the right picture above. The Events column on the left side of the window will allow configuring the specific events that are required to be shown on the Alerts Panel, and will also make the software navigate by itself to the corresponding door, located on the right map it has been placed on: The Preferences tab will allow configuring an automatic navigation to the map where an Event occurred. 25
When the navigation is active, and more than one event happen at the same time or with a very small time difference, the software could be configured to remain on a map during a certain amount of time, and then change to the next map where the next event occurred: This navigation could be also deactivated by enabling the Disable automatic navigation option. This tab allows also limiting the number of alerts that will be listed on the Alerts Panel, being the maximum number 1000. 6. Monitoring Doors Once the different maps, node, child nodes and behaviour of the software have been configured, the user of the system will be able to obtain information and carry out certain operations on the doors added to the different maps. Just by placing the cursor over a door, the information about the door status will be shown, as can be seen in the picture below: 26
By clicking over the door with the right button of the mouse, certain operations that can be performed over that particular door will be shown, no matter if this door is an online control unit (CU) or a wireless lock. Important Note: the following options will be only available in wireless locks for the RF2 system from SALTO, working with the RF2 Gateways and Nodes. These options are not available for the RF1 locks, Gateways and Repeaters. The available information and operations would be: Properties: This option will show the properties of the selected door. Last events: The last events that happened on the selected door will be shown, as can be seen below. 27
Open: This option allows opening remotely the door for the time specified in the door profile, in the Pro Access or HAMS software: Emergency Open: This option would allow leaving the door open until the situation emergency is over. No card would be required to go through this door during this period of time. Emergency Close: This option would allow leaving the door blocked until the emergency situation is over. Only users with the Override Lockdown option enabled would be able to go through during this emergency period. Users without this option enable will be rejected, even though they have access through that door normally. 28
End of Emergency: This option will end any of the above described emergency modes, and the programmed opening mode of the door will be active again. In case the drawing or plan used in a map contains a lot of details and doors, and a better view of the door and / or details is required, a zooming tool pops up when clicking with the right button of the mouse over the desired area of the plan, as can be seen below: A small navigation map showing the zoom value will be visible also in the bottom right corner of the drawing, in order to help locate the zoomed area within the active map to the system operator. The system operator can also monitor a door that notified an alert by selecting the alert in the Alerts Panel, and clicking on the Go to selected alert location button located on the left top corner or the Alerts Panel: The software also allows going to the door that notified the alert by selecting the alert with the right button of the mouse, and selecting the Go to alert location option that will pop up: 29
As explained during the software configuration sections, the system operator can navigate among the different maps by double clicking over the created Navigation Links (white arrows within blue circles): 30