Field | Description |
|---|---|
General | |
Name | Displays the app name. |
Partner identifier | Displays the app developer’s partner or group identifier. |
App identifier | Displays the app ID, typically the partner identifier, suffixed with the app name. |
Version | |
Version | Version of the app. The version must comply with semantic versioning (https://semver.org/), or an error will be displayed. The first digit displays the major version number. |
Built on | The Planon application version on which the app is developed. |
Platform API version | The Platform API version on which the app is tested and operates. |
Status | |
System status | The app status. When the installation of an app fails, both the status and this field is set to Failed. When installed successfully, the status is set to Inactive. |
App installation status | Indicates the app's installation status. |
Advanced settings | |
App account | Select the account associated with the app. This account might be required when the app executes functionality whereby no account can be retrieved (such as: the logged on user, the account that created a scheduled task, etc.). |
App log level | Indicate the log level for the app: • Debug (show debug, info, warning and error logs) • Info (show info, warning and error logs) • Warning (show warning and error logs) • Error (show error logs only) |
Auto-reactivate | Indicates if an app is automatically (re)activated when a rebuild / or a backup restore is done on a non-production environment. When restoring a backup from Production to Develop/Test/Acceptance, active apps are deactivated unless explicitly expressed otherwise in the app.json file (by the app developer). |
Field | Description |
|---|---|
Name | Displays the app's module name. |
App | Displays the app name. |
Field | Description |
|---|---|
Module configuration | |
App module | Displays the app's module name. |
Configuration | Displays the module's configuration. |
Module settings You can either toggle between View fields or View code. See also Module settings. | |
Settings | Displays the settings that are applied in the app. |
Settings schema | The type/format and constraints that apply for each setting that is present in the app (also which setting is mandatory). See also JSON-schema.org. |
Settings example | If a new version of the app containing new settings is introduced, this field is updated according to the new settings, which enables you to check which settings need to be filled out still. |
Multiline settings | Here, app developers can define up to 2 string settings to appear as a multiline text box in the 'Fields' view of the Platform app settings. |
Keep alive threshold | This setting is only available to Connect for IoT apps. The Keep alive threshold is a mechanism used to determine whether a device is still operational. The Planon IoT platform expects periodic pings from the device to confirm its operational status. The behavior of the platform depends on the value set for the Keep alive threshold: If Keep alive threshold = 0: The device is considered disconnected if no ping is received within 5 minutes. If Keep alive threshold= -1: The device is never marked as disconnected, even if no data or disconnection message is received. The device is only considered disconnected, if an actual disconnection message is received. If Keep alive threshold= n (where n is a positive integer): The device is considered disconnected if no ping is received within n + 1 minutes. For example, if the value is set to 10, the platform expects a ping or data within 10 minutes. If none is received, the device status is updated to Disconnected after 11 minutes. For all options goes that if new data is received, the device is considered connected. |