2.0 System Overview
Borealis is Keri Systems' Cloud-based access control solution. Borealis gives you
complete control of your system from any computer, tablet or mobile device that
has a web browser and an active internet connection. Borealis does not require a
dedicated PC, no software needs to be installed or updated - but you will always
be running the most up-to-date version. If you have multiple site locations (even
in different parts of the world), these can all be added to the same system and
administered from the single user login account.
The person who creates the new system is automatically the system owner and
has full administration rights. The system owner is also the only operator who
can make a payment for the Borealis subscription. System ownership can,
however, be transferred to a different operator.
Borealis is extremely easy to learn and so there is minimal training requirements.
This quick start guide walks you through the basics of getting a standard system
up-and-running for the first time.
The system supports up to 32 doors and 10,000 credentials per hub (50,000
credentials per system). The system is also compatible with the NXT Exit readers
(when using the Keri-MSC controller type).
3.0 Setup a New Operator Account
For a new installation, the first step is to setup a new account.
Note: The designated system owner and anyone else who will be using Borealis should also register a new Borealis account via the following steps.
- Go to: http://keri.aetheros.net
- The log in window will appear.
- Click on 'Don't have an account? Sign Up'.
- Enter your new Borealis account details.
- Place check marks to confirm you have read the EULA and you agree to the
master subscription agreement. - Click the REGISTER button in the lower-right corner of the form.
- You will see a notification that the new user is created.
- Go to the inbox of the registered e-mail address and you will see a verification email message.
Click the link to verify your registered e-mail address.
- Once verified, you will be able to log into the Borealis web portal.
Note: If you do not receive a verification e-mail, please call sales on 1-800-260-5265 and press #1 for someone in the sales team to verify you.
4.0 Create an Organization
Borealis requires you to create an Organization for registering tax exempt status and it simplifies the management of multiple systems/installations. The following steps explain how to create a new Organization that is tax exempt (so that SaaS tax is not applied to the Cloud subscription payments).
Important Note: Setting up an Organization must be done before setting up a system to ensure the correct price model is applied to your cloud subscription. You can call anyone in Keri Systems Sales department directly at 1-800-260-5265 (ext 1) from 9am EST-8pm EST after submitting your request to expedite your approval.
- Open a web browser and go to: keri.aetheros.net.
- Enter your registered e-mail address (user name and password) and click LOGIN.
- The Create Systems screen will appear.
- Click Organizations (listed on the left).
- The Create Organizations screen will appear.
- Click the CREATE button located in the upper-right.
- The Create Organizations form will appear.
- Enter a name for the new Organization.
- Enter a contact name for the Organization.
- Enter a contact phone number for the Organization.
- Place a check mark to confirm the Organization is a dealer/reseller.
- Place a check mark in the tax exempt status check box. If you are not tax exempt do not check this box.
- Enter the tax ID for the Organization.
- Enter any additional notes for the Organization.
- Select the Organization country from the drop-down list.
- Select the Organization state for the organization (where applicable).
- Enter the Organization's ZIP/Post code.
- Enter the Organization's street address.
- Scroll to the bottom of the form to locate the Supporting Documents section. Click the CHOOSE FILE button and locate a tax exempt status document for your Organization (the document must be either a .PDF, a .jpg or a .png file).
- Click the SAVE button.
- You will see a notification that the Organization is created.
- Return to the organization screen and you will see that the new Organization is pending.
- After the organization information has been submitted it will take up to 1 business day for the review process to be complete.
Note: You can also call anyone in Keri Systems Sales department directly at 1-800-260-5265 (ext 1) from 9am EST-8pm EST after submitting your request to expedite your approval.
- Once the Organization has been approved, the owner of the Organization will then be able to edit and add users to the Organization.
- Once your Organization is showing as approved you can then create your first system.
Important Notes:
- Any additional organization users should be added prior to setting up systems.
- Only the organization owner has the rights to add additional organization users.
- You MUST wait for the organization to be approved before setting up a new system.
5.0 Create a New System
Every Borealis installation will require a 'system' to be added. Currently, the initial
system is created and authorized by Keri Systems and at this point the system owner
is also defined.
To create a new Borealis system, call one of the following numbers:
- If based in the USA - +1-408-435-8400
- If based in the UK - +44 (0) 1763 273243
- If based in Latin America - +52 333 826 9113
IMPORTANT NOTES:
- You will need to provide your registered e-mail address, the name of your
Organization and a name for the new System. - If you are based in the US, only your initial system setup will need to involve Keri's sales team. Your operator account can be configured by the sales team to allow you to create new systems yourself in the future.
- If you are based outside of the US, it is not currently possible to make credit card payments directly from the user interface. You will need to call the
appropriate sales team to make your initial payment. - The system installer/technician should be added as an additional operator with the 'Super' operator role. This will give the installer the rights to add and configure new hardware but they will not receive billing information or invoices.
5.1 Confirm the System Owner
Once the system has been setup by inside sales you will need to provide the name of the system owner. This may be the installation company or the end user. The system owner is the only operator who has the ability to view the shopping cart and to pay for hardware. The system owner will also receive invoices and system renewal notifications.
5.2 Confirm your Preferred Payment Method
The system owner can choose one of the following payment methods:
- Account Credit
- Organization Credit
- Credit card payment via the user interface
If Account Credit or Organization Credit is the preferred method, this credit will need to be purchased via the sales team.
6.0 Add a New Site
Once your system is added you will then be able to create and add a new site. Every Borealis system requires at least one site. The site determines which hardware type will be used and you can add up to 32 doors to a site. Any system that will have more than 32 doors will require an additional hub to be added.
A site may represent a business location, a floor of a building or any other grouping of hardware. The requirements for a site are as follows:
- Each site will need a physical hub - IMPORTANT: See hub setup explained in the next two sections to determine how many hubs will be needed.
- All controllers on a site must be of the same hardware family, e.g. Keri-KB, Keri-NXT or Keri-MSC). However, multiple hubs for different hardware types can be part of the same system.
- A site must have a world timezone selected (and all controllers on the site will use this world timezone).
You can add up to 32 doors to a site - any system that will have more than 32 doors will require an additional hub. The hub counts controller reader ports, not the number of readers/doors actually in use.*
- Multiple sites can also be connected via a Virtual Private Network. This will allow “one” hub to be used for up to 32 doors and one hardware type if connected with a VPN.
*IMPORTANT NOTES:
- If you are not the system owner and you are not using all the reader ports on the controller you will need to let the sales department know which ports on which controllers are not being used when it is time to pay for your subscription. See the payment instructions (section 10.0).
- If you are the system owner, and have the permission to make subscription payments, you can exclude a reader from the subscription via the Readers screen. Use the reader's Action menu and select 'Remove from Subscription'.
- From within Borealis, click on the Sites main menu item.
- The Sites screen will appear.
- Click the CREATE button (located in the upper-right).
- The Create Site form will appear.
- Enter a site name.
- Enter a contact name for the site.
- Enter a contact phone number for the site.
- Select the specific hardware type that will be used with this hub.
- Select the country where this hub will be located.
- Select a specific world timezone for where this hub will be located.
- Place a check-mark in 'Enable Keypads' if keypads will be used on the site.
- Click the SUBMIT button and the new site will be created.
- The next step is to connect a hub and add it to the site.
7.0 Connect a Hub
IMPORTANT NOTES:
A hub provides the communication link between the Cloud and the access control hardware. The hub does not require any configuration – it is pre-configured to obtain a DHCP address from an internet-enabled network (the same network that the controllers will be connected to) via a hard-wired Ethernet connection.
- Power-up the hub.
- Use an Ethernet network cable to connect the hub to the internet router/hub or to a switch.
- The hub will obtain a DHCP address and will connect to the internet.
- The controllers will also connect to this same network. (The Keri-MSC and
Mercury controllers are also configured, by default, to obtain a DHCP address).
- Once connected and online (to the internet), the hub will be ready to add to Borealis.
8.0 Add a Hub
The next step is to add the Borealis hub to the system. The hub is the physical device that provides a communication bridge between the Cloud and the field hardware. The hub must be connected to a DHCP network that has an active, unrestricted internet connection. The hub should be added to the same network that the controllers are connected to.
8.1 Add a hub to the site
- From within Borealis, click on the Hubs main menu item.
- The hubs screen will appear.
- Click the CREATE button (located in the upper-right).
- Enter a name for the hub.
- Enter the hub GUID (this will be printed on the outside of the hub.
- Enter the hub PIN (this too will be printed on the outside of the hub).
- Click the SAVE button.
- You should see a notification at the top of the screen that the hub has been claimed.
8.2 Wait for the Hub to Update
Important Note: It is important to wait 2-3 minutes for the hub to perform its initial update. Failure to wait for the update to complete may result in not being able to scan for controllers.
The hub will begin updating a few seconds after it comes online. While the hub is updating, the status will display 'Update Started'.
The status will continue to display 'Update Started' for a few minutes. Wait until the status displays 'Update Completed'. A few moments later the hub will show as online.
Click on the name of the hub - this will display the hub information screen. Ensure there is information showing in the 'Updated On' section:
The next step is to add controllers to the system.
9.0 Add a New Controller
The process of adding a controller to Borealis is very similar for all supported controller types.
Notes:
- Keri-MSC or Mercury controller will obtain a DHCP IP address from the network. But once added, these controllers can then be assigned a static IP address. Refer to the individual controller setup guides at borealis.kerisys.com to find out how to assign a static IP address to these controller types.
- Keri NXT and Keri KB controllers do NOT use DHCP IP address assignment and will need to be factory reset before they can be added via auto-config. The Keri KB and Keri NXT controllers will need to be assigned a static IP address which is in the same range of the hub's IP address. Click on the hub name to view the hub details and note the IPv4 address (as highlighted).
- Keri NXT and Keri KB controllers can co-exist on the same site and can communicate with the same hub.
9.1 Scan for the controller
- From within Borealis, click on the Hubs main menu item.
- The Hubs screen appears and the hub should be online.
- On the right-side of the screen you will see an Actions drop-down list, select Scan.
- Or you can click the SCAN button.
- The scan function will search the network for controllers.
- Once the scan is complete, all detected controllers will be displayed in a list. Keri-MSC controllers will be assigned a DHCP address and Keri NXT and KB controllers will NOT be assigned an IP address. All new controllers should be displayed as unassigned.
Note: All controllers must be given a unique name.
- Place a check mark against each controller that will be claimed, enter a name for the controller, enter an IP address (if using Keri NXT or KB controllers).
- Click the CLAIM button in the upper-right.
- You should see notification at the top of the screen that the controllers have been successfully claimed.
IMPORTANT NOTE: The subscription for the readers must now be paid for - see next section.
10.0 Pay for the Hardware
Note: Payment for the hardware subscription can only be made by the system owner. If you are not the system owner; payment will have to be made by contacting Keri Inside Sales.
- Log into Borealis as the System Owner.
- Click the shopping cart icon located in the upper-right.
- A summary of items that need to be paid for will be displayed.
- Check the box to confirm you have read and agree to the reseller agreement.
- If you have enough account credit or organization credit this will be used to pay for the pending items.
- If you do not have enough account credit or Organization credit you will see a credit card payment form appear.
- Enter your credit card details then click the SUBMIT button.
Important Note: The credit card that is used to make the initial payment will automatically be used when the system comes up for renewal.
11.0 Setup a New System Operator
IMPORTANT NOTE: - To add a new operator account you must ensure the new
operator e-mail address is already registered with a Borealis account (and the account must also be verified via the welcome e-mail in their inbox).
11.1 Register an Account for the New Operator
- Open a web browser and go to: keri.aetheros.net
The Borealis log in window will appear.
- Click on 'Sign Up' (located beneath the SIGN IN button).
- Enter all the details for your new account (Note: all fields are required). Your registered e-mail address will be your account user name.
Place a check mark to confirm you have read and agreed to the end-user license
agreement (EULA) and the master subscription agreement.
- Click the REGISTER button.
You will see a notification that the new user is created.
- Go to the inbox of the registered e-mail address and click on the verification
e-mail. You will see a message that user verification is complete.
- Once verified, you will be able to log into the Borealis web portal:
keri.aetheros.net.
11.2 Add the New Operator Account
Note: - For security reasons the user name (e-mail) and password are both case-sensitive. Please ensure your email (user name) is entered ALL IN LOWERCASE characters.
- Return to: keri.aetheros.net.
Log in with the system administrator account.
- Click Operators from the main menu on the left.
Click the INVITE button (located in the upper-right corner of the operators screen).
- A window will appear for you to enter the new operator's e-mail address.
Select a operator role to assign to the new operator (for example; Super)
- editing the operator role is covered in the next section.
- Click the SAVE button.
You will see a notification at the top of the screen that the new operator has been added.
11.3 Editing the Operator Role/Permissions
The operator roles determine what areas of the user interface operators are able to access and administer after they have logged-in. By default, there are five different account roles but additional account roles can also be created.
Note: You will not be able to set a new operator with the Installer role.
Typically after a system installation has completed, the end user may then want to be added to the 'Super' role (or to a newly created role).
The following steps explain how to edit the permissions for the 'Super' account type.
- From the main menu click Operator Permissions.
The list of existing operator roles will appear. The default roles are: Owner, Super, Installer, Operators Manager and Sites Manager.
- Use the Action drop-down list for the Super operator role and select Edit.
The edit operator role form will appear - along with a list of all the possible permissions that can be applied to the role.
Note: The form also allows you to edit the name of this operator role and you can also add a description.
- Place a check mark against each of the permissions that should be applied to this role.
Note: There are certain options that, when enabled or disabled, will also enable or disable other associated permissions. For example: If you enable cardholders - create, this will automatically enable cardholders update and delete - at the same time this will also apply the same options for credentials - (because you need to be able to access cardholders when adding or editing credentials). The opposite is true when these options are disabled. Any option that you enable Create, you will also automatically enable Update and Delete for that option.
When you have selected all the options to apply to this role, click the SAVE
button.
- The operator role permissions will apply for the next time the operator logs into Borealis and will also be applied to every other operator which is assigned this role
12.0 View the Hardware Status
You can view the status of hardware by going to the respective pages. For example:
- Click on the Hubs menu item and the hubs on the system will be displayed.
- Click on Hardware >> Controllers to display controllers on the system.
- Click on Hardware >> Readers to view all the readers on the system.
- Click on Home - Various hardware status information is also displayed on the dashboard.
13.0 Controller Functions and Settings
13.1 Controller Functions
- From Borealis, click on the Hardware >> Controllers menu item.
- A list of all controllers on the system will be displayed.
- On the right-side of the screen locate the Actions drop-down menu. The
following options will be displayed:
- Edit - Allows you to access all the controller settings.
- Delete - Allows you to remove the controller (use with caution).
- Flash - Allows you to upgrade the firmware on the controller. Live events will display when a firmware upgrade is required.
- Sync - Allows you to sync the Cloud database with the controllers database (if you believe database changes may have been made while the controller was offline).
Note: The PXL controller type has two sync options (sync and full sync). Sync will send out to the controller only the most recent changes that were made and is not often used. You should use sync if you are not sure if a change has been successfully sent out to the controllers (for example, if there was an internet disconnection). Full sync is required for certain changes (such as adding or removing doors from access groups). A full sync should also be performed if changes were made while controllers were offline.
- Reset - Allows you to perform a basic memory reset on the controller. The controller will retain its network settings but its memory will be cleared and a total network update will be performed on the controller.
13.2 Controller Settings
- From the controller Action drop-down menu, select Edit.
- The controller settings window will appear.
- Description - Allows you to enter a new name for the controller.
- Enabled - Allows you to quickly toggle between enabling and disabling the
controller.
Note: a disabled controller will immediately go offline.
- Download Cardholders Without Access - Downloads all cardholder records to the controller - regardless of their access rights.
- Latitude and Longitude - Not applicable for general access control.
- Connection Control - Determines if the controller will automatically come back online if the connection is lost.
- IP Address - The controller's programmed IP address (DHCP address in the case of NXT-MSC controllers).
- Port - the TCP/IP communication port used by the controller (default values are 3001 for NXT-MSC controllers).
- Password - Not currently applicable in Borealis.
- Poll Delay - The delay between communication polls.
14.0 Reader Functions and Settings
The reader's screen and the reader's Action menu items allow you to access the
functions and settings that are available for that reader type. The following explains the basic reader functions and settings. Other options become available when certain
features are enabled (such as Card + PIN).
14.1 Reader Functions
- From Borealis, click on the Hardware >> Readers menu item.
- Place a check mark against the reader you wish to use.
- Lock - Allows you to re-lock a door that is currently unlocked.
- Unlock - Allows you to unlock a door that is currently locked.
- Temp Unlock - Allows you to temporarily unlock the door (based on the reader's strike time).
- Card & PIN, Card or PIN and PIN Only buttons become available when card + pin is enabled on the system. Note: Only the Card + PIN mode is supported when using Keri KB or Keri NXT controllers. Card or PIN and PIN Only are only supported when using NXT-MSC controllers.
14.2 Reader Settings
- From the reader Actions drop-down menu, select Edit.
- The reader settings window will appear.
- Description - Allows you to change the name of the reader.
- Enabled - Allows you to toggle between the reader being enabled and disabled.
- Keypad Enabled - Enable this option if the reader has a keypad. Required for Card + PIN.
- Auto Unlock Schedule - Assign an auto-unlock schedule to configure the door to unlock and re-lock at specific times of the day.
- Default Online Mode - This is the mode that the reader will go to if the controller goes offline or if it is memory reset. Typically this option is used with Card + PIN to ensure Card + PIN remains in force. The default setting is for the door to be 'Locked' - requiring a valid card read at the reader.
- Enable Door Contact - Enables the door contact monitoring for the reader - the reader will go into alarm state if the door is held or forced open.
- Strike Timing (max) - Is the amount of time the door will unlock following a valid card read from a standard cardholder.
Strike Timing - DDA - Is the amount of time the door will unlock following a valid card read from an ADA/DDA cardholder.
- RTE Disable Schedule - Allows you to define a time schedule when the RTE will not be functional for this door.
15.0 Setup Time Schedules
The Borealis system uses Time Schedules in access rights – to determine when cardholders are able to gain access. They are also assigned to doors as auto-unlock time schedules – to determine when doors will automatically unlock and re-lock. This setup guide will explain how to setup a time schedule for Monday to Friday between the hours of 06:00 and 18:59.
Note: A time schedule can consist of multiple intervals.
15.1 Add a New Time Schedule
- From the main menu on the left, select Schedules. For a new system you will see two default schedules (Always and Never) - these are non-editable.
Click the CREATE button on the right side of the screen.
- The Create Schedule form will appear.
Enter a description for the new schedule.
- Select the site that the schedule will apply to.
The schedule mode will default to 'Scan' - this will ensure the schedule uses the
schedule intervals to determine when it should activate and de-activate.
- The Enable check box will be checked by default.
15.2 Add a New Time Interval
The next step explains how to add an interval to the schedule. The interval determines a time of day and day of the week that the schedule will be active and inactive.
Note: a maximum of 12 intervals can be assigned to a schedule.
- On the create schedule form, click the ADD INTERVAL button. The interval
settings will appear on the schedule form. - Use the clock icon to select a start time for the interval (this determines when the interval will become active). For example 07:00. Or you can click Now to begin the schedule at the time that is set on the client PC.
- Click the SET button to set the start time.
- The end time will default to 23:59... use the clock to set a different end time (this determines when the interval will become inactive). For example 18:00.
- Click the SET button to set the end time.
- Click inside the Day of Week field and you will see a list of all the days of the week. Place a check mark against all the days that you wish the interval to be active. The selected days of the week will appear as a list inside the Day of Week field.
- Click inside the Holidays field and you will see a list of 8 available holiday types. Select the holiday types that will be active on this time interval.
Notes:
- The holidays must already be setup and configured.
- When a holiday is active on an interval that means the interval will be ACTIVE on the dates which are selected in the holiday setup. If a holiday is not selected then the interval will NOT activate on the holiday dates.
- Click the SAVE button to save and create the schedule and interval.
The schedule form will close and the new schedule will appear in the schedule list.
- If you require more than one interval for the schedule, place a check mark against the schedule name, select Edit from the Action drop-down list on the right and then click the ADD INTERVAL button again (located at the bottom of the create schedule form).
16.0 Setup Access Rights
The following steps explain how to setup access rights. Access rights are then assigned to credentials to determine when and where a cardholder will be able to gain access.
Notes:
- Unless the access groups will use a 24/7 time schedule you should also ensure the
relevant time schedules have been setup. - If your Borealis System has multiple sites, you will need to assign multiple access rights to cardholders (if access is required for doors located across different sites).
- From the main menu on the left, select Access Rights.
Click the CREATE button on the right.
- Enter a description for the new access right.
Select the site that the access right will apply to.
Click NEXT.
- Select readers to be added to the access right (or use TOGGLE to select all).
Note: Clicking the TOGGLE ALL button a second time will de-select all readers.
- Click NEXT.
Use the Apply to All drop-down list to select a time schedule and then apply that schedule to all readers. Or you can select a specific time schedule to apply to readers individually.
- Click SAVE to create the new access right.
The access rights can now been assigned to credentials or used an an auto-unlock schedule (to automatically lock and unlock doors).
17.0 Enroll a Cardholder and Credential
Cardholder and credential enrollment is a very simple process. Manual Enrollment involves manually enter the card details (imprint and facility code) or the full card number. The system supports manual enrollment of Keri MS, Keri NXT, 26-bit Wiegand card formats and RAW Wiegand card numbers.
Borealis uses an enrollment wizard to walk you through adding a cardholder, assigning a credential to that cardholder and then assigning access rights.
Notes:
17.1 Enroll the Cardholder
- From the menu on the left, click on Cardholders.
- For an existing system, a list of existing cardholders will appear.
On the right-side of the screen, click the CREATE button.
- Enter a first name.
Enter a last name.
- Place a check mark in the Never Expire option or set an activation date and expiration date if the cardholder will be temporary.
Note: If enrolling a temporary cardholder the calendar will default to selecting today's date.
Select the 'Use Extended Timing' option to apply an extended unlock time for the cardholder.
Note: The extended timing option is not supported on PXL controllers.
- Select the 'Different Access Groups per Credential' if the cardholder's credential will use different access rights. If unselected, all assigned credentials will have the same access rights.
Click Save & Next.
17.2 Enroll the Credential
(Following on from the previous section)...
- Select the card format that you wish to enroll.
Enter the credential's imprint (this is the number printed on the credential).
Enter the credential's facility code (if applicable). The facility code field will not appear if it is not required.
- Select a card status.
Click Save & Next.
18.0 Assign Access Rights
The following steps explain how to assign access rights to credentials. It assumes that
cardholders and their associated credentials are already enrolled.
Note: A newly enrolled credential will appear at the top of the credentials list.
- From the main menu, click on Credentials.
- If you have a large credential database, click on the filter icon located at the top of the Cardholder column.
- Begin typing in the Cardholder name - entries matching filter criteria will begin to display.
When you have located the record you wish to edit, place a check mark in the box next to the name and click the FILTER button.
- The credential record for that cardholder will be displayed.
Place a check mark to the left of the credential number and then click the EDIT ACCESS RIGHTS button.
- Use the drop-down-list to assign an access right to the credential.
Note: Borealis also gives you the option of mass-assigning access rights to a
selection of credentials/cardholders.
19.0 Reader Control
Reader Control allows you to lock, unlock or temp unlock any door on the system.
A temp unlock will unlock the door for the same duration as following a valid card read.
You can send remote lock and unlock commands to a single door or multiple doors.
- From the Borealis main menu, select Hardware >> Readers.
A list of all readers will appear.
- Place a check mark against the reader that you wish to lock or unlock.
Note: You can also select multiple readers to be controlled.
On the right-side of the screen, use the Action drop-down menu and select Lock, Unlock or Temp Unlock.
- Alternatively, click either the Lock, Unlock or Temp unlock button (located above the list of readers).
- The reader(s) will respond to the command almost immediately.
20.0 View Live Events
20.1 View Live Events
Borealis provides a live events screen which displays all the system transactions in real-time. Events such as: Access granted, access denied, door open, door forced open, door unlocked, etc along with their associated time stamp and location. Live events are displayed on a per-site basis. Once connected to a site, all events generated by that site will be displayed in the live events grid.
- From the main menu on the left, click on Live Events (at the bottom of the list).
If you only have one site, live events will immediately start appearing from the site immediately. For multiple sites you will need to select the appropriate site from the drop-down list.
- System events will appear immediately as they are generated by the system.
20.2 View Only Specific Event Types
- You can use the event types menu filter to display only specific events:
- Locate the Messages Types drop-down menu. By default it is set to display all
message types. - Use the drop-down list to select a specific event type. For example; you may wish to only view 'Access Granted' messages.
Note: If you click on a different menu item and then click back on Live Events, the message type filter reverts back to the default of displaying all message types.