Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
Updated README with 10.17 features
  • Loading branch information
@Vagdevi1998
Vagdevi1998 authored Aug 9, 2023
1 parent 780231c commit 42e6ad8
Showing 1 changed file with 80 additions and 32 deletions.
112 changes: 80 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,29 @@
- [Subscribing for Feature Branding](#subscribing-for-feature-branding)
- [Features](#features)
- [Overview](#overview-of-features)
- [Assets](#assets)
- [Asset hierarchy](#asset-hierarchy)
- [Creating assets via UI](#creating-assets-via-ui)
- [Creating assets via bulk import](#bulk-import)
- [Viewing assets](#view-assets)
- [Asset properties](#asset-properties)
- [Asset models](#asset-models)
- [Localization](#localization)
- [Asset tree](#asset-tree)
- [Bulk import](#bulk-import)

## Overview

The `Digital Twin Manager` enables you to create and manage assets around your physical connected devices in Cumulocity IoT. Assets can be used to structure and describe devices in logical hierarchies as encountered in the real world environment. In addition, assets in Cumulocity IoT can be extended and enriched with addtional information using the `Asset properties`.

The home screen of the DTM application gives an overview of the application. You can see the number of asset models, asset properties and assets available at a glance. You can add asset properties, asset models and assets using the quick links.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/813dd29c-ca61-4542-b912-5d354b60b44b)

<div align="center"><i>Sub assets screen displaying the details of the selected asset.</i></div><br>
**You cannot create asset models, properties and assets if you dont have inventory admin permission.**

`Note: Digital Twin Manager is supported on Cumulocity UI and microservice version of 10.14 and above`

## Installation

The `Digital Twin Manager` is shipped as a standalone application for now. This means it will be installed as a separate application, which provides all the features of the
`Digital Twin Manager` as described in the features section. The standalone application is available in the [release section](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/releases)
`Digital Twin Manager` as described in the [features](#features) section. The standalone application is available in the [release section](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/releases)
and can be downloaded.

### For installation of web application:
Expand All @@ -42,7 +43,7 @@ and can be downloaded.
5. Select `Upload web application` in the modal dialog
6. Select the zip archive, which you downloaded from the release section, to upload it to the tenant

![DTM installation](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/164a1ec9-343a-4354-88a1-1e799073b38f)
![DTM installation gif](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/cd1016a3-f52b-407c-b8e0-f5f5deb6a834)

After following these instructions, the application will be deployed on the tenant and is ready for use. In the application switcher on the top right you can now select the `Digital Twin Manager` application.

Expand Down Expand Up @@ -99,49 +100,43 @@ Complete the setup by following the below steps on the tenant where you want to

### Overview of features

The `Digital Twin Manager` consists of the following features, which support you to create your assets and asset hierarchies:
The `Digital Twin Manager` consists of the following features:

* `Assets` - Lists all the available assets and its hierarchy which are created using asset models and properties.
* `Asset properties` - Create your own asset properties (simple or complex) to define how data should be stored on an asset
* `Asset models` - Define asset models to describe the blueprint of your assets
* `Localization` - Dynamically translate asset model and asset property descriptions to multiple languages
* `Asset tree` - View and navigate to the subassets page of the asset hierarchy.
* `Bulk import` - To import the entire asset hierarchy with all the assets at once.
* `Localization` - Dynamically translate asset model and asset property descriptions to multiple languages.

### Asset properties
### Assets

The Asset properties can be used to create your own properties to define how data should be stored on an asset. These asset properties can be either complex (nested object) or simple (key-value pair). Furthermore, you can choose a specific data type for each property you define. As of now, the Asset properties supports following data types: Text, Number,File Upload Date Picker, Enumeration, Boolean.
Assets are the digital representation of physical assets. An asset in DTM application can contain subassets and devices. Initially, no assets are displayed in the `Assets` page by default. If you have already created assets, you find them listed with its hierarchy.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/9ccb90fe-4514-4af0-93cb-cf331599c739)
![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/0a761daf-64c7-4bf7-a4e0-9fef4403e430)

<div align="center"><i>Asset properties screen displaying the list of properties and an option to add or edit the property.</i></div>
<div align="center"><i>Assets screen displaying the list of assets and an option to add asset or import assets.</i></div>

### Asset models
### Asset hierarchy

Asset models serve as a blueprint for your assets and define how they are structured. An Asset model defines what asset properties an asset should have. Additionally, you can specify relationships between multiple Asset models, which will be respected when you create your actual asset hierarchies. Once the Asset model is created, it can be used to create various assets.
An asset hierarchy is a structure that organizes multiple assets and devices into a hierarchy, allowing for the visualization and management of complex systems.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/5711f9d5-ce3d-4fa9-acf5-99e0fd38595f)

<div align="center"><i>Edit Asset model screen displaying the details of the selected asset model.</i></div>

### Localization

You can use the Localization component to define translations for your asset models and asset properties. These translations can be provided for all supported languages in Cumulocity IoT. This component requires to have the `feature-branding` feature subscribed for your Cumulocity tenant.
The asset hierarchy is displayed in the Assets page. An asset hierarchy consists of a root asset and all its subsequent subassets. Click Add asset to create the entire hierarchy of an asset in the New asset page. For details, see [To create an asset](#creating-assets-via-ui).

[Subscribing for Feature-branding](#subscribing-for-feature-branding)
![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/b9076853-0d05-41e5-bb1c-71b917241321)

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/a1769673-119b-4fcb-a71f-110cd53de945)
<div align="center"><i>Asset hierarchy screen displaying the subassets of the root asset.</i></div>

<div align="center"><i>Localization screen displaying the list of translated terms for your asset models and asset properties.</i></div>
### Creating assets via UI

### Asset tree
You have two options for creating assets in the DTM application. The following section describes how to create an asset via the UI. Alternatively, see [Creating assets via bulk import](#bulk-import) on how to import assets in bulk into the DTM application.

The Asset tree tab is used to view the child assets hierarchy and can also navigate to the subassets page. You can add child assets using **Add asset** button and can also import the child assets using **Import assets** button.
You can create assets based on the asset models and properties you have defined previously.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/80b4eb9c-edbc-40f7-b270-8b91e2de2835)
![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/d9ca99a9-62d7-443b-8c54-ed1a56b56f03)

<div align="center"><i>Asset tree tab displaying the child asset hierarchy of the selected asset.</i></div>
<div align="center"><i>Asset creation screen displaying the asset hierarchy of the selected asset model.</i></div>

### Bulk import

To import all the assets of a particular asset hierarchy at once, use the bulk import feature. Microservice is being used to download the template and import the assets. To use the Bulk import feature, user must be part of a role that has `Admin` permission level for **Digital twin** type.
[Configure a role for Bulk Import](#configure-a-role-to-use-the-bulk-import-feature)

Expand All @@ -153,6 +148,60 @@ To import all the assets of a particular asset hierarchy at once, use the bulk i

You can find more information about how to download the template, import the assets [here](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/blob/main/README.bk.md)

### View assets

Select an asset in the Assets page to view the asset details in Subassets tab. It shows all the subassets, child devices and asset properties.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/813dd29c-ca61-4542-b912-5d354b60b44b)

<div align="center"><i>Sub assets tab displaying the details of the selected asset.</i></div><br>

You can view the hierarchy of the asset in the Asset tree tab. Initially the asset hierarchy is collapsed. Click the expand icon to view the next level of subassets.

Click Add asset to add more subassets or click Import assets to add [child assets in bulk](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/blob/main/README.bk.md).

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/5bb11509-4681-4d97-a3a5-4426089f6641)

<div align="center"><i>Asset tree tab displaying the child asset hierarchy of the selected asset.</i></div><br>

#### Asset search

You can search for assets through the Search button at the right of the top bar. Enter a search term into the textbox at the top of the Search window to see all assets matching the search criteria in the section Search results.

To see more details click Go to the asset data table at the bottom. This will show the entire search results in a table format.

The Search page only shows a limited number of matches. In case of more matches, switch to the asset data table to see the complete results.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/6c05fc0e-b79f-4712-a14c-1c611ef9c653)

<div align="center"><i>Asset search screen displaying the results based on the text entered.</i></div><br>

### Asset properties

The Asset properties can be used to create your own properties to define how data should be stored on an asset. These asset properties can be either complex (nested object) or simple (key-value pair). Furthermore, you can choose a specific data type for each property you define. As of now, the Asset properties supports following data types: Text, Number,File Upload Date Picker, Enumeration, Boolean.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/9ccb90fe-4514-4af0-93cb-cf331599c739)

<div align="center"><i>Asset properties screen displaying the list of properties and an option to add or edit the property.</i></div>

### Asset models

Asset models serve as a blueprint for your assets and define how they are structured. An Asset model defines what asset properties an asset should have. Additionally, you can specify relationships between multiple Asset models, which will be respected when you create your actual asset hierarchies. Once the Asset model is created, it can be used to create various assets.

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/5711f9d5-ce3d-4fa9-acf5-99e0fd38595f)

<div align="center"><i>Edit Asset model screen displaying the details of the selected asset model.</i></div>

### Localization

You can use the Localization component to define translations for your asset models and asset properties. These translations can be provided for all supported languages in Cumulocity IoT. This component requires to have the `feature-branding` feature subscribed for your Cumulocity tenant.

[Subscribing for Feature-branding](#subscribing-for-feature-branding)

![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/a1769673-119b-4fcb-a71f-110cd53de945)

<div align="center"><i>Localization screen displaying the list of translated terms for your asset models and asset properties.</i></div>

## Any comments, suggestions or ideas?

Let us know, if the current way for setting up and maintaining an asset hierarchy meets your needs and expectations. For any suggestions, please navigate to [Issues](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/issues) and open a new issue with all the relevant details. Once you have created your issue, we will make sure to assign the correct label to it, which will help us to categorize your issue:
Expand All @@ -167,4 +216,3 @@ Let us know, if the current way for setting up and maintaining an asset hierarch
_________________

These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.
![image](https://github.com/SoftwareAG/cumulocity-digital-twin-manager/assets/107403521/abe4bb84-f845-458b-abd3-1dc6ae02a2ef)

0 comments on commit 42e6ad8

Please sign in to comment.