Reference data download script

For easily download of reference data and installers we provide a python script.

The script will download the reference data based on your subscription and the necessary installer(s) for your platform.

How to get the download script?

You can download the script in the Download Service section of Uniserv Connect or directly here.

Why do you need the download script?

The script is a good choice if you don’t want to download reference data via browser and wish to automate your download process.

What is the script doing in detail?

The download script downloads the latest versions of reference data that have not been previously downloaded, thus reducing bandwidth usage and accelerating the download process. To achieve this, it compares the downloaded artifacts with the sha512 artifacts stored remotely. If the artifacts match, the script avoids redundant downloads.

For successful artifact comparison, ensure that the previously downloaded artifacts are located in the same directory as the download script.

Upon completion of the download process, a file named "downloadedFiles.txt" is automatically generated. This file contains the names of the downloaded artifacts, with each artifact listed on a separate line. This feature provides a convenient record of the downloaded files.

Troubleshooting

In case of issues during script execution, refer to the Error messages or contact our support for assistance.

Preconditions

Python 3.10 or higher
Uniserv API Key (to generate an API Key, see API Key)

Usage

python3 download-reference-data.py --api-key <your-api-key> [--installer <installer name, e.g. setupRefdata_linux_x64>]

python download-reference-data.py --api-key <your-api-key> [--installer <installer name, e.g. setupRefdata_linux_x64>]

The name of the python executable (python3 or python) depends on your operating system and your installation.

Arguments

The script offers the following arguments.

Argument

Description

--help

Show a description how to use the script.

--api-key

Mandatory argument. The API Key to use to access reference data download resources.

--installer

Specify the installer for your platform. For available installers, see https://connect.uniserv.com?redirect=/onpremises/reference-data.

If not specified, all installers will be downloaded.

--proxy

Set a proxy to use. Specify the host name or the IP address of the proxy server, optionally followed by a colon and a port number.

Examples: myproxy.company.de, myproxy.company.de:1080, 172.25.208.1:1080

--proxy-protocol

Set the protocol to use to connect to the proxy server.

Possible values: http or https

--proxy-user

Specify the username to use if proxy authentication is required.

--proxy-password

Specify the password to use if proxy authentication is required.

--version

Print the current version of the script.

Verifying downloaded files

After the script has been executed, it may be desired to verify whether any files were successfully downloaded. This can be achieved by examining the script’s exit status code and checking for the presence of the "downloadedFiles.txt" file.

Below is an example shell snippet demonstrating how to conduct this verification:

# Check the exit status code of the script
if [ $? -eq 0 ] && [ -f downloadedFiles.txt ]; then
      # Execution successful. New reference data downloaded
      # Further scripts or actions can be placed here
fi

Exit Status Codes

Status code

Description

script executed successfully (also including the case, all downloads were skipped due to up-to-date reference data)

error occurred during script execution