Documentation

Project settings

Aside from the specific settings for subjects and metrics there are also general project settings. These settings can be found under the general section in the settings menu. On this page you can find what the settings are about.

General

The general settings apply for each and every person in the project. So, changing the Theme will result in a Dark or Light theme for everyone. This is what you can set:

Field Description
Name The name of the project so you can easily find it among your list of projects.
Timezone The timezone of the project. Be aware that dates are always displayed in the timezone of the project which might differ from the timezone of your computer.
Description (optional) You can add a description to tell (new) project members what your project is about.
Theme You can choose a Dark or Light theme, cool right?

Leave project

You can remove yourself as a member of the project. Be aware of the fact that you will lose access to the project right after you’ve hit the button ‘Leave project.’ If you want back in, you will need someone else to invite you to the project.

Transfer project

This action can only be executed by the Owner of the project. As an owner of the project, you can transfer the project to someone else within the project. Especially useful when want to give someone else responsibility for the project when you are on a holiday or a well-deserved sabbatical of 3 months.

Remove project

This action can only be executed by the Owner of the project. As an owner of the project, you can remove the project and all its resources. This is a dangerous action, so be very, very, very careful with this action.

Here is an example of the General settings of the Blockbax Playground project:

Project settings

Roles

Roles give control on what kind of access you grant to the members of your project. From default roles to fine-grained custom roles, it’s all configurable at the project settings.

Default roles

Each project comes with default roles with fixed permissions. The permissions for these roles are the ones we see most often.

Role Permissions
Owner Full access
Administrator Full access but no possibility to remove a project or transfer ownership
Expert Read-only, with write access to event triggers and notification settings. No access to project settings and usage
Observer Read-only, with only write access to own notification settings. No access to project settings and usage

Custom roles

Custom user roles can be used to define more fine-grained permissions for your members compared to the default roles.

Configurable permissions
Resource Permission Filter(s)
Dashboards View, Edit, Manage All or include certain dashboards
Event triggers View, Edit, Manage All or include certain event triggers
Properties View, Edit All or include certain properties
Subjects View, Edit, Manage All, include and/or exclude certain subjects
View, edit and manage

The platform provides three permission levels.

Level Permission
View The resource is only viewable (read-only) for this role
Edit The resource is viewable and editable (write access) for this role
Manage The resource is viewable, editable, creatable and removable for this role
Important to keep in mind:
  • On a dashboard the resource access to event triggers, properties and subjects is still applied. Consequently providing just dashboard permission has no effect when the user has no permissions to the underlying resources.
  • To edit a resource you need to have at least view permissions to the other resources used. For example in order to edit an event trigger you need to have at least view permissions to the subjects in scope and/or properties used.
  • Editing subjects applies only to its properties where the user has edit permissions to.
Include and exclude subject permissions based on properties

The behavior of including and excluding subjects based on a property differs from selecting individual subjects.

Filter type Result
Include The user gets access to the subjects that match all properties
Exclude The user gets no access to the subject that matches one of the properties
Non-configurable permissions

Some resource permissions underlying certain sections in the interface are not configurable, but are derived or only accessible via system-defined roles.

Section Permission Explanation
Subject types Derived All subject types are viewable that are related to the subjects you have access to
Events Derived Events are visible for the subject(s) and event trigger(s) you have access to
Notifications Derived Notifications are constrained to the subject(s) and event trigger(s) you have access to
Explorer Derived You can always use the Explorer for the resources you have permission to
Usage Owner and admin only The default owner and admin role have permission to this section
Project settings Owner and admin only The default owner and admin role have permission to this section

Here you see a Blockbaxer creating a custom role.

Creating custom role

Members

Member management empowers you to keep an eye on the people and their permission in your project. At this part of the platform you can easily invite new people for your project, change roles for your project members and remove an account from the project.

The owner of a project can create an invite link in the members section. This makes it easy to invite people to the project without knowing and typing in their email-addresses.

People that use the invite link to join the project will automatically get the observer role.

The invite link can be revoked by the owner. The invite link is invalid after revoking and can not be used anymore. The owner can always create a new one, but never activate an old one again.

Properties

Properties can be used to label subjects. This is what you need to configure when adding or editing a property:

Attribute Description
Name Give the property a descriptive name so you can easily recognize and find it.
Data type Choose whether the value of the property is of the type text, number or location.
Values Provide pre-defined values or let project members come up with values they want.

Access tokens

Access tokens are needed to authenticate with our APIs. You can easily create one by giving the token a descriptive name to easily recognize and find it. Next, you can set the permission to constrain the person or system on what it can do with your data. Once created, you have to copy the token information and use it straight away, because you won’t be able to see it again.

Permissions Description
Full access Full access, the token can be used to read and write all data
Measurement writer Partly access, the token can be used to write new measurements.
Read only Read-only, the token can be used to read the data.

Like the members permissions, it is possible to specify the subjects where the Measurement writer and Read-only token have access to.

Here you see a Blockbaxer creating an access token with specific subject permissions.

Creating access token

Webhooks

Webhooks are developed to send events to other systems in real-time. You can see it as a reversed API: provide your endpoint and the platform makes sure you get the events you are interested in once they occur. The following information needs to be present to make use of the webhook.

General information

Field Description
State Active or Inactive
Name A descriptive name to recognize and find your webhook
Endpoint The URL where the platform needs to POST the events to.
Authorization header Provide an optional header to authorize the webhook for your external system

Event levels

Here you can select the event levels for which the webhook should be called. For example, you might only want to see Problem and Warning events being send to your external system.

Event triggers

Here you have some filter options to only have the webhook called for certain event triggers.

Subjects

Here you have some filter options to only have the webhook called for certain subjects.

The structure of the JSON message that is sent to the endpoint and more details can be found in the integrations section of the docs.

Configuring webhooks