Data interface: SFTP adapter

General

An SFTP adapter in a data interface enables the secure and automated transfer of data between systems via the Secure File Transfer Protocol (SFTP). In logistics applications, it is often used to reliably exchange delivery notes, orders, dispatch information or stock levels between companies, suppliers and logistics service providers.

Requirements

An SFTP server
Data interface for SFTP in the web service directory
Firewall rules for the smooth exchange of data between COGLAS & SFTP server
A COGLAS user with the WebAPI role

Input options

All input options are described in detail in tables. Mandatory fields, optional fields and buttons are each explained in separate tables.

Mandatory fields Source adapter	Description
sourceAdapter Type = Sftp	The SourceAdapter type ‘SFTP’ must be used as the source adapter in the data interface
FileType	File type that is output. e.g.: idoc
InboundDirectory	A directory for uploading data
OutboundDirectory	A directory for polling data
QueryIntervalSeconds	Specification of the inverval for retrieving data in seconds
SftpHost	Host IP address of the SFTP server
SftpPassword	Password of the SFTP access
SftpPort	Port of the SFTP server (default: 22)
SftpUsername	User name for SFTP access

Mandatory fields Target Adapter	Description
targetAdapter type = WebAPI	A WebAPI TargetAdapter is required to access the COGLAS.
URL	The URL of the COGLAS system, e.g.: https://test.coglas.com/server
Username	The user name of a user created in the interface with the role ‘WebAPI’
Password	The password of this user
RequestTimeoutInSeconds	The timeout after a request is cancelled. Standard 300 seconds

Optional fields	Description
SftpWorkingDirectory	Overwrites `InboundDirectory` and restores the previous behaviour, i.e. simple upload to the specified directory without subdirectories such as /New and /Processing

Web.config of an SFTP data interface

An example for maintaining the Web.config of the SFTP data interface with the data for the SFTP server.

CODE

<sourceAdapter type="Sftp">
  <AdapterSettings>
    <DataCleanup>
      <DeleteFailedMessageAfterDays>14</DeleteFailedMessageAfterDays>
      <DeleteSucceededMessagesAfterDays>7</DeleteSucceededMessagesAfterDays>
    </DataCleanup>
    <FileType>xlsx</FileType>
    <InboundDirectory>Inbound</InboundDirectory>
    <OutboundDirectory>Outbound</OutboundDirectory>
    <PollingIntervalSeconds>60</PollingIntervalSeconds>
    <SftpHost>127.0.0.1</SftpHost>
    <SftpPassword>psw</SftpPassword>
    <SftpPort>22</SftpPort>
    <SftpUsername>usr</SftpUsername>
  </AdapterSettings>
</sourceAdapter>

→ back to COGLAS processes
→ back to COGLAS menu