Zoho Sigma helps you to build extensions for Zoho services in two ways:
- Building apps using the command line interface (CLI). You can use this method if you want to build an extension offline with your own code editor.
- Use Zoho Sigma cloud editor and develop extensions without any pre-setup. Manage the entire process online.
To develop an extension using Sigma CLI tool you need to install Node.js and Sigma CLI commands.
Step 1: Install Node.js and ZET CLI
- Install node.js.
- Execute the following command: $ node -v to verify the node.js version ( 7.1.0 and above are supported).
The Zoho extension toolkit is a command line interface tool used to build, test, and pack your extension. Execute the command that is mapped to your OS to install the tool.
For Mac/Unix system
sudo: npm install -g zoho-extension-toolkit
For Microsoft Windows
system: npm install -g zoho-extension-toolkit
-g denotes global installation. When ZET is installed globally, you will be able to execute commands from anywhere on your machine. Otherwise, you will have to navigate to the path where ZET is installed, then execute commands.
- zet -v or zet -version shows the version of the ZET.
- zet - h or zet -help to view all the available commands in ZET.
$ zet -h
Commands:
Init, Creates a new extension template directory
run Starts a local server with current directory as context
Validate Validates the current app with validation rules
Pack Packs the project to upload into marketplace
Step 2: Build an extension
Build extensions using your preferred code editor. Navigate to the directory where you want to build the extension.
- Create source folders or files under app directory.
-
Run the following command to create a new project for the extension
zet init
- Choose a Zoho service, say Orchestly from the list.
- Type the project name and hit Enter.
- A project directory with necessary folders, dependency node packages, and files will be created. app is the folder where you create the source and resource files for your extension.
- Execute cd [extension name]. This command will set the current path to the newly created extension's directory path.
plugin-manifest.json file
A default plugin-manifest file is generated as a part of the project template directory. This is a crucial file, where the JSON parameters of your extension have to be configured before hosting. This file contains meta information about the extension such as widget details, locations, and connectors.
Learn more on how to configure the parameters in this file.
JS SDK
Develop your extension using client-side technologies like HTML, JS, and CSS. Learn more about JS SDK methods supported by different services.
- Orchestly
- Zoho Projects
Step 3: Run an extension
- Run and test the extension in your local machine.
-
Execute the following command in your terminal.
zet run
- This command starts a local server and runs the extension locally.
- Your extension will run on the port 5000. Ensure it is available before you execute this command.
- Enable developer mode while testing your extension.
- Refer to the service specific steps for testing your extension.
Step 4: Validate an extension
- Check if the guidelines specified in the plugin-manifest.json file are met.
-
Execute the following command in the terminal.
zet validate
- Repeat the command, after making necessary changes, until validation proves successful.
Step 5: Pack an extension
- This command compresses the files and folders essential for running the extension and gives a .zip file as the output.
Execute the following command in the terminal.

zet pack
-
The file will be present inside the path "/{extension's directory}/dist".
Sample file path "/myfirstextension/dist".
Step 6: Build your extension in Sigma
- Click Create Extension .
- Enter an extension name.
- Pick a Zoho service for which you’re building the extension.
- Toggle the Upload Existing File option and attach the zip file that you just created.
- Take a look at the terms and conditions and then click Save as Draft .
HTTPS support for localhost server using SSL certificates
What are SSL certificates
An SSL certificate, or Secure Sockets Layer certificate, is a digital certificate that authenticates the identity of a website and provides an encrypted connection between the user’s browser and the website’s server. Websites use two types of SSL certificates:
1. Certificates signed by a Trusted Certificate Authority (CA)
2. Self-signed certificates
While a Trusted CA issues SSL certificates to verify the identity of websites we can also create self-signed certificates that offer basic encryption from the websites. The release of Google Chrome 80 mandates all the webpages to be hosted in HTTPS. To implement this, Sigma provides a default SSL certificate to serve over HTTPS.
Note: You must be logged in to CLI with Developer Mode to generate the self-signed certificate.
How to install an SSL certificate
SSL certificates can be installed to avoid a ‘not secure’ warning in your browser while running ZET projects. We recommend installing the SSL certificate provided in ‘/project_directory/cert.pem’. This is a one-time action for all your ZET projects. We’ve compiled the steps to install the SSL certificate for different operating systems below.
MAC OS
- Open Keychain Access.
- Select System in the left panel.
- Navigate to Certificates at the top menu.
- Drag and drop the certificate from your project directory(/project_directory/cert.pem).
- Provide your authentication to proceed.
The certificate will be displayed with a red ‘X’, meaning it is not trusted yet.
To enable trust,
- Double-click the certificate: *.securly.com.
- Under Trust, select Always Trust in ‘When using this certificate’.
Windows
- Run the command ‘mmc’ in the command prompt.
- Once the Microsoft Management Console opens, click File and select Add/Remove Snap-in.
- Select Certificates and click Add.
- In the ensuing screen, select the Computer account radio button and click Next.
- Click Finish.
- In the Microsoft Management Console window, click Certificates (Local Computer) in the left panel.
- Right-click the Trusted Root Certificate Authorities in the left panel, select All Tasks, and then click Import.
- In the Certificate Import Wizard, click Next.
- Browse to find the Security certificate, select it, and click Open.
- In the Certificate Store window, ensure that Trusted Root Certificate Authorities is enabled and then click Next.
- Click Finish.
- Click OK.
Linux
Navigate to your project directory in the command prompt and execute the following command:
- sudo cp localhost.crt /usr/local/share/ca-certificates/localhost.crt
- sudo update-ca-certificates
Your SSL certificate will be installed and ready once these steps are successfully executed in the corresponding OS.