Introduction

Common install guide for WIP, SAM and Active Backup for administrators. Use this guide for a detailled technical installation, will cover prerequisites, software installation, connect to the database repository, and configuration.

Open

Installation Guide for WIP, SAM and Active Backup (AB)

Table of Contents

Configuration management

Guarantees

Ebiexperts does not guarantee that this document is error free

Copyright

Overview

What Do We Mean by "Installation”?

By installation we mean the installation of the ebiexperts solution. This includes the database specific installations, the server modules and web deployment.

Common Prerequisites

System Requirements

Remote Access:

In order to help you during installation we need a remote access to the WIP / SAM / AB Server and to the QlikView & Qlik Sense Servers. With no remote access we will charge hourly fees for setup and support.

Windows:

The product will run on a machine with Windows Operating System Installed:

Windows 2016, Windows 2019 and greater

.NET Framework

The .NET Framework 4.7.2 or greater is necessary check here system requirementshttps://docs.microsoft.com/en-us/dotnet/framework/get-started/system-requirements

Minimum Hardware Specification:

The application will run on 64Bit OS

Installed Memory: Min 4GB

Hard Disk: Min 2GB + 20GB if MariaDB embedded is used

CPU: Minimum 8 Cores

WIP / SAM / AB can be run in Virtual Machines. WIP for QlikView can’t be installed on QlikView Server Machines, but SAM, AB and WIP for Qlik Sense can be installed on Qlik Sense Server machines.

Databases:

Microsoft SQL Server 2005, 2008, 2008R2, 2012, 2016 and greater any editions but not Express Edition for production (Limited to 10GB)

• SQL Server authentication: Need username and password for a user with full rights on the database

• Windows AD authentication: Need an Active directory user able to login to the database and start a Windows Service and that have full access to WIP Server Folders

Oracle: 11g, 12c and greater

Need the database USERS credentials for a user with full rights on the database

My SQL 6.x and greater

Maria DB 10.x and greater

Internet Browser

• Currently WIP is compatible with all versions of Firefox, Safari, Google Chrome, Edge, Internet Explorer is not anymore supported.

• Screens Resolution of min 770px width

REMARK : A valid internet browser should be available on the server where you install WIP or you should have an external access to the server WIP:59272, SAM:59372, AB: 59472 port with a valid browser. Windows servers come by default with Internet Explorer that is NOT COMPATIBLE with WIP

Firewall: in order to access WIP from an external browser the ports WIP:59272, SAM:59372, AB: 59472 (if have not been changed) should be open.

Licenses:

A valid license will be prompted after logging into the Web Server.

Security:

For the best integration with QlikView and Qlik Sense we advise you to have an Active Directory network that covers the Qlik Servers. Other connection solutions are available on demand.

Resource Utilization:

WIP, SAM, AB utilizes very limited resources from your system about 200mb Memory is generally enough, but it will also depend of the number of concurrent users connected.

WIP, SAM, AB does not actually retain any data from Qlik Applications, it only retains the script generated for the applications. There is an option to retain the data should the user require this option.

If you install the embedded MariaDB repository, you will need the space for the database repository on the C drive. As this can grow very fast,for production environments we advise you to install the MariaDB repository to a dedicated server / drive.

WIP for QlikView:

QlikView Desktop Versions:

• 3.1.x

• 3.2.x

• June, September, November 2017 (end of life)

• February, April, June, September 2018 (end of life).

• 12.40 April 2019 Latest version supported (end of life April 27, 2022)

WIP supports both 32 and 64bit versions of QlikView and will automatically work with the current installed version.

Service user launching WIP Web Server must have the right to impersonate users after login

Also note the server memory depends directly on the size of the qvw files loaded simultaneously.

As WIP use 2 concurrent qlikview sessions and if the reloads are done on publisher we can compute 3x the size of your biggest app being checked in to be comfortable so 3x80GB 240GB plus os and wip services so 260GB

All AD users must have the right to create a session on the WIP server for windows impersonation - https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/impersonate-a-client-after-authentication

QlikView Desktop must be installed on WIP Web Server and service user launching WIP server must have a local or shared QlikView license assigned. (Use run as this user to ensure it)

WIP for SAP-BO:

SAP-BI Versions:

• SAP-BI4.2 SP5 and greater.

• SAP-BI Client tools installed with all JAVA, REST and .NET API (!!Not checked by default!!)

WIP, SAM, AB for Qlik Sense:

Qlik Sense Versions:

• February, April, June, September 2018.

• February, April, June, September 2019.

• February, April, June 2020 and upper

Qlik Versions: https://support.qlik.com/articles/000033652

Connect to Qlik Sense Servers

• Certificate authentication:

  • Need an exported certificate without password

Connect WIP to QlikView Servers

Windows AD authentication : Need an Active directory user having full access to QlikView Server application folder structure and shares in order to point WIP QlikView Server Folders

Connect WIP to SAP-BI Servers

WIP will connect using SAP-BI Enterprise Authentication, AD or any SAP-BI plugin authentication.

INTRODUCTION

Support Information

Should you have any questions or challenges please log a ticket to our support website at https://ebiexpert.atlassian.net/servicedesk/customer/portals.

Installation Files

The installation files can be downloaded from the following location:

Ebiexperts Download

Please note you have to be logged into the site in order to access our download section.

Other Information Sources:

For any additional support or technical queries please use the Support Ticketing System on our support website.

The following documentation can be accessed from WIP Application or downloaded from the ebiexperts support website.

https://ebiexpert.atlassian.net/servicedesk/customer/portals.

• Administration Guides

• Installation Guides

• User Manuals

• Wiki

• WIP White Papers (as published on our site from time to time)

Training Videos

Here you will find a list of very useful training videos for technical, installation and WIP daily usage.

<>

Social Media

ebiexperts Facebook page

ebiexperts Twitter page

ebiexperts LinkedIn

Should the reader require any additional information please email our support team.

General Configuration overview

Architecture

ebiexperts products are is a multi-tiered solution. It consists of a database (also called WIP repository) and of a Web Server. The Web Server is connected to the database through OLEDB and Native connection.

The Clients uses a Web Browser to connect the Web Server on HTTP or HTTPS default port. This port must be open on the WIP Web Server in order to be accessible externally.

For SAP and QlikView the client can install the WIP Addon locally to allow WIP Web Server to access the client machine folders system and open QlikView and SAP files. The default port is 59282 and port must be open between WIP Web Server -> Client machine

From WIP Version 19.9 WIP will Install two additional services, WIP Processor that will process checked-in documents in the background and accelerate the check-in and WIP SAP Service that will link WIP and SAP API.

SAM and AB products will use an additional service called Cache Service that will synchronize Qlik Sense assets with the product cache for faster access.

Web Server can be finally remotely controlled using a Rest API, see the WIP Rest for more information.

Open

Same for SAM and AB

INSTALL/ UPGRADE

WARNING: Before upgrading to a new Product Version ensure you have made a backup of your repository database.

The Upgrade to a newer version of is the same procedure as Install but you will not have to create the repository database, just need to Update Database using the Setup.

WARNING : As new version can require a Database Update always run Setup at the end of installation, it will prompt you if an update is necessary

BACKUP/ RESTORE Installation

Backing up the repository database and config file is enough to restore an ebiexperts installation

1. Backup the “WipDbSettings.config” file stored in

   1. C:\ProgramData\ebiexperts\[WIP | SAM | BAK] Web Server\webapp.

   2. this file store database connection and web server information for the product setup

2. Repository database

   1. Embedded Mariadb database:

      1. backup/restore the folder C:\ProgramData\ebiexperts\[WIP | SAM | BAK]Web Server\repository\[wip|sam|bak]

   2. External Database (SQLServer, Oracle..)

      1. use your standard database backup/restore

Downloading Installation Program

The installation file can be downloaded from Software Download

1. Register or login to access the Downloads section.

Double-click the Setup.exe file to start the installation.

The installation program should now have started.

Run the installation program

1. It is recommended that you install ebiexperts products as Administrator (Right Click install file and select “Run as administrator”)

2. When the Welcome dialog opens, read the information and click Next.

Choose a Personalized Setup

WIP is composed of 4 different modules:

WIP Setup: Application to set your different WIP Web Server parameters. Manage repository database, the different WIP Connector and Services. It is needed on every WIP installation

WIP Web Server: The WIP Web Server itself. It is needed on every WIP installation

WIP Repository: Embedded MariaDB repository database, Only needed if you don’t want to connect to your own repository database or for customer’s POC

WIP SAP Service: Connect WIP to SAP Servers. Only needed is you will connect to SAP-BI

Make the selections and click Next.

SAM is composed of 3 different modules:

SAM Setup: Application to set your different Web Server parameters. Manage repository database, the different SAM Connector and Services. It is needed on every SAM installation

SAM Web Server: The SAM Web Server itself. It is needed on every installation

SAM Repository: Embedded MariaDB repository database, Only needed if you don’t want to connect to your own repository database or for customer’s POC

Make the selections and click Next.

Active Backup is composed of 3 different modules:

BAK Setup: Application to set your different Web Server parameters. Manage repository database, the different Active Backup Connector and Services. It is needed on every Active Backup installation

BAK Web Server: The Active Backup Web Server itself. It is needed on every installation

BAK Repository: Embedded MariaDB repository database, Only needed if you don’t want to connect to your own repository database or for customer’s POC

Make the selections and click Next.

You will be required to input the Services user credentials.

The installation is now ready to start, click Next to start.

The installation process will run.

When the installation is completed, leave the checkbox ticked to immediately launch WIP. This will launch the WIP Setup where you will configure your WIP Server to your database repository.

Setup

The installation will install the software, but you will have to connect the web server to a database.

Necessary Modules

• Mandatory: Setup

• Mandatory: Web Server

Prerequisites for the installation

• An accessible database for the database repository

• A user with administrator’s rights on the system

Important: If you are using Windows Authentication for the database connection, run Setup as the same user that will start the Web Server Service. (In Windows explorer” Run As This User” C:\ProgramData\ebiexperts\[WIP|SAM|BAK] Web Server\webapp\WipSetup.exe)

Create SQL Server / Oracle Database

Create Database

Use your favorite database management tool to create a new database

Create a new clean Database, example: “WIP”.

Set the database up according to your own IT Policies.

For more information on configuring databases please see Database configuration.

Auto Create Database

You can create a new database directly in Setup for SQL Server.

Click “Create New Database” which will open a window to create a new database.

Input your desired new database name

Press Ok, will be created, you must return to the database connection to select the newly created database.

Connect SQL Server Repository

Database

The Database tab is used to configure the connection to the database.

Please Note

If no database is currently configured (e.g. first time install), Repository Version in the “General” tab will display as “Not Current”.

Connection

In the Database Connection Field click on the “….” Button which will open the Connection Properties Wizard:

Utilizing the Connection Properties wizard, create a connection to the Database that you have already created for WIP.

Provide a Server name

Provide either SQL Server Authentication with database Username and Password or Use Windows Authentication

1. Windows Authentication – an administrative user of the machine on your domain.

2. Use SQL Server Authentication – the credentials used to access your SQL server.

Enable “Save my password” if SQL Server Authentication is selected

Select a database that you previously created

Click “Test Connection” and based on a successful test, click on the “OK” button.

You should now have a connection to your database configured.

Install / update repository database

Automatic installation

Repository database can be created or updated semi-automatically from “XXX Setup”.

Installation Procedure

Define the connection to the repository database as described in “Connection Repository” section.

As long as you have not executed the repository database creation scripts, the following message will return:

Click Update Database Note: you might always make a backup of your database before making any database upgrade.

Click “Upgrade” for WIP Setup to create standard database tables utilized by the WIP Web Server.

To ensure that this is an action that needs to be performed, WIP Setup will confirm the action

To continue click Yes

Once the action has been completed click OK

Click OK and WIP Setup will verify the instructions are completed successfully, then Close the window.

Update Database

Setup will pop up with the upgrade database again (requires you to upgrade the database twice)

Update database process needs to be run twice as different database version scripts needs to run in order to merge them for the most recent database versions. Thus it is required to repeat the steps 3 - 7 again.

Please Note:

To ensure that the connection to the database is still correct the Test Connection button can be used on the Database tab.

In the event the database tables need to be deleted the Drop Database Tables button can be clicked. the Setup will execute a SQL script to remove all tables in the connected database.

If the repository database is updated to a newer version the same process needs to be followed to upgrade the repository database.

Database configuration

Database choice

If you own any of SQL Server, Oracle or MariaDB/MySQL database it would be a good option to use it. For demo or POC purposes you can use SQL Server Express but it is limited to 10GB (already quite big)

Else you can download a free Maria DB or MySQL version that will be a strong open source database

SQL Server Configuration

Generally, no middleware is necessary as OLEDB for MSSQL Server is installed on all Windows versions.

You can install a free version of SQL Server Express

See Connect SQL Server Repository

Oracle Configuration

Generally, no middleware is necessary WIP will connect using it’s own Oracle Managed data access driver

Maria DB / MySQL Configuration

Generally, no middleware is necessary WIP will connect using its own data access driver

Remark: If you chose to install “[WIP | SAM | AB] Repository” component setup will install and manage a MariaDB (MySQL) Database that can be used for production. Here the default embedded database credentials:

• Provider= mysql

• server= localhost

• port= WIP:59290 , SAM:59390, AB:59490

• user id= root

• password= EBIEXPERTS

• database= wip|sam|bak

Manually Upgrade : run manually the update scripts

Press the “Update Database” Button, select the SQL Instruction text, select All (CTRL-A), past it in your database editor and run the instructions line by line or in batch

Once done update the repository Metadata, press “Update Mapping Button”

Services

[WIP | SAM | AB] Web Server Service

The Web server for WIP, SAM and AB is set the same way, only the ports and services names are different

If the “Installed” check box is checked then Web Server is Installed correctly.

You can manually specify the web server port number or use the default ones WIP:59272, SAM;59372, AB:59472

WIP Web Api Url: Set the URL that your clients must type to access WIP Web Server remotely

• machine: will use the computer name

• autoip: detect one or your ip address (if not ok use <free>)

• <free> : specify your own URL

Use SSL: If you want your web server to be accesses through secured HTTPS check Use SSL. The setup will generate a local temporary certificate and bind it to the port you specify.

If you have a valid certificate install it on the Local Computer / Personal certificates and enter its Thumbprint in the Certificate Thumbprint field.

For more information refers to our wiki article

Press Apply Button, Stop and Start WIP Web Server and click the “[WIP|SAM|AB]Mgmt Console” Link

Note : You can start “Web Server” in interactive for debugging with the “Start Interactive” button.

Check the service

After installation it is recommended that you check that the services are running.

Run Services.msc

WIP|SAM|AB Web Server

Open WIP|SAM|AB Web Server

Check the Service status is “Running”

Logon

Installation Type

Local Host

You have installed WIP|SAM|AB on your local machine and you are connected to the Web Server.

Other Users can connect to your WIP|SAM|AB application using your machine name or IP address, your machine is therefore acting as a server machine for other Users in your organization.

In the example shown above – 59272 is the port used to connect WIP.

External connection

If you want to connect from an external computer you need to connect using the IP address or the DNS name of the machine and open the firewall for WIP|SAM|AB ports.

In the example shown above – 59272 is the port used to connect WIP.

Open firewall

By default, an outside machine will not allow you to connect to their machine. You need to create an Inbound Rule to allow the connection.

1. Copy the Port number.

2. Go to Windows Firewall With Advanced Security.

1. Inbound Rules

2. Create a new rule by clicking “New Rule…” on the right

Select “Port”

Select “TCP” and specify the Port number, paste the port number that you copied in the clipboard

Select “Allow the connection”

When does this rule apply? – When Users are connected to different domains, choose which domains should be allowed, this can be according to your own preference or company policy.

Specify the name of the rule eg. WIP Web Server

The WIP Web Server rule will now be created.

Note: Other users with your IP address will now be able to connect to your WIP server, they can use your IP address or your machine name.

Local Security Policy (only for WIP for QlikView and SAP)

In order WIP Web Service to work correctly, especially if your service user is not an admin, you must give certain rights to the WIP Service User:

Open Local Security Policy

Local Policies – User Rights Assignment

Log on as a service

Find “Logon as a service” and double click

Add the WIP Service User

Act as part of the operating system

Add the WIP Service User to “Act as part of the operating system”

Impersonate a client after authentication

Add the WIP Service User to “Impersonate a client after authentication”

WIP Manual CONFIGURATION

For security purposes WIP is installed in a hidden folder, only an Administrator will be able to access the installation contents of WIP.

Open Windows Explorer C Drive – View – Hidden Items – check hidden items

You will now be able to see hidden items – the WIP installation items is located in the hidden folder “Program Data”

Edit C:\ProgramData\ebiexperts\[WIP|SAM|AB] Web Server\webapp\WIPWebServer.exe.config

Concurrent Users

To edit the number of concurrent Users in WIP, find the ecowebmacpool line.

The default value is set to 10, meaning 10 Users will be able to connect to WIP simultaneously. If you have more than 10 Users in your license, increase the number to your required number of Users.

File locations

Log files :

• By default the log files are stored in C:\ProgramData\ebiexperts\TEMP"

• It’s possible to move the log files using NLog.config

  • Set value to new destination in <variable name="logDir" value="C:\ProgramData\ebiexperts\TEMP" />

  • replace fileName="${basedir}/log/... by fileName="${logDir}/log/...

Temp files

• All WIP Temp files are regrouped to C:\ProgramData\ebiexperts\TEMP\ and cleaned every hour

Install WIP from command line

Silent Installs

With the silent install command line parameter set, the entire installation will execute silently, without a user interface, or any user intervention. When input is required on dialog boxes, the default values of dialog controls will be used.

<setup.exe> /s

In the above example, setup.exe denotes the main setup executable.

Logged Installs

If the logging command line parameter is set, the installation will keep a verbose log of all the internal installation variables, as well as Windows Installer's own installation log. Be aware that logging significantly decreases the runtime speeds of an installation.

<setup.exe> /l=<logfile.ext>

In the above example, setup.exe denotes the main setup executable, and logfile.ext is the full path to the desired log file.

Uninstall WIP from command line

Uninstalling from the Command Line

You may silently remove InstallAware setups using setup command line parameters.

Silently Uninstalling

<setup.exe> /s MODIFY=FALSE REMOVE=TRUE UNINSTALL=YES

In the above example, setup.exe denotes the main setup executable.

Login and Activation

For the first time you login, select “Access as User/Admin” as the environment and “VMMANAGER” as the username. The password is “EBIEXPERTS”

Activation

Once you have logged in to WIP for the first time, you will be presented with the Licensing Option. You can copy - paste the license into the license tab or you can use the Import License function.

Note: In the WIP License file copy the text between <vm license> and </vm license>

You will receive this key from ebiexperts or one of its partners. Each key is unique, contains your customer id and should not be shared. The key gives access to the demo or purchased modules until the “Date End” of the license.

The key also includes a Maintenance date that allows for installation of products and updates until the “Date End” of the license.

Once you have installed and optionally activated your copy of WIP, you can start using the program.

Start Menu

Setup will automatically create some shortcut in the Start menu of your machine.

Log Files

The log files can be found in the following locations

https://<webserverurl>:59272/log/

and

C:\ProgramData\ebiexperts\WIP Web Server\webapp\log

The log files will be automatically generated in this location when you get an error in WIP.

Log Settings

These settings can be changed in the Setup in the General tab

By default the “Log Level” is set to log only errors. There is 2 levels, one for the log file the second for the console (if you run web server in interactive mode)

Log Level : defaults = Error, set it to Debug or Trace for more details

WIP Addon (only for WIP for QlikView and SAP)

The WIP Addon allow the WIP web server to communicate with your local machine in order to transmit and open files (mainly QlikView and SAP applications)

You can install latest version from here https://support.ebiexperts.com/runtimes/wip_addon.exe

As the program is not signed it's possible that you have to bypass Windows SmartScreen like this:

Installation and Update

Set URLACL rigth for single users

Run an elevated cmd and type following command

Once installed you should have a Tray Icon like below

If you right click on the tray icon you have a Configuration menu that display the version and the link to the next version.

You can also stop the WIP Addon using the Exit Menu

Debugging

It's also possible to display a debug console.

1. Stop the Wip Addon

2. Run C:\Program Files (x86)\ebiexperts WIP Addon\WIPAddonTray.exe /debug

WHAT NEXT?

Once you have installed and setup the database repository, please consult the

Administration Guide and User Guide

Administration Guide

The Administration Guide is a comprehensive overview of the Web Server product detailing the Configuration / Administration setup options to utilise the product.

User Guide:

User Guide is a comprehensive overview of the application that goes into some detail about all the various functions/features of the application and how to use them.