Analyze SFTP Data in Infragistics Reveal



Use the CData API Server to create an OData API on top of SFTP data and visualize live SFTP data in Ingragistics Reveal.

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server and SFTP ADO.NET Provider to build dynamic dashboards from live SFTP data. The CData API Server generates an OData API for SFTP, which is natively consumable in Reveal. In this article, we walk through connecting to SFTP in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to SFTP from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open API Server and click Settings -> Connection -> Add Connection
  2. Select "SFTP"
  3. Enter the necessary authentication properties to connect to SFTP.

    SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

    Set the following connection properties to control the relational view of the file system:

    • RemotePath: Set this to the current working directory.
    • TableDepth: Set this to control the depth of subfolders to report as views.
    • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
    Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server.

Add SFTP Resource Definitions in API Server

After connecting to SFTP, create Resources, which represent API endpoints for SFTP data.

  1. Click Settings -> Resources -> Add Resource
  2. Select the SFTP connection
  3. Select the table you wish to retrieve and click Next
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

Add an API Server User

Create a User to connect to SFTP from Reveal through API Server.

  1. Click Settings -> Users
  2. Click Add
  3. Configure a User with access to the SFTP Connection and Resource(s)

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.

  • Enable cross-origin resource sharing (CORS): ON
  • Allow all domains without '*': ON
  • Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
  • Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Create a Dashboard in Reveal

With the API Server configured, we can visualize SFTP data in Reveal.

  1. Log into Reveal and click Dashboards -> New
  2. Click Data Source -> OData Feed
  3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
  4. Select Generic Credentials and specify the API Server username and authentication token
  5. Select the entity you wish to visualize
  6. Select fields and choose a chart type

More Information & Free Trial

At this point, you have created a simple dashboard from live SFTP data. For more information on creating OData feeds from SFTP (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live SFTP data in tools that consume OData APIs.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server