Build and Distribute Extension
Extensions are the software components or add-ons that let you extend the functionalities of Zoho Creator.
Learn more
about extensions.
Note:
Currently, you can only build
widgets
as extensions in your Creator.
Step 1: Build Extension
-
Log in to
developer.zoho.com
and click
Start Building
in the
Sigma
card.
-
Under the Extensions section, click
New Extension.
-
Provide a
Name
and
Description
to your extension. Choose the service as
Creator.
-
Read and agree to the terms and conditions, then click
Create
.
-
On the next page, enter the widget name in the
Name
field
Note:
To build a widget extension, you need to create a custom widget that must be validated and packed as a .zip file based on your requirement. To do so,
follow these steps.
-
Click
Browse
on the
Widget File
field to upload widget zip file that you have
created.
Note : The maximum accepted file size is 10MB
-
Specify the name of index page inside the widget zip file in
Index File
field and click
Save.
Info:
The index page refers to the main HTML file where the execution starts.
Note:
The index name should be mentioned in the following format: /<index_page_name>.html
Step 2: Distribute Extension
After building, your extension is ready to be published. When you publish your extension, it creates a version of your extension. In order to make your extension available for all users across Zoho Creator, you should submit your extension in Marketplace.
To publish the extension,
-
Click
Publish.
-
Provide a
Title
and
Description
for your extension. The version will be auto-generated. Click
Publish.
Your extension will be published and a success pop-up will be shown. Now, continue the steps below to submit your extension in Marketplace.
To submit extension in Marketplace,
-
Click
Submit to Marketplace
from the success pop-up. You will be directed to the
Version
section in
Extension Details
page.
-
In the
STATUS
column, click
Submit to MarketPlace
near the version that you want to publish.
The
Marketplace Details
form will pop up to collect the details of the extension for submitting it in Zoho Marketplace.
Refer to this link
to fill up the
Marketplace Details
form.
After submitting the extension, it will go through a review process. You can check the status of your app in the My Apps section in
partner console.
Manage Extensions
When you publish an extension in Marketplace, it is available for all Zoho users to install and use. Yet, it is important to manage your extension by releasing new versions by enhancing the extension functionalities, updating the description, fixing the faults, and so on.
Managing extensions includes:
-
View extension details
-
Edit extensions and publish new versions
View Extension Details
You can view the general and version details of the extension within this section.
-
Go to Extensions module in
Sigma.
-
Hover over the extension and click the
icon.
You will be directed to the extension details page with the following details:
-
General Details:
This section contains the description of the extension, last modified date and time, extension visibility, service name, and developer name.
-
Version:
This section has the list of published versions of the extension, which includes version number, created date, updated date, and version status.
Edit Extensions and Publish New Version
You cannot edit the extension directly, however, you can make changes in the extension source file on your machine and upload the
updated zip file
in the Sigma to create new versions.
Note :
-
For updating the basic extension details like Name and Description, click the edit icon
in the extension details page.
-
Refer to this link
for information on viewing and updating the details of your extension in Marketplace, such as policy, supported edition, description, pricing, and other such information.
-
Navigate
to extension details page.
-
Click
Edit Extension.
You will be directed to the extension builder
-
Edit the desired parameters, such as the widget name or upload the modified widget file, and specify the index page, as specified while
building extension. Click
Save.
Your extension has been modified, and it is ready to be published.
-
Publish
your extension. You can notice the change in the auto-generated version number resembling the new version is being published.
Note:
Every time you publish a new version of your extension, you must submit it in the marketplace for review to make it available for all users.
-
Overview of Building a Zoho Creator Extension
-
Understand Extensions
-
Install and Manage Extensions