Configuring the SFTP Receiver Channel

Procedure

On the Display Configuration Scenario screen, choose the Objects tab page.
In the Type column, double-click the Communication Channel.
Choose (helps you to switch between the edit and display modes) , 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 Receiver radio button for the SFTP adapter to perform outbound message processing.

Choose the Destination 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
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, which 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 via unique username.
	Private Key View	This parameter determines the name of the Key-store 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 Key-store 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 parameter	Filename	This parameter determines the name scheme of the file that you want to write to the SFTP server.
	Filepath	This parameter defines the directory in the server from where the adapter writes the files. The prefix “~/” along with equals/home/username represents home directory of the configured user mentioned in the Username field.
	Create Directory	This parameter allows the adapter to create directory at the recipient’s server.
	Overwrite	This parameter allows the adapter to overwrite the latest data on the existing data.

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 Note

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

End of the note.

Component	Parameter	Description
Processing parameter	Add Timestamp to filename	This parameter ensures that the archived files are not overwritten and it enables you to sort them according to the time that they were received.
	Add Message-ID to filename	This parameter defines new IDs for each file, which ensures that no files are overwritten. The Integration Engine generates message ID that is added to the file by the adapter.
	Write modus	This parameter defines the mode of writing a file to a target directory. The modes available in this parameter are given below: Direct: In this mode the files are written directly to the specified directory. Append: In this mode the files are written when the inbound messages are appended. Use temporary file: In this mode the files that are to be immediately saved are written in a temporary file name.
	Maximal Concurrency	This parameter determines the maximum number of messages that are processed in concurrently at any point of time.
	Time out	This parameter determines the interval for message processing. If the time elapses then the message is moved to waiting status and the message log is updated.
	Time unit	This parameter allows you to configure the time format of the message to be displayed in the log.
	Empty File Handling	This parameter has two options available to handle empty files, which are given below: Write Empty File: Allows you to place an empty file in the target directory. Ignore: Doesn’t allow writing of any file in the target directory after processing.
	Set Permissions	This parameter defines to change the permission of a file using octal notations. For example, 600.
	Store Attachments	This parameter defines the PI Server to save the attachments of the message in the target folder.
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 Configuring Operating System for Message Processing.
	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.
	Command Line	This parameter defines the operating system command or script line, which is executed after processing the message. For more information, see Configuring Operating System for Message Processing.
	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
Variable substitution (File path/Filename)	Activate	This parameter identifies the message attributes or elements in the message payload found in Filename or Filepath to be substituted with a new value.
Adapter specific Message-Attributes	Use Adapter specific Message-Attributes	This parameter evaluates the adapter specific attributes in the header of the message. To include the adapter specific attributes with the file, specify a namespace along with appropriate attributes such as File name and Directory. The attribute namespace for the SFTP adapter is `“http://sap.com/xi/XI/System”`.
	Directory	This parameter evaluates the directory attribute mentioned in the header of the message.
	Filename	This parameter evaluates the filename attribute mentioned in the header of the message.
Archiving	Archive Files on PI Server	This parameter archives all the processed files in the PI server. 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 Parameter	This parameter defines the names and values that can be additionally configured to the SFTP adapter.

Note Note

Archiving: This feature in SAP NW PI business-to-business add-on allows you to save messages “as they were transmitted” from a source or destination database on your file system. It is the first task practiced after receiving messages with regard to the sender channel and the final task practiced before sending messages with regard to the receiver channel. The location of the archived files is 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”.

End of the note.