Extension Settings Widget

Extension Settings Widget - Zoho People

A configurable page within the extension that enables administrators to manage and update extension-specific settings. Built using HTML and JavaScript, it allows admins to define preferences, control features, and maintain configurations during and after installation, ensuring the extension functions as intended.

What is the needed for Extension Setting Widget

When an extension is installed in Zoho People, it may require certain configurations as listed below. Instead of hardcoding these values, the Extension Settings Widget allows administrators to configure and manage them easily through the user interface.
  1. API keys
  2. Feature toggles (enable or disable options)
  3. Workflow preferences
  4. Integration details (for instance, connecting another application)

How Extension Settings Widget works in Zoho People

  1. The developer builds the widget using HTML/JS and packages it with the ZET CLI tool.
  2. The package is then added to a Connected App in the Extension environment.
  3. Configure the extension setting widget using the connected app details.
  4. Publish the extension.
  5. Upon installing the extension in Zoho People marketplace, admins can access the widget within the Extensions app.

How to Configure Extension Setting Widget in Zoho People

  1. Login to you sigma.zoho.com workspace
  2. Create new or edit a existing Extension to add Setting Widget to it.
    To create or edit extension, refer to Extensions.

  3. In your extension application, navigate to Developer Space, Extension Settings Widget.
  4. Ensure that the Connected App is set up to use it in the settings widget.
  5. Click Create Extension Settings Widget.
  6. Enter the Setting Widget name and description

  7. Enter the connected app sandbox and production URLs. 
  8. Click Save.

View and Use Settings Widget in Extension

You can view and execute actions within extension setting widget in Zoho People marketplace.

To view and use your Extension Setting Widget:
  1. Login to you Zoho People account.
  2. Go to Settings > Marketplace > Extension > Installed.

  3. On the installed Extension, click View Details. At the top right you can view and use the Extension Settings Widget.