Connecting to an SFTP Server - data_integration_1 - discovery - spectrum_platform - 23.1

Spectrum Discovery Guide

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Discovery
Version
23.1
Language
English
Product name
Spectrum Discovery
Title
Spectrum Discovery Guide
Topic type
How Do I
Reference
Overview
First publish date
2007
ft:lastEdition
2024-02-07
ft:lastPublication
2024-02-07T17:21:58.768552

In order for Spectrum Technology Platform to access files on an SFTP server you must define a connection to the SFTP server using Spectrum Management Console.

Before connecting to an SFTP server, verify that the timeout settings on your SFTP server are appropriate for the jobs that will use this connection. Depending on the design of a job, there may be periods of time when the connection is idle, which may cause the connection to time out. For example, you may have a dataflow with two Read from File stages connected to an Import To Model stage. While the Import To Model stage is reading records from one Read from File stage, the other will be idle, possibly causing its connection to the SFTP server to time out. Consider setting the timeout value on your SFTP server to 0 to prevent connections from timing out.

Note: The SFTP server must be running in active connection mode. Passive connection mode is not supported.
  1. Access the Connections page using one of these:
    Spectrum Management Console:
    Access Spectrum Management Console using the URL: http://server:port/management console, where server is the server name or IP address of your Spectrum Technology Platform server and port is the HTTP port used by Spectrum Technology Platform.
    Note: By default, the HTTP port is 8080.
    Click Resources > Connections.
    Spectrum Discovery:
    Access Spectrum Discovery using the URL: http://server:port/discovery, where server is the server name or IP address of your Spectrum Technology Platform server and port is the HTTP port used by Spectrum Technology Platform.
    Note: By default, the HTTP port is 8080.
    Click Connect.
  2. Click the Add connection button .
  3. In the Connection Name box, enter a name for the connection. The name can be anything you choose.
    Note: Once you save a connection you cannot change the name.
  4. In the Connection Type field, choose SFTP.
  5. In the Host field, enter the host name or IP address of the SFTP server.
  6. In the Port field, enter the network port number that the server uses for SFTP. The default is 22.
  7. Toggle the Strict Host Key Checking button to Yes, if you want to enable it. Default is No. If the strict host key checking is enabled, ssh does not automatically add host keys to the known host file. This is an additional security feature.
  8. In the Known Host File field, browse the location of the file that maintains known hosts details, and select it.
    Note: If you disable Strict Host Key Checking, this field is not displayed. However, this detail is mandatory if strict host key checking is enabled.
  9. Enter the Username.
  10. Select the preferred Authentication Type. It can be Password or Key-Based. Default is Password.
    • Password: If you selected this as the authentication type, Password field is displayed below the Authentication Type field. Enter the required password in this field.
    • Key-Based: If you selected a key-based authentication, browse and select the Private Key File, and enter the Passphrase shared by the host server administrator. The pass phrase is needed only if the key is configured using this option.
  11. Click Test to verify that the Spectrum Technology Platform server can connect to the SFTP server.
  12. Click Save.