Build and Distribute Extension

Note: Currently, you can only build widgets as extensions in your Creator.

Step 1: Build Extension

1. Log in to developer.zoho.com and click Start Building in the Sigma card.
   
2. Under the Extensions section, click New Extension.
   
3. Provide a Name and Description to your extension. Choose the service as Creator.
   
4. Read and agree to the terms and conditions, then click Create .
   
5. 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.
6. Click Browse on the Widget File field to upload widget zip file that you have created. 
Note : The maximum accepted file size is 10MB


7. 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: Test Extension  

Once you’ve created your extension, you’ll be able to test it before publishing it to the marketplace.

1. Click Test, and a sandbox testing application will be initiated. Use the available extension to ensure it's working.
   

   

Note: As this application is exclusively designed to test extensions, some of its features will be limited. However, you can continue to use essential functions, such as forms, pages, reports, and workflows. Learn more

2. Create a page in the application by clicking the + icon in the header area of the application builder.
   

3. In the page builder, open Widgets in the left-side pane.
   
   

4. Drag and drop the extension widget that you created onto the page for testing. Click Done.
   

   Note: Configure your widget configurations is the widget parameters were created.
   
   

5. Click Access this application to go to the live mode of your application and test that the extension is working. Click the back arrow present in the top bar to distribute your extension.
   

Note:

- The test application extension will be loaded from the localhost URL 'https://127.0.1:5000/app/'. Make sure you run the command 'zet run' to start the local HTTP server. The port (5000) should not be occupied with any other process before starting the server, if it is occupied then the widget will not be rendered.

- Click Extension References to see all the places where the extension is being used.

Step 3: Distribute Extension

1. Click the Publish button present on the top bar.
   
   
2. Provide a Title and Description for your extension. The version will be auto-generated. Click Publish. Choose to enable your extension to multiple DC's.
   

   

   Note: Once the extension is published to multiple DC's, you can't disable it.

   
   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,
3. Click Submit to Marketplace from the success pop-up. You will be directed to the Version section in Extension Details page.
   
4. In the STATUS column, click Submit to MarketPlace near the version that you want to publish.
   

Manage Extensions 

1. View extension details
2. Edit extensions and publish new versions
   

View Extension Details

1. Go to Extensions module in Sigma.
   
2. Hover over the extension and click the    icon. 
   

1. General Details: This section contains the description of the extension, last modified date and time, extension visibility, service name, and developer name.
   
2. 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

Note :   

1. For updating the basic extension details like Name and Description, click the edit icon   in the extension details page. 
   
2. 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.

1. Navigate to extension details page.
   
2. Click Edit Extension.
   
   You will be directed to the extension builder
3. 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.
4. 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.

Related Topics

1. Overview of Building a Zoho Creator Extension
   
2. Understand Extensions
   
3. Install and Manage Extensions