+ All Categories
Home > Documents > SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API)...

SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API)...

Date post: 01-Oct-2020
Category:
Upload: others
View: 0 times
Download: 0 times
Share this document with a friend
21
SERVICE SPECIFICATIONS & ADDITIONAL TERMS AND CONDITIONS CLOUD OF THINGS Last revised: 26.03.2020
Transcript
Page 1: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

SERVICE SPECIFICATIONS & ADDITIONAL TERMS AND CONDITIONS

CLOUD OF THINGS

Last revised: 26.03.2020

Page 2: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 2 of 21

PUBLICATION DETAILS

Published by T-Systems International GmbH

Hahnstrasse 43d

60528 Frankfurt am Main, Germany

WEEE reg. no.: DE50335567

Information required by law can be found at: www.t-systems.de/pflichtangaben

- hereinafter referred to as "Telekom" -

Copyright

© 2020 All rights reserved, including those of partial reproduction, electronic or photomechanical reproduction and evaluation by data processing methods.

Page 3: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 3 of 21

CONTENTS

1 Introduction ............................................................................................................... 5

2 Functions ................................................................................................................... 6

2.1 User management ...................................................................................................... 6

2.2 Usage data ................................................................................................................. 6

2.3 Own applications ........................................................................................................ 6

2.4 Dashboards ................................................................................................................ 6

2.5 Management of IoT devices ....................................................................................... 7

2.6 Displaying measurement data .................................................................................... 8

2.7 Threshold monitoring and alerts ................................................................................. 9

2.8 Remote software/firmware updates on IoT devices .................................................... 9

2.9 Smart rules ............................................................................................................... 10

2.10 Application programming interface (API) .................................................................. 10

2.11 Protocols for communication with IoT devices .......................................................... 10

2.12 Help & Service .......................................................................................................... 11

2.13 Developer tools, SDKs, and agents .......................................................................... 11

2.14 Functions of the Enterprise edition ........................................................................... 11

2.14.1 Subtenancy ............................................................................................................... 11

2.14.2 Custom URL ............................................................................................................. 11

2.14.3 Branding manager .................................................................................................... 12

2.15 Optional functions ..................................................................................................... 13

2.15.1 Data Broker ............................................................................................................... 13

2.15.2 Mobile network and WLAN localisation .................................................................... 13

2.15.3 Remote control ......................................................................................................... 14

2.15.4 Anomaly Detection .................................................................................................... 14

3 Services provided by Telekom .............................................................................. 15

3.1 Initial provision .......................................................................................................... 15

3.2 Place of performance ................................................................................................ 15

3.3 Operation of the servers and system components ................................................... 15

3.4 Data storage ............................................................................................................. 15

3.5 Availability ................................................................................................................. 15

3.6 Maintenance work ..................................................................................................... 16

3.7 Support ..................................................................................................................... 16

3.8 Modification of services ............................................................................................ 16

3.9 Optional services ...................................................................................................... 16

3.9.1 Sale of IoT devices ................................................................................................... 17

Page 4: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 4 of 21

3.9.2 Certification of additional/in-house IoT devices ........................................................ 17

4 Customer cooperation services ............................................................................ 18

5 Minimum provision period ..................................................................................... 19

6 Remuneration .......................................................................................................... 20

7 Glossary/list of abbreviations ............................................................................... 21

Page 5: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 5 of 21

1 INTRODUCTION

With the Cloud of Things (CoT), T-Systems International GmbH (hereinafter referred to as "Telekom") provides customers with a web-based application that can be used to register and manage compatible IoT devices and display and evaluate data transmitted by the IoT devices.

The following editions of the CoT are available:

▪ Smart – single CoT tenant ▪ Enterprise – tenant with the option of creating and managing subtenants,

plus additional data exchange and customization functions

Telekom also offers an optional selection of IoT devices that have been specially qualified for the CoT and are suitable for various applications.

Page 6: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 6 of 21

2 FUNCTIONS

The Cloud of Things has the following functions:

2.1 User management

The Cloud of Things has integrated user management. User accounts and user roles can be created, edited, blocked, and deleted. Rights can be assigned to the user roles. Users can change and reset their passwords independently using the self-service portal.

2.2 Usage data

The CoT enables usage statistics to be displayed for the current and previous months. The statistics include the following data: Number of registered users, number of registered devices, total number of API requests, number of API requests from devices, memory used.

Sample figure 1 – Administration application

2.3 Own applications

The Cloud of Things allows self-developed applications to be used in the client. The applications are either ready-made, modular components or are uploaded by the customer.

2.4 Dashboards

With the Cloud of Things, dashboards can be created for IoT devices. These dashboards can be compiled from pre-configured widgets or the customer’s own widgets in order to display measurements, alerts, and device positions at a glance.

Page 7: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 7 of 21

Sample figure 2 – Creating a dashboard

Sample figure 3 – Adding a widget

2.5 Management of IoT devices

The customer can register its IoT devices, view its inventory, and organize the devices into groups. The search function makes it possible to look for IoT devices in the system and

Page 8: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 8 of 21

localize them on the map view. For each IoT device there is a detailed view in which further information can be displayed.

Sample figure 4 – Registration of IoT devices

Sample figure 5 – Inventory of IoT devices

2.6 Displaying measurement data

All measurement data identified by IoT devices can be displayed and evaluated as a whole or filtered according to definable groups. All measurement data can also be downloaded or documented in a report.

Page 9: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 9 of 21

Sample figure 6 –Visualization of measurement data (example)

2.7 Threshold monitoring and alerts

Thresholds can be defined for sensor values (location, status) or events in the portal. Alerts can be set that are triggered when a threshold is exceeded; they are displayed centrally in the Cloud of Things portal. The status of individual alerts can be changed. Events or alerts can be included in email or text message notifications.

Sample figure 7 – Alarm overview of IoT devices

2.8 Remote software/firmware updates on IoT devices

Using this function, software or firmware can be transferred from the Cloud of Things to connected IoT devices provided the devices support this feature. The customer must first upload the required software to the Cloud of Things.

Page 10: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 10 of 21

2.9 Smart rules

Rules for thresholds, events, and established alerts can be set and configured using graphic smart rules.

Sample figure 8 – Adding a smart rule

2.10 Application programming interface (API)

The Cloud of Things provides an API for communication with third-party systems. All API services provided are based on REST (Representational State Transfer) using JSON (JavaScript Object Notation).

2.11 Protocols for communication with IoT devices

The CoT uses the HTTPS protocol for communication with IoT devices.

In addition, customers can connect IoT devices to the CoT that support the following protocols:

Protocol Function Standard/optional

Fieldbus protocols

The CoT uses an application to record data from IoT devices and control the devices using fieldbus protocols. The fieldbus protocols supported are: Modbus/RTU, Modbus/TCP, CAN Bus, CAN open, OPC UA, Profibus

Standard

MQTT The CoT has an adapter that supports MQTT-capable IoT devices as required.

optional

Table 1 – Supported IoT device protocols

Page 11: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 11 of 21

2.12 Help & Service

Telekom gives customers its Support contact details and provides selected developer and user documentation as well as technical documentation in English in the current version. The user documentation is also made available in German.

2.13 Developer tools, SDKs, and agents

Telekom has posted programming tools and programming examples for the CoT on: https://github.com/cloud-of-things

2.14 Functions of the Enterprise edition

Customers with the Enterprise edition have access to the following Cloud of Things features in addition to the functions of the Smart edition:

2.14.1 Subtenancy

Under the master tenant in the Enterprise edition, the customer can create and manage its own subtenants. The subtenants have their own rights models, separating them from each other and from the master tenant.

The administrator of the master tenant has access to the subtenants’ statistical usage information and can manage the subtenants’ data storage, as well as assigning applications to the subtenants and setting limits for IoT devices.

Sample figure 9 – Setup of a subtenant

2.14.2 Custom URL

The Enterprise edition allows a customer-specific URL to be set for the master tenant of the Enterprise edition. When the subtenants are set up, they are each given a prefix to the URL.

Page 12: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 12 of 21

Sample figure 10 – SSL activation in the master tenant

2.14.3 Branding manager

The appearance of the portal interface in the Cloud of Things can be altered using the Branding Manager. The colors and fonts, the logo, and the title of the browser tab can be customized for the CoT portal.

Sample figure 11 – Changing the branding

Page 13: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 13 of 21

2.15 Optional functions

The customer can also order the following product options for tenants in both the Smart and Enterprise editions. Customers can request the options from the relevant Account Manager and Telekom will then send them a proposal.

2.15.1 Data Broker

Using the Data Broker, data can be exchanged selectively between tenants. In the rights settings, each tenant can be configured as the sender or recipient of the following data:

• IoT devices (object master data)

• Events

• Alerts

• Measurements

• Operations

Sample figure 12 – Setup of a sending data connection

The Data Broker is included as standard in the Enterprise edition at no extra cost.

2.15.2 Mobile network and WLAN localisation

The mobile network and WLAN localisation allow the position of an IoT device to be determined using the mobile or WLAN network information that the device records and transmits. This allows a user to determine a position and display routes in the CoT without a device using GPS.

Page 14: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 14 of 21

2.15.3 Remote control

Remote control enables remote configuration and diagnostics of machines and devices, e.g., in the event of downtimes or support requests.

The CoT supports the following protocols:

▪ Virtual Network Computing (VNC)

▪ Secure Shell (SSH)

▪ Telnet

To use remote control, compatible IoT devices that are registered in the CoT are required.

2.15.4 Anomaly Detection

With the CoT, anomalies can be detected on machines and alerts generated. The anomalies are detected based on three pre-defined models (singular spectrum analysis, time series, and logistic regression) that are used for measurements of selected IoT devices. The customer itself can train the selected model; a data scientist is not required.

Sample figure 13 – Anomaly Detection

Anomaly detection is currently only offered as a pilot package.

Page 15: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 15 of 21

3 SERVICES PROVIDED BY TELEKOM

Subject to technical and operational feasibility, Telekom shall provide the following services:

3.1 Initial provision

Telekom will set up a CoT tenant as standard with an individual URL for the customer:

https://<customer domain>.ram.m2m.telekom.com

For access, the customer is given an administrator account for his tenant with an initial password.

The access data will be sent to the customer's email address. Upon sending of the access data, and at the latest upon use by the customer, the provision of the service is completed.

3.2 Place of performance

Telekom will provide the service from a data center in Germany.

3.3 Operation of the servers and system components

All servers and system components that are required for the operation of the Cloud of Things shall be operated in a technically and organizationally secure high-performance computer network in Germany. This network is protected from attacks and unauthorized access from the internet by a firewall system.

The computer network is connected redundantly to the internet via Telekom's internet backbone or by a company commissioned by Telekom at a transmission rate that is in keeping with the state of the art.

3.4 Data storage

Telekom will provide the customer with a tenant with a defined storage volume (pooled) for each registered device. Within the scope of the available storage volume, the customer can also define its own data storage rules. Once the storage volume is fully used up, the following storage management options are available:

Volume overflow (standard):

If the storage volume of the ordered package is exhausted, customers can still seamlessly occupy additional storage. Customers will incur additional costs for this excess.

Fixed storage volume (storage enforcement):

If the volume overflow is disabled, the oldest data records are automatically overwritten without warning as soon as the storage space defined in the storage package is used up.

3.5 Availability

The average annual availability of the Cloud of Things platform is 99.95% (calendar year). It is measured at the transfer point to the public internet (router output of Telekom’s data center).

Page 16: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 16 of 21

The following service disruptions are not considered downtime and are not taken into account when calculating availability (excused events):

a) Maintenance work b) Incidents, downtimes, and problems that are attributable to the customer, its

employees, or representatives c) Downtimes that can be traced back to third-party action (e.g., DDoS attack)

3.6 Maintenance work

Telekom carries out maintenance work at regular intervals. Should the maintenance work result in service disruptions, Telekom will notify the customer in advance. Telekom strives to keep impairments caused by maintenance work to a minimum. Maintenance work is not considered downtime and is therefore not taken into account when calculating availability.

3.7 Support

Telekom provides the customer with a Service Desk to report incidents in the Cloud of Things (in German and English). This service desk is available Monday through Friday between 8:00 a.m. and 6:00 p.m. (except on national public holidays).

Incidents can be reported by email or telephone using the following contact details:

Tel.: +49 800 58 88 532

Email: [email protected]

The contact details are also stored in the self-service portal.

The customer receives a confirmation of receipt via e-mail including an associated incident number. The customer will be informed when the support requests have been processed and closed.

3.8 Modification of services

In its implementation of the Cloud of Things, Telekom uses technical solutions, the features of which are subject to continual development and review. If technical modifications are made to individual features of the Cloud of Things or individual features are no longer available, the changes must also be incorporated into the contract with the customer. Telekom will inform the customer and avert any disadvantages for the customer insofar as this is technically feasible. Service modifications carried out by Telekom will generally not be charged to the customer. In the event of unjustifiable economic costs of the modifications, Telekom shall be entitled to terminate these partial services. If the modifications cause significant restriction to one of the individual services for the customer, the customer may terminate these parts of the contract.

3.9 Optional services

The following optional services can be ordered by the customer for a separate charge. When requested from the responsible account manager, Telekom will submit a corresponding offer.

Page 17: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 17 of 21

3.9.1 Sale of IoT devices

Telekom will sell the customer devices from Telekom's hardware portfolio. These IoT devices are qualified for CoT and suitable for various use cases. The current list of qualified hardware is available online:

https://iot.telekom.com/de/produkte/iot-hardware

Telekom is continuously expanding its certified hardware portfolio for CoT and is coordinating this with the manufacturers.

3.9.2 Certification of additional/in-house IoT devices

By agreement, Telekom will integrate additional hardware into the CoT and carry out hardware certifications for the customer.

Page 18: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 18 of 21

4 CUSTOMER COOPERATION SERVICES

The customer undertakes to cooperate in order to ensure provision of the required services; in particular, he is obligated to provide the following, free-of-charge, on-time, and to the required extent:

a) The customer will complete the CoT data entry form provided by Telekom completely and accurately and send it to the contact person of Telekom named in the proposal.

b) Telekom will provide the customer with password-protected access to the self-service portal. The customer is obligated to keep passwords and access data secret, not to disclose them to unauthorized third parties, protect them from third-party access, and change them when necessary. The customer is to inform Telekom without delay of any suspected disclosure to non-authorized third parties.

c) Telekom does not back up data. The customer is solely responsible for downloading all of the data and information saved in the Cloud of Things onto its own storage media and making backup copies. Telekom will delete the access and all data stored in the Cloud of Things upon expiration of the contract without notifying the customer beforehand.

d) The customer undertakes to use the server-side interfaces (APIs) of the Cloud of Things to a generally acceptable extent. Telekom reserves the right to block access to the CoT if excessive access and requests are discovered that cause the platform to be overloaded to the disadvantage of other users.

e) The customer guarantees it will not introduce content containing malicious codes or other malware into the Cloud of Things or process such content in the Cloud of Things.

f) The customer ensures that his use of the service does not cause any risk or impairment to third parties and/or Telekom. In the event of such risk or impairment (e.g., due to a DDoS attack), Telekom will be entitled to deactivate the service concerned, without prior notification of the Customer, until the risk or impairment has been remedied. Any resulting downtime will not be taken into account when calculating availability. Telekom will keep the customer informed.

g) The customer guarantees that connected IoT devices have a valid SSL certificate with TLS encryption supported for the Cloud of Things.

h) Telekom reserves the right to change the TLS encryption in line with technical advances and security standards. The customer must make appropriate changes to its devices to ensure the devices can continue communicating with the CoT.

i) When using the Enterprise edition, the customer creates and manages subtenants on its own responsibility. In this context, the customer creates subtenants only to a reasonable extent, i.e. only if a subtenant is required for a contractual use. Empty and / or unused subtenants are to be deleted by the customer at regular intervals. The customer is responsible for using the desired domain address and the associated certificate when using a custom URL.

j) The lines needed to use the Cloud of Things, stable internet connections, and the equipment required on the customer's premises (software and hardware) are to be provided by the customer itself.

k) The customer is responsible for ensuring that its users are instructed on how to use the CoT.

l) The customer must ensure that only inquiries that relate to Telekom's services and for which Telekom is responsible are addressed to Telekom's technical support.

m) The customer will eliminate errors in the customer's configuration settings and any operating errors.

n) The Cloud of Things supports the functions for sending text messages. To activate this service, the customer must enter into a separate contract with the default text message service provider.

o) Where required for customization and configuration work or support requests, the customer will provide Telekom with the appropriate rights for accessing the CoT.

Page 19: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 19 of 21

5 MINIMUM PROVISION PERIOD

The CoT has a minimum term of 24 months, starting from the date of service provision.

The service may be terminated with a notice period of 6 (six) calendar months with effect from the end of the minimum provision period for the first time. Otherwise the respective minimum provision period will be extended automatically by twelve (12) months and may then be terminated in writing by giving at least three (6) months' notice with effect from the end of the relevant renewal term.

In the event of termination of the contract before expiry of the minimum rental period, the provisions of the contract will continue to apply until such time as this service is terminated.

All notices of termination must be submitted using the customer-specific URL.

Page 20: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 20 of 21

6 REMUNERATION

See attached "Cloud of Things" price list.

Page 21: SERVICE SPECIFICATIONS & ADDITIONAL TERMS ... - IoT …2.10 Application programming interface (API) The Cloud of Things provides an API for communication with third-party systems.

Cloud of Things Last revised: 26.03.2020 Page 21 of 21

7 GLOSSARY/LIST OF ABBREVIATIONS

Term Description

Agent Software component that enables an IoT device to be connected to and communicate with the CoT.

API Application Programming Interface

Child devices

Child devices are downstream systems in a cascade of IoT devices; they communicate with the CoT via an upstream IoT device. Child devices are registered as separate IoT devices in the CoT and their assignment to the upstream IoT device is displayed in the CoT.

CoT Cloud of Things

Dashboard A website whose content the user can design by arranging widgets.

DDoS Distributed denial of service (DDoS) is an overload of an internet service caused by an enormous number of requests, mostly intentionally.

Fieldbus Fieldbus is the name of a family of industrial computer network protocols used for real-time distributed control (e.g., Modbus RTU/TCP, CAN bus, and OPC UA).

HTTPS Hypertext Transfer Protocol Secure

IoT Internet of Things

IoT device

IoT devices are used to collect measurement data. The term refers to a hardware component that either has sensors (e.g., GPS) directly installed or can be connected directly or indirectly to the sensors and enables data transmission via mobile radio, based on mobile radio chipset technology. IoT devices can communicate with the CoT either directly or as part of a device cascade (→ Child devices).

JSON JavaScript object notation

M2M Machine to machine

MQTT Message Queue Telemetry Transport – message protocol for machine-to-machine communication.

REST Representational State Transfer – data transfer protocol

Tenant A tenant is a customer-specific area in the CoT. Data storage for each tenant is independent of each other. The customer manages his tenant and the access rights to devices, data, and functions under his own responsibility.

URL Uniform Resource Locator. Identifies and localizes a resource such as a website by the location of the resource and the access method to be used.

VNC Virtual Network Computing – input and output of the user interface of machines via remote access.


Recommended