Welcome to Portal

?Unknown\pull-down

Welcome to Zoho Cares

Bienvenido a Soporte de Zoho

Search our knowledge base, ask the community or submit a request.

A walkthrough tutorial for building a simple extension using Sigma

This tutorial's objective is to teach you the fundamentals of Sigma to build an extension.

STEP 1: Create your app

For this tutorial, let us create a new extension with Zoho Projects service to display 'Hello World' text. This extension will be displayed within the related section of tasks and issues.
  1. Login to sigma.zoho.com.
  2. Navigate to the Extensions module.
  3. Click New Extension.
  4. Enter the Name, Description, and choose Zoho Projects in Service.  
  5. Click the radio button to Agree to the terms and conditions.
  6. Click Save as Draft.
Once done, you'll be navigated to cloud editor with default files.


plugin-manifest.json

By default, plugin-manifest.json file will be opened in the cloud editor. The plugin-manifest contains all the metadata about your extension.
 
Structure of plugin-manifest.json:  
 
This file holds the details of an extension.

connectors: Integrate with third party apps using Connectors. If the connectors are configured and authenticated once, it can be commonly used in all extensions. Connectors are not used in this instance since this is a basic project extension. Know more about connectors from this help document.
 
whiteListedDomains: Mention the specific domains here if your extension needs third-party services. When making API calls, the extension can access only the domains specified. Other domains won't be supported due to security reasons. If no external access is required for the extension, the array can be kept empty.

service: It is the product for which the extension is created. Here the service will be Zoho Projects.

storage: Data storage can be enables or disabled for the extension. By default, the value will be false.

locale: It is the language that is supported by the extension. We only support English at the moment ("en").
 
modules : These are the modules supported in the extension.  Currently, we support Widgets module in Sigma. Within Widgets, you can provide the Name of the extension, location where the extension should be displayed and URL of the initial page of the extension.


index.html

Now, let's move on to index.html file. 

You can customize this HTML file as per your requirement. For 'Hello World' extension, update the text content in the file.



Below are the other required directories and files created in a project template directory:
 
app
This contains all the files required for the front-end component of the extension.
img
This contains all the images of the extension.
translations
This folder contains the files that are required for translating the app in other languages. 

STEP 2: Test the extension

  1. Click Run at the top bar to run and test the extension.
  2. You'll be navigated to the Zoho Projects portal to test the extension.
  3. In case you are a part of multiple portals, in the ensuing pop-up, select the organization in which you would like to run the extension.
  4. Go on to a task/ issue.
  5. Click (...) in the related section and choose Projects Extension.
  6. Hello World extension will be displayed within the task/ issue. 




Refer to this help document to know how to publish an extension in Sigma.  


Helpful?00
Updated: 11 months ago
Share :
1 comment

The zet CLI tool keeps saying that it must be mapped to a cloud model, but that isn't explained anywhere in the documentation. There are also no man pages for zet and the help info doesn't mention it.