|
|
# Debugging
|
|
|
|
|
|
The Transfer Tool will automatically log any error. If you need to debug it, make sure to always check the `logs` folder which contains all the logs and start by the `error.log` file. You can also quickly identify the log of the day by looking at the name (in comparison to the error log, the daily log record a events). If you open the error log file with a text editor, you will see a short description of what went wrong, allowing you to understand what needs to be fixed. If you don't understand the error message or you don't know what to do, don't hesitate to [contact us](mailto:spsp-support@sib.swiss).
|
|
|
The Transfer Tool will automatically log any error. If you need to debug it, make sure to always check the `logs` folder which contains all the logs and start by the `error.log` file. You can also quickly identify the log of the day by looking at the name (in comparison to the error log, the daily log records all events of a batch). If you open the error log file with a text editor, you will see a short description of what went wrong, allowing you to understand what needs to be fixed. If you don't understand the error message or you don't know what to do, don't hesitate to [contact us](mailto:spsp-support@sib.swiss).
|
|
|
|
|
|
If you would like to report an issue, please use this [link](https://gitlab.sib.swiss/SPSP/transfer-tool/-/issues) to report it and use the **Bug** template |
|
|
\ No newline at end of file |
|
|
If you would like to report an issue, please use this [link](https://gitlab.sib.swiss/SPSP/transfer-tool/-/issues) to report it and use the **Bug** template
|
|
|
|
|
|
## Common issues
|
|
|
|
|
|
- **I cannot connect to the SFTP server**
|
|
|
> It is very important that everyone using the Transfer Tool initialises correctly using the [instructions provided on the Wiki](https://gitlab.sib.swiss/SPSP/transfer-tool/-/wikis/Installation). This notably requires providing us your external IP range as well as a public ssh key. In some cases, we also realized that your IT had to enable ssh access to IP 192.42.198.80 (which is our SFTP server), otherwise transfers were being blocked.
|
|
|
|
|
|
- **The batches that I submit seem corrupted**
|
|
|
> In the past, when we observed this issue, it was because the storage on the data provider server side was insufficient, yielding to a corrupted compressed encrypted archive.
|
|
|
> We would recommend that you check if you have sufficient space on the machine where the Transfer Tool is running.
|
|
|
|
|
|
- **The Transfer Tool is not sending my batch that contains only a metadata file with updates**
|
|
|
> A potential reason for this is using an old version of the tool where we had constrains on the allowed file formats that have been, in the meantime, relaxed or extended. A typical example is that in versions older than 1.9.0, it was not possible to send a single file (e.g. single TSV with metadata updates).
|
|
|
> We would recommend that you [get the latest version of the tool](https://gitlab.sib.swiss/SPSP/transfer-tool/-/releases), which enables sending batches with a single file.
|
|
|
|
|
|
- **The Transfer Tool says everything went fine but apparently you didn't receive my batch**
|
|
|
> This has happened with older versions of the script but has been fixed in [v.1.10.0](https://gitlab.sib.swiss/SPSP/transfer-tool/-/releases/v1.10.0).
|
|
|
> We would recommend that you [get the latest version of the tool](https://gitlab.sib.swiss/SPSP/transfer-tool/-/releases).
|
|
|
|
|
|
- **I get a warning about permission when running the Transfer Tool**
|
|
|
> You should normally only change the rights of the script to make it executable (`chmod +x spsp`), while keeping the rest of the folder with the initial permissions. If instead the whole folder is on e.g. 777, this would mean that ANYONE can execute, read, and modify the files, which could trigger a warning about the permission, if the person executing the script is not the owner of the whole folder or in the group owning the whole folder.
|
|
|
> We would recommend adding yourself and your colleague to the group owning the whole folder and allow execution+writing only for the user and the group. |
|
|
\ No newline at end of file |