Skip to main content

Installation Guide

Prerequisites​

Installation​

  1. If you already have a Data Processing service running, make sure to stop this by following Stopping the service

  2. Store the exe-file that you downloaded at the place where you want the installation to take place

  3. Open a terminal (for example powershell) in administrator mode

  4. Navigate to the folder where the exe-file is stored:

    cd <PATH_TO_EXE_FILE>

  5. Install the service:

    .\AnalyticsDataProcessingService.exe install

    Note: A default run-config (Configurations) and a logs folder (Logging) will be created and placed at the same location as the .exe file during the installation

  6. Enter the connection string for your EWA Database and your EWA Analytics Database in this file: config/run_config.toml.

    Example of connection string: DRIVER={ODBC Driver 18 for SQL Server};SERVER=sql-main-dev-001.database.windows.net,1433;DATABASE=sqldb-main-dev-001;UID=<USER_NAME>;PWD=<PASSWORD>;autocommit=True;"

  7. Make changes to the configuration by editing the file names run-config.toml or use the default config.

  8. Start the service:

    .\AnalyticsDataProcessingService.exe start

Configuration​

Configuration options​

The service can be configured with the following options:

Setting Name (> Release 31)Description
BLIKSUND_TARGET_DATABASE_CONNECTIONConnection string to the EWA Reporting Database
BLIKSUND_TARGET_DATABASE_TYPEDatabase type for target, currently supported: mssql
BLIKSUND_SOURCE_DATABASE_CONNECTIONConnection string to the EWA Database
BLIKSUND_SOURCE_DATABASE_TYPEDatabase type for source, currently supported: mssql and mariabd
BLIKSUND_RUN_SCHEDULEDtrue if running the service on a schedule and false if running the service once
BLIKSUND_RUN_SCHEDULED_FREQUENCY_MINNumber of minutes between each run. If the frequency is set to be shorter that the run time for one run, the service will not start the next run before the previous ones are finished
BLIKSUND_LOAD_BATCH_SIZENumber of rows fetched in each batch from the EWA Database.
BLIKSUND_LOAD_BATCH_WAIT_TIMENumber of seconds to wait between each batch of data from the EWA Database
BLIKSUND_LOAD_FULL_ON_SCHEDULEtrue if running the loader part as a full load and false if running it incrementally
BLIKSUND_LOAD_FULL_ON_STARTtrue if running a full load of the loader part on start of the service
BLIKSUND_TRANSFORM_FULL_ON_SCHEDULEtrue if running the transformer part as a full load and false if running it incrementally
BLIKSUND_TRANSFORM_FULL_ON_STARTtrue if running a full load of the transformer part on start of the service

Note: If it is a Major version update you normally have to use the setting BLIKSUND_TRANSFORM_FULL_ON_START=True, but then you will be informed in the release notes.

Default configuration​

The default run configuration (> Release 31):

BLIKSUND_TARGET_DATABASE_CONNECTION = ""
BLIKSUND_TARGET_DATABASE_TYPE = "mssql"
BLIKSUND_SOURCE_DATABASE_CONNECTION = ""
BLIKSUND_SOURCE_DATABASE_TYPE = "mssql"
BLIKSUND_RUN_SCHEDULED = true
BLIKSUND_RUN_SCHEDULED_FREQUENCY_MIN = 60
BLIKSUND_LOAD_BATCH_SIZE = 500
BLIKSUND_LOAD_BATCH_WAIT_TIME = 1
BLIKSUND_LOAD_FULL_ON_SCHEDULE = false
BLIKSUND_LOAD_FULL_ON_START = false
BLIKSUND_TRANSFORM_FULL_ON_SCHEDULE = false
BLIKSUND_TRANSFORM_FULL_ON_START = false

Logging​

Logs are placed under logs/service.log, and if you are running the code as a windows service, the log file will be placed in the same folder as AnalyticsDataProcessingService.exe.

Stopping the service​

Follow this guide if you want to stop an already running service

  1. Open a terminal (for example powershell) in administrator mode

  2. Navigate to the folder where the old exe-file is stored:

    cd <PATH_TO_EXE_FILE>

  3. Stop the service:

    .\AnalyticsDataProcessingService.exe stop