File Connector

The universal file connector uses secure file transfer protocols to facilitate data transfers between an external application and the App Xchange platform.

Note: This connector is not publicly available at this time.

Unlike app connectors, universal connectors are configured at both the Connector and Service level. When setting up the File connector, enter values in the following fields:

Connector Configuration

  • Real-time Action Processing: This feature should always be enabled for optimal performance. Only disable it if you are advised to do so by support.

System Interface Configuration

  • Base Url of the Ryvit AppNetwork Environment: https://api.xchange.trimble.com/connect/v1 (default)
  • Partner Api Key: This field is pre-populated with a unique API key issued to you by App Xchange.

Service Configuration

  • Description: Enter a brief description to be displayed in the Services table of the Jobs page.

Ftp Connection Config

  • FTP Protocol :Select the appropriate secure file transfer protocol from the dropdown menu. SFTP is recommended.
    Note: Select FTP to use FTPS. Although it displays as FTP, rest assured we are using FTPS.
  • FTPS Security Type: This field is only used for FTPS connections. Select either Implicit or Explicit from the dropdown menu, as indicated by your FTPS provider.
  • FTP Server Host Name: Enter the FTP server hostname.
  • FTP Server Port: Enter the port for the FTP server. Below are the standard ports for common secure protocols:

    • FTPS/Implicit=990

    • FTPS/Explicit=21

    • SFTP=22

  • FTP Username: Enter the username used to sign in to the FTP server.
  • FTP Password: Enter the password used to sign in to the FTP server.
  • Private SSH Key: Enter the private SSH key used for your connection.
  • Use RSA SHA2: Select this checkbox to enable the RSA SHA2-256 host key encryption for the connection. Use this feature for new servers or if the connection is being closed by the server.
  • Server Response Timeout: Enter the time in seconds to wait for a server response before the connection times out. If left blank, this parameter defaults to 30 seconds.
  • Process this queued action instance?: This feature should always be enabled for optimal performance. Only disable it if you are advised to do so by support.