Configuration | Online Help | Zoho BugTracker

Configuration plugin-manifest.json

plugin-manifest.json

Here's a sample JSON descriptor file for your reference.

Now we'll see how to define the properties of this file.

locale

The language the extension supports. Currently, we support the locale "en" (English) only.

Key
Type
Value
locale*
JSONArray
en

service

Name of the Zoho product for which the extension is created. Here, it is "PROJECTS".

Key
Type
Value
service*
String
PROJECTS

storage

If this setting is true, storage space will be allocated in the product for this extension. By default, the value will be false.


Key
Type
Value
storage*
Boolean

  1. true
  2. false

whiteListedDomains

The domains specified in this array can be called from the extension. Calls to other domains, except the ones with which a connection is established, will not be handled from the extension. If your extension doesn't use any third-party service, then this array can be declared empty.


Key
Type
Value
whiteListedDomains*
Array

modules

Modules of the extension. We support widgets currently.


Key
Type
Value
modules
JSONObject

Example:

"widgets":[{
"location":"task_tab",
"name":"GDrive for Zoho Projects",
"url":"/app/index.html",
"countkey" : "extensionUniqueKey"
}]

widgets

This key holds an array of objects. Every object has three keys - 'location', 'name', and 'URL'.


Key
Type
Object Details



widgets
JSONArray
Key
Type
Description
Value


String
Places where the extension has to be rendered in the product.
  • issue_tab
  • app_settings
  • top_band
  • attachment_picker
  • issuedetails_rightpanel
Note: The location name must be unique.


name
String
The name of the widget.
Example: Checklist


url
URL
The relative path of the file that loads the widget.
/app/index.html


icon
String
The icon of the widget
Icon is mandatory for attachment picker


countkey
(milestone_tab and issue_tab)
String
Unique id to retrieve the widget count.
extensionUniqueKey

An extension can have multiple widgets.

Note: extensionUniqueKey is used to store/update the extension data.

connectors

Like widgets, this key also holds an array of objects. A connector helps to integrate an extension with a third-party service. Authorization of such third-party services is usually handled by Zoho Projects.


Key
Type
Object Details



connectors
JSONArray
Key
Type
Description
Value


connectionLinkName
String
Link name generated for the third-party service connection

The value of the connectionLinkName param generated in the JSON tab of the connection summary.

Note: The connection name must be unique.



connectionName
String
Name of the connection
The value of the connectionName param generated in the JSON tab of the connection summary.


serviceName
String
Name of the third-party service
The value of the serviceName param generated in the JSON tab of the connection summary.


userAccess
Boolean
This parameter decides whether the extension has to be authorized by each user individually or it has to be authorized only by the admin.
  • true
  • false


isUserDefinedService
Boolean
Is the connection established with a custom service?
  • true
  • false


Scope
JSONArray
The access privilege set for the users/admins.
An extension can be connected to a maximum of five third-party services at once.

config

This key can be used when you have to get more inputs from the user to operate the extension. Say, you need the user's domain name of a third-party service for your extension to function. To fetch it, you can use this key to get input from the user accordingly.


Key
Type
Object Detail



config
JSONArray
Key
Type
Description
Value


name*
String
Name of the parameter.
The name should be unique.


type*
String
The data type of the parameter
  • 'text'
  • 'password'
  • 'checkbox'
  • 'url'
  • 'number'
  • 'multiline'
  • 'selectbox'
  • 'hidden'


default
String
The default value of the parameter
Note: This parameter is optional.


options
JSON array
Options are mandatory if 'select box' is chosen as the type.
Example ["New feature", "Enhancement"]


is_secure*
Boolean
Setting this to "true" prevents the developer from accessing this configuration from the extension.
  • true
  • false


is_mandatory
Boolean
Is the configuration mandatory?
  • true
  • false


description
String
A brief description of the configuration
Note: This parameter is optional.



    Zoho CRM Training Programs

    Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

    Zoho CRM Training
      Redefine the way you work
      with Zoho Workplace

        Zoho DataPrep Personalized Demo

        If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

        Zoho CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION










                                    You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                        Manage your brands on social media

                                          Zoho Desk Resources

                                          • Desk Community Learning Series


                                          • Digest


                                          • Functions


                                          • Meetups


                                          • Kbase


                                          • Resources


                                          • Glossary


                                          • Desk Marketplace


                                          • MVP Corner


                                          • Word of the Day


                                            Zoho Marketing Automation

                                              Zoho Sheet Resources

                                               

                                                  Zoho Forms Resources


                                                    Secure your business
                                                    communication with Zoho Mail


                                                    Mail on the move with
                                                    Zoho Mail mobile application

                                                      Stay on top of your schedule
                                                      at all times


                                                      Carry your calendar with you
                                                      Anytime, anywhere




                                                            Zoho Sign Resources

                                                              Sign, Paperless!

                                                              Sign and send business documents on the go!

                                                              Get Started Now




                                                                      Zoho TeamInbox Resources



                                                                              Zoho DataPrep Resources



                                                                                Zoho DataPrep Demo

                                                                                Get a personalized demo or POC

                                                                                REGISTER NOW


                                                                                  Design. Discuss. Deliver.

                                                                                  Create visually engaging stories with Zoho Show.

                                                                                  Get Started Now









                                                                                                      • Related Articles

                                                                                                      • Configuration

                                                                                                        Configure your portal by uploading an image. Send notifications from Zoho BugTracker from your own domain. Edit portal URL, portal owner and rename the bugs tab. Portal Owner can also delete the portal, Portal Settings Update Portal Logo Click in the ...
                                                                                                      • Configuration

                                                                                                        Client Permissions Configure your client permissions and privileges. You can set the default client permissions to view the bugs for the selected project. And you can collaborate with your clients and work on the bugs. In Client Permissions, select ...
                                                                                                      • Portal Configuration

                                                                                                        In the Portal Configuration, we help you configure your company settings, customize fields, groups, and templates, and configure all the project modules with ease. Org Settings Configuration Update Portal Logo Portal Details Prefix & ID Sender Email ...
                                                                                                      • Create extensions using CLI

                                                                                                        Overview Zoho Marketplace is an online store where you can upload the extensions you develop for any of the products of Zoho. You can also use the available extensions in our store for your business. This developer guide will help you build an ...
                                                                                                      • List of widget locations in Zoho BugTracker

                                                                                                        Location An extension's widget can be rendered in multiple locations inside the product. This key (location) defines where the widgets should be rendered. Zoho BugTracker provides a list of widget locations. The key for the location should be ...
                                                                                                        Wherever you are is as good as
                                                                                                        your workplace

                                                                                                          Resources

                                                                                                          Videos

                                                                                                          Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                          eBooks

                                                                                                          Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                          Webinars

                                                                                                          Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                          CRM Tips

                                                                                                          Make the most of Zoho CRM with these useful tips.



                                                                                                            Zoho Show Resources