SFTP
  • 25 Nov 2021
  • 4 Minutes to read
  • Dark
    Light
  • PDF

SFTP

  • Dark
    Light
  • PDF

Setup SFTP Monitoring

The scenarios for SFTP (Secure Shell File Transfer Protocol) monitoring are:

  • SFTP with password authentication
  • SFTP with public key authentication
  • The above scenarios with a proxy server running. BizTalk360 can use default proxy settings which are given in 'Settings -> Gateway/Proxy settings' or can manually enter in the details

SFTP with password authentication

  • Log in to the BizTalk360 application
  • Click the 'Monitoring' tab in the navigation bar
  • Click the expand button in the 'Manage Mapping' section
  • Click 'File Locations' (File, FTP, SFTP) tab. You can see three tabs each containing port details of their respective adapters, which are File, FTP, and SFTP
  • Select the Alarm name (Manage Alarms) from the drop-down, which you would like to associate the SFTP location for monitoring
  • Click 'SFTP' to monitor SFTP locations

  • The port(s) (Send port or Receive port) created in the BizTalk admin console will be displayed in a grid. Click the SFTP grid row to open the SFTP Details blade to enter the password for the SFTP location
  • All file extensions (eg., CHPAPO*.txt, *.txt,  * . *, *outbound322*, PPI*, Tes*.*) and macros pattern are supported in File monitoring by making the file mask field editable

  • If the username and password columns are blank, it will be considered as anonymous authentication. The user can adjust the Connection Timeout settings between 5 to 300 seconds in BizTalk360
  • In this blade, the user can fill in gateway proxy details or just leave it blank. If the user wants to use the default proxy configuration given in 'Settings -> Gateway/Proxy settings', the user can click the 'Use Gateway Proxy' option
  • The adapter properties which is configured in the BizTalk admin console will appear in the blade under Security details. The user must enter the password in this blade

 

  • The user has the option to set the condition “Accept Any SSH key”. If the toggle button is green, then the user doesn’t need to fill the “SSH Server Host Key Finger Print” box. If the button is white or off, then the box “SSH Server Host Key Finger Print” needs to be filled
  • In the SFTP monitoring configurations section, the user can add conditions like trigger warning or error based on the file count in the target server

  • Click the 'Save' button to complete the process
Both BizTalk and nSoftware SFTP adapters can be monitored using BizTalk360
The Count and the Directory Size will be displayed in the Alarm - File Location grid only after the successful configuration of the SFTP location. The values of the Count and Directory Size depend on the File Mask
The SFTP location will be moved to orphaned if the configuration is not successful
  • If the username and password are valid the server will respond with the number of files with the file mask
  • If the credentials are wrong, then the server will respond with an error code and details. This will be displayed in the name column with a small orange icon, and when you hover over it, it will show the error occurred during the connection

SFTP with public key authentication

  • Log in to the BizTalk360 application
  • Click the 'Monitoring' tab in the navigation bar
  • Click the expand button in the 'Manage Mapping' section
  • Click 'File Locations' (File, FTP, SFTP) tab . You can see three tabs each containing port details of their respective adapters, which are File, FTP, and SFTP
  • Select the Alarm name (Manage Alarms) from the drop-down, which you would like to associate the SFTP location for monitoring
  • Click 'SFTP' to monitor SFTP locations
  • The port(s) (Send port or Receive port) created in the BizTalk admin console will be displayed in a grid with a gear icon in the config column. Click the SFTP grid row to open the SFTP Details blade to enter the password for the SFTP location
  • If the username and password columns are blank, it will be considered as anonymous authentication
  • In the next blade, the user can fill in gateway proxy details or just leave it blank. If the user wants to use the default proxy configuration given in 'Settings -> Gateway/Proxy settings', the user can click the 'Use Gateway Proxy' option
  • The user has the option to set the condition “Accept Any SSH key”. If the toggle button is green, then the user doesn’t need to fill the 'SSH Server Host Key Finger Print' box. If the button is white or off, then the box 'SSH Server Host Key Finger Print' needs to be filled
  • In the SFTP monitoring configurations section, the user can select Client Authentication Mode as Public Key Authentication and enter other details

  • Click the 'Save' button to complete the process
  • If the username and password are valid, the server will respond with the number of files with the file mask
  • If the credentials are wrong, then the server will respond with an error code and details. This will be displayed in the name column with a small orange icon, and when you hover over it, it will show the error occurred during the connection

Was this article helpful?

What's Next