Add Custom Widget

Add Custom Widget

Add Custom Widget to ServiceDesk Plus MSP Cloud 

Role Required: SDAdmin

Go to Setup > Developer Space > Custom Widgets and click New Custom Widget. Follow the steps mentioned below to configure your own custom widget.

  1. Provide a name and description to your custom widget.
  2. Select the status of your custom widget.
    1. Enable - Enabled custom widgets will be displayed at their corresponding locations and are accessible for users.
    2. Disable- Disabled custom widgets are not displayed at their locations and are accessible only to the administrators. Custom Widgets can be disabled during creating to ensure all dependencies are installed successfully. This helps to avoid errors or issues when users access the custom widget.
  3. Upload the zip file that contains the custom widget package. Note that the file size can be 5 MB at the maximum.
  4. Choose where to host your app:
    1. Sigma Server - You can host your custom widget on a server provided by Sigma, an extension development platform from Zoho.
    2. Development Mode - This mode is mainly used for development purposes where the custom widget is hosted in your local machine on port 5000. If you host the custom widget on development mode, run your server locally to complete the setup.
  5. Click Save.
The custom widget will be listed on the list view page.


Run the Server Locally

Before running the server locally, make sure that you have met the following pre-requisites:
  1. Developer Mode is configured as the hosting location in your custom widget.
  2. The server port 5000 is not occupied on your local machine.
Run the following command to start the HTTP server that runs your custom widget locally. This command makes use of the 5000 port of your local machine.

$ zet run

An illustration on running ZET installation on macOS terminal

To verify the successful running of the server, open the given URL in your browser: https://127.0.0.1:5000/
Info
Changes you make in any file under the 'app' folder will reflect in the corresponding custom widget in ServiceDesk Plus MSP Cloud. After the changes are reviewed, you can pack the custom widget using the 'zet pack' command and upload the zip on to ServiceDesk Plus MSP Cloud. 

Update Custom Widget 

Role Required: SDAdmin
To update your custom widget properties,
  1. Make the necessary changes in the plugin-manifest file.
  2. Go to Setup > Developer Space > Custom Widgets.
  3. Click and select Edit.
  4. Upload the latest zipped plugin-manifest file to the application.
  5. Click Save.
Alert
If connections, modules, or variables are removed in the updated widget package, the corresponding data will also be deleted from ServiceDesk Plus MSP Cloud database.  
Info
You can edit variables, enable/disable custom widgets, and manage custom widget/widget items location from custom widget list view.

    • Related Articles

    • Custom Widget Specifications

      The package directory of your custom widget includes a plugin-manifest.json file. This file contains the configuration details of your custom widget. While some keys included in this file are optional, others are mandatory. Use the following pointers ...

    • Develop Custom Widget Package

      Command Line Interface (CLI) is used to create and package custom widgets. ZET command is the CLI used to package custom widgets for ServiceDesk Plus MSP Cloud. Pre-requisites: In order to create your own custom widgets for ServiceDesk Plus MSP ...

    • Custom Menu

      Overview Custom Menu allows you to create customized actions that can be performed on various modules in ServiceDesk Plus MSP Cloud. You can configure actions for a custom menu by using custom functions, custom widgets, or by invoking a URL. The ...

    • Custom Widgets List View

      Role Required: SDAdmin You can manage the custom widgets by enabling/disabling widgets, editing widget details, or by managing their display locations from the list view. Enable/Disable Custom Widgets - You can disable custom widgets temporarily to ...

    • Connections for Custom Services

      Write new connections for custom services and expand the third-party support of ServiceDesk Plus MSP Cloud. Important Terminologies Before you set up connections with custom services, familiarize yourself with the following terms: Client: The ...