Installation Guide

Prerequisites

• Install Microsoft SQL Server ODBC Driver 18: learn.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server
• Might need to install Microsoft Visual C++ Redistributable in order to install Microsoft SQL Server ODBC Driver: learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist
• The Bliksund Analytics Data Processing artifacts are downloaded for deployment

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. Add and update needed configurations

   Create a file named .env in the same folder as the exe-file and add the following infromation to it:

   BLIKSUND_RUN_SCHEDULED = false
   BLIKSUND_RUN_SCHEDULED_FREQUENCY_MIN = 1
   BLIKSUND_LOAD_BATCH_SIZE = 50000
   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
   BLIKSUND_RUN_TAG = false
   
   # Source database connection details
   SOURCE__DATABASE__TYPE=mssql
   SOURCE__DATABASE__USERNAME=
   SOURCE__DATABASE__PASSWORD=
   SOURCE__DATABASE__HOST=
   SOURCE__DATABASE__PORT=
   SOURCE__DATABASE__NAME=
   
   # Target database connection details
   TARGET__DATABASE__TYPE=mssql
   TARGET__DATABASE__USERNAME=
   TARGET__DATABASE__PASSWORD=
   TARGET__DATABASE__HOST=
   TARGET__DATABASE__PORT=
   TARGET__DATABASE__NAME=

6. Install the service:

   .\AnalyticsDataProcessingService.exe install

   Note: A log folder (Logging) will be created and placed at the same location as the .exe file during the installation

7. Start the service:

   .\AnalyticsDataProcessingService.exe start

Configuration options

The service can be configured with the following options:

Setting Name	Description	default value
BLIKSUND_RUN_SCHEDULED	true if running the service on a schedule, false if running once	false
BLIKSUND_RUN_SCHEDULED_FREQUENCY_MIN	Minutes between each run	1
BLIKSUND_LOAD_BATCH_SIZE	Number of rows fetched in each batch from the EWA Database	50000
BLIKSUND_LOAD_BATCH_WAIT_TIME	Seconds to wait between each batch of data	1
BLIKSUND_LOAD_FULL_ON_SCHEDULE	true for full load on schedule, false for incremental	false
BLIKSUND_LOAD_FULL_ON_START	true for full load on service start, false for incremental	false
BLIKSUND_TRANSFORM_FULL_ON_SCHEDULE	true for full transform on schedule, false for incremental	false
BLIKSUND_TRANSFORM_FULL_ON_START	true for full transform on service start, false for incremental	false
BLIKSUND_RUN_TAG	false if no run tag is used; otherwise, schemas are prefixed with the tag	false
SOURCE__DATABASE__TYPE	Type of source database	mssql
SOURCE__DATABASE__USERNAME	Username for source database	(empty)
SOURCE__DATABASE__PASSWORD	Password for source database	(empty)
SOURCE__DATABASE__HOST	Host for source database	(empty)
SOURCE__DATABASE__PORT	Port for source database	(empty)
SOURCE__DATABASE__NAME	Name of source database	(empty)
TARGET__DATABASE__TYPE	Type of target database	mssql
TARGET__DATABASE__USERNAME	Username for target database	(empty)
TARGET__DATABASE__PASSWORD	Password for target database	(empty)
TARGET__DATABASE__HOST	Host for target database	(empty)
TARGET__DATABASE__PORT	Port for target database	(empty)
TARGET__DATABASE__NAME	Name of target database	(empty)

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.

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