Console
The console is the developer’s ClearBlade Platform web interface.
Purpose
You can create and configure systems, users, code services, data collections, triggers, and timers. You can also perform various analytics-related operations and inspect MQTT messaging history.
Features
Side navigation panel
![](../__attachments/2343796752/sidenav.png?inst-v=00a7a7be-0508-4b6c-9dbe-8063c38bb43c)
Panel item | Description | Screenshot |
---|---|---|
1 | The platform system list is available here. Clicking it will 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 | Console and platform information is found here. | ![]() |
5 | This will take you to the documentation homepage. |
User settings
![](../__attachments/2343796752/user_settings.png?inst-v=00a7a7be-0508-4b6c-9dbe-8063c38bb43c)
Panel item | Description | Screenshot |
---|---|---|
1 | This will take you to the ClearBlade Support Desk. | ![]() |
2 | This will take you to the ClearBlade account creation details. This information is not editable. | ![]() |
3 | Change the account owner’s password. | ![]() |
4 | Log out from the Platform. |
System
A system represents the web dashboard’s backend that needs a common record system. The first item must be created when a developer begins using the ClearBlade Platform.
![](../__attachments/2343796752/System_Diagram_FINAL.png?inst-v=00a7a7be-0508-4b6c-9dbe-8063c38bb43c)
Settings tab
Key | Description | Can it be edited? |
---|---|---|
System Name | The system’s unique name | Yes |
Description | Extra system information | Yes |
User Session Token | Amount of time a user’s token is valid | No, but it can be copied |
Device Session Token | Amount of time a device’s token is valid | No, but it can be copied |
System Key/System Secret | Required for every authentication request | No, but it can be copied |
Change Secret Key | Connected clients will be disconnected from the system | No |
Access tab
ClearBlade developers may be granted access here if it is desired to share this system with them. System ownership 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 to be highly customizable. A system can be exported and imported. This allows scaling with ClearBlade to be very easy. Developers can create their IPM package for other developers to use for their use cases.
Export a system from the system’s homepage to a new GitHub repository or download it as a ZIP file onto your device. The system can be imported by CLI (recommended) or by creating a new system.