Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This integration requires a Universal Agent, a Python runtime to execute the Universal Task, and a Rclone executable.

Software Requirements for for Universal Template and Universal Task

Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

...

  1. This Universal Task requires the the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

  2. To import the Universal Template into your Controller, follow the instructions here.

  3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

...

  1. The configuration file is following the INI format, and contains all required parameters and credentials to connect to a Storage System. All configuration options per Storage System can be found in the respective "Config Rclone documentation" here.

  2. It is advised that account credentials, tokens, or any other essential information to be passed as an encrypted Resolvable Credential field. To set a value with the respective Credential field, please make sure to use the appropriate Credential function inside  inside the configuration file.

    Note

    'Runtime Password' Credentials field supports values with up to 512 characters.

    Hard coded values can be provided in the script file, as well. However, it is not advised for security reasons.

  3. It is recommended to configure a storage system section, one to one with the Credential fields in this Universal Extension (please refer to the Input Fields section below).

  4. For local file system Storages, no credentials are required in the configuration file. The selected action will be executed with the Credentials that are provided in the "Agent Details" of the Universal Task. If no Credentials are provided for the used Agent, then the same user that runs ubroker daemon will be used.

  5. Script Type should be Data, and option Resolve UAC Variables should be enabled.


The indicative Configuration File below, contains the basic connection parameters (flags):

Note
Utilize the built-in Credential Functionsfunctions, in order to properly resolve the associated Universal Task Credentials.

...

Case ScenarioResult
Action is other than List, executed successfully and is not Dry-Run.true
Action executed successfully, and is Dry-Run.false
Action returned exit code 21.false
Αction executed with failure.false

...

This document references the following documents.

Document LinkDescription
Universal TemplatesUser documentation for creating Universal Templates in the Universal Controller user interface.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
RcloneRclone official documentation.
Rclone InstallInstallation instructions.
Rclone DownloadsDownload links for Linux, Windows, MacOS.
Rclone Storage Systems configurationConfiguration file details.
Rclone Exit CodesRclone exit codes list.

...