Prerequisite 

1. Node.js (version 7.1.0 or higher)
   
2. npm (version 3 or higher )
   
   

Creating Public Sigma 

1. Installing ZET
 

 2. Creating the ZET Project   

(i) Execute the below command in the terminal to list the Zoho services.

$ZET init

(ii) Select Zoho IOT in the Zoho services list and hit enter.

(iii) Enter the name of the project when prompted.

The ZET Sigma project will be created.

Note: A default plugin-manifest.json file is generated as a part of the project template directory. This is a core configuration file placed at the root directory that has the location where the application has to be loaded.

 3. Starting the ZET Server   

Initializing Sigma SDK 

 
1. Loading the Sigma SDK  

Note: The initializing of the SDK should happen only after downloading the sigma-sdk.min.js file.

 

2. Initializing the Sigma SDK 

 3. Communicating with UI client to get Data 

 
Validating, Packing, and Uploading the Application 

 1. Validating the Application 

 2. Packaging the  Application 

 3. Uploading the  Application

1. category
   
1. tab - customized page in the main menu tab
   
2. form - customized form or user-created custom module addition
   
2. module - this is mandatory for "form category"
   
3. Extension zip (the packaged ZIP file generated in the previous step)
   

 Notes: To show the Sigma extension as a tab (menu), it has to be added as a menu through the Navigation Menu in the Zoho IoT Developer Portal. You can see Sigma Extensions as one of the modules there. 

Sigma Extension - SDK Utils 

1. Get Current User
   

Use this to get current logged in user details

Sample: GET  ZIOT.iotSDK.get('current-user')

 

ZIOT.iotSDK.get('current-user').then((response)=>{         //your logic });

Response can be used to include own logic.

1. Get Org/Application info
   

Use this to get org/application details

Sample: GET  ZIOT.iotSDK.get('app_info')

ZIOT.iotSDK.get('app_info').then((response)=>{         //your logic });

1. Get Client portal info
   

Use this to get client portal details

Sample: GET  ZIOT.iotSDK.get('client_portal_meta')

ZIOT.iotSDK.get('client_portal_meta').then((response)=>{         //your logic });

1. Get All records by module
   

Use this to get records array by module (Get Records API) with pagination

Sample: GET  ZIOT.iotSDK.get(['records', '<module_apiname>', '', queryparams])

ZIOT.iotSDK.get(['records', '<module_apiname>', '', queryparams]).then((response) => { // your logic });

Refer to API documentation for query params.

1. Get specific record by module
   

Use this to get record by module

Sample: GET  ZIOT.iotSDK.get(['record', '<module_apiname>', <record_id>, queryparams])

ZIOT.iotSDK.get(['record', '<module_apiname>', <record_id>, queryparams]).then((response) => { // your logic });

Refer to API documentation for query params.

1. Get module

Sample: GET  ZIOT.iotSDK.get(['modules', '<module_apiname>', queryparams]);

ZIOT.iotSDK.get(['modules', '<module_apiname>', queryparams]).then((response) => { // your logic });

Refer to API documentation for query params.

1. Get total records count of module
   

Use this to get records count by module

Sample: GET  ZIOT.iotSDK.get(['records_total_count', <module_api>, queryparam]);

ZIOT.iotSDK.get(['records_total_count', <module_api>, queryparam]).then((response) => { // your logic });

Refer to API documentation for query params.

1. Get related records of a specific record
   

Use this to get related record count by module

Sample: GET  ZIOT.iotSDK.get(['records_total_count', <module_api>, <record_id>, <related_list_api_name>, queryParam]);

ZIOT.iotSDK.get(['related-records', <module_apiname>, <record_id>, <related_list_api_name>, queryParam]).then((response) => { // your logic });

 

Refer to API documentation for query params.

1. Get total related records count of a specific record
   

Sample: GET  ZIOT.iotSDK.get(['records_total_count', <module_api>, <record_id>, <related_list_api_name>]);

ZIOT.iotSDK.get(['related-records', <module_api>, <record_id>, <related_list_api_name>]).then((response) => { // your logic });

1. Get BD data by datapoint name
   

Use this to get BD data by giving datapoint name and source name

Sample: GET     ZIOT.iotSDK.get(['datapoints_data', queryparam]);

let queryparam = {         source: <record name>,       datapoint_name: <datapoint_name>,       days: 1, hrs: 4, aggregation: 'avg', time_grouping: 'hour'     }; ZIOT.iotSDK.get(['datapoints_data',queryparam]) .then((response)=>{ //Your logic     });

1. Create record by module
   

Use this to create a record for a module

Sample: GET     ZIOT.iotSDK.dispatch('createRecord', {module: <module_apiname>, data: {}});

ZIOT.iotSDK.dispatch('createRecord', {//No I18N         module: <module_apiname>,//No I18N         data: {<module_apiname>: {}}     }).then((response)=>{ //Yur logic     });

1. Update record by module
   

Use this to update a record for a module

Sample: PUT     ZIOT.iotSDK.dispatch('updateRecord', {module: <module_apiname>, data: {}});

ZIOT.iotSDK.dispatch('updateRecord', {//No I18N      module: <module_apiname>,//No I18N      data: {<module_apiname>: {}}     }).then((response)=>{ //Yur logic     });

1. Delete record by module
   

Use this to delete a record for a module

Sample: DELETE     ZIOT.iotSDK.dispatch('deleteRecord', {module: <module_apiname>, id: <record_id>});

ZIOT.iotSDK.dispatch('deleteRecord', {//No I18N      module: <module_apiname>,//No I18N      id: <record_id>     }).then((response)=>{ //your logic     });