Configure Bridge agent | Online Help | Qntrl

Configure Bridge agent

Step 1: Set up Bridge 

Setting up Bridge for Mac/Linux 

Once the Bridge file is downloaded as in the previous step, save it in a new directory and open your Terminal.
  1. In the terminal, unzip the downloaded file in a new directory by typing the following command: 
    1. unzip <file-name>
    Note that  Java is bundled with the zip file. If you do not have Java installed in your host, go to, conf/wrapper-bridge.conf and change wrapper.java.command into jre/bin/java.
  2. Go to the bin directory and run the Bridge using the commands: 
    1. (./start.sh) or (./bridge.sh start)                      
To test the connectivity of the bridge before installation, go to the bin directory and execute ./bridge.sh console.
  1. Logs will be displayed in the current console.
  2. If you close the window, the Bridge will be stopped.

Install daemon  for Mac/Linux

To  restart  the Bridge automatically when the host is restarted, install Bridge as a daemon process. This in turn installs the Bridge as a daemon service and adds auto-start scripts to init.d directory. Your directory must be the root for this action to occur.
 
Go to the bin directory and execute: 
  1. sudo ./bridge.sh install
  2. sudo ./start.sh
Note: You cannot install more than one Bridge service as a daemon on a Linux host. This is a limitation of the Tanuki wrapper service.
 
If the Bridge starts successfully,
  1. Open your browser and access http://<hostname>:8500 (if it is same host, then you can mention it as localhost). To get hostname, use hostname command.
  2. 8500 is the default port. You can change it in conf/config.xml. Restart the Bridge if you need to change the port.
  3. You can set proxy details in conf/config.xml. Restart the Bridge to update your changes.

If the Bridge fails to start,
  1. You can verify the reason in wrapper logs (logs/wrapper.log) or bridge logs (logs/logs.txt)
  2. Mostly, the startup fails if the webserver port is occupied by some other application.
 

Setting up Bridge for Windows

Once the Bridge file is downloaded, save it in a new directory and open your Terminal.
  1. In the terminal, unzip the downloaded file in a new directory by typing the following command: 
    1. unzip <file-name>
    Note that Java is bundled with the zip file. If you do not have Java installed in your host, go to, conf/wrapper-bridge.conf and change  wrapper.java.command  into  jre/bin/java.exe
  2. Go to the bin directory and run the Bridge using the commands: 
    1. bridge.bat install and bridge.bat start         
To test the connectivity of the bridge before installation, go to the bin directory and execute  bridge.bat console
  1. Logs will be displayed in the current console.
  2. If you close the window, the Bridge will be stopped.

Install multiple Bridges in a single Windows host

To install multiple bridges, follow these steps:
  1. Execute Open conf/wrapper-bridge.conf
  1. Give an unique name in wrapper.name and wrapper.displayname in all the bridges you want to run and start the Bridge. 

If the Bridge starts successfully,
  1. Open your browser and access http://<hostname>:8500 (if it is same host, then you can mention it as localhost).To get hostname, use  hostname command.
  2. 8500 is the default port. You can change it in conf/config.xml. Restart the Bridge if you need to change the port.
  3. You can set proxy details in conf/config.xml. Restart the Bridge to update your changes.

If the Bridge fails to start,
  1. You can verify the reason in wrapper logs (logs/wrapper.log) or bridge logs (logs/logs.txt)
  2. Mostly, the startup fails if the webserver port is occupied by some other application.

Step 2: Create a new client 

Client ID and Client Secret can be generated by creating a new client using Zoho API Console. Hit the URL https://accounts.zoho.com/developerconsole .  To create a new client, click the + button next to the Client ID in the previous step.
  1. Enter the Client Details :
    1. Client Type: Select the type of application as Server-based Applications .
    2. Client Name: Enter a client name.
    3. Homepage URL: Enter the URL of homepage
    4. Authorized Redirect URIs: Enter the Redirect URI populated in the previous section. (E.g., http://localhost:8500/account/authcallback )
  2. Click Create .              


The Client ID and Client Secret  will be generated.



You can also use the same OAuth credentials in different data centres by enabling Multi-DC option in the Settings tab.



Configure client details

Enter the web server port (e.g.,  http://<hostname>:8500) in your browser , a new tab opens in the local port. Configure the client details here.
  1. Enter the client details:
    1. Accounts Domain: Select the domain you use, either localzoho.com or zoho.com.
    2. Client ID: Enter the client ID generated in the pervious step.
      1. Click + to create a new client. 
    3. Client Secret: Enter the client secret generated in the pervious step.
    4. Redirect URI: A redirect URI will be automatically populated.
  2. Click  Save .


You will now be redirected to a confirmation page. Click  Accept .

Step 3: Login to Bridge 

Once you complete the configuration, you will be prompted to verify your organization. Enter the following details:
  1. Organization Name : Enter your Qntrl organization name for which this Bridge is being configured. 
  2. Bridge Name : Enter the Bridge name created in Step 1 .
  3. Registration Key : Enter the registration key of the created Bridge. This is available under Configuration section of Bridge details. 

  4. Click Start Server.
Once the verification is done, you will  be redirected to the login page.
  1. User Name: Provide a user name.
  2. Password: Enter a password.
  3. Confirm Password: Re-enter the password.
  4. Click Sign Up.
You will now be navigated to Bridge's message list page. You can view all the Bridge calls here. 
 
If you are unable to sign up,
  1. Refresh the Bridge list page to view the current status your Bridge.
  2. Check if you have filled the right data.
  3. Click the Verify Organization button again, and try to refresh.
 

Step 4: Test the Bridge 

To test the Bridge, use the Messages module.
  1. Navigate to  and select Messages under Bridge.
  2. Click the New Message button.
  3. Fill the details:
    1. Title: Enter a title for your message.
    1. Bridge: Select the Bridge you would like to test.
    1. Module: Select the module in which you would like to test the Bridge.
    1. Type: Select the message type.
      1. Synchronous: Executes tasks in the same request and provides response.
      2. Asynchronous: Executes tasks in the background and updates response automatically.
  4. Request Data: Enter the JSON request data.
  5. Response: If the type is Synchronous, you will be able to view the response to the request.
  6. Click Execute.


Once the message is executed successfully, you must be able to view a server call entry in the message list of your local bridge.

Learn more about Bridge Settings.




    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








                                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

                                      Zoho Desk Resources

                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                        Zoho Marketing Automation

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







                                                                                            You are currently viewing the help articles of Sprints 1.0. If you are a user of 2.0, please refer here.

                                                                                            You are currently viewing the help articles of Sprints 2.0. If you are a user of 1.0, please refer here.



                                                                                                  • Related Articles

                                                                                                  • Install Bridge

                                                                                                    Follow the below step-by-step procedures to configure and use Bridge in Qntrl. Step 1: Download the Bridge agent Only one Bridge agent can be installed per machine. To download a Bridge agent in Qntrl: Navigate to >> Advanced >> Bridge >> select ...
                                                                                                  • Bridge agent settings

                                                                                                    View Bridge agent configuration Once the Bridge agent is set up, you will be able to view and modify the allowed Configuration when required. In Qntrl, navigate to (settings) >> Advanced >> Bridge >> select Bridge. Hover your cursor over the Bridge ...
                                                                                                  • Use case for Bridge: Connect with remote databases using Bridge

                                                                                                    Most organizations secure their remote databases using firewalls. If you are looking for a way to navigate these firewalls to access remote databases, Bridge can be of help. Let us try to solve a real-time business case where Bridge is used to access ...
                                                                                                  • Other actions in Bridge

                                                                                                    View / Edit Bridge properties Once you create a Bridge, you can view and edit its properties. Click the Settings gear icon at the top right of the header bar. Navigate to Advanced >> Bridge, and choose Bridge. In the Bridge list page, click the Name ...
                                                                                                  • Overview of Bridge

                                                                                                    What is a Bridge? Bridge is an installable, lightweight independent agent that can be deployed on the customer’s local network. It is compatible both on Windows and Linux machines with 32 and 64-bit OS. Its role is to facilitate communication between ...
                                                                                                    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