/cumulocity-smart-map-settings-widget

This is configuration widget for Smart Map Widget. Runtime installation is available. Created by Global Presales.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Smart Map Settings Widget for Cumulocity

This widget 'Smart map settings' is created using Angular Library and can be deployed in App Builder and Cockpit as a Cumulocity widget. It allows you to mark and create a Geography on specified location. After the Geography is created, it allows to create floors, Geofences and device positioning. This widget is used as configuration for Smart Map widget

⚠️ This project is no longer under development. Please use cumulocity-smart-map-settings-widget-plugin for Application Builder >=2.x.x and Cumulocity >=1016.x.x⚠️

Please choose Smart Map Settings release based on Cumulocity/Application builder version:

APPLICATION BUILDER CUMULOCITY SMART MAP SETTINGS WIDGET
1.3.x >= 1011.x.x 2.x.x
1.2.x 1010.x.x 1.x.x

What's new?

  • Smart Map Settings: Smart Map Settings widget upgrade to angular 11.
  • Location Search: Support for Location Search to find any location across globe.
  • Geofences & Smart Rule: Now User can configure geofences and Smart Rule for geofeces on Map.
  • GeoJSON and SVG Support: User can now also upload GeoJSON and SVG file for floor plan.
  • Device Positioning: Multiple devices can be positioned on the floor plan.
  • Supports for Assets: Device marker and Smart Rules for geofence also supports assets

Features

  • Add the Geography by drawing its location and entering the details.
  • Edit the geography details and its location.
  • Delete the geography.
  • Add, Edit, Delete, Revert the floor plan of the geography after the addition of geography.
  • Preview the floor plan image added.
  • Rotate and positioned image using smart rotation point
  • Devices can be marked on the map at floor level.

Installation

Runtime Widget Deployment?

  • This widget support runtime deployment. Download Runtime Binary and use application builder to install your runtime widget.

Installation of widget through Appbuilder?

Supported Cumulocity Environments:

  • App Builder: Tested with Cumulocity App Builder version 1.3.0.

Requirements:

  • Git
  • NodeJS (release builds are currently built with v14.18.0)
  • NPM (Included with NodeJS)

External dependencies:


"leaflet-draw": "^1.0.4",
"leaflet2": "npm:leaflet@^1.6.0",
"@angular/material": "11.2.3",
"leaflet.markercluster": "^1.4.1"

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.

  1. Open Your existing App Builder project and install external dependencies by executing below command or install it manually.

    npm i leaflet-draw@1.0.4 leaflet2@npm:leaflet@^1.6.0 @angular/material@11.2.3 leaflet.markercluster@1.4.1

  2. Grab the Smart Map settings Latest Release Binary.

  3. Install the Binary file in app builder.

    npm i <binary file path>/gp-smart-map-settings-*.*.*.tgz

  4. Copy smart-map.css file from here and paste it at /cumulocity-app-builder/ui-assets/

    Note: Ignore this step is already done as part Smart-Map Installation.

  5. Open index.less located at /cumulocity-app-builder/ui-assets/

  6. Update index.less file with below Material theme. Import at first line in file/begining of file(Please ignore this step if it already exist).

    @import  '~@angular/material/prebuilt-themes/indigo-pink.css';

  7. Update index.less file with below map-settings.css. Import at last line/end of file.

    @import  'smart-map.css';

  8. Import SmartMapSettingsModule in custom-widget.module.ts file located at /cumulocity-app-builder/custom-widgets/

    import { GpSmartMapSettingsModule } from 'gp-smart-map-settings';
@NgModule({
imports: [
GpSmartMapSettingsModule
]
})

  9. 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

  1. Clone the repository:

    git clone URL

  2. Change directory:

    cd cumulocity-smart-map-settings-widget

  3. (Optional) Checkout a specific version:

    git checkout <specific version>

  4. Install the dependencies:

    npm install

  5. (Optional) Local development server:

    npm start

  6. Build the app:

    i) Run the command to create a binary file under dist folder npm run buildMinor

    ii) Check the Installation Guide sections to add the library build to cumulocity application.

QuickStart

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

  1. Open you application from App Switcher
  2. Add new dashboard or navigate to existing dashboard
  3. Click Add Widget
  4. Search for Smart Map settings
  5. Click Save

Congratulations! Smart Map settings is configured.

User Guide

Smart Map settings Details:

  • Configuration:

    • Location Search URL: User can configure any 3rd party location search API(Must be get request) which return json response with Latitude and Longitude coordinates for given search text.
    • Latitude Field: Latitude field name which is part of Location Search API Response.
    • Longitude Field: Longitude field name which is part of Location Search API Response.

  • Geography:

    • Add the geography by clicking on the + button on the top right.

    • When the map dialog opens, select the shapes (rectangle or polygon) to draw the geography co-ordinates. Then on finish of drawing, popup appears to enter the details of the building, which needs to be filled.

    • Multiple geography co-ordinates can be drawn.

    • Table header details
      • Id: Managed object id.
      • Name: Name of the Geography.
      • Asset type: Type of the Geography. eg: Office, Production, Warehouse.
      • Location: Location of the geography.
      • Total floors: Number of floor added to a geography.

  • Floor:

    • To add floor, click on the respective geography row, which is expandable. Then click on + to add the floor.

    • To preview the floor on added geography co-ordinates, click on preview.

    • To rotate / scale up/down, use smart rotation/scalling points(available for jpeg, png and svg).

    • Geofence along with Smart Rule can be configured on ground floor(level 0) only with help of draw tool available on the top right corner.

    • Devices can be marked on the image with the help of draw tool available on the top right.

    • Floor plan can be edited, clicking on the edit button.

    • To delete, click on the delete icon.

    • To revert back to the original image, click on revert button.

    • To save the added/edited/delete floors, click on tick button next to +.

    • Table header details

      • Floor level: Level of the floor.

      • Status:

        • Empty: Already available floor.
        • New: Newly added floor.
        • File changed: Floor plan changed.
        • Marked for deletion: Marked for deletion.
        • Geofences for deletion: Geofences for deletion.

      • Geography: Preview the geography to set image position/scalling, geofeces, device positions, etc.

      • Delete: Marks the floor plan for deletion.

      • Floor Plan: * Upload/replace Floor Plan: User can upload new floor plan or replace existing floor plan. * Image types: JPG, JPEG, PNG and SVG file types are supported. * GeoJSON: User can also upload .json file which is valid GeoJSON file. To generate GeoJSON file, there are many tools/editors are available. for example Geojson Editor

      • Revert: Reverts back to the original state.

Note Only floorplan(image) can be edited. And unless the floors are saved, changes to the floors can not be seen.

Troubleshooting

  • Floor Plan not loaded:
    • Verify that your device is located on floor plan.
    • Check and verify smart-map-settings widget for exact geo coordinates.
    • Check in browser console for any content security violation error. If any content violation error present then update content security policy in your app. Content security policy located in package.json file in your app. You can compare and update as per below example:
    "contentSecurityPolicy": "base-uri 'none'; default-src 'self' 'unsafe-inline' http: https: ws: wss:; connect-src 'self' *.billwerk.com http: https: ws: wss:; script-src 'self' open.mapquestapi.com *.twitter.com *.twimg.com 'unsafe-inline' 'unsafe-eval' data:; style-src * 'unsafe-inline' blob:; img-src * data: blob:; font-src * data:; frame-src *;"

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.

You can find additional information in the Software AG TECHcommunity.