SFTP
SCSB has a provision for transferring files such as reports, data files or anything else to a FTP server.
Transferring files
In order to transfer files, you will need the following;
- Private key
- Host URL
Please contact your institution or recap-support@htcindia.com to obtain the private key. The host url is devops-recap.htcinc.com and there are few different ways you can connect.
- Command Line: If you are going to use command line, ssh client must be installed on your machine. For Unix/Linux based systems (Ubuntu, Mac), it comes pre-installed. For windows, you could choose to use command line or a GUI, explained in the point 2.
- Use the following command to connect to the server:
- sftp -i "path to the key file" recapftp@devops-recap.htcinc.com
- Once connected, you can upload the files with the following command:
- put "file name"
- Use the following command to connect to the server:
- Graphical User Interface (GUI): Install any FTP client or Filezilla.
- Open Filezilla.
- Go to Preferences or Settings.
- You should see the settings dialog as shown in the screenshot below.
- Add the key file (that you obtained earlier) and click "Add Keyfile" to add the key.
- In the Host section: devops-recap.htcinc.com
- In the username section type in "recapftp"
- There is no need for a password since the private key will be used for authentication/authorization.
- In the port section type in "2222"
- Click on "Quickconnect".
- Once you are connected, you can transfer files from your local machine to server.
Folder structure in FTP
SCSB uses folders in FTP to access records and also generate reports. The folder paths are configured in the respective project's application.properties file.The default folder structure that is currently expected for various functionalities is listed below.
Deaccession
<FTP>/share/recap/de-accession/<environment> - This is the location where the Deaccession report is stored when the report is generated from the Solr Admin page.
Submit Collection
<FTP>/share/recap/submitcollection/<environment>/<partnerInstitutionId> - This is the location where the Submit Collection API polls for files to process.
<FTP>/share/recap/reports/collection/submitCollection/<environment>/<partnerInstitutionId> - This is the location where the Submit Collection report is saved.
Reconciliation
<FTP>/share/recap/daily-reconcilation/<environment> - This is the location from which daily reconciliation files are taken for processing.
<FTP>/share/recap/daily-reconcilation/processed/<environment> - This is the location to which processed files are saved.
<FTP>/share/recap/accession-reconcilation/<environment>/<partnerInstitutionId> - This is the location from which reconciliation files for accession are taken for processing.
<FTP>/share/recap/accession-reconcilation/processed/<environment>/<partnerInstitutionId> - This is the location to which processed files are saved.
Matching Algorithm
<FTP>/share/recap/matching-reports/<environment> -
Ongoing Accession
<FTP>/share/recap/reports/collection/ongoinAccession/<environment> - This is the location where ongoing accession related reports are saved.
Solr
<FTP>/share/recap/solr-reports/<environment> - This is the location where solr related reports are saved.
ETL
<FTP>/share/etl-reports/<environment> - This is the location where the ETL related reports are saved.
Export Data Dump
<FTP>/share/recap/data-dump/<environment> - This is the location where the data dump files are exported.
<FTP>/share/recap/data-dump-reports/<environment> - This is the location where the data dump related reports are saved.