Skip to content

Configuring the upload type FTP (FTP jobs)

Jobs with the upload type FTP access an FTP server.

  1. Select your component in the Project tree.
  2. Click on the Create button in the menu bar or drag and drop the component into the Jobs area.
  3. Check whether the upload type FTP is displayed in the Job configuration area.
  4. Configure the general sections General, Notification, Upload and compare and Create a version automatically after job run. The sections Notification and Create a version automatically after job run are only displayed if the settings required for this have been made.

FTP settings section

Figure: Job configuration, FTP settings section

  1. In the FTP server field, enter the IP address of the FTP server to which a connection is to be established.
  2. In the Connection type dropdown menu, select the connection type to be used for communication.

  3. 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, please contact our support team for further information.

  4. Enter the port to be used for communication in the Port field. Port 21 is set by default.

  5. If you want to use passive FTP, activate the checkbox.
  6. Activate the Follow Symlinks checkbox to back up files in directories that can be reached via symlinks (symbolic links).
  7. If required, enter the login data (Username and/or Password) 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.

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

    Info

    Access to the subdirectory must be possible with the specified login data. 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

  9. You can check whether the login to the FTP server is possible with the specified login data by clicking on the Check button. If the check is not successful, the job will also fail.

Info

You may need to enable the port set in step 4 in your firewall.

Advanced section

Enter Sleep between packets and the Maximum size of data packets (in KB) to throttle the bandwidth to the device. This helps to prevent the device or network from becoming overloaded.

Activate the Upload only when timestamp is different (reduces network load) so that the timestamp is checked during the upload instead of the content of the files. 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.

File specifications and compare settings section

By default, comparisons are performed using the component's comparison settings. In this section, job-specific adjustments can be made.

The table shows the set comparison and storage behavior.

  1. Activate the Enable custom configuration for this job checkbox.
  2. Click on Edit.
  3. In the dialog that opens, define new parameters for the comparison and storage process.

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. Login to the system with a suitable user name and password.
  3. Open the Jobs module.
  4. Select the Home tab.
  5. In the Project tree, select the component whose FTP job ended with errors.
  6. Select the upload type FTP.
  7. In the Jobs table, select the job whose execution caused errors.
  8. Activate the Use FTP passive mode option under FTP Settings.
  9. Save the changes.
  10. In the Execute group, click the Execute selected jobs once button.
  11. Wait until the job has finished running.
  12. If necessary, reset the type of execution to According to schedule or Not active.

Info

If the activation of Use FTP passive mode has no effect and the errors continue to occur, deactivate 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