This is an Angular widget, which is designed to display the Device Details can fetch the details from the Api call and can display data according to the fields provided. The angular widget has the ability to summarize information relating to the names from the Api call.
⚠️ This project is no longer under development. Please use Cumulocity Device Details Widget Plugin for Application Builder >=2.x.x and Cumulocity >=1016.x.x⚠️
Please choose Device Details Widget release based on Cumulocity/Application builder version:
APPLICATION BUILDER | CUMULOCITY | DEVICE DETAIL WIDGET | |
---|---|---|---|
1.3.x | >= 1011.x.x | 2.x.x |
Requirements:
Git
NodeJS (release builds are currently built with v14.18.0
)
NPM (Included with NodeJS)
External dependencies:
"@angular/cdk: "^11.2.13",
Installation Steps For App Builder:
Note: If you are new to App Builder or not yet downloaded/clone app builder code then please follow App builder documentation(Build Instructions) before proceeding further.
Open Your existing App Builder project and install external dependencies by executing below command or install it manually.
npm i @angular/cdk: "^11.2.13"
Grab the Device detail widget Latest Release Binary
Install the Binary file in app builder.
npm i <binary file path>/device-details-runtime-widget.tgz
Import Device detail Module
Import GpDeviceDetailsWidgetModule in app.module.ts and also place the imported Module under @NgModule
.
import { GpDeviceDetailsWidgetModule } from 'gp-device-details';
@NgModule({
imports: [
GpDeviceDetailsWidgetModule
]
})
Congratulation! Installation is now completed. Now you can run app builder locally or build and deploy it into your tenant.
//Start App Builder
npm run start
// Build App
npm run build
// Deploy App
npm run deploy
## Build Instructions
Note: It is only necessary to follow these instructions if you are modifying/extending this widget, otherwise see the Installation Guide.
Requirements:
Git
NodeJS (release builds are currently built with v14.18.0
)
NPM (Included with NodeJS)
Instructions
Clone the repository:
git clone https://github.com/SoftwareAG/cumulocity-device-details-widget.git
Change directory:
cd cumulocity-device-details-widget
(Optional) Checkout a specific version:
git checkout <your version>
Install the dependencies:
npm install
(Optional) Local development server:
ng serve
Build the app:
npm run buildPatch
Deploy the app: Follow the Installation instructions.
This guide will teach you how to add widget in your existing or new dashboard.
NOTE: This guide assumes you have followed the Installation instructions
Open you application from App Switcher
Add new dashboard or navigate to existing dashboard
Click Add Widget
Search for `Device detail
Select Target Assets or Devices
6.In the config add the URL,Document list from url,add the coulmn headings and column names of the api
Save
Congratulations! Device Details Widget is configured.
Click on Add Widget and Select Device Detail as a widget.In the configuration,you have to select the device group of your interest.
This widget is 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.
For more information you can Ask a Question in the TECHcommunity Forums.