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

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

  • 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": "<FILE PATH>",
 		"credential_name": "<REMOTE CREDENTIAL NAME>",
		"host": "<HOST NAME>"
	    }
	},
	"destination": {
	    "remote": {
		"path": "<FILE PATH>",
		"credential_name": "<REMOTE CREDENTIAL NAME>",
		"host": "<Host Name>"
	    }
	}
    } 
}


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

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




    • Related Articles

    • 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 necessary ...

    • Bridge Agent Configuration

      The Bridge Agent serves is the local management console for your Bridge installation. It provides access to service configurations, execution logs, messages, credentials, and communication settings. The Agent UI is accessible only from within the ...

    • Files

      Files and Folders act as a central repository to keep your organization's paperwork organized. Every time a card gets executed, it accumulates attachments or files that support it. Storing these files in a central, easy to retrieve location provides ...

    • SSH Engine

      SSH Engine state is configured to connect to a client's machine or network and remotely execute commands or scripts on the client's Linux/UNIX operating system. Prerequisite Bridge must be installed and should be active. Learn how to install and ...

    • Credentials

      The Credential module provides a streamlined solution for storing and managing authentication credentials for databases, remote machines, and application servers. Instead of entering usernames, passwords, or API keys repeatedly across multiple tasks, ...