Skip to content

Configuring jobs with the upload type FTP

  1. Create a job with the FTP upload type.

  2. Go to the FTP settings section.

    Figure: Job configuration, FTP settings section

  3. In the FTP server field, enter the IP address of the FTP server to which a connection is to be established.

  4. From the Connection type dropdown menu, select the connection type to be used for communication.

  5. WodFtp is set as the FTP client library by default.

    Info

    As FTP is an old protocol, it is possible that not all possible FTP servers can be covered by the default library WodFtp. However, there are many different options for this. If your variant is not listed in octoplant, contact our support team for further information.

  6. In the Port field, enter the port to be used for communication. Port 21 is set by default. You may need to enable the port in your firewall.

  7. If you want to use passive FTP, select the checkbox.
  8. Select the Follow Symlinks checkbox to back up files in directories that can be reached via symlinks (symbolic links).
  9. In the Username and Password fields, enter the credentials of the user under which access is to take place. Depending on the configuration of your FTP server, this step is optional. An upload can also be carried out without a user name or password.

  10. If the data is stored in a subdirectory of the FTP server, enter the path of the subdirectory in the Subdirectory field.

    Info

    Access to the subdirectory must be possible with the specified credentials. octoplant supports up to 10 subdirectories per job.

    If only one subdirectory is specified, the entire path on the FTP server is not displayed in the backup, but only the last directory in the path:

    Example: Path on the FTP server: /Folder1/Subdirectory1/* Structure of the backup: Archive.zip/* If several subdirectories are specified, the entire directory structure is included in the backup.

    Example:
    Path on the FTP server: /Folder1/Subdirectory1/Subdirectory2 and /Folder1/Subdirectory1/1234
    Structure of the backup: Archive.zip/Folder1/Subdirectory1/Subdirectory2 and Archive.zip/Folder1/Subdirectory1/1234

  11. To ensure that the the login to the FTP server is possible with the specified credentials, select the Check button. If the check is not successful, the job will also fail.

  12. Go to the Advanced section.

  13. You can reduce the network load caused by the job by increasing the Sleep interval between data packets and reducing the Maximum size of data packets.

    Higher values for the waiting time and lower values for the maximum packet size mean that the job execution takes more time.

  14. Select the Upload only when timestamp is different (reduces network load) checkbox to ensure that the timestamp instead of the content of the files is checked during the upload. This means that only new and edited files are uploaded for a backup. Files without changes are transferred from the previous backup, which further limits the network load.

FAQ

Error occurring when creating a backup using a backup job of the upload class FTP

Two options can be considered to resolve this problem:

Switch on passive mode

  1. Start the AdminClient.
  2. Open the Jobs module.
  3. In the Project tree, select the component whose FTP job ended with errors.
  4. Select the FTP upload type.
  5. In the Jobs table, select the job whose execution caused errors.
  6. Select the Use FTP passive mode option under FTP Settings.
  7. Save the changes.
  8. In the Execute group, select the Execute selected jobs once button.
  9. Wait until the job has finished running.
  10. If necessary, reset the type of execution to According to schedule or Not active.

If the activation of Use FTP passive mode has no effect and the errors continue to occur, clear the checkbox and continue with the next option.

Add VDogUpload.exe to firewall exceptions

The VDogUpload.exe file is (also) executed when uploading via FTP.
If the data transfer, which is due to the execution of the above-mentioned file, is prevented by the firewall, Timeout errors occur. To prevent these errors from occurring, the VDogUpload.exe file must be added to the firewall exceptions. As it can be assumed that not all customers use the same firewall (software), no information on the correct procedure can be provided here.
Information on this can be found in the documentation for the product you are using. Another source of information is the Internet. Enter one of the following search texts in the text field of your search engine:

  • {product name/name of the firewall} exception
  • {product name/name of the firewall} configure exception
  • {product name/name of the firewall} allow exception
  • {product name/name of the firewall} add exception

Related topics