Skip to content

Policy Foundry

Introduction to Policy Foundry

Policy Foundry is a smart tool that allows you to set up rules that can trigger actions. Policies can be related to multiple factors such as beacons battery level, button click, telemetry data, positions, or even occupancy. You can either create rules from scratch or create new ones based on already created ones.

Important

Please note to create a policy you need to have actions already created.

Policy List

Go to Policy Foundry

Policy list allows you to see all your configured policies, their IDs, Names, descriptions and statuses. You can edit already configured policy

Add a policy

Click on Add Policy button, system will display a prompt asking if you would like to create a policy from the scratch or a policy based on an already configured one. Click on Create from scratch.

Add policy name and description

The first step is to set a policy name and description. Always use names that allows you to find the correct policy easily. For the porpouse of this guide, we will describe a scenario when room occupancy exceeded its maximum value.

Define schedule

You can define a schedule for the policy. The policy can be always active, active on specified days, or active for specified time range.

Select participating devices

Depending on the use case, you can create a policy that will be valid for all devices or only specified ones.

Set location

The next step is to select the location for your policy. You can either choose any location or select a specific location. You can select a location, building, floor or even room. Note, that after you choose a location level, you are obligated to operate only in this level. For example, when you choose one building you can't select rooms, only another building.

Set conditions

Now, configure the conditions for your policy. Conditions specify what needs to happen for your policy to trigger an action.

Available policy conditions

Condition types Parameters
Beacon Signals Low battery
High battery
Button click
Telemetry Low temperature
High temperature
Bad air quality
Low humidity
High humidity
Positions Exit location
Enter location
Occupancy Room occupancy exceeded
Room occupancy not reached

Click Add Condition, select occupancy, choose above or equal.

After you've selected the type of condition, specify the max occupancy for the room to 6.

Set an action

The next step is to select an action that needs to be taken when the policy is triggered. Click Add Action and select a previously created action from drop down list.

Policy coordinator

Policy coordinator allows you to set a limiter that limits the amount of messages sent in a specified time duration to certain numbers. Depending on the use case, you can choose values that are suitable for the particular policy. Another useful feature of policy coordinator is an aggregator that collects all messages for a specified amount of time and sends them as one message.

Introduction to Actions

Action are used to communicate to users policy violations. In order to assign an action to a policy, you need to create an action from the policy creation wizard. There are multiple channels of communication to send notifications.

Streams

You can configure AWS Kinesis or Azure Event Hub as a target of notifications sent from Kio Cloud.

AWS Kinesis

When configuring AWS Kinesis data stream following parameters are required to be provided:

  • Endpoint
  • Stream name
  • Access key
  • Secret key
  • Region
  • Forced partition key

Learn more about AWS Kinesis

Azure Event Hub

When configuring AWS Kinesis data stream the following parameters are required to be provided:

  • Endpoint
  • Shared access key name
  • Shared access key
  • Event Hub name

Learn more about Azure Event Hub

Emails

Another communication channel you can use is email.

  • Set email notification a name
  • Add recipients
  • Set subject of the email

Email notifications support parameters to provide additional information based on the policy they are connected to. From the text field type in a dollar sign ($) or click Insert Parameter.

Parameters supported include:

  • Battery level
  • Company ID
  • Occupancy
  • Occupancy limit
  • Previous room ID
  • Room ID
  • Temperature
  • Threshold
  • Tracking ID

Warning

Be careful when configuring emails, try to avoid the situation where the condition is true for long periods of time.

A particular notification can be sent only once a minute.

Text Messages

You can also use text (SMS) messages to notify users.

  • Name
  • Add recipients

Similar to email notifications, text (SMS) notifications also support parameters to provide additional information based on a policy they are connected to. From the text field type a dollar sign ($) or click Insert Parameter.

Parameters supported include:

  • Battery level
  • Company ID
  • Occupancy
  • Occupancy limit
  • Previous room ID
  • Room ID
  • Temperature
  • Threshold
  • Tracking ID