How to Create Widgets in Zoho People?

Estimated reading: 3 minutes 6 views

Introduction

Widgets in Zoho People allow you to extend the functionality of your application by embedding custom interfaces within dashboards, forms, or custom buttons. This helps streamline user interaction and supports custom workflows within the Zoho People environment.

This guide explains how to upload a widget, and how to add it to dashboards, related forms, and custom buttons.

Step-by-Step Instructions:

Uploading Your Widget in Zoho People

  1. Go to Settings > View All > Developer Space > Widgets.
  2. Click Create New Widget.
  3. Enter the name and description for your widget.
  4. Select the Widget Type (Dashboard, Related List, or Button).
  5. Choose the Hosting Method:

Internal Hosting:

      • Select Internal from the Hosting drop-down.
      • Click Upload and select the widget.zip file from your project’s dist folder.
      • Enter the Index Page URL.
      • Refer to the Create Internal Widget Using Zet-CLI Tool guide for development steps.
    • External Hosting:
      • Select External from the Hosting drop-down.
      • Enter the public URL where your widget is hosted.

6. To control who can access the widget:

    • Enable Based on role, and select the applicable roles.

7. Once uploaded, your widget can be added to a dashboard, form, or button as needed.

Adding a Widget to the Dashboard

  1. Go to Settings > View All > Developer Space > Widgets.
  2. Create a new widget and set Widget Type to Dashboard.
  3. The widget will be automatically added to your dashboard.
  4. To view the widget:
    • Go to Home > Dashboard.
    • The widget will appear at the end of your dashboard.

Adding a Widget to a Related Form

  1. Go to Settings > View All > Developer Space > Widgets.
  2. Create a new widget and set Widget Type to Related List.
  3. After uploading:
    • Go to Settings > View All, and click on the service you want to extend.
    • Select Extend Service > Forms.
    • Click the form where you want to add the widget.
    • In the Customization section, click the ellipsis icon.
    • Select Related Forms Configuration > Widgets > Map Widget.
  4. A list of available related list widgets will be shown.
  5. Click Install for the desired widget, then click Save.
  6. To view the widget:
    • Go to Operations > View All > [Service] > Related Form.
    • Click on a record, and the widget will appear at the end of the record view.

Adding a Widget to a Custom Button

  1. Go to Settings > View All > Developer Space > Widgets.
  2. Create a new widget and set Widget Type to Button.
  3. After uploading:
    • Go to Settings > View All, and click on the service where the button should be added.
    • Select Extend Service > Custom Button.
    • Click the dropdown and choose Add Custom Widgets.
  4. In the Add Custom Widgets dialog:
    • Select the form where the button should appear.
    • Select the widget to invoke.
    • Set role-based access control.
    • Choose the placement:
      • In Record Listing – Widget will appear on the record listing page.
      • In Record View – Widget will appear on the individual record view page.
  5. Click Add to complete the setup.
  6. To view the widget:
    • Go to Operations > View All > [Service] > Related Form.
    • Select or open a record to see the custom button widget.

Tips:

  • Always test widgets in a sandbox environment before deploying them in production.
  • Use role-based access control to manage visibility for sensitive widgets.
  • Use the Zet-CLI tool for building internal widgets for better compatibility and deployment.

Related Articles

Developer Space - Previous What is the use of Connections in Zoho People? Next - Developer Space What is meant by extensions in Zoho People?

Leave a Reply

Your email address will not be published. Required fields are marked *

Learn how we helped 100 top brands gain success