Console
The console is the developer’s web interface in the ClearBlade platform.
Purpose
You can create and configure systems, users, code services, data collections, triggers, and timers. You can also perform various operations related to analytics, and inspect MQTT messaging history.
Usage
The console is the developer’s web interface into the ClearBlade platform. From the console, you can create and configure systems, users, code services, data collections, triggers, and timers. You can also perform various operations related to analytics, and inspect MQTT messaging history.
Features
Side navigation panel
1 | The list of systems on the platform are available here. Clicking will also take you to the homepage. | |
2 | A system can be added by clicking the ‘Add’ button | |
3 | You can do a quick search of the documentation or IPMs here | ![]() |
4 | The information about console and platform is found here | ![]() |
5 | This will take you to the documentation homepage |
User settings
1 | This will take you to the ClearBlade Support Desk. | ![]() |
2 | This will take you to the details of the ClearBlade account creation. **This information is not editable. | ![]() |
3 | Change the account owner’s password | ![]() |
4 | Logout from the platform |
System
A system represents a backend for the web dashboard that needs a common system of record. It is the first item that must be created when a developer begins using the ClearBlade Platform.
To learn how to create and configure a system, click here
Settings Tab
Key | Description | Can be edited? |
---|---|---|
System Name | Unique name of system | Yes |
Description | Extra information about the system | Yes |
User Session Token | Amount of time a user’s token is valid | No, but can be copied |
Device Session Token | Amount of time a device’s token is valid | No, but can be copied |
System Key/System Secret | Required for every authentication request | No, but can be copied |
Change Secret Key | Connected clients will be disconnected from the system | No |
Access Tab
If it is desired to share this system with other ClearBlade Developers they may be granted access here. Ownership of the system can be changed as well. The override fields allow customization in the authentication and registration processes. The system can be deleted in the settings modal.
Sharing
Systems are designed in a way to be highly customizable. A System can be exported & imported. This allows scaling with ClearBlade to be very easy. Developers can create their own IPM package for other developers to use for their usecase.
Export a system from the system’s homepage to a new GitHub repository or download it as a zip file onto your computer. The system can be imported by CLI (recommended) or by creating a new system.