Salto Offline Lock Integration Guide

Transcription

1 Salto Offline Lock Integration Guide August 2015

2 SATEON Salto Offline Lock Integration Guide Issue 1.0, released August 2015 Disclaimer Copyright 2015, Grosvenor Technology. All rights reserved. SATEON and the SATEON logo are trademarks or registered trademarks of Grosvenor Technology. All other brands, names, or trademarks appearing in this document are acknowledged as the trademarks of their respective owners. No part of this document may be reproduced in any form or by any means for any purpose without the written permission of Grosvenor Technology. Whilst we make every effort to ensure the accuracy of our publications, Grosvenor Technology assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. SATEON 2 Issue 0.4

3 Contents Preface... 5 About the Salto Offline Lock interface... 5 About this guide... 5 Related documents... 6 Technical support... 6 Introduction... 7 Overview of the integration... 8 Key functionality... 9 Important points... 9 System structure Salto server and Sateon database Salto Portable Programming Device Salto key cards Key card encoders Key card control unit/hotspots Installing the Salto interface Installing the Salto Offline Lock interface Installation options New installations What is installed Licensing the Salto Offline Lock integration Configuring the Salto interface Salto system prerequisites Lock/zone configuration SHIP Protocol Configuring Salto connection data in Sateon Linking the Salto host to Sateon Specifying the Salto Encoders SATEON 3 Issue 0.4

4 Setting up Sateon data for Salto token use Configuring Salto key cards Setting up a Salto Token Type Creating Salto Tokens Configuring Salto access Create access groups and permissions Defining Salto token options for personnel Assigning and revoking a Salto key card Assigning and issuing a Salto key card Revoking a Salto key card Issuing, updating and cancelling Salto key cards Monitoring the token state Viewing and monitoring the Salto system Salto event reporting Salto Door Events Salto Service Events Salto event configuration Default event configuration Using Salto events Reconciling the Salto service Monitoring Salto doors Additional Salto troubleshooting SATEON 4 Issue 0.4

5 Preface This document provides information on the SATEON Salto Offline Lock interface, which provides an interface between SATEON and a Salto Offline Lock system. The integration has been documented for SATEON Release 2.9: it may not include changes incorporated in later versions of the software. Representations of screens are shown for general illustration only: there may be some differences in the screens you see, depending on the operating system and the computer configuration. Date of latest update: August About the Salto Offline Lock interface SATEON is a powerful yet easy-to-use browser-based access control system that allows users to manage and monitor physical access to sites. It integrates access control, alarm and incident monitoring and comprehensive reporting facilities. The Salto Offline Lock interface supports the use of Salto wireless locks within the access control system. SATEON supports an offline solution which means that the locks are not connected to a server and require a valid card to be presented. The card maintains all the access information and all of the details of valid and invalid access requests made since the card was last synchronised. About this guide This document provides information on setting up and monitoring the Salto Offline Lock interface. It assumes familiarity with SATEON and Salto systems. It is aimed at installers and system managers who are responsible for setting up and configuring interfaces to third-party systems. SATEON 5 Issue 0.4

6 This guide includes the following information: Section 1 Introduction. This section provides an overview of the integration and introduces the Salto concepts. Section 2 - Installing the Salto interface. This section explains how to install the Salto module and upgrade the SATEON licence. Section 3 - Configuring the Salto interface. This section explains how to ensure connection between the Salto host system and SATEON. Section 4 Setting up Salto token use. This section explains how to set up and issue Salto tokens and configure access for personnel. Section 5 Viewing and monitoring Salto activity. This section explains how to view Salto interface events within the SATEON interface and ensure everything is working correctly. Note: This guide does not provide information on any configuration of the Salto Offline Lock system that may be necessary. Related documents The following SATEON documents may also be useful: The SATEON Installation Guide. Explains how to install SATEON, including details of software prerequisites and licensing. The SATEON Personnel Module Guide. Explains how to set up the people who will use the system and the tokens they use to gain access to the site. The SATEON Control Centre Guide. Explains the SATEON Control Centre, which allows security staff to view and monitor events, to deal with reported incidents and to manage or control specific elements of the system. The SATEON Event Configuration Guide. Details how to set up the way in which system events are reported, tagged and used within the system. Technical support For further assistance with SATEON, please contact Grosvenor Technology Technical Support as follows: (EMEA): (US): (APAC): Website: ac-support@grosvenortechnology.com ac-ussupport@grosvenortechnology.com apacsupport@grosvenortechnology.com SATEON 6 Issue 0.4

7 Section 1 Introduction This section provides an overview of the Salto interface and introduces some of the system concepts. For a summary of the Salto interface, see Overview of the integration on page 8. For an explanation of the various elements of the Salto system and terms used, see System structure on page 10. SATEON 7 Issue 0.4

8 Overview of the integration The integration between Sateon and Salto enables the support of Salto wireless locks within the Sateon system. With Salto wireless locks, access permission information is maintained in the token (i.e. the Salto key card) without the requirement for Sateon door controller panels. The integration requires a separate, licensable Sateon module which manages communication between the main Sateon system and the Salto system, and enables the issue and updating of Salto key cards. The following diagram illustrates the various elements of the Salto integration. SATEON 8 Issue 0.4

9 Key functionality The Salto Offline Lock interface module within Sateon includes the following functionality: It ensures synchronisation between the Salto and Sateon databases. It enables Salto door locks, zones and timezones to be represented in the Sateon interface. It enables Salto key cards and access permissions to be set up within Sateon and synchronised with Salto. It allows key cards to be issued, cancelled and updated with access control information via encoders. It enables details of access attempts and key updates to be viewed in the Sateon Control Centre. It allows a Sateon user to view the status of the Salto service and the Salto door locks, including any faults reported. Important points Note the following important points: The configuration steps described in this document assume that the Salto system is being configured at the same time and contains no user or card details. All personnel and access information must be configured and managed in SATEON. Any existing user and card data in the Salto system will be overwritten by the SATEON data when the systems synchronise. Note: If the Salto system has already been set up with user and card details, do not install the interface. Contact Grosvenor Technical Support. The Salto integration supports offline locks. In this mode the locks are not connected to a server and depend on a valid Salto key card being presented before issuing the unlock command. The key card must be updated regularly to ensure the information remains current. Communication between Sateon and Salto requires the Salto Server to be enabled, running the Salto Host Interface Protocol (SHIP). The Salto integration operates in SALTO Mode, meaning that the SALTO system maintains all user data and Sateon ensures it is synchronised with it. The alternative HOST mode is not supported. The audit trail, recording events occurring at Salto locks, is held on the key card and will only be transmitted to Sateon when the key card in question is next updated. This means that events and status changes may not appear in the Control Centre in real-time. The Salto Outputs and Visitors concepts are not supported. A Sateon access control system can include doors managed by Sateon panels as well as doors with Salto locks. SATEON 9 Issue 0.4

10 We recommend that the interface between SALTO and Sateon is secured appropriately either by firewall configuration and a secure network or by installing both the SALTO and Sateon systems on the same PC. It is possible to configure a system that permits access to both Salto locks and Sateon readers. Personnel should be issued with tokens supporting the Mifare F Wiegand (32 bit) format. Sateon and Salto access can be configured within the same access group. See Configuring Salto access on page 26. System structure Salto server and Sateon database Data is maintained within both the Salto system and the Sateon system. It is important to understand where the different types of data are held and updated. Salto data The Salto system is responsible for managing and controlling the Salto devices in real time. The following data must be created and maintained in the Salto system: Doors individual doors/locks Zones collections of doors with specific access rights Timezones timings that define access. Card encoders used to configure and issue cards. This Salto data can be viewed within Sateon, but not amended. Sateon data The Sateon system is responsible for managing all personnel and access information. The following data must be created and maintained in the Sateon system: Personnel the people that are issued with key cards. Tokens the key cards used for access. Access permissions the doors that people can access. When data is synchronised, personnel and tokens in Sateon appear as User data within Salto. If any amendments are made to this data within Salto, the changes will not be reflected in Sateon. Notes: A Token within Sateon will be matched to a User record, as there is no separate concept in Salto. If the Salto system already contains user and card information when the integration is set up, it will be overwritten with the data in Sateon. In this case please contact Grosvenor Technical Support before installing the interface. SATEON 10 Issue 0.4

11 Synchronisation between Salto and Sateon databases is achieved by the Salto Server (SHIP). The Sateon and Salto databases are synchronised as follows: Changes made within Sateon are pushed to the Salto system whenever the changes are saved. Changes made within the Salto system require a manual synchronisation to update the Sateon database. Salto Portable Programming Device The Salto Portable Programming Device (PPD) is used for the initial configuration of the locks. This document assumes this has already been done. Salto key cards Salto key cards must be supplied in advance, and are then set up as tokens in the Sateon system. To support the use of Salto locks you need to configure a specific Salto Token Type within Sateon and configure the individual tokens. Salto key cards do not use a card number. However as a token number is required by Sateon, a random unique number is generated for each card. It is also possible to use the same token for Salto locks and Sateon readers. In this case the Sateon readers use a Mifare F Weigand (32 bit) format and use the number encoded on the card. Access rights for the different lock zones in the system are stored on the key cards. When a key card is presented to a Salto lock, the lock reads the access rights for its own lock zone and takes the decision about granting access. As well as the access rights, the key cards need to have correct time validity and encryption. Key card encoders Key cards are issued by means of an encoder. Multiple encoders can be supported, each attached to a local system. Key cards can be issued and withdrawn from within Sateon. Key card control unit/hotspots The Salto key cards need to be presented to a control unit on a regular basis to ensure the access permissions are up to date and to upload the audit trail stored within the card. The time period can be specified in Sateon and will depend on the security requirement of the installation. Failure to update a token within the specified time will mean the token will no longer open Salto locks. SATEON 11 Issue 0.4

12 Section 2 Installing the Salto interface This section explains how to install the Salto interface module in Sateon and upgrade the licence file. For details of installation, see Installing the Salto Offline Lock interface on page 13. For information about licensing, see Licensing the Salto Offline Lock integration on page 17. SATEON 12 Issue 0.4

13 Installing the Salto Offline Lock interface For full details of installing Sateon, see the SATEON Installation Guide. Installation options The Salto interface is an optional Sateon module and is not installed as part of the standard default Sateon installation. Note: To install optional features, you must use the advanced installer, Sateon Installer.msi. The one-step installer cannot be used. Brief instructions are given here; for full details, see the SATEON Installation Guide. Note: Even if the Salto module has been installed, it can only be used when an appropriate licence is present. New installations For a new installation you need to run a customised installation to ensure that the Salto options are selected. To ensure the Salto options are included 1. On the release media, navigate to..\installer\sateon\ and run SATEON installer.msi. 2. On the first screen, press Next. 3. After reading the Licence Agreement, select the checkbox to accept the agreement and click Next. The following dialog appears: SATEON 13 Issue 0.4

14 4. Click the Customise button. 5. On the Destination Folder dialog, accept the default or click Change to select an alternative location. 6. Click Next. The Custom Setup dialog appears. In the tree structure, only the databases and services required for core functionality are selected by default. Expand the SATEON Databases structure and select the Salto Database within Global Databases. 7. Expand the SATEON Services structure and select Salto Service. 8. Click Next and continue to follow instructions on the dialogs. 9. Click Install to begin the installation. When it is completed, click Finish. SATEON 14 Issue 0.4

15 Existing installations For an existing installation you will need to re-run the installer to add the Salto options. Note: Sateon will be shut down during the re-installation process. Ensure that all users are logged off. To add the Salto options to an existing installation 1. On the release media, navigate to \Installer\Sateon\ and run SATEON installer.msi. 2. On the first screen, press Next. 3. Choose Change. 4. In the tree structure, select the features to be installed. Expand the SATEON Services structure and select the Salto Service. Expand the SATEON Databases structure and select the Salto Database within Global Databases. Ensure that all previously selected options are also selected (otherwise they will be removed). SATEON 15 Issue 0.4

16 5. Click Next. 6. Follow the instructions on the dialogs, ensuring you provide exactly the same settings as when Sateon was first installed. 7. Click Change to begin the installation. When it is completed, click Finish. What is installed The Sateon Salto database and service are installed. The service should start automatically following installation. If necessary, you can manage it from the Control Panel > Administrative Tools > Services dialog. The Salto service maintains a log of its actions and activities, which you can check for testing and diagnostic purposes. Logs can be monitored using either the Sateon Real Time Diagnostics tool or the Windows Event Viewer. For full details, see the SATEON Administration Guide. SATEON 16 Issue 0.4

17 Licensing the Salto Offline Lock integration The Salto Offline Lock integration is a separately licensed SATEON feature. For a new installation you need to ensure that the licence includes support for the Salto interface. If you have added SaltoSalto Offline Lock support to an existing installation, you will need an updated licence file. You can add a new or updated licence from the System Configuration > System Administration > Licensing page within Sateon. For full details on how to add a licence file, see the SATEON Installation Guide. For a new installation the licence needs to be validated within 30 days for Sateon to continue to work. Note: If you do not have a valid licence file yet, contact Grosvenor Technical Support as soon as possible. Support for the Salto Offline Lock interface is indicated on the Licencing page: The maximum number of Salto doors/locks that the installation will support is indicated. If you attempt to connect more Salto doors than the licence supports, the ones that exceed the maximum licensed number will be ignored. SATEON 17 Issue 0.4

18 Section 3 Configuring the Salto interface This section explains the initial set up of data needed to ensure correct communication between the systems and valid access to Salto locks. For an overview of what needs to be configured in the Salto system, see Salto system prerequisites on page 19. For information about setting up key parameters that ensure connection to the Salto elements, see Configuring Salto connection data in Sateon on page 20. SATEON 18 Issue 0.4

19 Salto system prerequisites Lock/zone configuration SATEON assumes all locks and zones have already been added to ProAccess and programmed using the Portable Programming Device. When connection is made between the two systems all configured data relating to locks and zones is synchronised and made available in the Sateon user interface. If any changes are made to the locks and zones the SALTO service will need to be resynchronised. See Reconciling the Salto service on page 40. SHIP Protocol Communication between Sateon and Salto requires the Salto Server (SHIP). The location of the SHIP endpoint is configured in the Sateon system, where it is known as the Salto Service. See Linking the Salto host to Sateon on page 20. You needed to make sure the Salto server (SHIP) is configured and enabled. In the SALTO Service Configurator, specify the name of the machine that the service is running on. When configuring SHIP, ensure that SALTO Server mode is Enabled. SATEON 19 Issue 0.4

20 Configuring Salto connection data in Sateon It is important that before you set up Salto tokens and access in the Sateon database, you set up the connection to the Salto host system and ensure details of locks and zones are synchronised between the two systems. Linking the Salto host to Sateon The Salto Host value within Service Settings defines the location of the system which is running the Salto host service. To configure the Salto system 1. Select System Configuration > System Administration > Service Settings. 2. Expand the hierarchy to view the saltohost settings in the Salto section. This is initially blank. 3. When you click on the setting, the value becomes editable. Specify the hostname of the machine running the Salto service: 4. Save the changes. As long as the Salto host system is running, communication is made and the Sateon database is populated with details of the Salto doors, zones and time zones. You should check this data is present before issuing Salto tokens. Note: It may take several minutes to synchronise all the data. To view SALTO data in Sateon 1. Select Access Control > Salto Management. 2. Details of configured Salto Door, Salto Zone and Salto Timezone options will be shown. SATEON 20 Issue 0.4

21 Note: This information is taken directly from the Salto system. None of it can be amended within Sateon. 3. If no information appears, check the following: That the Salto Host Interface Protocol system is running and data has been set up in the Salto system. That the hostname of the machine running the Salto system is correctly configured within the service settings. Specifying the Salto Encoders A number of different Sateon users may be responsible for issuing Salto key cards via locally-connected encoders. Therefore the encoder that any individual uses need to be configured in the Sateon Personal Preferences. To define the Salto encoder 1. Move to the top right of the screen. When you hover over this area a menu appears: 2. Choose Preferences. The System User Preferences dialog appears. SATEON 21 Issue 0.4

22 3. Select the appropriate Default Salto Encoder from the drop-down. This list is populated with all the Salto encoders configured in the Salto system. 4. If no information appears, check the following: 5. Click Close. That the Salto Host Interface Protocol system is running and encoder data has been set up in the Salto system. That the hostname of the machine running the Salto system is correctly configured within the service settings. SATEON 22 Issue 0.4

23 Section 4 Setting up Sateon data for Salto token use This section explains how to set up Salto tokens and configure access. For details of creating suitable token types and tokens within Sateon, see Configuring Salto on page 24. For information about setting up Salto access options for specific people, see Defining Salto token options for personnel on page 27. For an explanation of setting up access groups and permissions and assigning access to personnel, see Configuring Salto access on page 26. For details of assigning and revoking Salto tokens, see Assigning and revoking a Salto key card on page 29. For details of issuing, updating and cancelling Salto tokens, see Issuing, updating and cancelling Salto key cards on page 32. SATEON 23 Issue 0.4

24 Configuring Salto key cards To support the use of Salto locks you need to configure specific Salto Token Types and Tokens within Sateon. No token types are set up in standing data. Setting up a Salto Token Type You need to set up a token type to represent the Salto key cards. Normally only one token type is required. To set up a Salto Token Type 1. Choose Personnel > Token Types. 2. Choose Token Types and click the Create button. 3. On the Basic tab, provide a Description for this token type and set other details as required. 4. Choose Salto from the Technology Type drop-down and click the button to add it to the list. (Note that Reader Type is not relevant for Salto tokens.) It is possible to use the same token for Salto locks and Sateon readers. In this case ensure that both technologies are selected: Note that the Sateon readers use a Mifare F Wiegand (32 bit) format. 5. Click Save. SATEON 24 Issue 0.4

25 Creating Salto Tokens Suitable encoded key cards will be supplied by Salto and will need to be added to Sateon as tokens. To set up a Salto token 1. Choose Personnel. 2. Choose Tokens and click the Create button. 3. Select an appropriate Salto token type from the Token Type drop-down. If the selected token type supports Salto technology only, the system generates a random token number which appears in the Token Data field. Note that this cannot be edited. However, if the selected token type supports Sateon technology as well as Salto, the token can be presented to a reader to populate the Token Data field. 4. Complete other information as required: Token Status Token Pool Card Identifier Valid From/Valid To Select the initial status of the token. Note that this must be Enabled if the token is to be used straight away. Required field. Select the pool that this token belongs to from the drop-down list. Not required. A validity period for the token can be set if required. Note: If the time on the Salto server and the Sateon server differ, this may affect the access card SATEON 25 Issue 0.4

26 Other data is not necessary for the Salto system. 5. Click Save. Configuring Salto access Once cards are set up you can configure access groups that permit access via the Salto doors/locks. Note: It is possible to have both Sateon and Salto access within the same access group. You can create a Salto-specific access group or add Salto access to an existing SATEON access group. Create access groups and permissions To create a new access group 1. Choose Access Control > Access Management > Access Groups. 2. Click the Create button. 3. On the Basic tab, enter a Description to uniquely identify the access group. SATEON 26 Issue 0.4

27 Note: Access Start and Access End are not required and if set are ignored by Salto. 4. Click Save. 5. To add the individual access permissions that form this access group, click the Manage Permissions button. The Manage Permissions dialog box appears, allowing you to define access permissions 6. The Resources drop-down will be populated with all Salto Zones. Ensure you select the appropriate one. Note: If your system includes Sateon controlled doors as well as Salto locks, the Sateon Reader Groups will also appear in the Resources drop-down. Note that it is possible to have both Sateon and Salto access within the same access group. 7. When this appropriate zone is selected, the Salto Timezones drop-down appears. This is populated with all timezones configured on the Salto system. 8. Click Add Permission to include this access permission in the access group. Defining Salto token options for personnel A number of options or special privileges can be set up for specific SALTO key card users. These are set up on the Personnel record within Sateon, although they are related to the specific key card. A summary of these settings is given here; for full details consult the SALTO documentation. SATEON 27 Issue 0.4

28 To set up SALTO options 1. Choose the Personnel option and locate the appropriate person. 2. Select the Salto tab. Note: This tab only appears if Salto is licenced on your system. 3. Complete details as follows: Use Extended Opening Time Override Privacy Set Lockdown Override Lockdown Office Use Antipassback Indicates that this person/key card has an extended unlock time at Salto locks. This setting can be used to assist people with mobility problems. Indicates that this person/key card has the additional privilege to unlock a door even when the privacy option is enabled from the inside of the door. Indicates that this person/key card has the additional privilege to automatically lock all specified doors in the event of a security emergency. Indicates that this person/key card has the additional privilege to override an existing lock down. Indicates that this person/key card has the additional privilege to set locks to Office mode (doors unlocked; card access not required). Indicates that anti-passback is implemented for this person/key card to prevent different people entering with the same card. This option must also be configured on the door itself. SATEON 28 Issue 0.4

29 Audit Openings in Key Update Period Indicates that the audit trail (all activities involving the key card including access attempts) is recorded on the card. This is selected by default but can be deselected. Defines how often Salto key cards need to be updated. This value will depend on the security requirement of the installation. The default value requires the tokens to be updated every 30 days. Failure to validate a token within the specified time will mean the token will no longer open Salto doors. Note: For more details of these settings, consult the Salto documentation 4. Click Save. Assigning and revoking a Salto key card Note: The description here assumes all personnel and their access permissions have already been set up. Before a Salto key card can be used it has to be encoded with the appropriate access permissions. This requires the use of the portable card reader/encoder. Note: Different Sateon users may be responsible for encoding Salto cards using a locallyconnected Salto encoder. Ensure the correct encoder for the workstation is selected in the Sateon User Preferences (see Specifying the Salto Encoder on page 5). Assigning and issuing a Salto key card Issuing a Salto key card is a two stage process: Assigning it to a person Encoding it with the appropriate access permissions. Note that if the card is already assigned, but not valid for Salto locks, you can perform the encoding step by using the Issue Salto key button. See Issuing, updating and cancelling Salto key cards on page 32. To issue a key card 1. Choose Personnel > Tokens. 2. Choose the appropriate Salto token. Note that the Token State tab will indicate that the key has not been assigned: SATEON 29 Issue 0.4

30 3. Press Issue Token. The following dialog appears: 4. Select the person to assign the key card to and choose Permanent Token or Temporary Token. 5. Click Save. The following dialog appears. SATEON 30 Issue 0.4

31 6. Place the key card on the encoder and click OK. The Salto token is programmed with the current access permissions configured in Sateon. 7. When a confirmation dialog appears, the process is complete and you can remove the key card. Note: To confirm that the token works as expected, we advise that you check it against a Salto lock. Revoking a Salto key card Cancelling a Salto key card is a two stage process: Revoking it from the assigned user. Cancelling the key card. To revoke a Salto key card 1. Choose Personnel > Tokens 2. Choose the appropriate Salto token. 3. Select Revoke Token. A screen of the following format appears. 4. Enter a reason for revoking the token. Select the Remove token on revoke box if this token is to be deleted from the database as well as being revoked. (If this is not selected the token is returned to the appropriate token pool). SATEON 31 Issue 0.4

32 5. Click the Revoke button. The following dialog appears: 6. Click OK to confirm. The following dialog appears: 7. Click OK. The Salto token is unassigned and access permissions cancelled. Issuing, updating and cancelling Salto key cards In normal use a Salto card key is encoded when first issued to a user (see Assigning and issuing a Salto key card on page 29) and is updated with access data when the user presents the card to a Salto system control unit, normally located near a main door lock. Further intervention is not required. However in some situations additional actions are required: If a card has been assigned to a Sateon user, but is not valid for Salto locks, you can perform the encoding step separately by using the Issue Salto Key button. If any changes are made to the key card status, including access permissions, time validity and the personnel options, you can update the token s encoding at any time by using the Update Salto Key button. If you want to remove a user s Salto access rights but leave the key card assigned to that person, you can use the Cancel Salto Key button. This functionality may be required if the installation supports Sateon readers as well as Salto locks. SATEON 32 Issue 0.4

33 These buttons appear at the bottom of the Token page. Buttons will be greyed out if a particular function does not apply to the token status. To issue a Salto key card Note: The Token State tab will indicate if the key card is not assigned. See Monitoring the token state on page Choose Personnel > Tokens. 2. Choose the appropriate Salto token. 3. Press Issue Salto Key. The following dialog appears: 4. When prompted, place the key card on the encoder and click OK. The Salto token is programmed with the current access permissions configured in Sateon. 5. When the process is complete, a confirmation dialog appears and you can remove the key card. To update a Salto key card Note: The Token State tab will indicate if the key card needs to be updated. See Monitoring the token state on page Choose Personnel > Tokens. 2. Choose the appropriate Salto token. 3. Press Update Salto Key. The following dialog appears: SATEON 33 Issue 0.4

34 4. When prompted, place the key card on the encoder. When it beeps, click OK. The Salto token is updated with the current key card data configured in Sateon. To cancel a Salto key card 1. Choose Personnel > Tokens. 2. Choose the appropriate Salto token. 3. Press Update Salto Key. The following dialog appears: 4. Click OK to confirm. The following dialog appears: 5. Click OK. The key card assigned to that person is cancelled, but remains assigned to the person within Sateon. SATEON 34 Issue 0.4

35 Monitoring the token state The status of the Salto key card can be checked on the Token State tab. For example, if a token has been issued to a person but not encoded, the status will be as follows: If any changes are made to the key card, the status will indicate that an update is needed: SATEON 35 Issue 0.4

36 Section 3 Viewing and monitoring the Salto system This section explains the information that is available within Sateon about the configured Salto integration. For information about the events that can be reported from Salto objects, see Salto event reporting on page 37. For a summary of default event configuration related to Salto objects, see Salto event configuration on page 38. For information about ensuring the Sateon and Salto databases are in sync, see Reconciling the Salto service on page 40. For details of viewing the status of Salto doors in the Control Centre see Monitoring Salto doors on page 41. For information about extra features to monitor the Salto hardware, see Additional Salto troubleshooting on page 42. SATEON 36 Issue 0.4

37 Salto event reporting Activities and issues that occur at Salto doors/locks are reported as events and will appear on the Sateon Control Centre. Events occurring at Salto locks are held on Salto cards and will only be transmitted to Sateon when the card in question is next updated. This means that events and status changes will not appear in the Control Centre in real-time. Salto Door Events Events that may be raised on a Salto Door are as follows: Event Door Opened Salto Door Opening Not Allowed Salto Door Low Battery Explanation A person has successfully gained access via a Salto lock. The person s name and token number are reported in the event. A person has presented a card to the Salto lock but access was not granted. Additional information is returned from Salto, indicating the reason for access being denied, such as lock key expired or not allowed at this door. Indicates that the battery in this lock is running low and needs to be replaced by a Salto engineer. Note that the battery life is calculated on number of card reads.. SATEON 37 Issue 0.4

38 Salto Service Events Events that may be raised on the Salto Service are as follows: Event Salto Key Cancelled Salto Key Issued Salto Key Updated Salto Offline Salto Reconcile Explanation Salto Key card has been cancelled. Salto key card has been issued and encoded with the appropriate access permissions. Key card has been updated with the appropriate access permissions. The Salto Service is offline. Check the server that the Salto Host Interface Protocol system is running on. Reconcile has been run to resynchronise data in Sateon with data in the Salto database. Salto event configuration Sateon includes some default event configuration related to the Salto interface. Depending on the needs of your installation, you can set up additional event groups, topics and rules in order to report and group the various events raised from Salto system elements. Reported Salto event reporting can be used in a variety of ways, such as including them in event profiles for display on the Control Centre, recording them in specific log files or using them to trigger or control system elements of the system by means of command invokers. For full details of setting up events, see the SATEON Event Configuration Guide for more information. Default event configuration Event groups Event groups are used to group similar objects together, such as Salto doors in a specific area of the building. By default the following event groups are included in Sateon standing data. Additional ones can be configured if required: All Salto Doors includes all Salto doors/locks configured in the system; any new locks added are automatically included in this group. Salto Service the Salto service has a specific event group to itself. Event topics An event topic is basically a label or tag that will be used to identify the events you are interested in. You can then use the event topics in various ways, enabling great flexibility SATEON 38 Issue 0.4

39 and control over the way in which events are reported and used. By default the following Event Groups are including in Sateon standing data: Salto Door All Events used to tag all events from all configured Salto doors Salto Service used to tag all events from the Salto service. Additional topics can be set up if required. Event rules Event Rules define the relationship between actual events, event groups and topics. By default the following Event Rules are included in Sateon standing data: All Events for Salto Doors reports all events specific to Salto doors. All Events for Salto Service reports all events specific to the Salto service. Any of these can be amended as required, or new rules set up. Using Salto events Event reported from the Salto system can be viewed and used in various different ways within Sateon. For full details of setting up events, see the SATEON Event Configuration Guide for more information Event profiles An event profile defines a specific view of events; it is used when selecting the events to view on Control Centre page. By default, all Salto events are included in the Live View (All Events) and Live View (Main events) event profiles. As users in different circumstances may need to view different sets of events, any number of event profiles can be set up. For example, you could set up an event profile specifically to view Salto events. Incidents An incident is any event that requires further investigation, such as a door that has been forced, or a power failure. No Salto events are configured as incidents by default, but if necessary you can configure the system to report any event as an incident. For example, you can report failed access attempts at Salto locks as incidents. Event logging Details of events occurring can be saved in a log file. You can define what events are logged, and how long the logs are kept for. Salto events are not included in the standard Sateon log by default, but if required you can include them. Alternatively, you can set up a specific event logs to store Salto events. SATEON 39 Issue 0.4

40 Notifications You can configure notifications within Sateon to enable s and text messages to be automatically sent to appropriate individuals or teams whenever certain system events occur. For example, you could alert an IT administrator if the Salto service is reported as being offline. Command invokers The command invoker feature within Sateon enables users to associate an event with the triggering of a system object. This offers enormous opportunities for automatic control of the system in both day-to-day use and abnormal situations. For example, for the Salto integration you could set up the system to run a service reconciliation on a regular basis by setting up a command invoker triggered by a time schedule. Reconciling the Salto service If any amendments are made to the Salto lock or zone configuration, you need to resynchronise the data in the Sateon system with the Salto data. Note that this will not happen automatically. To reconcile the Salto service 1. On the Control Centre page, choose the Devices tab. 2. Select Service and choose Salto Service from the Instances list (there will only ever be one) 3. Click the Salto Reconcile button on the right. A confirmation dialog appears: SATEON 40 Issue 0.4

41 4. Confirm the action to synchronise the database and update all lock information. Monitoring Salto doors Some information about Salto doors/locks can be viewed in the Control Centre. Note: Unlike the elements within the Sateon system, the Salto lock status in the Control Centre is not updated in real-time. This is because the information is encoded on the Salto tokens, and is not transmitted to Sateon until card data is uploaded when the card is re-authorised. To view configured Salto Doors locks 1. On the Control Centre page, choose the Devices tab. 2. Select Salto Doors to list all configured locks. A page of the following format is displayed: All configured Salto doors appear in the Instances list. When you select a lock, its currently reported states are listed on the pane on the right. The states and their possible values are as follows: SATEON 41 Issue 0.4

42 Battery Level Property Explanation This value indicates whether the battery within the lock is Normal or Low. If the battery level is low, this may indicate that the battery needs to be replaced by a Salto engineer. Note that the battery life is calculated on the number of card reads. Since real-time reporting is not possible for offline locks, we advise that you check the time of the property change. Additional Salto troubleshooting The Sateon Salto service maintains a log of its activities. This allows you to examine events that have occurred. You can monitor the events raised in two ways. The SATEON Real-Time Diagnostics Tool is a utility aimed at support staff and system administrators. It allows you to configure and view the information logged by the various Sateon services log. It is generally installed as part of a standard Sateon installation and is located in the..grosvenor Technology Ltd/SATEON/Utilities folder. The Windows Event Viewer also allows you to monitor services (Control Panel > System and Security > Administrative Tools). SATEON 42 Issue 0.4