Configuration

sdmx-dl CLI is designed to work out-of-the-box but can be configured if needed by using command-line options, properties files, execution properties and environmental variables.

Properties files

The properties files are just text files that contains a list of key-value pairs.
All these files are named sdmx-dl.properties and are located in 3 different folders which are parsed in a specific order to define a scope:

SYSTEM: the installation folder (where the binary is located)
GLOBAL: the user profile folder (%userprofile% on Windows)
LOCAL: the execution folder (where the CLI is called)

Each of these scopes overwrites properties defined in the previous scope; for example, properties in execution folder overrides those in user profile folder.

The default values of command-line options can be overridden in two ways:

Widely by targeting any command using their option names.

# enable verbose mode on all commands
verbose=true
# set languages on all commands
languages=fr,nl,en

Narrowly by targeting a specific command using their option names prefixed by the command full path.

# enable verbose mode on status command
sdmx-dl.check.status.verbose=true
# set languages on status command
sdmx-dl.check.status.languages=fr,nl,en

Execution properties

Execution properties can be customized using Java system property.
There are several types of system properties: some are defined by the platform, others by the libraries.

Specific sdmx-dl properties ↕

Property	Description
`sdmxdl.caching.noCache`	Disable caching
`sdmxdl.caching.cacheFolder`	Set cache folder
`sdmxdl.caching.noCompression`	Disable cache compression
`sdmxdl.caching.persistenceId`	Set cache persistence backend
`sdmxdl.networking.autoProxy`	Enable automatic proxy detection
`sdmxdl.networking.noSystemSSL`	Disable system truststore
`sdmxdl.networking.noDefaultSSL`	Disable default truststore
`sdmxdl.networking.urlBackend`	Set networking URL backend
`sdmxdl.registry.sourceFile`	Set data source definitions file

Generic command-line properties ↕

Property	Description
`picocli.ansi`	Disables ANSI colors on output
`org.fusesource.jansi.Ansi.disable`	Disables ANSI support of Windows

Java networking properties ↕

Property	Description
`https.proxyHost`	The hostname, or address, of the proxy server
`https.proxyPort`	The port number of the proxy server
`http.proxyHost`	The hostname, or address, of the proxy server
`http.proxyPort`	The port number of the proxy server
`http.nonProxyHosts`	Indicates the hosts that should be accessed without going through the proxy

More on https://docs.oracle.com/javase/8/docs/api/java/net/doc-files/net-properties.html

Java security properties ↕

Property	Description
`javax.net.ssl.trustStore`	Trust Store Path
`javax.net.ssl.trustStorePassword`	Trust Store Password
`javax.net.ssl.trustStoreType`	Trust Store Type
`javax.net.ssl.keyStore`	Key Store Path
`javax.net.ssl.keyStorePassword`	Key Store Password
`javax.net.ssl.keyStoreType`	Key Store Type

More on https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#InstallationAndCustomization

Environmental variables

Specific sdmx-dl properties can also be set using environmental variables. For each property, the corresponding environmental variable is the same name but uppercase and with dots replaced with underscore.

Example: sdmxdl.caching.noCache becomes SDMXDL_CACHING_NOCACHE.

Troubleshooting

Using properties files is usually error-prone.
Fortunately, sdmx-dl CLI includes a command to pinpoint the problems: sdmx-dl check config

Common problems:

Problem	Cause
Property is not available in the output	The property file is either not in the right folder or is misspelled
Property doesn’t have the right type	The property name is misspelled