When you want to import a file with source data to BlueDolphin once or not on a structural basis, you can use the StandAlone DataCollector tool.
This article contains a .zip file with the required installer for the software and a template.json file. You can install it on a computer that runs Microsoft Windows, has the Microsoft Access DB Engine installed, and has access to the internet.
When you extract the zip file, it contains a "DataCollection StandAlone.msi" file.
Place the template.json file in the installation folder.
After you have installed the StandAlone DataCollector, edit the file "DataCollection.Agent.Host.StandAloneImport.exe.config", which is in the installation folder (%PROGRAMFILESFOLDER%\ValueBlue BV\StandAloneImport) with a basic text editor.
You need to configure the following settings to make the Standalone DataCollector work. The required values can be found in the General part of the Admin module.
Configuration property | Value |
DataCollection.Tenant.APIKey | The value can be found in your BlueDolphin tenant, menu Admin > General > Datacollection API key. |
DataCollection.Tenant | The value can be found in Admin > General > Database. |
PresentationServiceEndPointAddress |
For EU-based tenants: https://api.eu.bluedolphin.app/api/ For US-based tenants: https://api.us.bluedolphin.app/api/ 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. After editing and saving the config file, you need to restart the StandAlone application. |
When there is a Proxy server required to connect to the internet, there are configuration settings available for it.
Configuration property | Value | Description |
PresentationServiceUseProxy | true / false | Is a proxy server required |
PresentationServiceProxyAddress | Proxy server address | |
PresentationServiceProxy UseCustomCredentials | true / false | Are there other credentials required to connect to the proxy. |
PresentationServiceProxyUsername | Username to use to authenticate to the proxy server. Please user the format: %domain%\%username% | |
PresentationServiceProxyPassword | Password to use to authenticate to the proxy server |
When all settings are correct, you can start the StandAlone DataCollector tool and the screen below will appear.
When not already configured in the config file, you can alter the Tenant name & Tenant API Key before connecting to your BlueDolphin tenant. To find this information in your BlueDolphin tenant, go to Admin > System > General. The tenant name is called 'Database' in BlueDolphin and the API key is called 'Datacollection API key'.
After you make sure the tenant name & tenant API Key are correct, click Connect and a connection to the specified BlueDolphin tenant is made.
When the connection is successful, you can select a "Target Collection" or a "Template" from your BlueDolphin tenant.
A Template pre-fills the "Data Provider", "Connection String" and "Select Statement" fields.
You then only have to complete the remaining fields (see the figure below).
The table below explains the fields present in the StandAlone DataCollector configuration.
Field | Description |
BlueDolphin Target Collection |
Here you specify the name of the collection. All data from the configured source will be loaded into this collection. |
Data Provider | Here are all possible data provider installed on the machine selectable. The active data provider is selected. |
Connection String | Here is the connection string used by the Data Provider to open/connect to the datasource. |
Select Statement | Here is the select statement used by the data provider to extract the data from the datasource (using the connection string specified). |
Preview | By pressing the Preview button, you get a glimpse of the result from the connection string and the select statement. |
Primary key(s) |
Here you need to specify one or multiple fields to uniquely identify a row in the datasource. There must be a Primary Key present if you want the update functionality to work. When you need multiple fields, you can separate the fields using the ";" character. |
When you have finished replacing the connection string and select statement, you can click Preview to see if the data looks like expected. When the data looks fine, click Start Import to send the data to your BlueDolphin environment.
Save and load an import configuration to/from file
If you expect to import the exact same data again, you can store the import configuration information to a file. Do so by choosing "File" and "Save". The configuration is now stored in an .xml file.
By choosing "File" and "Load", you are able to load the .xml configuration file that was saved earlier.
You can also use an .xml configuration file with the StandAlone Commandline.
Comments
0 comments
Please sign in to leave a comment.