The Getting Started section describes how to access and log into the Cumulocity IoT platform and will walk you through basic functionalities applying to all Cumulocity IoT applications.
Accessing and logging into the Cumulocity IoT platform
You access the Cumulocity IoT platform via a web browser.
Our products have been tested with the following desktop web browsers:
- Edge Browser
- Internet Explorer (latest version)
- Firefox (latest version)
- Chrome (latest version)
Info: Cumulocity IoT is fully functional on Internet Explorer 11. However, layouts may not be perfect in all cases.
You may also use recent smartphone and tablet web browsers. We have tested our products with the following mobile web browsers:
- Chrome on Android (latest version) on Galaxy smartphones and tablets
- Safari on iOS (latest version) on Apple iPhone and iPad
Info: Cumulocity IoT on mobile devices shows some limitations:
- The usage may be constrained by the memory and the processing power available on the devices. For example, loading graphs with large amounts of data points may make the mobile device unresponsive.
- Using the private mode on browsers may not work.
- Apama Analytics Builder (an optional component) does not support mobile/ touch devices.
To access the applications for your Cumulocity IoT tenant, use the following URL:
This will direct you to the login page of your default application. See Tenants > Tenant ID and tenant domain in the Reference guide for further details on tenant ID and tenant domain.
Info: The above URL is only valid for Cumulocity IoT Standard Tenant subscribers. For Enterprise Tenant deployments of Cumulocity IoT, the URL is specific to your organization.
Important: Make sure that the address bar of your browser shows a lock icon. The lock icon indicates that you are using a secure connection and that you are indeed connected to the Cumulocity IoT platform.
On the Login screen, enter your username (case-sensitive) and password and click Login to enter the application.
Select the Remember me checkbox if you want the browser to remember your credentials, so that you do not have to enter them again when opening the application the next time. This is also convenient if you frequently switch between Cumulocity IoT applications, as the Cumulocity IoT platform will request you to authenticate each time when starting an application. You can make the browser “forget” your credentials by explicitly logging out.
When you log into the Cumulocity IoT platform for the first time, you will be taken to the default application (usually the Cockpit application if not configured differently).
To explicitly logout, click the User button at the right of the the top bar and from the context menu select Logout.
- Click the Forgot password? link on the Login screen.
- In the resulting dialog box, enter your email address and click Reset password.
- Check your email account for an email from the Cumulocity IoT platform support providing a password reset link.
- Click the link in the email and provide your new password.
Info: The password reset link is only valid for one day.
Info: The automated password reset will only work if your email address is stored with your Cumulocity IoT user. If you get a warning that the password cannot be reset, you are either using a different email address than the one stored with your Cumulocity IoT user, or your Cumulocity IoT user has no email address stored. In either case, contact a Cumulocity IoT administrator in your organization. Administrators can reset your password.
If you yourself are the primary administrator, your email address used on first registering is automatically stored with your user. If you have questions, please contact support.
You can navigate straight to any place inside a Cumulocity IoT application using the respective URL. For example, to show the basic information for a device, you can enter the following URL:
Using such an URL, you can:
- Save bookmarks for specific devices or pages.
- Send emails (manually or automatically, using the real-time event engine) which include a link to devices or sensor data.
- Use the backward and forward navigation of your browser.
- Write own web applications which link directly to information contained in a Cumulocity IoT application.
Cumulocity IoT applications
Per default, Cumulocity IoT comes with the following three standard applications:
|Administration||The Administration application enables account administrators to manage their users, roles, tenants, applications and business rules and lets them configure a number of settings for their account.|
|Cockpit||The Cockpit application provides you with options to manage and monitor Internet of Things (IoT) assets and data from a business perspective.|
|Device Management||The Device Management application provides functionalities for managing and monitoring devices and enables you to control and troubleshoot devices remotely.|
Apart from these standard applications that initially come with Cumulocity IoT, various additional applications are provided, offering a wide variety of functionalities. The availability of this applications depends on the Tenant you are using and the applications your organization is subscribed to.
Find a detailed list of all applications available with Cumulocity IoT in Administration > Managing applications.
On top of this, the Cumulocity IoT platform provides broad functionality to add your own applications to be used in your Cumulocity IOT account, see Administration > Managing applications for details.
The content of the Cumulocity IoT platform therefore is entirely dynamic and is generated based on various criteria:
- The applications that your organization has subscribed to.
- The applications that your organization has configured or developed itself for Cumulocity IoT.
- The functionality that your user is permitted to see.
- The configuration of the user interface, such as groups and reports.
UI functionalities and features
The general structure common to all Cumulocity IoT applications includes the following screen elements:
|Navigator||On the left you find the navigator. At the top of the navigator the name and logo of the application is displayed, indicating which application you are currently using. Below you find a list of entries leading to the various pages of the application. The entries are grouped into menus and menu items. You can collapse or expand menus in the navigator by clicking the menu name. Clicking the small arrow at the very left of the top bar will hide/or unhide the navigator. Per default, it is visible.|
|Page||"Page" actually refer to the main area in the application. The content provided here depends on the menu item selected in the dashboard. The structuring of the content differs from page to page. Data may for example be displayed in a list with a row for each object or you may find it being presented in a grid in which objects are represented by cards.|
|Tabs||Some pages, e.g. the page of any particular device, are divided into several tabs, either displayed vertically or horizontally.|
|Top bar||Page title
At the left of the top bar the title of the active page is displayed, if any.
Clicking the Search button opens a search field to enter text for a full-text search. For details, see Searching below. Not always available.
Most application pages show an Plus button at the top bar. Clicking it opens a context menu providing further functionalities. The context menu is created dynamically, i.e. it depends on the active page which commands are provided.
Application Switcher button
Clicking the Application Switcher button opens the application switcher which allows you to quickly switch between applications.
Right from the Application Switcher button you will find the User button with your user name. Clicking it will open up a context menu with commands related to your account settings.
Other buttons/ information may be available in the top bar depending on the application and the page being displayed.
|Top menu bar||Depending on the active application and the active page, a secondary bar is displayed below the top bar providing further functionalities like a Reload link for reloading the page or a Realtime link for the display of realtime data.|
|Right drawer||Clicking the small arrow at the very right of the top bar will unhide/hide the right drawer, offering quick links to other applications and to relevant documentation. Per default, the right drawer is hidden.|
On smaller screens, the layout is slightly different. The navigator is hidden and can be accessed by clicking the arrow icon on the top left. Only the active tab is displayed. To switch tabs, click the arrow on the tab header and select a tab from the list.
Info: Cumulocity IoT applications provide tooltips when you hover over a particular screen element. When you use Cumulocity IoT applications on touch devices, tooltips are shown when you touch a screen element for a longer time.
The application switcher allows you to quickly switch between applications. Click the Application Switcher button at the right of the top bar to display a list of icons representing applications.
The application switcher shows all Cumulocity IoT applications you currently have access to. These can be subscribed applications, either built-in or custom ones, and own applications. Just click the icon for the desired application to open it as active application.
If you are using SAG Cloud, the application switcher also shows other SAG Cloud applications at the first level, followed by the Cumulocity IoT applications:
Cumulocity IoT provides a full text search, available through the search field at the right of the top bar in the UI.
The search result includes groups, devices and child devices. On entering a search term into the textbox, Cumulocity IoT returns all devices containing this term in any property (name, model, any fragment).
The search functionality is based on the MongoDB full text search.
Entering multiple words separated by a blank returns all objects that match any of the words. For example, entering
My Demo Device
will return objects containing “My”, “Demo” or “Device”.
If you want to search for objects matching an exact phrase enclose it in quotation marks:
"My Demo Device"
You can also exclude words by putting a hyphen before the word to search the inventory for objects containing e.g. “My” or “Demo” but not “Device”:
My Demo -Device
Case is ignored. The following search texts return the same result:
My Demo Device my demo device
Info: Other than with filtering, using wildcards in a search is not supported.
For details on the MongoDB full text search, see https://docs.mongodb.com/manual/text-search/.
Some pages offer a filtering functionality to filter objects in a list.
As opposed to the search functionality, on entering filtering criteria you must not necessarily enter complete words.
In many cases you can just enter any arbitrary text into the text field, even just 2-3 characters. Entering
will reduce the list to all objects containing the string “cl”.
In other cases you may enter * as wildcard character to return all objects starting with “cl”:
The list will immediately be reduced to the selected objects.
Important: On certain pages, the filter mechanism only searches through items shown on a page. This means that if an item is not listed on the respective page, it will not appear in the results. You need to load all results first to search through all items. This behavior applies to the following pages:
- Device protocols
- Firmware repository
- Software repository
- Configuration repository
- File repository
For details on the filtering mechanism in the devices list refer to Device Management > Viewing devices > To filter devices.
Real-time behavior of the navigator
In the navigator, changes are not updated in real time, i.e. new, removed or renamed devices or groups will not be updated immediately.
You will only see such changes in the navigator of the application, in which you have made the changes. For example, if you unassign a device from a group in the Device Management application you will immediately see it removed from the group in the navigator of your current application, but if you have another window open with e.g. the Cockpit application you won’t see the changes.
You will only see the changes after a refresh or another request (expanding a group in the navigator for example).
User options and settings
Clicking the User button at the top right will open a menu which provides access to various actions or information.
The User menu contains the following items:
|User settings||Provides access to the user settings, see below.|
|Access denied requests||Shows a list of data requests which could not be accessed due to missing permissions, if any.|
|Logout||Logs you out from your Cumulocity IoT account.|
|Activate support||Allows support users to access your account. This option is only available if support user access is not set globally for subtenant users in the management tenant, see Supporting users in other tenants for details. After the support user access has been activated, the menu item switches to Deactivate support. If your support request has been resolved but the duration for the support user access is not expired (24 hours per default) you can actively disable an active support user request here.|
|Version information||Shows release information on the Cumulocity IoT version you are using, i.e. 10.5.8, for both Backend and UI. Moreover shows the ID of your tenant, which might be required if you request support. Click the copy icon next to the tenant ID to copy it to the clipboard.|
Several account settings can be changed by the user.
- Click the User button at the right of the top bar and then click User Settings.
- In the Edit user dialog box, make the relevant changes.
- To change the language, select a language from the dropdown list in the Language field.
- Click Change password to change your current password, see To change your password for details.
- Click Save to apply your settings.
The user interface language will be selected along the following criteria, in the order listed below:
- The language selected in the Cumulocity IoT user settings.
- The language selected in the browser preferences.
- The operating system language.
The UI is available in the following languages:
- Click the User button at the right of the top bar and then click User settings.
- In the Edit user dialog box, click Change Password.
- Enter a password and confirm it.
- Click Save to apply your settings.
Make sure to select a strong password. To support you in doing so a password strength indicator is displayed along with a password change.
By default, the password must consist of at least eight characters. For a strong password you must include at least three of the following character types: uppercase letters, lowercase letters, numbers and symbols.
Info: The password rules can be configured by the administrator, i.e. your administrator can configure your account to enforce a password policy. You may be required to pick a strong password for example or to change your password regularly.