In observance of Memorial Day, RS2 Technologies will be closed Monday, May 27th, 2019

SALTO SHIP Integration


Overview
The SALTO SHIP (SALTO Host Interface Protocol) is an integration between SALTO ProAccess SPACE and Access It! Universal.NET. This integration allows for managing users and basic hardware configuration of offline and online SALTO locksets within the Access It! Universal.NET application.

The SHIP integration requires Doors, Timezones, and Calendars be managed within ProAccess SPACE.

SALTO keys are referred to as cards within Access It! Universal.NET. The SHIP integration allows the key/card to encode its own access database and event trail directly to the card. This allows for offline locks to be used without the need for a central repository.

Access It! Universal.NET Licensing
The following licensing option must be enabled within the Access It! Universal.NET dongle and is a per integrated reader count license.

  • Integrated Reader Count - 1/x

Requirements
Before you begin ensure you have the following:

Software

  • SALTO ProAccess SPACE 2 min s/w 2.5.3.1
  • The following SALTO ProAccess SPACE licensed features:
    • Event Stream
    • SHIP Functionality
    • Antipassback (if APB is required)
  • Access It! Universal.NET min s/w 5.4

Hardware

  • SALTO Card Encoder - External USB or Ethernet device that reads and updates keys with access information.
  • SALTO Portable Programming Device (PPD) - Communicates information to the lock such as door identification and configuration details. This device, which can be physically connected to a lock, is used to initialize and update offline doors.
  • Online Control Unit (CU) - Provides real-time access control. Managed by the SALTO server, the CU works as both an online IP door and as a card updater.
  • Standalone Electronic Escutcheon and Cylinder - Allows or denies access, based on the permissions of the presented key. These access point devices are offline and battery-powered. However, they can be equipped with RF technology to allow online capability.
  • UBOX(optional) - Provides ability for a Control Unit Adapter (CUADAP) to output the Wiegand code of enrolled SALTO cards to any Mercury-Security reader port. 

Configuring SALTO ProAccess SPACE

Prior to configuring the SALTO ProAccess SPACE for the SHIP integration, the SALTO Virtual Network (SVN) must be fully configured and all doors added into the application. In addition, the card encoder must be configured as needed prior to enrolling cards through Access It! Universal.NET. For assistance with creating the SALTO Virtual Network or configuring the encoder please contact SALTO technical support.

Timezones

While the ability to be assigned, the creation and modification of Timezones are not supported within Access It! Universal.NET. Timezones can be accessed within the SALTO ProAccess SPACE by navigating to Cardholders | Cardholder Timetables.

Event Streams

Event Streams are used to select which transaction events should be forwarded to the Access It! Universal.NET service.

  1. Within SALTO ProAccess SPACE navigate to Tools | Event Streams
  2. Select Add Events Stream
  3. Assign a friendly name for the event stream
  4. Within the transport layer:
    • Select TCP/IP
    • Enter the Access It! Universal.NET server IP address
    • Enter a TCP port used to forward events to the Access It! Universal.NET service
      This port will be required when configuring Access It! Universal.NET.
      Port ranges are 5,000 - 10,000.
  5. Within the Event Message Format:
    • Select JSON
    • Select the Encoding type ANSI
  6. Click Next Step
  7. Select Add/Delete
  8. Move over all event fields to the right hand pane
  9. Click OK
  10. Click Next Step
  11. By default no events are filtered when forwarded, should any specific filters be required configure as needed
  12. Click Next Step
  13. Click Finish to create the Event Stream
  14. Restart the SALTO service

Wiegand Code
The Wiegand Code must be configured when the optional UBOX hardware is installed. This allows for storing a Wiegand code within any encoded SALTO key. When used in conjunction with the UBOX, the Wiegand code will be sent to a Mercury-Security reader port.

  1. Within SALTO ProAccess SPACE navigate to System | General Options
  2. Select the Users tab
  3. Within the Tracks of User Key section select (check) the box Wiegand Code
  4. Select the option Profile Code
  5. Click Save

Wiegand Format
The Wiegand Format must be configured when the optional UBOX hardware is installed. The defined format is a 45 bit Wiegand format which must be configured within Access It! Universal.NET application. When entering format details use exact values described below in bold.

  1. Within SALTO ProAccess SPACE navigate to System | General Options
  2. Select the Users tab
  3. Within the Wiegand Format section select Configure
  4. Select Add Code
  5. Within the Wiegand Code Definition form:
    • Code = B
    • Description = RS2 Format
    • Bit Order = MSB
    • Number of Digits = 11
    • Digit Format = Hexadecimal
  6. Click OK
  7. Within the Interface Format enter the letter B
  8. Set Bit Composition to 
    PBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBP
  9. Set Parity Rule 1 to 
    EXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-
  10. Set Parity Rule 2 to 
    -XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXO
  11. Click OK
  12. Click Save

SHIP Protocol
The SHIP protocol is a licensed feature that must be enabled within SALTO ProAccess SPACE. When SHIP integration is enabled, only doors are managed by the SALTO system. Users are managed by Access It! Universal.NET, which controls their access permissions.

  1. Within SALTO ProAccess SPACE navigate to System | General Options
  2. Select the SHIP tab
  3. Select (check) the Enabled checkbox within the SALTO SERVER (SHIP) section
  4. Enter a TCP port to be used for server communication
    This port will be required when configuring Access It! Universal.NET.
    Port ranges are 5,000 - 10,000
  5. Click Save
  6. Restart the SALTO service

Configuring Access It! Universal.NET

Server Setup- version 6.4 and newer

  1. Within Access It! Universal.NET navigate to System | Servers
  2. Edit the Access It! Universal.NET server
  3. Select the Hardware tab
  4. Configure the SALTO settings:
  5. [Salto]
    SHIPHostName=XXX.XXX.XXX.XXX
    SHIPHostPort=XXXX
    EventStreamPort=XXXX
    The letter X is strictly used as a placeholder and values replaced as needed per the following steps.

  6. Click Save
  7. Restart the Access It! Universal.NET service

Settings.ini - version 6.4 and previous

  1. From the Windows Start menu navigate to Access It! Universal.NET | Open AppData Folder
  2. Edit the Settings.ini file
  3. At the end of the document enter the following 4 lines of text exactly as shown in bold:

    [Salto]
    SHIPHostName=XXX.XXX.XXX.XXX
    SHIPHostPort=XXXX
    EventStreamPort=XXXX
    The letter X is strictly used as a placeholder and values replaced as needed per the following steps.

  4. Configure the SHIPHostName field to be the IP address of the SALTO SHIP server
  5. Configure SHIPHostPort to the TCP port specified in step 4 of the SHIP protocol section
  6. Configure the EventStreamPort to the TCP port specified in step 4 of the Event Streams section
  7. Save the Settings.ini file
  8. Restart the Access It! Universal.NET service

Salto Doors

  1. From the Hardware menu, select Salto Doors
  2. Click New to open a list of available Salto Doors
  3. Select the destination Site the door will reside in
  4. Select the door
  5. Click OK
  6. Edit the newly added lock by clicking Edit from the toolbar
  7. Within the Edit Door form:
    • Salto door name = Enter friendly door name
    • Description = Enter friendly door description
    • Open mode =
      • Standard - The lock only opens when an authorized key is used.
      • Office - The lock can be unlocked by any user who has the Office option selected in their user profile and has access to the door. To activate Office mode, present the key to the lock, while keeping the inner handle pressed down. To disable the Office mode, repeat the procedure.
      • Timed Office - This is the same as the Office mode detailed above except that the Office mode is only allowed during defined time periods (e.g., 08:00 to 15:00). The time periods must be previously defined.
      • Automatic Opening - The lock unlocks automatically at specific times and remains open during a defined time period (e.g., 08:00 to 18:00). At the end of each time period, the lock closes and reverts to Standard mode. It is essential to set an access point timed period for this mode.
      • Toggle - The lock can be unlocked by any authorized user that presents a valid key. You do not need to hold down the inner handle. The next authorized key presented then closes the door. This continues switching (toggling) on presentation of each valid key.
      • Timed Toggle - This mode operates in the same way as the Toggle mode described above. However, you can only toggle the option on and off within set access point timed periods.
      • Keypad Only - The lock can be opened at any time by typing a valid code on a keypad. The keypad code must contain between one and eight digits and is the same for every user. When you select the Keypad only option from the Open mode drop-down list, a keypad code field is displayed in which you can define the code. The lock can also be opened with a valid key.
      • Timed Keypad - This mode is the same as the Keypad only mode described above except that the Keypad only mode is only allowed during a defined timed period. The lock can be opened with a key at any time.
      • Key + PIN - The lock can only be opened using both a valid key and by typing a valid PIN on the keypad. This acts as a dual security control. If the PIN code is incorrect, access will not be granted. The PIN must be defined in the cards screen.
      • Timed Key + PIN - This is the same as the Key + PIN mode above except that the Key + PIN mode is only allowed during specific time periods. Outside of these time periods, the lock operates in Standard mode.
      • Automatic Opening + Office - This mode works in the same way as the Automatic opening mode. However, outside of the timed period, the lock reverts to Office mode rather than Standard mode.
      • Automatic Opening + Toggle - This mode is the same as Automatic + Office mode except that outside of the timed period the lock reverts to the Toggle mode.
      • Automatic Changes - This ‘mode’ acts as an indication that the lock will work with a mixture of modes during certain time periods throughout the day. The combination of modes is defined in an automatic changes entry, for example, Automatic change#001. Automatic change schedules must be defined in SALTO ProAccess SPACE.
    • Open period = Enter time schedule to be used in conjunction with timed open modes.
    • Keypad code = Enter keypad code to be used in conjunction with keypad open modes.
    • Open time = Enter the amount of time that the door handle will remain active after a valid key has been presented. The door locks as soon as the handle is released, even if the time value is not reached. The default time value is six seconds. The value can be increased or decreased in the range 0 to 255 seconds.
    • Increased Open Time = Enter the amount of time that the door handle will remain active after a valid key, that has the extended access times option enabled, has been presented. Used typically for ADA solutions.
    • Audit on keys = Select (check) this option in order for offline locks to log the key's access events upon presentation as long as the key's memory is not full. When the key is used at an online lock, the event history is uploaded to Access It! Universal.NET. This requires the Audit openings in the key option to be enabled within the cardholders card screen.
    • Antipassback enabled = SALTO license dependent feature. Select (check) this option to enable the use of Antipassback (APB) and have the lock move a key from the inside to outside area. Ensures that a user cannot enter through the same door multiple times until they have first exited the door (or until a specified time period has passed). This is to prevent a key being used by a number of different users.
    • Outward antipassback = SALTO license dependent feature. Select (check) this option to enable the use of Antipassback (APB) and have the lock move a key from the outside to inside area. Ensures that a user cannot enter through the same door multiple times until they have first exited the door (or until a specified time period has passed). This is to prevent a key being used by a number of different users.
    • Update required - Indicates if an offline lock is pending an update. Updates require the use of the SALTO Portable Programming Device (PPD).
    • Battery status - Indicates the current battery status of the lock.
  8. Click Save 

Access Levels

Salto door access can be defined within a traditional Access Level. When assigning access the timezone list originates from the Cardholder Timetable's configured within SALTO ProAccess SPACE.

  1. From the Configuration menu, select Access Levels
  2. Either click New from the toolbar to create a new Access Level or Edit to modify an existing Access Level
  3. Select the Salto Doors tab
  4. Select the timezone to be used for all of the selected doors being assigned to the access level. Only one timezone can be selected at a time, so when doors are being assigned for different timezones, they must be selected individually or in groups by the desired timezone. To change a timezone for an assigned door it must be moved back to the available window, then re-assigned with the new timezone.
  5. Move the door(s) from the available pane to the assigned pane
  6. Click Save 

Cards

After a card has been created and configured it can then be encoded to a SALTO key using the SALTO card encoder. Any updates made to an existing key will require the card to be re-encoded or presented to an online door in order to reflect any changes. 

  1. From the Main menu, select Cards
  2. Find the Card to be encoded and select Edit from the toolbar to edit the card
  3. Within the Salto tab:
    • Key Options =
      • Override privacy - Allows the user access to a door that has been locked from the inside.
      • Override lockdown - Allows the user to open a door closed by lockdown.
        Applies to both online doors and offline doors that have AMOK locks
      • Set lockdown - Allows the user to enable or disable the lockdown mode on a door. This is done by presenting a valid key to the door’s inside reader.
        Applies to both online doors and offline doors that have AMOK locks
      • Office - Allows the user to set doors to Office mode.
      • Use antipassback - Ensures that a user cannot enter through the same door multiple times until they have first exited the door (or until a specified time period has passed). This is to prevent a key being used by a number of different users.
      • Audit openings in the key - Allows an audit trail of the user’s access point activity to be written to their key. If this option is disabled, the locks will not write any audit information to the key. You must also enable this feature on the required doors by selecting the Audit on keys option.
      • PIN code enabled - This allows a user entry to access points that require card and PIN code.
    • Key Expiration =
      • Calendar - Select Calendar to be applied to the key. Calendar must be created within SALTO ProAccess SPACE.
      • Enable revalidation of key expiration - Allows for automatic renewal of keys when presented an an online lock. The key will be renewed for the specified update period.
      • Update period - The amount of time the key will be renewed for when presented at an online lock.
    • Door/timezone access = Select the timezone to be used for all of the selected doors being assigned to the card. Only one timezone can be selected at a time, so when doors are being assigned for different timezones, they must be selected individually or in groups by the desired timezone. To change a timezone for an assigned door it must be moved back to the available window, then re-assigned with the new timezone. To assign a door move the door(s) from the available pane to the assigned pane.
  4. Click Save
    The card is now inserted into the SALTO database and can now be encoded.
  5. Edit the newly saved card 
  6. Select the Salto tab
    • Key Status = 
      • Assign Key - Initializes selected encoder. To encode a new key, present it to the SALTO encoder.
      • Update Key - Initializes selected encoder. To update an existing key, present it to the SALTO encoder. Card updates can also be applied by presenting credential to an online lock
      • Cancel Key - Deactivates current key. Key will continue to work at offline locks until presented at an online reader.
  7. Click Save

SCP Card Format (UBOX install)

When using a SALTO UBOX to send Wiegand data to a Mercury-Security panel the SCP requires the SALTO 45 bit card format to be added. This format is defined in this article: SALTO 45 Bit UBOX Card Format.


  • 571
  • 23-Jan-2019
  • 3293 Views