Testing Your Extensions | Zoho People 5.0 | Developer Space | Administrator Guide

Testing Your Extensions

Introduction

Before you deploy and publish your Extensions, and to ensure your extension works well, it's important to test it. Testing helps you find and fix any issues early. Zoho Developer Console provides a sandbox environment where you can test all the components, customizations, and automations you've added. 
Alert
CAUTION
  1. When using any Zoho People API with connection support in a custom function, webhook, or widget, ensure that the ZSOID of the extension organization is passed using the portalId key during testing.
  2. Once testing is complete, make sure to remove the portalId parameter before publishing or deploying the extension to the customer.
  3. In Custom Functions and Webhooks, if any API/v3 API is used, the portalId must be passed in the request header with the key PEOPLE_ORG.
  4. For other/API requests, the portalId must be passed as a request parameter using the key portalId.

Accessing Sigma and Initiating Test Enviroment

Follow these steps to initiate testing:
  1. After logging into your Zoho People account, in a new tab, navigate to sigma.zoho.com (Zoho Sigma—Zoho's cloud-based extension development platform.)
  2. Hover pointer over your extension and click on the Pencil (edit) icon.
  3. This will load the respective extension enviroment. This will also include the Test Your Extension button on the top-right corner, click on the button to proceed.
  4. A sandbox organization will be created for you to test your extension. 
  5. If any issues occur, go back to your Extensions page and make the necessary changes.

Steps Associated With Testing Widget / Webtabs

Notes
Depending on the type (external or internal) the steps for testing will vary.
External Widgets/Web Tabs
For external-type widgets or web tabs:
  1. No additional configuration is required inside the widget itself.
  2. Just configure the Connected App in the Extension Org.
  3. Create the widget/web tab.
  4. Launch your Extension Test Environment and navigate to the designated render area.
For internal-type widgets (hosted locally or using ZET CLI):
Steps:
  1. Configure the Connected App.
  2. Create a Widget/Web Tab (e.g., "Home" type).
  3. Click Test Your Extension to access the sandbox environment.


Alert
 Troubleshooting Localhost Connection Issue
If you see an error like:
“127.0.0.1 refused to connect” — this means your local development server isn’t running or accessible. Read below for solution (Run a Local Server).
Follow these steps:
  1. Ensure you’ve created the widget zip using the ZET-CLI tool.
  2. Open your terminal.
  3. Navigate to your widget project directory.
  4. Run the following command:
    1. zet run


  1. Copy and paste your local host address in the a new browser tab.
  2. Click Advanced, followed by Proceed to 127.0.0.1.



  3. Now Navigate to your extension test environment browser tab.
  4. Reload your browser tab to view.


Notes
Scheduler Behaviour:
  1. In the Extension Org, schedulers behave the same as they do in the Production Org.
  2. All scheduler configurations and execution logic remain consistent across environments.
    To configure schedulers in extension org, refer to Custom Schedulers and Email Schedulers.
Repetitive Scheduler Type:
  1. Until development is completed, for repetitive scheduler types, you may disable the scheduler if you do not want it to trigger repeatedly at the configured schedule time.
  2. Before packaging the extension, ensure that the scheduler is enabled again, if required.
One-Time Scheduler Type:
  1. One-time schedulers are installed in the customer org only if the scheduled execution time has not yet passed.
  2. The one-time scheduler will not be installed in the customer org if the customer installs the extension after the scheduled time has passed.