Validate and Pack Widget

Validate and Pack Widget

Execute the following command to validate your custom widget:
$ zet validate
Your custom widget needs to follow the widget specifications. Running the 'zet validate' command will identify violations of the specifications if any.

An illustration on validating ZET installation on macOS terminal

Any violations in widget specifications need to be rectified before uploading the widget package. Note that only a basic validation of the configurations is performed.

Run the below command to create a zip with all the files and folders required for the running of your custom widget:

$ zet pack
 
An illustration on packing custom widget files on macOS terminal

The zip is present in the 'dist' folder of your package directory. You can upload this zip to the custom widget page in ServiceDesk Plus MSP Cloud.

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

    • 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. Provide a name and description to ...

    • Manage Variables/Connection in Custom Widget

      SDP.getVariables() Fetches all the variables associated with the custom widget. Returns: Promise - Resolved with Success or Rejected with Failure. Syntax: SDP.getVariables().then(function(response) { console.log(response); }).catch(function(response) ...

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

    • Fetch Custom Widget/User Details

      SDP.getCurrentInstance(); Fetches the details of the instance where the custom widget is loaded. Returns: Object – Returns instance details object. Syntax: var instanceDetails = SDP.getCurrentInstance(); Sample Response: { appdisplayname: "IT Desk" ...