Skip to main content

Install and configure: Commandline tool

Jetmir Abdija avatar
Written by Jetmir Abdija
Updated over a month ago

You can use the StandAlone Commandline tool to import or export data once or to import non-structural data in BlueDolphin. This commandline tool uses the stored StandAlone Import configuration files as input. This article contains a .zip file with the necessary software.

When you have unpacked the software, it contains the files for the “Commandline tool”. You need to carry out the configuration, which is done by editing the file “DataCollection.Agent.Host.StandAloneCmd.exe.config”.

Here you must configure the following properties. The values can be found in the admin section of BlueDolphin.

Configuration property

Value

DataCollection.Tenant.APIKey

To find this key, go to the Admin menu and from the left-hand menu, under System click General. There you will find the value for Datacollection API key. Fill in this value here.

DataCollection.Tenant

To find it, go to the Admin menu and from the left-hand menu, under System click General. There you will find the value for Database. Fill in this value here.

PresentationServiceEndPointAddress

Due to the old domains https://api.bluedolphin.valueblue.nl and https://api2.bluedolphin.valueblue.nl being deprecated soon, please change the value to one of the above, depending on the location of your tenant.

If your organization uses a proxy server to connect to the internet, the following configuration elements of a value must be provided.

Configuration property

Value

Description

PresentationServiceUseProxy

true / false

Makes use of the proxy server

PresentationServiceProxyAddress

Address of the proxy server

PresentationServiceProxy UseCustomCredentials

true / false

Specifies the credentials in order to use the proxy server

PresentationServiceProxyUsername

Proxyserver user name, in the format %domain%\%username%

PresentationServiceProxyPassword

Proxyserver user password

Usage

As indicated before, the Commandline tool processes the configuration files of the StandAlone DataCollector tool as import.

The Commandline tool supports the following arguments

Argument

Value

--files

Here you specify the configuration files that you want to be processed by the Commandline tool

--replace

Here you can give the variables in the configuration files a value. Thus, it is possible to provide the configuration files with a variable.

--mode

Specify import or export. Default mode is import.

Examples

Import single file, no variables

Command:

DataCollection.Agent.Host.StandAloneCmd.exe --files import1.xml

Output:

The above command processes the file "import1.xml" from the current folder

Import multiple files, no variables

Command:

DataCollection.Agent.Host.StandAloneCmd.exe --files import1.xml "d:\import2.xml" "c:\temp\import3.xml"

Output:

The above command processes the configuration files : "import1.xml" from the current folder, "import2.xml" uit d:\ en "import3.xml" uit c:\temp

Import single file, with variables

Command:

DataCollection.Agent.Host.StandAloneCmd.exe --files import1.xml --replace "%pass%=geheim" "serverwaarde=server01"

Output:

The above command processes the file import1.xml from the current folder. The value %pass% will be replaced by secret and server value will be replaced by server01.

Did this answer your question?