Sychronous File Transfer

triggers Open File Transfer system to transfer the files (send or receive) synchronously between two connected Open File Transfer systems.

Overview

This Snap triggers Open File Transfer system to transfer the files (send or receive) synchronously between two connected Open File Transfer systems.


Synchronous Snap Settings dialog

Prerequisites

None.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input Optional. This Snap has at most one document. Mapper
Output This Snap has exactly one document output view. Router
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Account configuration.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / field set Type Description
Label String Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.
Local OpenFT Server Directory String/Expression Required. Specify the folder path in the local system where OFT Agent is running

Default value: N/A

Example: adl://storename/folder/directory

Local OpenFT Server Filename String/Expression Enter the file name in the local system where OFT Agent is running.

Default value: N/A

Example: sl-test-docs

Remote OpenFT Server Directory String/Expression Specify the folder path in the remote OFT system.

Default value: N/A

Example: test-docs

Remote OpenFT Server Filename String/Expression Enter the file name in the remote OFT system.

Default value: N/A

Example: sftp://sftp.mock.com/students/grades

Direction Dropdown list Select if you want to send or receive the file.

Default value: Send

Example: Recieve

File Type Dropdown list Select the File type supported by OpenFT systems during file transfer. Options available are:
  • User format
  • Binary
  • Extension
  • Text

Default value: Binary

Example: Text

Write Mode Dropdown list Select the mode supported by the OpenFT systems during file transfer. Options available are:
  • Overwrite
  • New
  • Extend

Default value: Overwrite

Example: New

Compressed Checkbox Select if you want the compressed output.

Default status: Deselected

Transparent Checkbox Select if you want the transparent output.

Default status: Deselected

Encrypted Checkbox Select if you want the encrypted output.

Default status: Deselected

Tab Extension Dropdown list Select the settings for the tab extensions Options available are:
  • Automatic
  • On
  • Off
FNC Mode Dropdown list Select the encoding mode for the file name in the long output of log records. Options available are:
  • Character
  • Transparent

Default value: CHARACTER

Example: TRANSPARENT

Management Password String/Expression Specify the management password to access the file system.

Default value: N/A

Example: N/A

Remote OpenFT Server Command Use this fieldset to configure the OpenFT remote server commands. This field set contains the following fields:
Successful String Specify the command to execute in Remote Open File Transfer system after a successful file transfer.

Default value: N/A

Example: Copy

Aborted String Specify the command to execute in Remote Open File Transfer system after the file transfer is failed.

Default value: N/A

Example: delete

Inherit Modification Date Checkbox Select if you want the Snap to inherit the modification date of the sent file.

Default status: Deselected

Local OpenFT Server Command Use this fieldset to configure the OpenFT local server commands. This field set contains the following fields:
Successful String Specify the command to execute in local Open File Transfer system after a successful file transfer (executes the command where the OFT Agent is running)

Default value: N/A

Example: Copy

Aborted String Specify the command to execute in Local Open File Transfer system after the file transfer is failed (executes the command where the OFT Agent is running).

Default value: N/A

Example: delete

Snap execution Dropdown list Select one of the three modes in which the Snap executes.
Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.