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 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 below section explains how to set up File states within a circuit configuration.

File Upload  

Builder View

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. The Bridge ID field should capture the details of the Bridge to be used for this task. 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.
   

1. Move - Relocates files from source to destination.
   

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

1. Host - Enter the hostname/IP address of the machine from where the file has to be uploaded.
   

2. Credential Name - Select the credential of the source machine from the dropdown list.
   

3. 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 Input / Output, enter the Input Path, Output Path, and Result Path. Learn more about I/O paths.

Code view

"Upload Employee Documents": {
	"type": "file_upload",
	"next": "Wait Period for Orientation",
	"bridge_id": "bridge-1368_1",
	"payload": {
		"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"
			}
		},
		"recursive": true,
		"action": "copy"
	}
}

File Transfer

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. The Bridge ID field should capture the details of the Bridge to be used for this task. Select the bridge to be configured from the drop-down list.  

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

1. Move - Relocates files from source to destination.
   

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

1. Host - Enter the hostname/IP address of the machine from where the file has to be transferred.
   

2. Credential Name - Select the credential of the source machine from the dropdown list.
   

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

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

2. Credential Name - Select the credential of the destination machine from the dropdown list.
   

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

7. In Input / Output, enter the required paths. Learn more about I/O paths.

Code view

"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