Create extensions using CLI | Online help | Zoho Sigma

Create extensions using Command Line Interface(CLI)

Zoho Sigma helps you to build extensions for Zoho services in two ways: 
  1. 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.
  2. Use Zoho Sigma cloud editor and develop extensions without any pre-setup. Manage the entire process online. 

Create an extension using Zoho Extension Toolkit CLI

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 

  1. Install node.js.
  2. 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.
Quote
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. 
Notes
  1. zet -v or zet -version shows the version of the ZET. 
Notes

Notes
  1. 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.   
  1. Create source folders or files under app directory. 
  2. Run the following command to create a new project for the extension
    Quote
    zet init
  3. Choose a Zoho service, say Orchestly from the list.
  4. Type the project name and hit Enter. 

  1. 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.

  1. 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.
  1. Orchestly
  2. Zoho Projects


Step 3: Run an extension  

  1. Run and test the extension in your local machine.
  2. Execute the following command in your terminal. 
    Quote
    zet run
    1. This command starts a local server and runs the extension locally.
    2. Your extension will run on the port 5000. Ensure it is available before you execute this command.
  3. Enable developer mode while testing your extension. 
  4. Refer to the service specific steps for testing your extension. 

Step 4: Validate an extension 

  1. Check if the guidelines specified in the plugin-manifest.json file are met.
  2. Execute the following command in the terminal.
    Quote
    zet validate
  3. Repeat the command, after making necessary changes, until validation proves successful.   

Step 5: Pack an extension

  1. This command compresses the files and folders essential for running the extension and gives a .zip file as the output.
  2. Execute the following command in the terminal.
    Quote
    zet pack
  3. The file will be present inside the path "/{extension's directory}/dist". 
    Sample file path  "/myfirstextension/dist". 

Step 6: Build your extension in Sigma  

  1. Click  Create Extension .
  2. Enter an extension name.
  3. Pick a Zoho service for which you’re building the extension.
  4. Toggle the  Upload Existing File option and attach the zip file that you just created.
  5. 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. 

Notes
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
  1. Open Keychain Access.
  2. Select System in the left panel.
  3. Navigate to Certificates at the top menu.
  4. Drag and drop the certificate from your project directory(/project_directory/cert.pem).
  5. Provide your authentication to proceed.
 
The certificate will be displayed with a red ‘X’, meaning it is not trusted yet.
 
To enable trust,
  1. Double-click the certificate: *.securly.com.
  2. Under Trust, select Always Trust in ‘When using this certificate’.
 
Windows
  1. Run the command ‘mmc’ in the command prompt.
  2. Once the Microsoft Management Console opens, click File and select Add/Remove Snap-in.
  3. Select Certificates and click Add.
  4. In the ensuing screen, select the Computer account radio button and click Next.
  5. Click Finish.
  6. In the Microsoft Management Console window, click Certificates (Local Computer) in the left panel.
  7. Right-click the Trusted Root Certificate Authorities in the left panel, select All Tasks, and then click Import.
  8. In the Certificate Import Wizard, click Next.
  9. Browse to find the Security certificate, select it, and click Open.
  10. In the Certificate Store window, ensure that Trusted Root Certificate Authorities is enabled and then click Next.
  11. Click Finish.
  12. Click OK.
 
Linux

Navigate to your project directory in the command prompt and execute the following command:
  1. sudo cp localhost.crt /usr/local/share/ca-certificates/localhost.crt
  2. sudo update-ca-certificates

Your SSL certificate will be installed and ready once these steps are successfully executed in the corresponding OS. 

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          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







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure Forms

                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now






                                                        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


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                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 Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • Related Articles

                                                                                                                        • Create extensions using online Zoho Extension Toolkit

                                                                                                                          Zoho Extension Toolkit (ZET) is used to create extensions offline in your machine. Once the extensions are created, you'll need to upload the extension as a zip file in Sigma and publish the extension. This can be tedious when you make changes to the ...
                                                                                                                        • Create extensions using Zoho Sigma cloud editor

                                                                                                                          Sigma has introduced a cloud editor where users can build extensions for Zoho services . Upon selecting a Zoho service, the corresponding service’s plug-in manifest file will be pre-populated into Sigma’s editor as a new project, eliminating the need ...
                                                                                                                        • Extensions Gallery

                                                                                                                          Building an extension might be a daunting task, but with Sigma, you can do it with ease. Start creating extensions using ready-made templates available in Sigma. Navigate to Extensions Gallery section on the top right corner. Start creating your ...
                                                                                                                        • Public and Private Extensions

                                                                                                                          Extensions in Sigma can be hosted as Public or Private. While public extensions are hosted for a wider audience, private extensions are restricted to smaller circles.   Public  extensions are hosted through Zoho Marketplace, a platform where all Zoho ...
                                                                                                                        • About Sigma

                                                                                                                          As your company expands, you might add new business processes to your organization and recruit more employees. Having several tools to monitor the development will make managing the organization laborious. Also, if you have to juggle between many ...
                                                                                                                          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