Developers Getting Started With i2b2
Space shortcuts
Space Tools
Skip to end of metadata
Go to start of metadata

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 Administration Module
Step 2:   Create an FRC directory

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 JBoss Server  

Yes

The name of the machine where JBoss is installed  

FRPort

Example: 22

No

The port to be used when retrieving files



Steps to Add Parameters to File Repository Cell


Error rendering macro 'excerpt-include'

User 'null' does not have permission to view the page.


6. Enter the following parameter to define the method of transfer.
Parameter Name: FRMethod
Parameter Value: SFTP or local
Parameter Data Type: Text

Important

If the CRC is on the same JBoss 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.



7. Click on Save to save the new parameter.
8. The Parameters List page will display with the new parameter.

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.



9. In the Parameters List page click on Add New Parameter to enter another parameter.
10. Enter the following parameter for the name of the machine where your JBoss resides.

Parameter Name: FRHost
Parameter Value: Machine_Name_Where_JBoss_Resides
Parameter Data Type: Text


11. Click on Save to save the new parameter.
12. In the Parameters List page click on Add New Parameter to enter another parameter.
13. Enter the following parameter for the port to be used by the FRC to connect. This parameter is optional. The value is usually set to 22.

Parameter Name: FRPort
Parameter Value: 22
Parameter Data Type: Text


14. Click on Save to save the new parameter.
15. The Parameters List page will display all the new parameters you have entered.
16. In the Navigation panel click on Params to refresh the hierarchical tree and display the new parameters.



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 JBoss installation.


Location of New "FRC" Directory


Linux Server:
  • The new directory will reside in the /opt/ directory.
Example:    /opt/FRC/


Windows Server:
  • 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.
Example:    C:\opt\FRC\


Important

When creating the new directory you need to log onto the server with the same user that will be running JBoss.