Purpose Statement

This guide provides instructions for installing and configuring the First Due SFTP Connector on a local Windows Server.

The SFTP Connector allows files generated by a local system, such as a CAD system, to be transferred to First Due through a configured SFTP connection.

Download the Connector Installer attached at the bottom of this article before beginning the installation.

Background Information

The First Due SFTP Connector is installed on a local server and monitors a designated input folder for files that need to be transferred.

During installation, you will configure the SFTP connection information, identify the folders used for incoming and processed files, configure the synchronization frequency, and verify that the First Due SFTP Connector service is running.

Prerequisites

Before beginning the installation, confirm the following requirements are met:

• A supported version of Windows Server. Refer to Microsoft's Windows Server Release Information for currently supported versions.
• .NET Framework 4.8.
• The First Due SFTP Connector installer.
• SFTP credentials provided for the integration.
• An allow rule configured to permit traffic to and from the SFTP host included with the provided credentials.

Required Permissions

The user completing the installation must have sufficient Windows permissions to:

• Extract the installation files.
• Run the installer as an administrator.
• Install applications and Windows services on the server.
• Access the folders being used for incoming and processed files.
• Open and review Windows Services.

Specific First Due application permissions are not identified as part of this local connector installation process.

Step-by-Step Guide

1. Extract the Connector Installation Files

Right-click the downloaded ZIP folder and select Extract All.

Select the location where you want the extracted folder to be saved.

By default, Windows extracts the files to the same location as the original ZIP file.

Once you have selected the extraction location, click Extract.

2. Open the Connector Folder

Open the extracted folder and select:

Common.sFTP.Connector.v1.XX.X.PROD

3. Launch the Installer

Open Common.sFTP.Connector.v1.XX.X.PROD again.

The folder should contain the connector installation files.

Right-click Setup and select Run as administrator.

4. Approve the Windows UAC Prompt

A Windows User Account Control (UAC) prompt will appear.

Click Yes to allow the installer to make changes to the server.

5. Start the Setup Wizard

The Welcome to First Due – sFTP Connector Setup Wizard screen will appear.

Click Next.

6. Select the Installation Location

Choose where the First Due SFTP Connector should be installed.

We recommend keeping the default installation location and installing the application for everyone who uses the server.

Click Next when finished.

A confirmation screen will appear.

Click Next to begin the installation.

7. Enable the Connector

Once the installation is complete, the configuration window will open.

Confirm that Enable is selected, and then click Next.

8. Configure the Connection Name

Click the pencil icon to configure the connection name.

Enter the provided connection code/name and click OK.

9. Enter the SFTP Connection Information

Enter the provided SFTP connection information into the appropriate fields:

• Host Name
• Port
• Username
• Password

10. Configure the Input Folder

Select the folder icon in the Input Folder field.

Navigate to and select the folder where the CAD system or other source system sends files.

Click OK.

11. Configure the Processed File Folder

Select the folder where processed files should be moved for archive purposes.

Then - 



 

12. Test the SFTP Connection

Click TEST to verify the connection.

If the connection is successful, a confirmation message will appear.

If the test is unsuccessful, verify the SFTP connection information and network access before continuing.

13. Continue the Configuration

After successfully testing the connection, click Next.

14. Configure the Sync Frequency and Logging

Set the desired synchronization frequency.

Confirm that Enable Logging is selected, and then click Next.

15. Complete the Installation

Click Finish to complete the connector configuration.

16. Open Windows Services

To confirm that the connector service is running:

1. Press Windows Key + R.
2. Enter:

services.msc

3. Press Enter or click OK.

17. Confirm the First Due SFTP Connector Service Is Running

In the Windows Services list, locate:

First Due sFTP Connector Service

Confirm that the Status displays Running.

The First Due SFTP Connector installation and configuration are now complete.

Best Practices

• Install the connector using an account with the necessary Windows administrator privileges.
• Keep the default installation location unless your organization's server configuration requires a different location.
• Confirm firewall and network rules allow communication with the provided SFTP host before testing the connection.
• Verify that the connector has access to both the input and processed/archive folders.
• Keep Enable Logging selected to assist with future troubleshooting.
• For dispatch-related integrations, keep the synchronization frequency at or near the recommended default to minimize delays in data delivery.
• Confirm the First Due sFTP Connector Service is running after installation and whenever troubleshooting connector activity.

Troubleshooting & FAQs

The connection test is unsuccessful. What should I check?

Verify that the Host Name, Port, Username, and Password match the credentials provided for the integration. Also confirm that firewall or network rules allow traffic to and from the specified SFTP host.

The connector is not processing files from the input folder. What should I check?

Confirm that the correct Input Folder was selected and that files are being delivered to that location. Also verify that the connector service has permission to access the folder.

Where can I confirm that the connector is running?

Open Windows Services by pressing Windows Key + R, entering services.msc, and locating First Due sFTP Connector Service. Its status should display Running.

The First Due sFTP Connector Service is not running. What should I do?

Confirm that the installation completed successfully and review the connector logs for additional information. Verify that the service has access to the required folders and network resources.

What synchronization frequency should I use for dispatch integrations?

For integrations involving dispatch data, use the default synchronization frequency or a setting as close to the default as possible to help ensure timely delivery of data.

Should Enable Logging remain selected?

Yes. Keeping logging enabled provides information that can assist with troubleshooting if the connector encounters an issue.