Configuring the SFTP Sender Channel

Procedure

On the Display Configuration Scenario screen, choose the Objects tab page.
In the Type column, double-click the Communication Channel.
Choose Edit to configure the adapter.
In the Edit Communication Channel screen area, enter the channel parameters.
In the Display Language field, select the required application UI language.
Choose the Identifiers tab page and enter the parameters that identify the sender and receiver agencies.
Choose the Module tab page and enter the parameters that specify generic modules for adapters.
Choose the Parameters tab page and select the Sender radio button for the SFTP adapter to perform inbound message processing.

Choose the Source tab page and enter the values in the respective fields based on the description of the parameters mentioned in the table below:

Component	Parameters	Description
SFTP Server	Server	This parameter determines the TCP/IP address or the host name of the SFTP server, which establishes a secure communication between the client and the SFTP server on the network. Contact your server administrator to obtain the TCP/IP address or the host name of the SFTP server.
	Port	This parameter identifies the port of the SFTP server. The default port number is “22”. Contact your server administrator to obtain the port number of the SFTP server.
	Timeout (ms)	This parameter defines the maximum permissible amount of time (in milliseconds) that the transmitted message remains unacknowledged by the server. After the lapsed time the adapter terminates the connection.
	Server Fingerprint	This parameter identifies the SFTP server with a unique key. Each SFTP server has a unique key that is used to encrypt the server connection. Contact your server administrator to obtain the SFTP Server Fingerprint. An example of the Server Fingerprint key is shown below: 56:45:40:67:e3:a1:72:4f:43:59:f7:23:3f:1c:d8:5f
Proxy	Proxy	This parameter specifies the types of proxy server, which are used to communicate with the SFTP server. The SFTP adapter supports SOCKS4, SOCKS5 and HTTP types of proxy servers. The No Proxy option allows you to connect to the SFTP server without using the proxy server.
	Server	This parameter determines the TCP/IP address or the host name of the proxy server, which establishes connection with the proxy server on the network.
	Port	This parameter identifies the port of the proxy server.
	Username	(Optional) This parameter authenticates the proxy server using a valid username.
	Password	(Optional) This parameter authenticates the proxy server using a valid password.
Authentication Method - Password	Username	This parameter authenticates the client to the server using the username.
Authentication Method - Password	Password	This parameter authenticates the message at the source using a valid password.
Authentication Method - Private Key	Username	This parameter authenticates the message at the source using a valid username of the Private Key. Each private key is accessed by a unique username.
	Private Key View	This parameter determines the name of the keystore view, which stores the private key certificates. The Private Key View is applied from the Entries in Secure Store screen.
	Private Key Entry	This parameter determines the name of the keystore entry, which holds cryptographic information used to encrypt the message at the source. The Private Key Entry is applied from the Entries in Secure Store screen.
File	Filename	This parameter determines the name scheme of the file that you want to transfer. The field accepts regular expression. The files, whose name matches the expression, are retrieved.
	Directory	This parameter defines the directory in the server from where the adapter retrieves files. The prefix “~/” along with equals/home/username represents home directory of the configured user mentioned in the Username field.
	Advanced Source File Selection	This parameter enables the SFTP adapter to poll for files in multiple directories at a given time and exclude specific files from the directories. The options available are described below: The Exclusion Mask field specify the file type that has to excluded from communicating to the recipient. For example, if you specify .*pdf, then "pdf" files are excluded from sending. The Ignore Individual Directory Not Found Errors feature allows the adapter to ignore change directory (cd) errors during switching directories and continue processing files in other directories. If you do not check this option, then the adapter stops processing directory when it encounters a cd error.
	Additional Files	This parameter specifies additional files to be included in the XI message as attachments. Note For more information on attaching additional files in the sender adapter, see Specifying Additional Files in the Sender File Adapter.
Period	Poll Interval (minimum 10 seconds)	This parameter determines the response time of the adapter to check for stored files in the source directory. If the poll interval is less than 10 seconds, then the minimum interval of 10 seconds is considered as default.

Choose the Processing tab page and enter the values in the respective fields based on the description of the parameters mentioned in the table below:

Note

The parameters in the Processing tab page allow you to define the file transferring process in an adapter.

Component	Parameter	Description
Processing parameters	Delete File	(Optional) This parameter deletes the processed files from the sender server.
	Process Empty File	This parameter determines the processing of a file according to the modes given below: Process Empty File: Allows you to process files by creating XI messages with an empty payload. Skip Empty File: Allows you to skip the processing of an empty file without creating XI messages. Create No Message: Does not create XI messages from empty files, but processing such as deleting and archiving can be performed on these files.
	Duplicate File Checking	This parameter checks for duplicate files (on the basis of file size, SFTP server details, last modified timestamp, and the correct file path) or if a file is processed earlier.
	Interval (ms) for modification check	This parameter defines the sender channel to poll the directory at regular intervals and checks for file modifications. The SFTP adapter polls after every interval and checks for the last modified time and size of the file. The criteria for the adapter to process the file is given below: If the file has been modified, then it is not processed. If the file is not modified, then it is processed. The default value of interval is 100 ms.
	Maximum file size restriction	This parameter restricts the maximum size of a file (Byte). The Error when restricted option changes the status of the communication channel to an error state, if the file size exceeds the limit set for the file size and it still allows the channel to process the message.
	Process Sequence	This parameter determines ascending or descending order, which the files are to be processed either by date or by file name.
	Archive faulty files	This parameter allows the Integration Engine to archive faulty source files to a target folder located in the source directory. The Archive name field defines a name that refers to the archived data. For more information on archiving, see the note below.
	Stop processing after faulty file	This parameter allows the Integration Engine to terminate the process if faulty source files are detected.
Quality of Service	Quality of Service	This parameter determines the manner in which a message is delivered by the Integration Engine.
Run Operating System Command Before Message Processing	Command Line	This parameter defines the operating system command or script line, which is executed before processing the message. For more information, see Defining OS Commands for Message Processing by SFTP Adapter.
	Timeout (sec)	This parameter determines the maximum time taken to execute the program.
	Terminate Program After Timeout	This parameter indicates the adapter to terminate the executing program in the event of a timeout.
Run Operating System Command After Message Processing	Command Line	This parameter defines the operating system command or script line, which is executed after processing the message. For more information, see Defining OS Commands for Message Processing by SFTP Adapter.
	Timeout (sec)	This parameter determines the maximum time taken to execute the program.
	Terminate Program after Timeout	This parameter indicates the adapter to terminate the executing program in the event of a timeout.

Choose the Advanced tab page and enter the values in the respective fields based on the description of the parameters mentioned in the table below:

Component	Parameter	Description
Adapter specific message attributes	Set adapter specific message attributes	This parameter defines the adapter to store specific attributes in the message with the file by specifying a URL in the Namespace field along with appropriate attributes such as: File Name Directory File Size Time Stamp SFTP Host
Archiving on SFTP Server	Archive files on SFTP server	This parameter archives all the processed files in the SFTP server. The location of the target folder is provided in the Archive name field.
Archiving on File System	Archive files on File System	This parameter archives all the processed files in the local system. The location of the target folder is provided in the Archive name field.
Adapter status	Adapter status	This parameter has two options, which are given below: Active: Enables the adapter to exchange messages. Inactive: Disables the adapter to exchange messages.
Advanced Mode	Additional Parameters	This parameter defines the names and values that can be additionally configured to the SFTP adapter

Note

Archiving: This feature enables you to save messages transmitted from a source or destination database "in original format" on your file system. It is the first task practiced after receiving messages with regard to sender channel and the final task practiced before sending messages with regard to receiver channel. The location of the archived files are shown in the Archive name text box. The file path of the archiving location can contain the substitution parameters to ensure uniqueness of the archived file.

The archiving parameters used in the Integration Engine are as follows:

%SEQNUM: A sequence number, starting with 1
%RTSEQNUM: A server wide sequence number, starting with 1
%START: The start time of the adapter
%TIME: The archiving period in milliseconds
%MSGID: The XI message ID

For example, the archiving parameters used to define a file path to an archive location are shown as "D:/x400Archiv/%TIME_%SEQNUM.msg".