Multi-User Support

The NodeJS SDK supports both single-user and multi-user app.

Multi-user App

Multi-users functionality is achieved using the Initializer's static switchUser() method.

Copy to Clipboard
(await new InitializeBuilder())
    .user(user)
    .environment(environment)
    .token(token)
    .SDKConfig(sdkConfig)
    .switchUser();

Use the below code to remove a user's configuration from the SDK.

Copy to Clipboard
await Initializer.removeUserConfiguration(user, environment)

Sample Multi-user code

Copy to Clipboard

const UserSignature = require( "@zohocrm/nodejs-sdk-2.0/routes/user_signature").UserSignature;
const USDataCenter = require( "@zohocrm/nodejs-sdk-2.0/routes/dc/us_data_center").USDataCenter;
const EUDataCenter = require( "@zohocrm/nodejs-sdk-2.0/routes/dc/eu_data_center").EUDataCenter;
const {RecordOperations, GetRecordsHeader, GetRecordsParam} = require("@zohocrm/nodejs-sdk-2.0/core/com/zoho/crm/api/record/record_operations");
const ParameterMap = require("@zohocrm/nodejs-sdk-2.0/routes/parameter_map").ParameterMap;
const HeaderMap = require("@zohocrm/nodejs-sdk-2.0/routes/header_map").HeaderMap;
const ResponseWrapper = require("@zohocrm/nodejs-sdk-2.0/core/com/zoho/crm/api/record/response_wrapper").ResponseWrapper;
const InitializeBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/initialize_builder").InitializeBuilder;
const Initializer = require("@zohocrm/nodejs-sdk-2.0/routes/initializer").Initializer;
const OAuthBuilder = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/oauth_builder").OAuthBuilder;
const Levels = require("@zohocrm/nodejs-sdk-2.0/routes/logger/logger").Levels;
const LogBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/logger/log_builder").LogBuilder;
const DBBuilder = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/store/db_builder").DBBuilder;
const FileStore = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/store/file_store").FileStore;
const SDKConfigBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/sdk_config_builder").SDKConfigBuilder;
const ProxyBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/proxy_builder").ProxyBuilder;

class Record {
    static async call() {
        /*
         * Create an instance of Logger Class that takes two parameters
         * level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
         * filePath -> Absolute file path, where messages need to be logged.
         */
        let logger = new LogBuilder()
        .level(Levels.INFO)
        .filePath("/Users/user_name/Documents/node_sdk_log.log")
        .build();
    
        /*
        * Create an UserSignature instance that takes user Email as parameter
        */
        let user = new UserSignature("abc@zoho.com");

        /*
        * Configure the environment
        * which is of the pattern Domain.Environment
        * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
        * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
        */
        let environment1 = USDataCenter.PRODUCTION();

        /*
        * Create a Token instance
        * clientId -> OAuth client id.
        * clientSecret -> OAuth client secret.
        * grantToken -> OAuth Grant Token. 
        * refreshToken -> OAuth Refresh Token token.
        * redirectURL -> OAuth Redirect URL.
        */
        let token1 = new OAuthBuilder()
        .clientId("clientId")
        .clientSecret("clientSecret")
        .refreshToken("refreshToken")
        .redirectURL("redirectURL")
        .build();

        /*
        * Create an instance of TokenStore.
        * host -> DataBase host name. Default "localhost"
        * databaseName -> DataBase name. Default "zohooauth"
        * userName -> DataBase user name. Default "root"
        * password -> DataBase password. Default ""
        * portNumber -> DataBase port number. Default "3306"
        * tableName -> DataBase table name. Default "oauthtoken"
        */
        let tokenstore = new DBBuilder()
        .host("hostName")
        .databaseName("databaseName")
        .userName("userName")
        .portNumber("portNumber")
        .tableName("tableName")
        .password("password")
        .build();

        /*
        * Create an instance of FileStore that takes absolute file path as parameter
        */
        // let store = new FileStore("/Users/userName/Desktop/nodejs_sdk_tokens.txt");

        /*
        * A Boolean value to allow or prevent auto-refreshing of the modules' fields in the background.
        * if true - all the modules' fields will be auto-refreshed in the background whenever there is any change.
        * if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or the specific module's fields using methods from ModuleFieldsHandler
        */
        let sdkConfig1 = new SDKConfigBuilder().autoRefreshFields(false).pickListValidation(true).build();

        /*
        * The path containing the absolute directory path to store user specific JSON files containing module fields information. 
        */
        let resourcePath = "/Users/user_name/Documents/nodejs-app";

        // let requestProxy = new ProxyBuilder()
        // .host("proxyHost")
        // .port("proxyPort")
        // .user("proxyUser")
        // .password("password")
        // .build();
        /*
        * Call the static initialize method of Initializer class that takes the following arguments
        * user -> UserSignature instance
        * environment -> Environment instance
        * token -> Token instance
        * store -> TokenStore instance
        * SDKConfig -> SDKConfig instance
        * resourcePath -> resourcePath
        * logger -> Logger instance
        */
        try {
            (await new InitializeBuilder())
                .user(user1)
                .environment(environment1)
                .token(token1)
                .store(tokenstore)
                .SDKConfig(sdkConfig1)
                .resourcePath(resourcePath)
                .logger(logger)
                .initialize();
        } catch (error) {
            console.log(error);
        }

        await Record.getRecords("Leads");

        await Initializer.removeUserConfiguration(user1, environment1);

        let user2 = new UserSignature("abc2@zoho.eu");

        let environment2 = EUDataCenter.SANDBOX();

        let token2 = = new OAuthBuilder()
        .clientId("clientId")
        .clientSecret("clientSecret")
        .refreshToken("refreshToken")
        .redirectURL("redirectURL")
        .build();

        let sdkConfig2 = new SDKConfigBuilder().autoRefreshFields(false).pickListValidation(true).build();

        (await new InitializeBuilder())
        .user(user2)
        .environment(environment2)
        .token(token2)
        .SDKConfig(sdkConfig2)
        .switchUser();

        await Record.getRecords("Leads");
    }

    static async getRecords(moduleAPIName) {
        try {

            //Get instance of RecordOperations Class
            let recordOperations = new RecordOperations();

            let paramInstance = new ParameterMap();
    
            await paramInstance.add(GetRecordsParam.APPROVED, "both");
    
            let headerInstance = new HeaderMap();
    
            await headerInstance.add(GetRecordsHeader.IF_MODIFIED_SINCE, new Date("2020-01-01T00:00:00+05:30"));
    
            //Call getRecords method that takes paramInstance, headerInstance and moduleAPIName as parameters
            let response = await recordOperations.getRecords(moduleAPIName, paramInstance, headerInstance);
            
            if(response != null){

                //Get the status code from response
                console.log("Status Code: " + response.statusCode);
    
                if([204, 304].includes(response.statusCode)){
                    console.log(response.statusCode == 204? "No Content" : "Not Modified");
    
                    return;
                }
    
                //Get the object from response
                let responseObject = response.object;
    
                if(responseObject != null){
    
                    //Check if expected ResponseWrapper instance is received
                    if(responseObject instanceof ResponseWrapper){
    
                        //Get the array of obtained Record instances
                        let records = responseObject.getData();
    
                        for (let index = 0; index  {
                                    //Get the Name of each Tag
                                    console.log("Record Tag Name: " + tag.getName());
                                    
                                    //Get the Id of each Tag
                                    console.log("Record Tag ID: " + tag.getId());
                                    
                                });
                            }
    
                            //Get all the values
                            let keyValues = record.getKeyValues();
    
                            let keyArray = Array.from(keyValues.keys());
                            
                            for (let keyIndex = 0; keyIndex 

1. The program execution starts from call()

2. The details of user1 is given in the variables user1, token1, environment1.

3. Similarly, the details of another user user2 is given in the variables user2, token2, environment2

4. Then, the switchUser() function is used to switch between the User 1 and User 2 as required.

5. Based on the latest switched user, the Record.getRecords(moduleAPIName) will fetch record.

SDK Sample Code

Copy to Clipboard
const UserSignature = require( "@zohocrm/nodejs-sdk-2.0/routes/user_signature").UserSignature;
const USDataCenter = require( "@zohocrm/nodejs-sdk-2.0/routes/dc/us_data_center").USDataCenter;
const EUDataCenter = require( "@zohocrm/nodejs-sdk-2.0/routes/dc/eu_data_center").EUDataCenter;
const {RecordOperations, GetRecordsHeader, GetRecordsParam} = require("@zohocrm/nodejs-sdk-2.0/core/com/zoho/crm/api/record/record_operations");
const ParameterMap = require("@zohocrm/nodejs-sdk-2.0/routes/parameter_map").ParameterMap;
const HeaderMap = require("@zohocrm/nodejs-sdk-2.0/routes/header_map").HeaderMap;
const ResponseWrapper = require("@zohocrm/nodejs-sdk-2.0/core/com/zoho/crm/api/record/response_wrapper").ResponseWrapper;
const InitializeBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/initialize_builder").InitializeBuilder;
const Initializer = require("@zohocrm/nodejs-sdk-2.0/routes/initializer").Initializer;
const OAuthBuilder = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/oauth_builder").OAuthBuilder;
const Levels = require("@zohocrm/nodejs-sdk-2.0/routes/logger/logger").Levels;
const LogBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/logger/log_builder").LogBuilder;
const DBBuilder = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/store/db_builder").DBBuilder;
const FileStore = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/store/file_store").FileStore;
const SDKConfigBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/sdk_config_builder").SDKConfigBuilder;
const ProxyBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/proxy_builder").ProxyBuilder;

class Record{

    static async getRecords(){

        /*
         * Create an instance of Logger Class that takes two parameters
         * level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
         * filePath -> Absolute file path, where messages need to be logged.
         */
        let logger = new LogBuilder()
        .level(Levels.INFO)
        .filePath("/Users/user_name/Documents/node_sdk_log.log")
        .build();

        /*
        * Create an UserSignature instance that takes user Email as parameter
        */
        let user = new UserSignature("abc@zoho.com");

        /*
        * Configure the environment
        * which is of the pattern Domain.Environment
        * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
        * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
        */
        let environment = USDataCenter.PRODUCTION();

        /*
        * Create a Token instance
        * clientId -> OAuth client id.
        * clientSecret -> OAuth client secret.
        * grantToken -> OAuth Grant Token. 
        * refreshToken -> OAuth Refresh Token token.
        * redirectURL -> OAuth Redirect URL.
        */
        let token = new OAuthBuilder()
        .clientId("clientId")
        .clientSecret("clientSecret")
        .refreshToken("refreshToken")
        .redirectURL("redirectURL")
        .build();

        /*
        * Create an instance of TokenStore.
        * 1 -> DataBase host name. Default "localhost"
        * 2 -> DataBase name. Default "zohooauth"
        * 3 -> DataBase user name. Default "root"
        * 4 -> DataBase password. Default ""
        * 5 -> DataBase port number. Default "3306"
        */
        let tokenstore = new DBBuilder()
        .host("hostName")
        .databaseName("databaseName")
        .userName("userName")
        .portNumber("portNumber")
        .tableName("tableName")
        .password("password")
        .build();

        /*
        * Create an instance of FileStore that takes absolute file path as parameter
        */
        // let store = new FileStore("/Users/userName/Desktop/nodejs_sdk_tokens.txt");

        /*
        * A Boolean value to allow or prevent auto-refreshing of the modules' fields in the background.
        * if true - all the modules' fields will be auto-refreshed in the background whenever there is any change.
        * if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or the specific module's fields using methods from ModuleFieldsHandler
        */
        let sdkConfig1 = new SDKConfigBuilder().autoRefreshFields(false).pickListValidation(true).build();

        /*
        * The path containing the absolute directory path to store user specific JSON files containing module fields information. 
        */
        let resourcePath = "/Users/user_name/Documents/nodejs-app";

        // let requestProxy = new ProxyBuilder()
        // .host("proxyHost")
        // .port("proxyPort")
        // .user("proxyUser")
        // .password("password")
        // .build();
        /*
        * Call the static initialize method of Initializer class that takes the following arguments
        * user -> UserSignature instance
        * environment -> Environment instance
        * token -> Token instance
        * store -> TokenStore instance
        * SDKConfig -> SDKConfig instance
        * resourcePath -> resourcePath
        * logger -> Logger instance
        */
        try {
            (await new InitializeBuilder())
                .user(user)
                .environment(environment)
                .token(token)
                .store(tokenstore)
                .SDKConfig(sdkConfig)
                .resourcePath(resourcePath)
                .logger(logger)
                .initialize();
        } catch (error) {
            console.log(error);
        }

        try {
            let moduleAPIName = "Leads";
    
            //Get instance of RecordOperations Class
            let recordOperations = new RecordOperations();
    
            let paramInstance = new ParameterMap();
    
            await paramInstance.add(GetRecordsParam.APPROVED, "both");
    
            let headerInstance = new HeaderMap();
    
            await headerInstance.add(GetRecordsHeader.IF_MODIFIED_SINCE, new Date("2020-01-01T00:00:00+05:30"));
    
            //Call getRecords method that takes paramInstance, headerInstance and moduleAPIName as parameters
            let response = await recordOperations.getRecords(moduleAPIName, paramInstance, headerInstance);
            
            if(response != null){

                //Get the status code from response
                console.log("Status Code: " + response.statusCode);
    
                if([204, 304].includes(response.statusCode)){
                    console.log(response.statusCode == 204? "No Content" : "Not Modified");
    
                    return;
                }
    
                //Get the object from response
                let responseObject = response.object;
    
                if(responseObject != null){
    
                    //Check if expected ResponseWrapper instance is received
                    if(responseObject instanceof ResponseWrapper){
    
                        //Get the array of obtained Record instances
                        let records = responseObject.getData();
    
                        for (let index = 0; index  {
                                    //Get the Name of each Tag
                                    console.log("Record Tag Name: " + tag.getName());
                                    
                                    //Get the Id of each Tag
                                    console.log("Record Tag ID: " + tag.getId());
                                    
                                });
                            }
    
                            //Get all the values
                            let keyValues = record.getKeyValues();
    
                            let keyArray = Array.from(keyValues.keys());
                            
                            for (let keyIndex = 0; keyIndex 

Record Response