File transfers and file management using Bridge in Qntrl | Qntrl | Bridge | Online Help

File Management

Alert
Early Access
File Management module is not enabled for all users. If you’d like to try it out, please email our support team for early access.
The File Management module facilitates file transfer operations across various locations, providing versatility and convenience for managing your files. It enables you to move files within your network or transfer files to and from cloud storage.
 
This module enables three file transfer modes:
  1. Remote to Cloud (File Upload) - Transfer files from a remote machine to Qntrl's File module, effectively uploading them to your cloud-based storage.
  2. Cloud to Remote (File Download) - Transfer files from Qntrl's File module to a remote machine. This is particularly useful when you need to retrieve files stored in the cloud and download them to your local device.
  3. Remote to Remote (File Transfer) - Transfers files between two machines connected to the same network. It's ideal for moving files directly between remote devices within your network.

Supported file operations

Move - Relocates files from the source to the destination. However, only the files will be removed from the source location, while the source folder persists in its original location.
Copy - Copying creates an exact duplicate of the file and stores it in a different location, while the original file remains in the source.
Recursive - Move/Copy all the files and subfolders within the source directory, including files from nested subdirectories. This is useful for duplicating entire folder structures while maintaining the original hierarchy.
Notes
Recursive is not supported for file download tasks, for downloading a file from Cloud storage.

Use Case

In a common business scenario, when a purchase is completed, it's essential to store invoice and billing copies on a remote machine. This module provides the capability to store these copies efficiently. Process owners can effectively transfer bills and invoices related to a job or file module into designated folders on their remote devices, ensuring well-organized and secure file management.

 

Prerequisite

  • Installation of SSH is necessary on servers where file transfers occur.
  • While creating Credentials, select Type as SSH and provide the user name and password for your remote machine. Click here to learn how to create a credential.
  • An authenticated connection has to be established to interact with the File module. Refer to the OAuth configuration section within the bridge agent to make a connection with the File module.
Payload Formats
Here are the payload examples for each file transfer operation:

1. Cloud to Remote (File Download)

{
   "task_name": "file_task",
   "task_details": {
       "source": {
           "cloud": {
               "path": "<QNTRL FILE MODULE PATH>",
               "type": "qntrl_files"
           }
       },
       "destination": {
           "remote": {
               "path": "<REMOTE FILE PATH>",
               "credential_name": "<CREDENTIAL_NAME>",
               "host": "localhost"
           }
       }
   }
}

 

2. Remote to Cloud (File Upload)

{
   "task_name": "file_task",
   "action": "<move/copy>",
   "subfolder_copy": <true/false>,
   "task_details": {
       "source": {
           "remote": {
               "path": "<REMOTE FILE MODULE PATH>",
               "credential_name": "<CREDENTIAL_NAME>",
               "host": "localhost"
           }
       },
       "destination": {
           "cloud": {
               "path": "<QNTRL FILE MODULE PATH>",
               "type": "qntrl_files",
               "overwrite": true
           }
       }
   }
}

 


3. Remote to Remote (File Transfer)
{
   "task_name": "file_task",
   "action": "<move/copy>",
   "subfolder_copy": <true/false>,
   "task_details": {
       "source": {
           "remote": {
               "path": "<REMOTE FILE MODULE PATH>",
               "credential_name": "<CREDENTIAL_NAME>",
               "host": "<HOST NAME>"
           }
       },
       "destination": {
           "remote": {
               "path": "<REMOTE FILE MODULE PATH>",
               "type": "<CREDENTIAL_NAME>",
               "host": "<HOST NAME>"
           }
       }
   }
}
 
Notes
The regex pattern (*) is not supported for Move operations.
where,

Key

Description

task_name

A system-defined name for the respective modules. 'file_task' is the task name for file management tasks.

action

Specifies the type of file operation to be carried out.

  1. move
  2. copy

subfolder_copy

(optional)

Specifies whether a recursive transfer should be executed or not.  

  1. true
  2. false

By default, it is set to 'true' if not specified.

task_details

A JSON object that contains details of the task.

destination

A JSON object with the information on the location to where the file has to be transferred.

source

A JSON object with the location details from where the file has to be transferred.

remote

A JSON object that contains details of the remote machine to be connected.

cloud

Refers to the cloud network/storage.

path

Location of the file in the remote machine.

credential_name

Name of the credential object created within the Credential module for the remote machine.

host

Host name of the remote machine.

type

'qntrl_files' if the file is available in Qntrl's file module.

overwrite

To update an existing file content.

  1. true
  2. false

Notes

For Windows machines, the file path should be "\\"                                                                                        



      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

                                                              Use cases

                                                              Make the most of Zoho Desk with the use cases.

                                                               
                                                                

                                                              eBooks

                                                              Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                               
                                                                

                                                              Videos

                                                              Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                               
                                                                

                                                              Webinar

                                                              Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                               
                                                                
                                                              • Desk Community Learning Series


                                                              • Meetups


                                                              • Ask the Experts


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner

                                                                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

                                                                                                                        • 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

                                                                                                                          Once the Bridge agent is set up, you can log in to the Bridge agent to view and modify the allowed configuration as needed. To do this: In Qntrl, navigate to (settings) >> Advanced >> Bridge , then select your Bridge. Hover your cursor over the ...
                                                                                                                        • 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 >> choose Bridge. In the bridge list page, choose the ...
                                                                                                                        • 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 ...
                                                                                                                        • Files

                                                                                                                          Files task enables the creation of workflows for file management, offering the following available states: File Upload File Transfer File Download Prerequisite An active Bridge agent. Refer here to install and configure Bridge. Create the necessary ...
                                                                                                                          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