softwareag / cumulocity-service-request-plugin

Plugin adding a notification tab to each group and device route. Displays 2 widgets where alarms can be handled using the service request form.

Service request plugin

This plugin extends Cumulocity application like Cockpit with the capability to create, update and manage service requests.

The UI Plugin is depending on the domain specific API provided by service-request-mgmt microservice: Open API documentation

This microservice can be extended or even replaced if needed. Custom microservices have to implement the REST API as documented above.

Requirements

This plugin requires a Microservice called Service-request-mgmt to be installed on the tenant. Repository: Standard cumulocity-microservice-service-request-mgmt

Create Service Request

The service request can be created for an alarm as shown in the screenshot above or with out any context via (+) button "Create service request". The service request will be stored at Cumulocity. If the service request is created and a alarm status transition is configured the alarm status will change to the configured status, in that example the alarm changes to ACKNOWLEDGED.

Create Comment for Service Request

There are SYSTEM comments and USER comments. SYSTEM comments reflect specific changes at the service request object and show the status history of it. USER comments can be created by any user which is allowded to create service requests. Service request comments are a very sufficient way to communicate with the field service technician in the device context.

Attachments

Each service request and each comment can have arbitrary files like pictures, excel documents etc. as attachment. This attachments allow the user to add additional information for the field service team.

Recommended versions

node v 14.x npm v 6.x

Plugin versions

Angular v 14.x WebSDK v 1016.0.x

How to start Change the target tenant and application you want to run this plugin on in the package.json.

c8ycli server -u https://{{your-tenant}}.cumulocity.com/ --shell {{cockpit}}

Keep in mind that this plugin needs to have an app (e.g. cockpit) running with at least the same version as this plugin. if your tenant contains an older version, use the c8ycli to create a cockpit clone running with at least v 1016.0.59! Upload this clone to the target tenant (e.g. cockpit-1016) and reference this name in the --shell command.

The widget plugin can be locally tested via the start script:

npm start

In the Module Federation terminology, widget plugin is called remote and the cokpit is called shell. Modules provided by this widget will be loaded by the cockpit application at the runtime. This plugin provides a basic custom widget that can be accessed through the Add widget menu.

Note that the --shell flag creates a proxy to the cockpit application and provides AdvancedMapWidgetModule as an remote via URL options.

Also deploying needs no special handling and can be simply done via npm run deploy. As soon as the application has exports it will be uploaded as a plugin.

Useful links

📘 Explore the Knowledge Base
Dive into a wealth of Cumulocity IoT tutorials and articles in our Tech Community Knowledge Base.

💡 Get Expert Answers
Stuck or just curious? Ask the Cumulocity IoT experts directly on our Forum.

🚀 Try Cumulocity IoT
See Cumulocity IoT in action with a Free Trial.

✍️ Share Your Feedback
Your input drives our innovation. If you find a bug, please create an issue in the repository. If you’d like to share your ideas or feedback, please post them here.

More to discover

• How to install a Microfrontend Plugin on a tenant and use it in an app?
• Cumulocity IoT Web Development Tutorial - Part 1: Start your journey
• The power of micro frontends – How to dynamically extend Cumulocity IoT Frontends

---

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.

cumulocity-service-request-plugin's Issues

Empty status and priority list not handled

Current state:

If any of this APIs return empty array:

{{url}}/service/service-request-mgmt/api/service/request/status

{{url}}/service/service-request-mgmt/api/service/request/priority

the loading indicator is shown and nothing happens.

Desired state:

If user clicks on new service request or update existing service request an error message dialog should be shown that service request status and priorities are not configured correctly.

vertical arrangement of service request dashboard

Currently the alarm list is above the service request list. For higher resolution screens a arrangement where alarms are on the left and the service request on the right are more usefull.

dashboard must refreshed after service request is created/updated

After service request gets created or updated the service request list and alarm list should be refresh in order to see directly the changes from ACTIVE to ACKNOWLEDGED or comments added

Page is empty after reload

If the service request page gets reloaded (F5), the side is empty:

If i click again to the device via UI it is working:

Improve README.md

Improve documentation of plugin

Adjust notification details view

Please adjust the following points, as we have discussed, to get ready for MVP release:

1. Clear sections
   Adjust layout to provide better visual structure to the form.
   Reference: Admin App » Auth Config (/apps/administration/index.html#/auth-configuration/basic_settings)
2. Separate actions
   Move the resolve button to a separate card, below the form-card.
   Provide a short (placeholder) text that references the consequence of the action.
3. Full width form
   Go full width, instead of partial left-aligned.
4. Remove "No comments" info
5. Remove "Not available in MVP" info/section

Use new standard Alarm widget or new developed custom Alarm widget.

The Alarm is shown as json string instead as Alarm object

Current Version:

Desired Version:

Status Icon is not shown and clear action should be possible as well

1. The Status icon of the alarm should be shown, is not shown in current version.
2. Next to "Create service request", "Clear Alarm" should also be available.

Like it is at Alarm list.

Alarm and Device isn't shown on service request formular

If service request create option is clicked, the device and alarm context isn't shown in the dialog.

Current Version:

Desired Version:

Tooltip should contain all available timestamps of an alarm

The different timestamp of an alarm are important to show in the alarm list:

Missing cancel button at service request dialog

I miss the cancel button at service request dialog. If i want just look at the details of the service request i want to cancel without changes to service request.