OpenFT File Reader

transfers files from the target system to the SnapLogic system.

Overview

This Snap transfers files from the target system to the SnapLogic system. It notifies the OFT Agent to receive the configured file from the remote system to the shared folder in the helper system. After the content is saved successfully, the Snap reads the file content from the shared folder and write to the binary output view.


OpenFT File Reader 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.
Output This Snap has exactly one document output view. Delete File
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.
Shared OpenFT Server Directory String/Expression Required. Specify the path of the shared directory.

Default value: N/A

Example: adl://storename/folder/filename

File name String/Expression Required. Specify the name of the file.

Default value: N/A

Example: sl_test_docs

Directory path in helper system String/Expression Required. The directory pathin the local system where OpenFT Agent is running.

Default value: N/A

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

Directory path in target system String/Expression The directory path in the remote system where the file is existing.

Default value: N/A

Example: adl://storename/folder/filename

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: Bimary

Example:

Write Mode Dropdown list Select the mode supported by the OpenFT systems during file transfer. Options available are:
  • Overwrite
  • New
  • Extend
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 Selectif you want the encrypted output.

Default status: Deselected

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

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

Default status: Deselected

Priority Dropdown list Select the priority of the file transfer. Options available are:
  • Low
  • Normal
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.