Building extensions #1: Creating, testing, and editing Zoho Projects extensions using the cloud editor

Building extensions #1: Creating, testing, and editing Zoho Projects extensions using the cloud editor

Hello!! We're happy to announce the beginning of a new series called "Building Extensions," which aims to help guide developers in creating and developing extensions for Zoho Projects. The goal of this series is to assist developers with the extension creation process, as well as to explore the features and functionalities that are available in the developer platform to build extensions for Zoho Projects.

Extensions are essentially plugins or add-ons that extend a Zoho product's existing functionality by either enhancing itsexisting features or integrating with other applications and performing third-party actions from within the Zoho product itself. Zoho offers a developer platform named Sigma, which is intended exclusively for building extensions for various Zoho products.

In our first post of this new series, we'll look at how to create, test, and edit a Zoho Projects extension. Let's take a look at each of these topics individually.

Creating an extension using the Sigma cloud editor
  • Go to Sigma and access your workspace.
  • Once you enter your workspace in Sigma, you will be taken to the Extensions section in Sigma.
  • You may either build a new extension entirely from scratch, or use one of Sigma's current templates to begin your extension development process.
  • To begin creating an extension using a template, simply select the Extensions Gallery option in your workspace.

  • Choose an extension from the options available in Zoho Projects to begin creating one with a template. When you select an extension, you will be taken to the Sigma cloud editor, where you will find a template for that extension.
  • Alternatively, you can also start building an extension entirely on your own. To do this, click the New Extension button to start creating and building an extension.
  • Enter a Name and Description for the extension. Choose the service as Zoho Projects.

  • There are two ways you can create an extension for Zoho Projects:
➤ Using the cloud editor
➤ Using the command line interface (CLI)
  • Toggle Upload Existing File to YES to build your extension using CLI, and NO to develop it using the cloud editor.
  • In this post, we'll look at how to create an extension with the cloud editor. So toggle to NO, accept the terms and conditions, then click Create.
Note: We'll be exploring building extensions using CLI in our next post.

  • You'll be redirected to the cloud editor for the extension you've created, where an app folder and a plugin-manifest.json file will be available by default.
  • The app folder will have a defined directory structure populated automatically for the sample Zoho Projects extension. This app folder can be used to manage all of the important resources that are required for your extension.
  • The plugin-manifest.json will help with the configuration of your extension. It contains a set of keys and values that determine your extension's settings.
Note: We'll go over most of these keys in detail when we get into the related feature and functionality in upcoming posts.

  • When you examine the default plugin-manifest json file populated in the cloud editor, you'll find the widgets key being configured with these details for a default sample widget:
➤ A name key mapped with the sample widget name as "Projects Extension."
➤ A location key mapped with the default location as "task_tab." This key determines the location to load thewidget. Zoho Projects supports multiple locations where you can load widgets. You can select the location based on your requirements; however, the default location is the task details tab.
➤ An URL key that holds the path or location of the HTML file that will be loaded as the widget UI. By default, the path is defined as: /app/index.html.
  • The cloud editor also includes a pre-populated index.html file in the app folder that will be loaded as the widget UI in the task details tab.


Now that we've looked at the folders and files that are created by default when an extension is created, let's now explore how you can test this extension in a testing environment.

Testing an extension using the cloud editor
  • The Sigma cloud editor allows you to test your extension functionalities in a testing environment before publishing the extensions and installing them in a Zoho Projects portal.
  • To test the extension, click Run in the cloud editor.

  • You'll be taken directly to a specific portal in your Zoho Projects account. If you only have one portal, you'll be landing directly in that portal. If you have multiple portals, you'll be prompted to select the portal where you wish to test your extension.
Note: The extension's components (for example, widgets) can be tested in the portal by selecting the Run option; however, no instance of the component will be reflected on the portal until the extension is published and installed in that portal.

  • Once you've entered the testing environment, click on a task to enter the task details page, because the extension you've created has a sample widget named Projects Extension in the task details tab.

  • On the task details page, you can view the widget named Projects Extensions as an individual task tab. Click on the Projects Extensions tab.

  • The widget will be loaded with the UI as available in the index.html file.

  • Once you are done with testing your extension functionalities, switch to the cloud editor tab and click Stop.

  • In what situations can we use the Run option?
➤ To run the extension for the first time in the testing environment.
➤ Whenever the plugin-manifest.json file is modified, you have to use the Run option again.
Note: If you make modifications to any other files, simply refresh the extension to see the changes; there's no need to use Stop and Run again.
➤ When you use the Stop option to end a test and then want to retest the extension, the Run option has to be used.
Editing an extension using cloud editor
  • Whenever you want to make changes to your extension code, choose the Extensions section in the left panel of your Sigma workspace.
  • Hover over the extension to which you want to make changes. Click on Edit Builder icon.

  • You'll be taken to the cloud editor of that particular extension, then you can go ahead and make your edits.
  • Alternatively, you can also click on the Extension Details icon.

  • Then, click Edit Extension.
  • This method will also take you to the cloud editor of the extension where you can make necessary changes.
In this post, we've covered creating an extension, testing it, and making changes to it. We hope you found this information useful. Keep following us for more information!

Sign up for a Zoho Developer account ans start developing extensions for Zoho products using Sigma.

    Access your files securely from anywhere







                            Zoho Developer Community




                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts





                                                            Manage your brands on social media



                                                                  Zoho TeamInbox Resources



                                                                      Zoho CRM Plus Resources

                                                                        Zoho Books Resources


                                                                          Zoho Subscriptions Resources

                                                                            Zoho Projects Resources


                                                                              Zoho Sprints Resources


                                                                                Qntrl Resources


                                                                                  Zoho Creator Resources



                                                                                      Zoho CRM Resources

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner









                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources

                                                                                              Zoho Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ



                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                              • Recent Topics

                                                                                                              • Leistungsdatum in Rechnungen (Zoho Books)

                                                                                                                Hallo, ist es irgendwie möglich den Leistungszeitraum in der Rechnung aufzuführen? Beste Grüße Aleks
                                                                                                              • Unable to Create Task as a Support Administrator

                                                                                                                Hello! I want to ask for help regarding creating tasks within the tickets. I am by default the Support Admin. I should be able to create tasks or activities right? But there's a prompt that I need to contact the Administrator. See photos for reference.
                                                                                                              • Utilisation de Zoho en conformité avec l’article 286 du Code général des impôts (CGI)

                                                                                                                Cher(e) client(e), Conformément à l’article 286 du Code général des impôts (CGI) impose aux entreprises assujetties à la TVA d’utiliser des systèmes de caisse ou de gestion commerciale certifiés lorsqu’elles enregistrent des ventes à des particuliers.
                                                                                                              • Introducing Forms in Zoho Sheet

                                                                                                                We hereby bring you the power of ​forms in Zoho Sheet. ​Now, build and create your own customized forms using Zoho Sheet. Be it compiling a questionnaire or rolling out a survey, Zoho Sheet can do it all for you. Forms is an excellent feature that helps you collect information in the simplest of ways and having it in Zoho Sheet takes it a notch higher. Build Simple yet Powerful forms Building forms using Zoho Sheet is fairly simple. The exclusive 'Form' tab lets you create one quickly. Whether you
                                                                                                              • Layout one survey question in a time & redirect next Page based on previous response

                                                                                                                I have doubt while, I am scripting survey on the Zoho where I redirecting to next page based on my previous response but didn’t get success on this. Please help me on this and tell me how I layout one survey questions in a time when I submit response
                                                                                                              • Seeking help to be able to search on all custom functions that are defined

                                                                                                                Hello I have a lot of custom functions defined (around 200) and i would like to search some specific strings in the content of those. Is there a way to accomplish that? If not, is there a way to download all existing custom functions in some files locally
                                                                                                              • Zoho Bookings form pre-filled with Zoho Forms in

                                                                                                                Hi, I've got a contact page on my website and I'd like to have the option to book an appointment (redirected to zoho bookings page) after an option is submitted on the contact form. how would I go about doing this? thanks
                                                                                                              • Support “Other” Option with Free Text in Dropdown Fields

                                                                                                                Hello Zoho Bookings Team, Greetings, We would like to request an enhancement to the registration form fields in Zoho Bookings, specifically for dropdown fields. Current Limitation: At the moment, dropdown fields do not support an “Other” option that allows
                                                                                                              • How to Customize Task Creation to Send a Custom Alert Using JavaScript in Zoho CRM?

                                                                                                                Hello Zoho CRM Community, I’m looking to customize Zoho CRM to send a custom alert whenever a task is created. I understand that Zoho CRM supports client scripts using JavaScript, and I would like to leverage this feature to implement the alert functionality.
                                                                                                              • Sending automated messages that appear in the ticket's conversation thread

                                                                                                                Good morning, esteemed Zoho Desk community, warm greetings Today I am here to raise the following problem, seeking a solution that I can implement: I need to implement an automation that allows me to send reminder messages to customers when I am waiting
                                                                                                              • Introducing parent-child ticketing in Zoho Desk [Early access]

                                                                                                                Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-child
                                                                                                              • Whatsapp Connection Status still "Pending" after migration

                                                                                                                Hello, I migrated my WhatsApp API to Zoho from another provider a day ago. So far the connection status is still “Pending”. There is a problem? How long does it usually take?
                                                                                                              • Payment Card or Identity form-fill from Vault?

                                                                                                                Hello! I'm working on replacing Bitwarden with Vault and one issue I've run into is that I can't find any option to fill address and payment forms from Payment Card or Identity info that has been saved in Vault. Is there a way to do this? Is it a planned
                                                                                                              • Ability to add VAT to Retainer Invoices

                                                                                                                Hello, I've had a telephone conversation a month ago with Dinesh on this topic and my request to allow for the addition of VAT on Retainer Invoices.  It's currently not possible to add VAT to Retainer Invoices and it was mutually agreed that there is absolutely no reason why there shouldn't be, especially as TAX LAW makes VAT mandatory on each invoice in Europe!   So basically, what i'm saying is that if you don't allow us to add VAT to Retainer Invoices, than the whole Retainer Invoices becomes
                                                                                                              • Ability to assign Invoice Ownership through Deluge in FSM

                                                                                                                Hi, As part of our process, when a service appointment is completed, we automated the creation of the invoice based on a specific business logic using Deluge. When we do that, the "Owner" of the invoice in Zoho FSM is defaulted to the SuperAdmin. This
                                                                                                              • filtering lookup field options based on information in another module.

                                                                                                                In our CRM system. We have the standard Accounts and Deals modules. We would like to introduce the ability to classify Accounts by Sector. Our desired functionality is to have a global list of all sectors that an Account can select, with the ability to
                                                                                                              • How can i view "Child" Accounts?

                                                                                                                It can be very useful in our field of business to know the parent-child account relationship. However, there seems to be a shortcoming in the parent account view:  no child account list. How can we view the child accounts per each account?
                                                                                                              • Time Log Reminder

                                                                                                                Tracking the time spent on tasks and issues is one of the most important functions of a timesheet. However, users may forget to update the time logs because they have their own goals to achieve. But, time logs must be updated at regular intervals to keep
                                                                                                              • Shift-Centric View for Assigning and Managing Shifts in Zoho People

                                                                                                                Hello Zoho People Product Team, Greetings and hope you are doing well. This feature request is related to Zoho People - please don't move it to zoho one! We would like to submit a feature request regarding the shift assignment and management view in Zoho
                                                                                                              • FSM - Timesheet entires for Internal Work

                                                                                                                Hi FSM Team, Several of my clients have asked how they can manage internal timesheets within Zoho FSM. Since their technicians already spend most of their day working in FSM, it would be ideal if they could log all working hours directly in the FSM app.
                                                                                                              • [Early-access] Introducing Zoho's CommandCenter - Cross-Zoho business process automation

                                                                                                                  Resources to help Webinar recording | Documentation  Feature Restrictions Currently available on early-access only for US data center accounts Features Role CommandCenter as a Service uses signals across Zoho services to propel the movement of records
                                                                                                              • Someone made ActiveSync and Autodiscover work, with iOS and macOS

                                                                                                                Hi, I'm trying to set this up for the fifth day now and I"m not getting anywhere. Weird thing is that somewhen in the beginning, I had it working, when I still had VirtualServers and certificates mixed up. But now it's all fine, I have the XML file from
                                                                                                              • Profile Page View Customization

                                                                                                                I need to change the fields, sections from the profile view of an emplyoyee.
                                                                                                              • Tip #58- Accessibility Controls in Zoho Assist: Learning- 'Insider Insights'

                                                                                                                Learning should be clear and interruption-free for everyone. Timely feedback plays an important role in helping users understand actions as they happen, without breaking their focus. In this post, we’ll explore the final section of Accessibility: Learning.
                                                                                                              • ZIA "Generate Content" action doesn't have contexual data from the ticket

                                                                                                                "Generate Content" action doesn't have contexual data from the ticket. I try to get AI to help me with this ticket but it doesn't seem to have any ticket information as context. Although the ticket has a lot of information in it.
                                                                                                              • Zoho Desk - Zoho FSM Integration issue on Mobile and iPad

                                                                                                                Hello Team, I am trying to create a Work Order (WO) using the Zoho FSM integration (Add-on Service) that is integrated with Zoho Desk. The issue is that the integration is not working on mobile devices and iPads. While I am able to create the WO, Request,
                                                                                                              • E-File Form 1099 Directly With the IRS From Zoho Books

                                                                                                                The Form 1099 filing season has begun, and businesses are required to e-file certain forms with the IRS to report payments made to vendors and contractors. If your business made qualifying payments during the year, you must e-file the appropriate Form
                                                                                                              • Can I hide empty Contact fields from view?

                                                                                                                Some contacts have a lot of empty fields, others are mostly filled. Is there a way I can hide/show empty fields without changing the actual Layout? I would like to de-clutter my view, and also be able to add information later as I am able. I would be willing to learn to code a button, but I am highly confused about it and thus worried it would be beyond me.  I've looked at a lot of the developer documents and I'm not able to make a lot of sense of them.  Thank you in advance to anyone who knows the
                                                                                                              • Totals for Sales Tax Report

                                                                                                                On the sales tax report, the column totals aren't shown for any column other than Total Tax. I can't think of a good reason that they shouldn't be included for the other columns, as well. It would help me with my returns, for sure. It seems ludicrous
                                                                                                              • Suggestions for showing subscribed Topics in CRM (contact record)

                                                                                                                We have several Topics set up in ZMA. We also have a sync set up between ZMA and CRM. I'd like to display the subscribed topics on the CRM Contact record. This will allow the Sales team (who uses CRM) to see at a glance what topics a Contact is subscribed
                                                                                                              • Replies sometimes creating separate ticket

                                                                                                                Sometimes when a customer responds to an email coming from Zoho Desk, instead of adding a reply to the original ticket, a separate ticket is created. This happens even though the response subject line contained the ticket number, and the person responding
                                                                                                              • Highlight a candidate who is "off limits"

                                                                                                                Hello: Is there a way to highlight a candidate who is "off limits"?  I would like to have the ability to make certain candidate and / or Client records highlighted in RED or something like that.   This would be used for example when we may have placed a candidate somewhere and we want everyone in our company to quickly and easily see that they are off limits.  The same would apply when we want to put a client or former client off limits so no one recruits out of there. How can this be done? Cheers,
                                                                                                              • Zoho Trident Windows - Streams Not Visible

                                                                                                                Namaste We’re having an issue with Streams not being visible in Trident (Windows), which is important for us as we share many emails internally. It appears that the feature to show Streams above the Inbox folder, as seen in the default mailbox view, is
                                                                                                              • Kill zoho meeting

                                                                                                                Saying the quiet part out loud. Can zoho please just give up on the idea that they can make a meeting platform and just make our workplace licenses cheaper when you remove it so people can switch to zoom or teams. Tired of the excuses, you guys cant make
                                                                                                              • Re-hide fields when option is unselected

                                                                                                                Hi all Can anyone help me with this - when I create a 'show' field rule for when a dropdown option is selected, how to I make it so the 'show' option re-hides if that option is no longer selected?
                                                                                                              • Allow Attaching Quartz Recordings to Existing Zoho Support Tickets

                                                                                                                Hi Zoho Team, We would like to request an enhancement to how Zoho Quartz recordings integrate with Zoho Support tickets. Current Behavior: At the moment, each Quartz recording automatically creates a new support ticket. However, in many real-world scenarios:
                                                                                                              • I'm getting this error when I try to link an email to a deal inside the Zohomail Zoho CRM extension.

                                                                                                                When I click "Yes, associate," the system displays an "Oops!! Something went wrong" error message. I have attached a screenshot of the issue for reference.
                                                                                                              • Custom Fields

                                                                                                                There is no way to add a custom field in the "Timesheet" module. Honestly, the ability to add a custom field should be available in every module.
                                                                                                              • Workflow Down/Bug

                                                                                                                We have a workflow that sends an email to one of our internal departments 10 minutes after a record is created in a custom module. The workflow actually works correctly. However, we have now noticed that on January 8, between 3:55 p.m. and 4:33 p.m.,
                                                                                                              • Remove the “One Migration Per User” Limitation in Zoho WorkDrive

                                                                                                                Hi Zoho WorkDrive Team, Hope you are doing well. We would like to raise a critical feature request regarding the Google Drive → Zoho WorkDrive migration process. Current Limitation: Zoho WorkDrive currently enforces a hard limitation: A Zoho WorkDrive
                                                                                                              • Next Page