Creating and Publishing a Gadget

Note that this feature is in the Beta stage.

Creating a gadget

Follow the instructions below to create a gadget:

The gadget needs to be created as part of a microsite.

Access the UES portal.
On the Create menu, click Microsite.
Enter a title for the dashboard.
Only alphanumerical and - hyphen is allowed to be entered as the dashboard title.
Click Create new app.
Click and open the folder containing the name of the newly created microsite.

Open the jaggery.conf file in the Jaggery Web IDE and remove the following authentication snippet from the file:

"loginConfig": {
  "authMethod": "BASIC"
},
"securityConstraints": [
  {
    "securityConstraint": {
      "webResourceCollection": {
        "name": "nnn",
        "urlPatterns": [
          "/*"
        ],
        "methods": [
          "GET",
          "POST",
          "PUT",
          "DELETE",
          "HEAD",
          "OPTIONS",
          "TRACE",
          "CONNECT",
          "PATCH"
        ]
      },
      "authRoles": [
        "private_admin"
      ]
    }
  ]
}

Navigate to the UES portal.
Click Add a new file.
Rename the file as a XML file (e.g., gadget.xml)
Click Edit.
Enter the customized code in the file.
Use the tools in the editor when necessary.
Click Save.
Publish the gadget.

Publishing a gadget to the store

If there are multiple XML files with multiple gadget definitions, each of the gadget definition files need to be published separately to the store.

Follow the instructions below to publish a gadget to the store:

Access the UES portal.
On the My Items menu, click on the microsite folder.
Click on the XML file that contains the gadget definition.
Click Publish.
The Published Settings page will appear.
Select "gadget" as the Publish as option.
Select the permission type allowed for this gadget.
Users who have the edit permission will be able to edit the gadget. However, the changes will only be visible to the user who made the changes and will not be visible publicly.
Enter a name for the gadget.
Enter the gadget version.
Enter the URL that will be used to publicly access the gadget.
For example:
If your gadget definition is defined in a file named publisher-gadget.xml and this file is within a parent folder named publisher-gadget, then you should enter your gadget URL in one of the following formats:
- https://localhost:9443/publisher-gadget/publisher-gadget.xml
- http://localhost:9763/publisher-gadget/publisher-gadget.xml
Enter a description on the gadget.
Enter the URL of the thumbnail.
Enter the URL of the image.
Click Publish.