Skip to main content

Setup guide

  • Updated

This guide is intended for those responsible for the setup of the Kio Staff Safe app - a key phase in the Kio Apps deployment journey.

Prerequisites

To complete this setup, the following requirements are must be met.

  • Assigned User roles: You are assigned to the Administrator role for Staff Safe and Company Settings .

  • Infrastructure devices installed: This will vary by your deployment, but commonly includes the BLE to Wi-Fi gateways being either Kontakt.io Portal Lights or third-party BLE Access Points, and Beam Minis or Portal Beams for 100% room-level certainty.

  • Kontakt.io order claimed: The order with the Smart Badges is claimed in Kio Cloud Device Management 2.0.

Required setup tasks

We recommend completing the tasks in the following order.

Task

Related article

Create Staff Roles and Staff Groups and Add Staff 

  • Staff Roles: A categorization of staff that commonly mirrors the types of roles or positions within your organization.

    Staff Roles apply to metrics, can be assigned to Alert Rules, and staff are required to be assigned to a Staff Role. Staff Roles are the Entity Types within Company Settings.

  • Staff Groups (optional): An additional method to categorize staff.

    If your deployment requires the "average time to respond metric" that is computed by an alert's first responder, you will need to create Staff Groups. This metric requires responders to be added as Staff and assigned to a Staff Group and badge, and wear their assigned badge onsite at all times. A Staff Group is assigned to the Include Responder setting within Alert Rules.

  • Staff: Each person within your organization that will wear a Kontakt.io Smart Badge must be added to Kio Staff Safe.

    Staff are assigned to their Kontakt.io Smart Badge (tag), a Staff Role, and optionally a Staff Group. Staff will always be those that require the ability to activate a staff duress alert from their assigned Smart Badge. Staff will not have permissions to sign in to the Kio Cloud platform, which requires a User account.

    If your deployment includes the "average time to respond metric", that requires responders to also wear a Smart Badge they are required to be added as a Staff, and will also be added as a User that allows them to sign in to the Kio Cloud platform.

Note

Staff Roles and Staff can also be created and managed from the Kio Cloud Company Settings app. Within Company Settings, Staff Roles are Entity Types and Staff are Entities. For first-time setup, Kontakt.io recommends use of the Company Settings app.

Staff Groups are only managed from the Kio Staff Safe app.

Staff management

Create Alert Rules 

An Alert Rule defines when an alert is activated by a Smart Badge button press event including the blue, red, or any button, who the alert applies that identifies the staff wearing badges, the location including one to multiple Campuses and Buildings, and the alert notification recipients that identifies the responders. Based on the scope of your deployment, you may have one to multiple Alert Rules.

If your deployment includes sending alerts to a third-party system, you will also need to complete the Webhooks advanced setup.

Alert Rule management

Add Users 

A user is someone that requires access to Kio Staff Safe and the Kio Cloud platform. This includes those responsible for the Staff Safe setup and administration, who will be responding to staff alerts, and users that require access to metrics and analytics.

User access management 

Assign staff to their Kontakt.io Smart Badges 

Each badge has a unique MAC address and Unique ID that is linked to the staff assigned to the badge.

Staff badge management 

Onboard responders and users 

Responders are those responsible for responding to staff duress alerts. It's important for them to know how to respond to and manage staff duress alerts.

Users are commonly stakeholders interested in alert analytics and metrics.

Quick start guide 

Staff Safe web: Respond to and manage alerts 

Staff Safe Alerts mobile: Respond to and resolve active alerts

Onboard staff wearing badges for staff duress alerts 

It's important for staff to know how to activate an alert, how to properly wear a badge, and how it all works.

The Smart Badge button that activates an alert is dependent on your Alert Rules - that being either the blue, red, or any button.

Guide to activate a staff duress alert 

Advanced setup

This setup is dependent on the scope of your deployment and is completed from the Kio Cloud Company Settings app.

Company Settings: Room Management

If your deployment includes the tracking the status of staff by their real-time room locations, you will also need to set up Room Management within Company Settings.

Complete the tasks in the following order.

Task

Related article

Create Room Types

Room Types management

Create Room Type rules by Entity Types (Staff Roles)

Room type rule management

Match Smart Location rooms to their Room Type

Room Matching

Company Settings: Webhooks

If your deployment includes sending new alerts to a third-party system, this requires the set up of Webhooks. This is commonly performed by your IT staff or integration team.

Complete the tasks in the following order.

Task

Related article

Create and configure Webhooks

This task is commonly performed by your IT department or integration team.

Webhooks setup and management

Assign Webhooks to Kio Staff Safe Alert Rules

This results in alerts being sent to the third-party system configured within the Webhook.

Alert Rules and Webhooks

Related articles