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.

File Upload  

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

"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

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

"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  

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.

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 Bridge to be configured from the drop-down list.  

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

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

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