HomeGuidesAPI
HomeGuidesRecipesAPI
HomeGuidesAPILog In
Guides
These docs are for v17. Click to read the latest docs for v33.

File Transfer (FTP/SFTP) Action Installation and Upgrade

📘

Configuration and Usage

For configuration and usage of this connector please go to the File Transfer (FTP/SFTP) Action guide.

Installation Requirements

📘

SaaS Environments

No action needs to be taken for customers on cloud deployments hosted by Smart Communications as the environment should already have this connector installed. If you need a licence please contact your Customer Service Manager.

For customers on self-hosted deployments (either in the cloud or on-premise), consider the following requirements before installing or upgrading this extension:

  • You must have administrator/elevated permissions to the USER.PRODUCTNAME web server, including the ability to copy and replace files in the USER.PRODUCTNAME installation folder. This is usually c:\inetpub\wwwroot\<<productname>>. However, this may vary from system to system.
⚠

Licence key required

You must have a valid license key to enable this module. If you do not have one, please contact your USER.PRODUCTNAME representative.

  • Ensure you have a compatible version of the connector with your current USER.PRODUCTNAME system (Connector and USER.PRODUCTNAME should match versions).
❗

️ Schedule Downtime

Changes to the configuration may cause interruptions to users in forms.

  • Before installing this Connector in a production USER.PRODUCTNAME environment, ensure the environment is backed up.
  • It is recommended that this installation is tested in a non-production environment first, and installed during scheduled downtime.

Installation Files

You must have the following installation files:

  • System.Net.FtpClient.dll
  • SshNet.Security.Cryptography.dll
  • Renci.SshNet.dll
  • FileTransferExtension.dll

Installation and Configuration

Use the instructions below to install the connector. If you are upgrading the extension from a previous version, refer to the section Upgrading the Connector.

Note that [PRODUCTNAME Produce Path] refers to the installation path on the webserver running USER.PRODUCTNAME, where the Produce site has been installed. By default, this is c:\inetpub\wwwroot\<<productname>>\produce. However, this may vary from environment to environment. Equally, [PRODUCTNAME Manage Path] refers to where the Manage site has been installed, and [PRODUCTNAME Scheduler Path] refers to where the Scheduler service has been installed.

How to Install the Connector

  1. Copy the installation files into the following folder on the USER.PRODUCTNAME web server:
    [PRODUCTNAME Produce Path]
  2. Using a text editor such as Notepad, open the following file:
    [PRODUCTNAME Produce Path]\appsettings.json
📘

Note

Ensure you have elevated privileges when opening the appsettings.json file, otherwise you may not be able to save in the current folder.

  1. Locate the <Extensions> section of the appsettings.json file and add the following entries:
"FileTransferExtension.FileTransferAction, FileTransferExtension",
"FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension"

A similar process has to be done in Manage.

  1. Copy the installation files into the following folder on the USER.PRODUCTNAME web server:
    [PRODUCTNAME Manage Path]
  2. Using a text editor such as Notepad, open the following file:
    [PRODUCTNAME Manage Path]\appsettings.json
"FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension"
  1. Using a web browser, navigate to the USER.PRODUCTNAME Produce and USER.PRODUCTNAME Manage applications to allow the system to register the Connector.

Upgrading the Connector

If your USER.PRODUCTNAME environment is already running an earlier version of the File Transfer Action and you are simply upgrading to a new version for USER.PRODUCTNAME, please follow these simple upgrade steps below.

How do I know if I need to run these steps?

If you have upgraded to a new major version, or have upgraded a number of minor versions or are having issues with the File Transfer Action after an upgrade you should run these steps.

Can I install both versions at the same time?

No, you can only have the latest version of the File Transfer Action installed on USER.PRODUCTNAME.

How to Upgrade a v10+ File Transfer Action

  1. Copy the installation files (these files should be found in upgrade pack’s “Bin” folder) into your [PRODUCTNAME Produce Path]\\bin\ and [USER.PRODUCTNAME Manage Path][PRODUCTNAME Manage Path]\\bin\ folder:
  • System.Net.FtpClient.dll
  • SshNet.Security.Cryptography.dll
  • Renci.SshNet.dll
  • FileTransferExtension.dll
  1. Using a text editor such as Notepad, open the file [PRODUCTNAME Produce Path]\appsettings.json
  2. Locate the <Extensions> section of the appsettings.json file and add the following entries if not already present:
"FileTransferExtension.FileTransferAction, FileTransferExtension",
"FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension"
  1. Copy the installation files into the following folder on the USER.PRODUCTNAME web server:
    [PRODUCTNAME Manage Path]\bin
  2. Using a text editor such as Notepad, open the following file:
    [PRODUCTNAME Manage Path]\appsettings.json
  3. Locate the <Extensions> section of the appsettings.json file and add the following entries if not already present:
"FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension"
  1. Using a web browser, navigate to the PRODUCTNAME Produce and PRODUCTNAME Manage applications to allow the system to register the Connector.

How to Upgrade a Legacy File Transfer Action

📘

This migration has to occur prior to upgrade to this version.

  1. Make sure you remove all files of the current Excel Connector from your USER.PRODUCTNAME web server. Navigate to your [PRODUCTNAME Produce Path]\\bin folder, then remove the following files:
    • System.Net.FtpClient.dll
    • SshNet.Security.Cryptography.dll
    • Renci.SshNet.dll
    • FileTransferExtension.dll
  2. Navigate to your [PRODUCTNAME Manage Path]\bin folder, then remove the same files listed in the previous step.
  3. Using a text editor such as Notepad, open [PRODUCTNAME Produce Path]\appsettings.json. Locate the “Extensions” section of the appsettings.json file and remove the following entries if present:
"Intelledox.Action.LegacyAction`1[[FileTransferExtension.FileTransferAction, FileTransferExtension], Intelledox.Action",
"Intelledox.Action.LegacyAction`1[[FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension], Intelledox.Action"
  1. Locate the “LegacyActions” property if present, and remove the following:
"LegacyActions": {
  "FileTransferExtension.FileTransferAction, FileTransferExtension": {
    "Name": "File Transfer Action"
  }
}
  1. Locate the “LegacyDatasources” property if present, and remove the following: 
    "LegacyDatasources": {
  "FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension": {
    "Name": "File Transfer Datasource"
  }
}
  2. Using a text editor such as Notepad, open [PRODUCTNAME Manage Path]\appsettings.json. Locate the “Extensions” section of the appsettings.json file and remove the following entries if present:
"Intelledox.Action.LegacyAction`1[[FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension], Intelledox.Action"
  1. Copy the installation files (these files should be found in upgrade pack’s “Bin” folder) into your [PRODUCTNAME Produce Path]\\bin and [PRODUCTNAME Manage Path]\\bin folder:
    • System.Net.FtpClient.dll
    • SshNet.Security.Cryptography.dll
    • Renci.SshNet.dll
    • FileTransferExtension.dll
  2. Using a text editor such as Notepad, open the file [PRODUCTNAME Produce Path]\appsettings.json
  3. Locate the <Extensions> section of the appsettings.json file and add the following entries if not already present:
"Intelledox.Action.LegacyAction`1[[FileTransferExtension.FileTransferAction, FileTransferExtension], Intelledox.Action",
"Intelledox.Action.LegacyAction`1[[FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension], Intelledox.Action"
  1. Copy the files listed above into the following folder on the USER.PRODUCTNAME web server:
    [PRODUCTNAME Manage Path]\bin
  2. Using a text editor such as Notepad, open the following file:
    [PRODUCTNAME Manage Path]\appsettings.json
  3. Locate the <Extensions> section of the appsettings.json file and add the following entries if not already present:
"FileTransferExtension.FileTransferDatasourceExtension, FileTransferExtension"
  1. Using a web browser, navigate to the PRODUCTNAME Produce and PRODUCTNAME Manage applications to allow the system to register the Action.

Installation to Scheduler

If the target environment is using the Scheduler, it is best practice to always install connectors and accelerators to this service at the same time as the installation in the USER.PRODUCTNAME Produce application. If this is not installed to the Scheduler, there may be errors if any projects are executed from the scheduler that refers to this connector.

To install any connector to the Scheduler, follow the instructions in this guide as they apply to USER.PRODUCTNAME Produce, except instead of [Produce Path] use [PRODUCTNAME Scheduler Path], noting that there is no ‘bin’ folder in this path so all files should be copied into the root of this path. For example, consider the path:

c:\inetpub\wwwroot\<<productname>>\produce

To install to the Scheduler, simply use this path:

c:\inetpub\wwwroot\<<productname>>\IntelledoxScheduler

Also, you must apply the same configuration changes as instructed for the Produce appsettings.json file.