Device Cloud Platform
The Winter 2017 release provides functionality equivalent to that of the previous the platform.
The platform provides multi-tenant support through the use of organizations. Organizations have a hierarchy and all suborganizations of an organization have the same potential capabilities. However, the functionality available to individual organizations is configurable. Users can belong to more than one organization.
User names must be an email address, which ensures that each user is uniquely identified across the platform. The role (equivalent to a permission set) assigned to a user in an organization controls the functionality they can access on the Management Portal. A user can have different roles in different organizations.
The rules functionality, also referred to as automated responses, is implemented through cloud triggers. Rule conditions are equivalent to trigger events and rule responses are equivalent to trigger actions. Triggers are created through a graphical interface, which you can access from the Developer page on the Management Portal.
Alerts raised as rules are implemented as alarms. However, alarms have user-defined states instead of predefined states. Alarms are defined as part of the thing definition and can be updated (published) through a cloud trigger or an agent API.
To run a method on multiple applications, you use a campaign instead of selecting items from the Things page. You access campaigns from the Developer page on the Management Portal.
Data retention periods, including properties (telemetry) are configurable by the organization administrator. You can access configuration settings from the menu.
Applications and Things
There is no explicit representation of a physical device. Device Cloud manages applications, referred to as things, which may represent an entire device or part of a device.
Both device and cloud applications are represented as things and are accessed through the Things page on the Management Portal. Things are identified by a thing key, which must be unique across the organization. If multiple applications attempt to register with Device Cloud using the same thing key, registration fails.
Permission sets are implemented as roles. Permission sets previously applied only to users and cloud applications, whereas roles apply to users and all applications, including those that run on the device. An application defined in Device Cloud must have a role or administrator access, which is specified when the application is created on the Management Portal. Permissions for a device or cloud application are enforced based on the application token the application provides at registration time.
Logs
-
The system log functionality is implemented as event logs. Logs for the organization are accessed from the Developer page and for individual devices from the thing details page.
-
API logs are accessed from the Developer page.
-
Action (method) logs are accessed from the thing details page under the menu.
REST APIs
With the exception of remote login, the platform REST APIs have been replaced by the TR-50 service APIs. The API tester, accessed from the Developer page, replaces the interactive REST API reference. All APIs are accessed through a RESTful interface. APIs use token-based authentication instead of an API key.
The remote login REST API has been replaced by the remote access REST API, which provides equivalent functionality.
The following table lists the REST APIs and the corresponding TR-50 service APIs:
|
REST API |
TR-50 Service API |
|---|---|
|
Data Forwarding |
Third Party Services |
|
Device Actions |
Method Service, Mailbox Service |
|
File Management |
File Service |
|
Issues Management |
Not supported |
|
Rule Management |
Trigger Service |
|
Software Repository Management |
File Service, Method Service, Mailbox Service, Campaign Service (to update a group of things) |
|
System Logs |
Log Service |
|
System Management |
Thing Service, Search Service |
|
Telemetry |
Property Service (numeric telemetry), Attribute Service (string telemetry), Alarm Service, Location Service |
|
User Management |
User Service, Role Service |
For more information, see the Device Cloud Service API Reference and the Device Cloud Platform REST API Reference.