Add Custom Widget to ServiceDesk Plus 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.

• Provide a name and description to your custom widget.
• Select the status of your custom widget.
  • Enable - Enabled custom widgets will be displayed at their corresponding locations and are accessible for users.
  • 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.
•  Upload the zip file that contains the custom widget package. Note that the file size can be 5 MB at the maximum.
•  Choose where to host your app:
  • Sigma Server - You can host your custom widget on a server provided by Sigma, an extension development platform from Zoho.
  • 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.
• 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:

• Developer Mode is configured as the hosting location in your custom widget.
• 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.

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/