Files state in Circuit | Qntrl | Circuit | Online Help

Files

Files task enables the creation of workflows for file management, offering the following available states:

  1. File Upload
  2. File Transfer
  3. File Download 

Prerequisite

  • An active Bridge agent. Refer here to install and configure Bridge.

  • Create the necessary Credentials for the applications to be connected by the Files module.

For more details about the File management module in Bridge, the keys, and its description, click here.


Example Use Case: In the employee onboarding process, once the employee verification is done and approved, the documents related to the employees have to be uploaded and saved for future reference and compliance purposes.

 

The following section explains how to set up File states within a circuit configuration.

File Upload  

By integrating the state into your workflow, you can upload files to Qntrl's File module.

Builder View

For associating a File Upload state to a circuit:

  1. In Builder View, drag and drop the File Upload state from the left pane into your circuit or click the required File Upload state in your circuit.

  2. Under Configuration, update the common state field attributes. 

  3. Bridge ID field should capture the details of the bridge to be used for this task. Click and select the required Bridge from the drop-down list.  

  4. In the Add Configuration section, choose whether to enable recursive transfers by selecting the Is Recursive checkbox, and then specify the desired action type.

    • Move - Relocates files from source to destination.

    • Copy - Copying replicates the file to a distinct location, leaving the original file intact in the source.

  5. Under the Source Details section, fill in the following fields:

    • Host - Enter the hostname of the machine from where the file has to be uploaded.

    • Credential Name - Click and select the credential of the source machine from the dropdown list.

    • Path - Location of the file from where the file has to be uploaded.

  6. Under the Destination Details section, enter the Path location of the file to where it has to be uploaded.

  7. In the Error Handling section, you can select and configure error handling settings. For additional details, refer to the Error Handling in the circuit states.
  8. In Input/Output, enter the required paths. To learn more about I/O paths, click here.                

      


Code view

In Code View, the JSON to configure a state in circuit for uploading a file is given below:
"Upload Employee Documents": {
      "type": "file_upload",
      "next": "Wait Period for Orientation",
      "bridge_id": "bridge-employee onboarding",
      "payload": {
            "recursive": true,
            "action": "copy",
            "source": {
             "remote": {
                   "host": "qntrl-hr-machine",
                   "credential_id": "api_cred_1",
                   "file_path": "/Users/qntrl-hr-machine/files/employees/idlist.csv"
             }
            },
            "destination": {
             "cloud": {
                   "file_path": "/Qntrl/HRFiles"
             }
            }
      }
}


File Transfer

File Transfer state is used to perform file transfer operations from one remote location to another remote location during your workflow process.

Builder View

For associating a File Transfer state to a circuit:

  1. In Builder View, drag and drop the File Transfer state from the left pane into your circuit or click the required File Transfer state in your circuit.

  2. Under Configuration, update the common state field attributes. 

  3. Bridge ID field should capture the details of the bridge to be used for this task. Click and select one of the Bridges from the drop-down list.  

  4. In the Add Configuration section, choose whether to enable recursive transfers by selecting the Is Recursive checkbox, and then specify the desired action type.

    • Move - Relocates files from source to destination.

    • Copy - Copying replicates the file to a distinct location, leaving the original file intact in the source.

  5. Under the Source Details section, fill in the following fields:

    • Host - Enter the hostname of the machine from where the file has to be transferred. 

    • Credential Name - Click and select the credential of the source machine from the dropdown list.

    • Path - Location of the file from where the file has to be transferred.

  6. Under the Destination Details section, fill in the following fields:

    • Host - Enter the hostname of the destination machine to where the file has to be transferred.

    • Credential Name - Click and select the credential of the destination machine from the dropdown list.

    • Path - Location of the file to where the file has to be transferred.

  7. In Input/Output, enter the Input Path, Output Path, and Result Path. To learn more about I/O paths, click here. 

Code view

In Code View, the JSON to configure a state in Circuit for transferring a file is given below:
"Transfer Documents": {
      "type": "file_transfer",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
      "payload": {
            "recursive": true,
            "action": "copy",
            "source": {
                 "remote": {
                      "host": "<Host IP of the remote machine>",
                      "credential_id": "<credential_name>",
                      "file_path": "<source_file_path>"
                 }
            },
            "destination": {
                 "remote": {
                      "host": "ncs mc",
                      "credential_id": "files_6",
                      "file_path": "hdsnjd"
                 }
            }
      }
}

File Download  

The state facilitates file downloads from Qntrl's File module to the remote machine.

Builder View 
For associating a File Download state to a Circuit:
  1. In Builder View, drag and drop the File Download state from the left pane into your Circuit or click the required File Download state in your Circuit.

  1. Under Configuration, update the common state field attributes. 

  1. Bridge ID field should capture the details of the Bridge to be used for this task. Click and select the Bridge to be configured from the drop-down list.  

  1. Under the Source Details section, enter the Path location of the file from where the file has to be downloaded.

  1. Under the Destination Details section, fill in the following fields:

    1. Host - Hostname/IP address of the destination machine to where the file has to be downloaded.

    2. Credential Name - Click and select the credential of the destination machine from the dropdown list.

    3. Path - Location of the file to where the file has to be downloaded.

  2. In Input/Output, enter the required paths. To learn more about I/O paths, click here. 

Code view 

In Code View, the JSON to configure a state in Circuit for downloading a file is given below:
"Download a File": {
      "type": "file_download",
      "next": "End",
      "start": true,
      "bridge_id": "<Bridge Name>",
      "payload": {
            "source": {
                 "cloud": {
                     "file_path": "<source_file_path>"
                 }
            },
            "destination": {
                 "remote": {
                     "host": "<Host IP of the machine>",
                     "credential_id": "<credential_name>",
                     "file_path": "<destination_file_path>"
                 }
           }
      }
}


    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









                                            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









                                                                                                              • Related Articles

                                                                                                              • Files

                                                                                                                The files module acts as a repository to keep the organization's paperwork organized. Users with the permission to manage organizational settings can access and organize files in this module. Business cases Using Bridge, the log files on the local ...
                                                                                                              • File Management

                                                                                                                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 ...
                                                                                                              • What kind of files can be imported or exported in Cards?

                                                                                                                Qntrl allows users to import cards saved in XLS, XLSX, or CSV files. This helps to automate cards and track the progress efficiently.  You can also export   the data available in cards either as an XLS or CSV file.  
                                                                                                              • Dropbox Extension

                                                                                                                Share files from your Dropbox account, right into Qntrl using this extension.     Business Scenarios Share user manuals with customers or vendors Share files of other apps to record inventory and production Share audio recordings for specific ...
                                                                                                              • What types of attachments can be added to email templates?

                                                                                                                You can add four types of attachments to an email template. Click the icon on the bottom tray and choose the files to attach .  1.   Choose files to attach : Attach files from your computer. 2.   Latest attachments from Card  : Attach the five most ...
                                                                                                                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