Setting up Secure File Transfer Protocol (SFTP)
By default, the File Repository Cell uses SOAP to transfer files in i2b2. If you prefer your admin user transfer files directly via SFTP you will need to take the following steps.
Step 1: Enter Cell Parameters in i2b2 Admin
The first step in setting up the File Repository to use SFTP is to enter a few parameters on the File Repository cell. These cell parameters will define the Method, Host and Port to be used when transferring files.
Parameter Name | Values | Required | Description |
---|---|---|---|
FRMethod | SFTP or local | Yes | Defines the method to be used when retrieving files |
FRHost | Name of your WildFly Server | Yes | The name of the machine where WildFly is installed |
FRPort | Example: 22 | No | The port to be used when retrieving files |
Steps to Add Parameters to File Repository Cell
Important
If the CRC is on the same WildFly as the File Repository then you will want to set the FRMethod to local. This will prevent the CRC Loader from accessing the File Repository via a web service call, which will result in faster responses.
Note
The Navigation panel will not automatically refresh to display the new parameter. If you wish to update the list in the Navigation panel you can click on Params and it will refresh the hierarchical tree.
Step 2: Create an FRC directory
The second and last step in setting up File Repository to use SFTP is to create a directory on the server to host the files. This new directory will be called FRC and will reside on the same server as your WildFly installation.
Location of New "FRC" Directory
- The new directory will reside in the /opt/ directory.
- The FRC directory needs to reside in a directory called opt. Since Windows does not typically come installed with an opt directory you will need to create one in the root directory.
- Once you have an opt directory you can create the new FRC directory within it.
Important
When creating the new directory you need to log onto the server with the same user that will be running WildFly.