Symmetry Otis Integration Installation and Users Guide
Symmetry Otis Integration Installation and Users Guide
Otis – Symmetry
Integration
Installation and Configuration
Symmetry Custom
Solutions
Page 1 of 23
Installation and Configuration Manual
Section 1 Overview
The Symmetry – Otis Integration allows Otis elevator access using Symmetry access control and
hardware. The complete solution consists of a Windows Service running on the Symmetry
database server that monitors various type of requests, and generates Otis elevator commands,
and a Configuration and Administration interface that allows you to specify the properties and
behaviour of the integration.
1.1 Terms
DEC - Destination Entry Computer is the Otis touch screen or keypad that the user
interacts with. Equates to Symmetry readers.
DET - Destination Entry Terminals is the Otis touch screen or keypad that the user
interacts with. DET and DEC are used interchangeably.
DEAS – Destination Entry Server is the OTIS controller. It is equivalent to Symmetry
Nodes.
Access to floors is given to Symmetry card holders via floor group definitions, including time
code, holiday and advanced access rights. Multiple definitions can be given to a card holder and
the sum of floor access will be sent to Otis.
OTIS device status (DEC/DEAS offline/online) is also monitored and reported in Symmetry.
Page 2 of 23
Installation and Configuration Manual
In rare cases, the license maintenance window may pop up sometime in the future, with the indication that
the license has become invalid. This can occur due to perceived changes in hardware, including network
addresses and disk drives. If this become a problem, contact Symmetry Professional Services. Some
applications can create virtual networks dynamically, for example. Professional services can provide a
work-around that can be added to the registry to limit the hardware components used for licensing
purposes.
If the license is valid, the application will attempt to connect to the Symmetry database. If it is unable to
find the Symmetry database, it will ask you to tell it where the database resides.
Page 3 of 23
Installation and Configuration Manual
Use the connection wizard (the '...' button) to specify connection string components (database address,
connection information). When complete, press the 'test' button to confirm that the connection string is
valid. Press the OK button to save the connection information.
Note: The application will attempt to write the connection information to configuration files read by both the
Configuration Manager and the Windows service. Depending on your PC configuration, login account and
the running state of the service, the configuration manager may ask you to manually copy some files.
Exit and restart the Configuration Manager to pick up the updated connection definitions.
To add a DEAS, start with a blank form (press Clear if necessary). Create a name and enter in the ‘DEAS
Name:’ field. Type in the primary IP address for that DEAS. If a backup DEAS will be used, check the
‘Backup DEAS IP’ checkbox and add the backup’s IP address. If online/offline events associated with this
DEAS should be reported to Symmetry using Monitor Points (requires Symmetry 8.1 or greater), select a
Monitor Point from the dropdown list of previously defined Symmetry monitor points. Click the Add button.
The new DEAS will be displayed below in the DEAS definitions grid.
To Update DEAS information, double click the DEAS to be updated in the DEAS definitions grid. The ‘Add’
button will be changed to
‘Update’. Make changes as
desired and press Update.
To Remove a DEAS
definition, highlight the
DEAS to be removed in the
DEAS definitions grid and
click the ‘Remove’ button.
If there are any DECs
linked to the DEAS, a
notification will inform the
user that the DEAS can’t be
removed until the DECs are
removed.
The Connect button can be used to access the selected DEAS Otis native scheduler. Due to compatibility
issues between the OTIS scheduler and Windows Internet Explorer, the scheduling interface may not be
displayed properly. It is recommended to Contract OTIS support to have them enter your schedules, or use
Symmetry scheduling by checking the Symmetry Control of DEC Mode and Schedules box on the
System Setting tab. Symmetry scheduling uses Symmetry floor group schedules to control one or more
OTIS DECs. Refer to Sections 2.6, 2.7 and 4 of this manual for more information.
The Timeout value determines how long the Symmetry Interface will wait for a response from the DEAS. If
the integration service doesn’t receive a response from either the primary or backup DEAS within this
number of seconds, a DEAS Offline message will be sent to Symmetry. To update, enter a new value in
the textbox and press the Update Timeout Period button.
Page 4 of 23
Installation and Configuration Manual
If Symmetry scheduling is being used, you can set the elevator mode by appending the text MD<#> to the
DEC name to indicate mode as follows:
MD1 - Mode 1 – Seamless Entry: Automatically select the 'default' floor, as specified in
Symmetry's cardholder personal data field (as defined on the Special Features page).
MD2 - Mode 2: Requires credentials for access. If the credentials are accepted, the user may
select any floor they have access to (as defined by the floor groups assigned to the cardholder
and current DEC schedule).
MD 3 - Mode 3 (default): Allows the user to enter a floor on the elevator terminal. If the floor is
not publically accessible, the terminal will ask for user credentials (access card). This is the
default if the dec name does not end in MD#.
MD4 - Mode 4: The user must present credentials for elevator access. The terminal will allow
the user to select a floor, but if none is specified within a period of time, the elevator will
assume the 'default' floor, as specified in the cardholders personal data field in the Symmetry
database.
To update an existing DEC, double click the DEC from below and make the changes to the data populated
above. Click the Update button to save the changes.
To remove a DEC, select the DEC from the grid and click the Remove button.
Page 5 of 23
Installation and Configuration Manual
The Floor Group Access Map page configures the floors accessible to cards assigned the corresponding
floor group. In Symmetry,
the floor group must be
defined, but does not need to
have any data associated
with it. It simply serves as a
place holder, to allow card
access to the floors defined
on this page. Select the
Floor Group Access Map
tab to add/view/change floor
group to OTIS floor
associations.
Select the floor group from the ‘Symmetry Floor Group’ drop down list at the top of the form. The
floor groups in the list are pulled from Symmetry. Select a floor group to see the existing mapping.
Specify the DECs to which the floor group applies. Select one or more DECs from the ‘All DECs
List:’ and press the '>>' button. The DEC name is copied to the 'Assigned' list. To remove a DEC,
select the DEC(s) in the Assigned list, and press the '<<' button.
Specify the floors that are given free access when this floor group is assigned to a cardholder.
Click the ‘>’ or ‘<’ buttons located between the ‘Available Floors:’ and ‘Floors Assigned:’ list boxes,
to move a selected floor into or out of the floors assigned. Click ‘>>’ or ‘<<’ to move all floors into
or out of the floors assigned. Use the upper set of buttons to enable 'front' doors, the lower set of
buttons to enable 'rear' doors.
Click the ‘Save Mapping’ button to save the definition.
To use Symmetry scheduling and control of elevators, first create Symmetry virtual reader definitions
(including an auxiliary outputs for each floor), and floor group(s) within Symmetry (see Section 4 of this
manual). Create schedules using these floor groups and auxiliary outputs in Symmetry. Map the auxiliary
outputs to Otis floors using the Floor Group AUX Output Map page.
Page 6 of 23
Installation and Configuration Manual
Select a floor group from the dropdown, or by clicking on the floor group (bold text) in the reference tree.
The list of associated auxiliary outputs is displayed. Enter the floor (-127 to 128) and side (F for front or R
for rear) in the respective columns. Changes are written to the database as they are made.
Changes may not be immediately propagated to the reference tree. Press Refresh to update the tree to
include any changes made to floor mapping or made in Symmetry since the tree was first displayed.
When Symmetry scheduling is used, a floor group (and its associated schedule, trigger and command
center operations) may be applied to one or more OTIS DECs.
For example, if floors that become 'public' at specific times of day are 'public' from all DEC kiosks in the
building, the floor group used in the Symmetry schedule would apply to all OTIS DECs. All items on the
Apply to DEC list would be checked.
In other cases, a company occupying multiple floors may want their floors to be 'public' only to users
already on one of the company floors, in which case the corresponding floor group would only be assigned
to that company's DECs.
Select the Floor Group Schedule Map tab to assign Symmetry floor groups to OTIS DECs.
Page 7 of 23
Installation and Configuration Manual
Select the OTIS DECs to apply this floor group by placing a check in front of the DEC name in the Apply to
DEC list. Press Check All or Clear All buttons to check or clear all DECs. Press the Save button when
complete.
Before defining which PDFs are associated with given special features, the Personal Data must be defined
in Symmetry. In the Symmetry software, select Setup/Personal Data/Card Holder Titles. Define a
Personal Data Card Holder Title for each special feature to be used for card holders. The ‘Field Type’
should be set as ‘List Only’.
The Default Floor PDF is
mandatory. All other options are
optional, and may be omitted from
PDF Title definition if the feature will
never be used.
In the ‘Symmetry Otis Access Integration’ application, click the ‘Special Features' tab.
Page 8 of 23
Installation and Configuration Manual
Local IP Address: Enter the IP address that the Otis interface should answer to. The address must be an
address on the machine running the service.
Local IP Address 2: Performs the same function as the first IP Address. A separate heartbeat thread
listens for OTIS heartbeat messages on this address in addition to the first IP address.
Symmetry Control of DEC Mode and Schedules: Check this box to enable Symmetry control of
schedules and operating modes. If checked, the elevator mode is determined by the DEC name, and the
free/secure state of each floor is determined by Symmetry schedules (or as overridden by Command
Center actions or triggers).
Use Symmetry Readers for Access: Check this box to have Symmetry readers at the Kiosks. Uncheck if
cards are to be presented to OTIS readers. When OTIS readers are used, Symmetry 8.1 or greater will
generate standard Symmetry 'access granted' events. The integration software is unable to distinguish
whether these events came from a Symmetry reader, which should be forwarded to Otis, or from an OTIS
Page 9 of 23
Installation and Configuration Manual
reader. This setting allows the integration software to determine the original of access events, and behave
accordingly.
Verbose Logging: Check this box to include additional information in the log files. Uncheck during normal
production operations.
Press Save to save the setting changes. With the exception of the Verbose setting, the service must be
restarted to pick up new settings. The interface will ask if you want it to re-start the service.
Click the refresh button in the bottom left corner to populate the drop down list with log files.
Select a log file and click View Log File to open the file and review any errors that have occurred with
either the service or the application.
Select a log file and click Delete File to delete the file. A new one will be created the next time a log event
occurs.
Note: If using a firewall, certain UDP Sockets must be open. Contact Symmetry Professional
Services to get a list of required open sockets.
The service runs in multiple threads, each responsible for different functions.
From the OTIS DEAS: Process heartbeat, access credentials and security messages. The SOIS
looks for a heartbeat from all defined DEASs. If there are no heartbeats (primary or backup server)
within the defined timeout period, it creates an offline message in Symmetry. Access credentials
received are matched to Symmetry credentials, and the access rights (floor group & time code) are
used to determine the valid floors, default floor and special features to be returned to the
appropriate OTIS DEC.
From Symmetry: Card access events are monitored. If an access grant is found from a reader
whose name matches a DEC name, then the corresponding DEC is sent the valid and default floor
and special feature information derived from that card. If Symmetry is controlling schedules, then
scheduled events and operator events (command center operations) are also monitored and
processed.
From the OTIS DEC: Processes acknowledgements of data received (if not acknowledged, the
message is resent up to 3 times). Receives 'floor selected' messages for logging into Symmetry
transaction history table.
Heartbeat: The SMS Otis integration service sends a continuous heartbeat to a multicast address.
Page 10 of 23
Installation and Configuration Manual
When settings are changed in the ‘Otis Integration Configuration Form’ that are only loaded into the service
during start up, the service will be restarted automatically. Running the application as an Administrator
gives you this ability.
The service account must have permissions to query the multiMAX database, write to the multiMAXImport
database, and be a SysAdmin to the multiMAXProServices database.
Page 11 of 23
Installation and Configuration Manual
This section reviews user-configuration scheduling options available from the Otis-Symmetry interface.
Scheduling allows you to define how the elevators behave (whether access cards are required to select a
particular floor) on specified days and times. For example, you can program the elevator to allow anyone
to access a specified floor during business hours, but require access cards to be presented during non-
hours.
Note that Otis engineers have many more options than available from the Interface software. If you need
additional functionality, or have other issues, contact Otis Elevator.
3.1 Overview
The following step-by-step procedure should be followed to schedule the Otis Elevator access behaviour.
For example, we use a 2 tenant building containing company A and company B. Company A, who
nd
occupies the 2 floor, allows anyone to access their floor Monday – Friday from 8 a.m. to 5 p.m..
rd
Company B occupies the 3 floor, and allows free access Monday – Friday from 6 a.m. to 6 p.m.. At all
nd rd st
other times, access to the 2 and 3 floor is allowed via an authorized card only. The Lobby (1 floor) is
always publically accessible.
The example needs to be specified in terms of accessible floors during time periods as follows:
Time Floor publically available
12 a.m. – 6 a.m. All days 1
6 a.m. – 8 a.m. Mon - Fri 1, 3
8 a.m. – 5 p.m. Mon - Fri 1, 2, 3
5 p.m. – 6 p.m. Mon - Fri 1, 3
6 p.m. – 12 a.m. All days 1
Page 12 of 23
Installation and Configuration Manual
A browser window will be opened and populated with the Scheduler window.
The scheduling window contains a column for Standard Day, which is applied to all days of the week, and
columns for each day of the week. Data entered into the individual day columns will override the Standard
Day definition.
Give this scheme a name that will identify it on the Compass Device Schedule window. The name must be
at least 5 characters.
Assign a Mode, which defines how the user credentials (access card) is used for elevator access.
Mode 0 - Unconfigured/Secured: All users have access to all floors. No credentials required.
Page 13 of 23
Installation and Configuration Manual
Mode 1 – Seamless Entry: Automatically select the 'default' floor, as specified in Symmetry's
cardholder personal data field (see Symmetry Otis Integration Operation guide).
Mode 2: Requires credentials for access. If the credentials are accepted, the user may select any
floor they have access to (as defined in Symmetry cardholder record and the Symmetry Otis
Integration Configuration).
Mode 3: Allows the user to enter a floor on the elevator terminal. If the floor is not publically
accessible, the terminal will ask for user credentials (access card).
Mode 4: The user must present credentials for elevator access. The terminal will allow the user to
select a floor, but if none is specified within a period of time, the elevator will assume the 'default'
floor, as specified in the cardholders personal data field in the Symmetry database.
Check the box labelled Audit Support to allow elevator access to be recorded in the Symmetry events
database.
Select any value for Tone (if editing a pre-existing scheme, leave the value unchanged).
The Allowed Floors box is used to specify which floors have public access during the period this scheme
is applied (exceptions to the specified mode). Place a check next to each floor that should have public
access during time periods when this scheme is allowed.
Press Save when the scheme definition is complete. Use the 'X' button
We assign a scheme to a time period from the from the Compass Device Scheduling Window. Position the
cursor on the block on the grid where the period should start, and click.
The Timeslot Details window is displayed. This window will display all the 'fixtures' (elevator terminals)
defined for the elevator.
Page 14 of 23
Installation and Configuration Manual
Give this timeslot details item a name (the name will show on the schedule grid). Using the slider beneath
the name, adjust the start and end times. The body of the details window will contain a definition for each
Fixture (elevator terminal) defined.
It is not recommended to make any changes from the 'Hardware' or 'Template' options. Doing so may
make your elevator terminals unusable (for example, you may select to format the display to a size that
doesn't actually fix in the display you are using).
In most cases, you will want the same scheme to apply to all fixtures. Press
the +Apply button next to the newly assigned time period scheme. The
Apply Settings to ... window will be displayed.
Select each fixture you want the scheme applied to (or press the Select All
button to check all fixtures). Press the Apply button. The Timeslot Details
window will be re-displayed, this time with the scheme name next to the lock
icon on all the selected fixtures.
Press the Save button on the Timeslot Details page to implement the
timeslot scheme mappings.
To copy a slot from one day to another, position the cursor on top of the timeslot in the Compass Device
Scheduling window, and click to edit.
Page 15 of 23
Installation and Configuration Manual
Press the Copy key and select the destination day from the window.
You can create Special Day schedules by pressing the button from the
Compass Device Scheduling window.
Enter the name for this 'special day'. The name must be at least 5
characters.
Enter the dates the special schedule should start and end.
The new Special Day will be displayed on the Special Day Config
Schedule window. Select the special day by positioning the cursor on
the name a clicking. You can now assign a mode to the hours in the
same way you assigned a mode to normal time slots (see section 2.5).
The Special Day Config Schedule will display the name with its timeslot schedule.
Page 16 of 23
Installation and Configuration Manual
In order to allow Symmetry to create and manage schedules for the Otis elevators, you must define 'virtual'
nodes, panels, readers and auxiliary outputs in the same way you would if Symmetry hardware was
controlling an elevator. The difference in this case is that the panels are never enabled, and that a single
Symmetry reader definition can be applied to multiple OTIS kiosks (DECs).
Page 17 of 23
Installation and Configuration Manual
Page 18 of 23
Installation and Configuration Manual
Page 19 of 23
Installation and Configuration Manual
Note: To enable Symmetry control of schedules, ensure the option Symmetry Control of DEC Mode and
Schedules on the System Settings tab is checked.
Using the OTIS Configuration Manager, specify the DECs that will be affected when a schedule, trigger or
Command Center operation references the floor group. Normally, the floor group schedule will be sent to
ALL DECs, and all DECs will be checked on this page.
Page 20 of 23
Installation and Configuration Manual
Check/uncheck a DEC if it should not respond to access requests in the same way as other DECs. For
example, you might have a single DEC at the lobby desk that allows the attendant to grant access to any
floor, potentially overriding a user's assigned access rights. In this case, a separate floor group would be
created and assigned to a schedule that has free access to all floors at all times. This schedule would be
assigned to just this one DEC (the lobby desk DEC would be checked on this page, and all others
unchecked).
Use the Otis Access Monitor to view the status of each floor of a selected DEC. Note that the display
reflects the last access map sent to the OTIS system. Offline DECs generally revert to 'free' access.
Start the Otis Access Monitor using the Start menu item or desktop icon.
Page 21 of 23
Installation and Configuration Manual
Expand the tree in the window on the left side, and select the DEC you want to view.
The floor grid displays the free/secure status of each floor to a user at the selected DEC. In the illustration
above, a user at DEC named 'dec 1.2 MD3' would be able to select floors 0, 1, 2, 4, 5, 6 and 7 (in addition
to any floors authorized by the individual's card access rights).
Display Floors minimum and maximum boxes can be used to remove unused floors from the
display.
Front and Rear radio buttons determine whether the display shows front or rear elevator doors.
Polling Interval determines how often the monitor checks for display updates. You can update at
any time by pressing the Refresh button.
Database connection string is used to run the monitor from a location other than the Symmetry
server. Use the ... button to bring up the connection string wizard, which allows you to specify the
location of the Symmetry database server. The status box next to the connection string must
display OK to get an accurate floor status display.
Page 22 of 23
Installation and Configuration Manual
Section 5 Installation
5.1 System Requirements
Symmetry Enterprise V7.0.1 (or greater) Standard Edition
Microsoft SQL 2008 or greater
Microsoft .NET 4.0 Framework
Windows 2008 or greater.
The installation must be run from an account with privileges to create new databases in SQL Server.
Current versions of Windows does not grant this privilege to users in the Windows administrator group. If
the MultimaxProServices database cannot be created, a popup window will inform you during the
installation, but the installation itself will not fail. Database creation may also be performed by the
Configuration Utility. If database creation fails during installation, just be sure to run the
Configuration utility from a account with full sysadmin rights to SQL Server before starting the Otis
Interface Windows service.
Page 23 of 23