WIP Plugins Configuration

Owned by Jean-Philippe Golay
Last updated: Oct 10, 2024 by Hemangi Kurapati
22 min read

 

 

Disclaimer

No part of the Computer Software or of this Document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage and retrieval system, without permission in writing from Ebiexperts. The information in this document is subject to change without notice.

If you find any problem with this documentation, please report it to Ebiexperts in writing at support@ebiexperts.com.

Ebiexperts does not guarantee that this document is without errors.

WIP Plugins Configuration

WIP Connect to Qlik Sense

Table of Contents

Prerequisites

Please consult WIP Install Guide for prerequisites

Link to a Qlik Sense Server

Click “Create New Server” and select “Qlik Sense” to link to a Qlik Sense Server.

 

Name: WIP Name of this specific server.

URL: The Qlik Sense Server URL that WIP will connect to, generally in the intranet

External URL: The Qlik Sense Server URL the users will connect to

Ports: Ports 443 (https), 4242 and 4747 must be open between WIP Web Server and Qlik Sense Server to connect

Authentication: The method used to identify the user on the Qlik Sense Server. Currently WIP will connect using Certificates on port 4242 for QRS REST API and 4747 for .NET API bypassing the PROXY.

Impersonate:

  • Never: will use Logon User for all actions,

  • For publish: will use Logon User for all actions but server user for publish

  • Always: will use server user for all actions

Import Certificate: See below

Click “Test Qlik Sense Server” to validate the server connection.

Open firewall ports

Ports: Ports 443 (https), 4242 and 4747 must be open between WIP Web Server and Qlik Sense Server to connect

Export Qlik Sense Certificate

Go to the QMC and choose the certificate menu, enter a machine name and press export

Certificates will be exported in the

“C:\ProgramData\Qlik\Sense\Repository\Exported Certificates“

folder. Note that if you have multiple nodes it can be on any of them.

Import Qlik Sense Certificate in WIP

Back in WIP Press the “Certificate” button select your exported client.pfx, Open

In WIP Press “Save” button

Test link to Qlik Sense server

Qlik Sense Enable Multiuser Checkout

From sense November 2018 you need to make this manipulation in order to allow Qlik Sense App sharing

  • Edit “C:\Program Files\Qlik\Sense\ServiceDispatcher\services.conf” (or the equivalent path if you chose a non-default install location)

  • Search for the section [hub.parameters]

  • In that section add --enable-non-published-sharing

  • Restart the Qlik Sense Service Dispatcher

  • Restart Qlik sense server if it doesn’t work

  • Repeat on each node in the deployment

Create Environments

When you create the Qlik Sense server, WIP creates an environment by default with same name that the server.

You can create multiple environments in a single Qlik Sense server see the chapter Create a DEV-UAT-PRD Environment on one single Qlik Sense Server

Refers to WIP Admin Guide to create new environment.

Note: ensure you add Administrators Group to the security else you will not be able to see it.

Create a DEV-UAT-PRD Environment on one single Qlik Sense Server

With WIP you can create a multiple environments infrastructure in a single Qlik Sense server. You will log on against DEV environment to make your check out / check in to “My Work”, then create a set of streams for UAT and PRD.

Example:

In WIP create 00_EBISENSE_DEV, 01_EBISENSE_UAT and 02_EBISENSE_PRD environments.

Create departments or feature folders in WIP like “Finance”

In Qlik Sense create finance_DEV, finance_UAT, finance (PRD) streams

Select WIP Finance folder and assign the respective streams in the Destinations

Import Qlik Sense Users

WIP can import the users from Qlik Sense Repository.

Only users not already in WIP will be displayed.

Note: that on first import user information in WIP is not filled.

Setup SAML Authentication

WIP can use SAML connectivity using Qlik Sense proxy. WIP will authenticate your users redirecting to the virtual proxy that will login the user and callback WIP for login process.

Any kind of Qlik Sense authentication is supported like AD, Azure, Okta, custom forms…

All you need to do is enter the proxy address to use in the Url field

You need to set impersonate “For Publish” and set a Username and Password as WIP don’t know your username on first login

Then in login form choose Qlik Sense for login mode, you will be redirected to Qlik Sense Authentication

Proceed to Qlik Sense authentication (Azure in that case but can be any authentication you have defined in the Qlik Sense Proxy)

On first registration WIP will create your user in the repository but an administrator need to validate it and assign you a WIP License. If no license assigned or user is not already validated you should receive a message like this:

User XXX.onmhttp://icrosoft.com not active or not yet validated please contact your administrator"

To validate you user Administrator must login select Users, and check the “Validation Required”

Uncheck the Validate User

Assign you a license and a Group

That’s all you should be able to login using Qlik Sense SAML

Setup Qlik Sense Load Balancing

WIP Connect to QlikView

Table of Contents

Prerequisites

Please consult WIP Install Guide for prerequisites

Installing WIP for QlikView

This is a special chapter for WIP for QlikView installation, as QlikView is an old desktop technology it requires a little more configuration.

Related documentation: see this training video

WIP Training 03 Connect QlikView Server

WIP for QlikView User’s Impersonation

WIP for QlikView Security

  • As WIP is a Web Server it’s the user starting the service (WIP Service User) will interact with database and launch QlikView sessions

  • In order respect Windows user’s security WIP Web Server will impersonate (create a local windows session) on belong of the <WIP Log On> user or the WIP Proxy user. The proxy user is the user defined in the QlikView Server.

 

Impersonation

As WIP service is running with the WIP Service User credentials in order to browse logged-in user folders with the correct credentials, WIP Service User must have the right to create a windows session in behalf of the logged-in user (Impersonate)

https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/impersonate-a-client-after-authentication

Also, the user being impersonated must have the right to logon locally on the windows server where WIP is installed.

https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/allow-log-on-locally

Browse QlikView Servers

The QlikView Server browsing is done using the <WIP Log On> User he must have Read right on Qlik View Server shares and folders defined in WIP QlikView Server

Checkout

  • The checkout is done using <WIP Log On> User and this user must have Windows AD RW right on destination checkout path.

  • If you want the WIP Web Server to checkout to your local machine install the WIP Addon and prefix the Destination path by «@» (@C:\QlikViewApps)

Publish

The QlikView Server publish is done using <WIP Proxy User>. If no <WIP Proxy User> is defined then WIP will use <WIP Log On>. <WIP Proxy User> or <WIP Log On> must have WRITE and CREATE FOLDER right on publish destinations shares or folders.

User’s Rights for <WIP Service User>

These are the user’s rights necessary for WIP Service User

  1. Belong to Administrators Group

  2. Have RWCD rights on the database in integrated authentication is used

  3. Local Security Policy

    1. Access this computer from the network

    2. Act as part of the operating system (can be necessary to launch QlikView Sessions)

    3. Allow log on locally

    4. Logon as a service

    5. Log on as a batch job

    6. Impersonate a client after authentication

User’s Rights for <WIP Log On> User

In order to be impersonated a QlikView user need to be allowed to logon locally

To check this launch to C:\Program Files\QlikView\Qv.exe

Press Shift+Right Click / Run as a different user and enter the user’s credentials

Install and configure QlikView Desktop

Install QlikView Desktop version 12 and Later

Assign a License QlikView Desktop

QlikView Desktop must be assigned a license for the user that starts the WIP Web Server Service. It’s very important, failing to license this user will result to check-in errors.

With the file explorer go to C:\Program Files\QlikView

Search Qv.exe

Press Shift-Right Click Run as different user

Enter the same user’s credentials that you used to start the WIP Web Server Service

Assign a QlikView Server License

In QlikView press File / Open In Server

Type the QlikView Server url like qvp://<url>

Then press Connect will assign a license. It’s the best way to assign a license it as if license expires it will fetch a new one

Assign a QlikView License Key

Install WIP

Ask us for the link to our Google Drive or FTP

Under the WIP folder you will find official releases

Under dailybuild you can find your Service Pack. Only install from that folder if instructed by ebiexperts.

Installation

Launch WIP Installer

Select Complete Setup and click Next.

 

You will be required to input the credentials of the Service User that will launch WIP Web Server. This user needs to be an Administrator of the machine, the password is required as this user will be used to start the WIP service.

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

 

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.

 

Launch WIP Setup

If you are logged in Windows with the WIP Web Service user launch WIP Setup from start menu

Else if you are not logged in Windows with the WIP Web Service user entered in the WIP Installed and want to connect the repository database with windows integrated security locate

C:\ProgramData\ebiexperts\WIP Web Server\webapp\WIPSetup.exe

and run it as same user than the WIP Web Server Service User to have the same database credentials

Press Shift – Right Click on VmCcNETSetup.exe

 

Once in VmSetup

Refers to WIP Install Guide “10 INSTALL / UPDATE WIP REPOSITORY DATABASE” chapter to connect the database.

In short for SQLServer select OLEDB SQLServer and press the “…” button right to Database Connection

Enter your connection Server and select Database then press Test Connection

Remark: as you see if you “Use Windows Authentication” the Logon User will connect the database. So in order to use same WIP Web Server Service user credentials

  1. Logon Windows as WIP Web Server Service User

  2. Rus WIPSetup.exe as WIP Web Server Service User

Back in the Database tab press Update Database.

Go Back to WIP Setup select the QlikView Versions, click on Default to QV12 and press the Launch Default QV, should launch QlikView

Double check that QlikView is not in Personal Edition in the Windows Title

Go to the Services Tab and check that the WIP Web Server is started

More details on WIP Web Server Configuration is available in WIP Install Guide in chapter “WIP Services”

Check the WIP Web Server Service Credentials

Run services.msc check the login account is correct should have access to the database if using Integrated SQLServer Security and start the service. (Restart it if you change something)

Check the WIP Web Server Service User’s Authorizations

Do this only if your WIP WebServer Service User is not part of the Administrators Group

In Start Menu Search for “Local Security Policy”

Security Settings / Local Policies / User Rights Assignment and add WIP Service User to

  • “Impersonate a client after authentication”

  • “Logon as a service”

  • “Act as part of the operating system”

Check that all users that will log into WIP can login to this machine

All users that will Use WIP for QlikView must have the right to login the Windows machine where WIP Web Server is installed in order to be Impersonated by the WIP Service User

Locate

C:\ProgramData\ebiexperts\WIP Web Server\webapp\WIPSetup.exe

and run it as same user than the WIP Web Server Service User to have the same database credentials

Press Shift – Right Click on WIPSetup.exe

Run as different user and enter your user credentials. If it fails or your user have not the rights to “impersonate a user after authentication” or the user have not the right to logon to this machine, see with your administrator

Testing WIP for QlikView

Enter WIP License

Launch WIP (http://wipwevserver:59272/wip)

Login with VMMANAGER / EBIEXPERTS

If no license has been entered a license form will be shown. If an expired license is detected or you need to update it follow these steps

Enter your license in Options / License and check that you have a WIP QlikView User License

Create a New QlikView Server

Go to Servers + Create New Server / QlikView

Name: WIP Name of your QlikView Server

Root Folder: Root folder where you will publish your QlikView applications. You can define supplementary folders (Mount) in QlikView Directory option

Impersonate: Set for Publish, Mean that Logged-In user will browse your QlikView servers and the proxy user (WIP\ebiadmin) will be used for publish in that server.

Username / Set Password: The Proxy User as defined in Impersonate

Publisher Option: If you have a QlikView Server or Publisher enter it’s URL in the form http://<qvserver>:4799/QMS/Service it will be used for reloads and QlikView desktop licenses upload

Authentication: WinAD if the QlikView server is not using https, certificate else. See the WIP Installation Guide to see how to import the certificates.

Test WIP QlikView Server

Once QlikView Server created press Save

Then Test

  1. WIP will test impersonation of the Proxy User (WIP\ebiadmin) by the WIP WebServer User (NOTE you can change the proxy user temporarily to any user you want to test)

  2. WIP Will check that this user can Access the Root Folder

  3. Test Publisher

  4. Test QlikView Desktop Licensing and Launch

If all the tests succeeded then you are ready to work with WIP for QlikView.

WIP configure Reload with QlikView Publisher

By default, WIP will reload QlikView Applications inside WIP server and that can lead for big apps to a performance problem.

You can ask WIP to use publisher to reload published applications.

Checkout

Note that check-out of QlikView apps will still occurs on WIP server as the applications are not in the publisher apps.

Activate the Publisher reloads

Open the QlikView Server, and check Use Publisher for Reloads & Schedules

 

  • Fill the QMS API URL as https://qv12:4799/QMS/Service

    • if the QMS url starts with "http" check the WinAD authentication

    • if the QMS url starts with "https", check the Certificate authentication

  • Press the Certificate button, select the QMS .pfx file and press save

  • Press the "Test QlikView Server" button

Remark : Add the WIP Proxy User in the “QlikView Management API” Group on the Qlik View Publiosher server. If the group does not exists create it

How to export the QMS certificate

Windows / run mmc.exe, Add / Remove Snap-in

Add certificates / Computer account

Find the QlikView certificate, issued by is generally "QlikViewCA" and export it

Export the private Key

Use Personal Information Exchange – PKCS #12 (.PFX) Format

IMPORTANT: Password must be set to "ebiexperts"

Export the certificate

WIP Connect to Qlik NPrinting

Table of Contents

Prerequisites

Please consult WIP Install Guide for prerequisites

Installing WIP for NPRINTING

Related documentation: see this training video

WIP Training 04 Connect NPrinting Server

NPrinting user’s Roles

In Order to manage NPrinting reports WIP Users must be defined as

Browse / Checkout

The NPrinting Server browsing and checkout is done using the <WIP Log On> User he must have be an administrator on NPrinting Server in order to export the reports

Publish

The NPrinting Server publish is done using <WIP Proxy User>. If no <WIP Proxy User> is defined then WIP will use <WIP Log On>. <WIP Proxy User> or <WIP Log On> User he must have be an administrator on NPrinting Server in order to export the reports

Create New NPrinting Server

Name: Server name in WIP

Url: The internal NPrinting URL used between WIP and NPrinting

External Url: The external NPrinting URL available for users to connect to NPrinting

Authentication:Always “Win AD”

ImpersonateSet “For Publish”

UsernameProxy user for publishes

Import CertificateSee below Import Certificate

Import NPrinting Certificate

The certificate is just used to encrypt communications between WIP and the NPrinting Server. The authentication will still be done using Active Directory

Generate NPrinting certificate

Open NPrinting Url https://<nprintingurl>:4993/

On Chrome Right click on the certificate

In Details tab Press Copy to file

Press Next

Select DER encoded binary X.509 (.CER)

Choose filename and press Next to export

 

Import NPrinting Certificate in WIP

In WIP NPrinting server press the “Certificate” button, select the just exported NPrinting certificate and press Open.

Press Save and Import button

WIP should display “Saved Certificate CN=…”

Press Test Server

Test NPrinting connection

Create a user in WIP that is defined as an Administrator in NPrinting (see NPrinting user’s Roles)

Test the NPrinting server, log on WIP with a user with a NPrinting license assigned open NPRINTING in MANAGE CONTENT, create a root folder and press the N icon, browse a report and press “Check-in(1)”

Et voilà WIP is now connected to NPrinting, for any issue please contact ebiexperts Support at http://support.ebiexperts.com

WIP Connect to SAP-BI

Table of Contents

Prerequisites

Please consult WIP Install Guide for prerequisites

Supplementary Prerequisites for SAP-BI

SAP-BI Client Tool BI4.2 SP5 and further (SP4 OK, SP3 might work but not fully tested)

SAP-BI Client Tool

Screenshots (With options Selected for Java and Rest API)

Ports to be open between the WIP and the SAP Servers:

Installing WIP

See document WIP Install Guide run the standard WIP Install procedure.

In the modules ensure you have selected SAP Service

Installing SAP-BI Client tools

Run the SAP-BI Client tools installer on the WIP Web Server. It is important to run the SAP complete installation, not an in-house installation.

If you have multiple SAP BI versions in your company, install the greater version you have on your servers/clients

Clients Components

In the “Clients Components” WIP needs at least (else check all)

  • Universe Design Tool

  • Information Design Tool

  • Webi Rich Client (Mandatory prior to 4.2 SP8. This is needed for the jvm.dll)

Developer Components

In the “Developer Components” WIP needs at least (else check all)

  • SAP BusinessObjects BI platform Java SDK

  • SAP BusinessObjects BI platform Web Services SDK

  • SAP BusinessObjects BI platform .NET SDK

  • SAP BusinessObjects Semantic Layer Java SDK/ Semantic Layer Java SDK

Database Access and Security

In the “Database Access and Security” select all items to ensure you have at least the same drivers you have on your clients and server installations

Data Federator is mandatory as this is required by the JVM for IDT.

Configure SAP-BI Connector

Launch WIP Setup and go to the SAP BO Versions

Versions: If you see Designer or Webi Connector version 14.2.5 mean BI4.2 and SP5

Assembly Version:

  • for versions till 4.2SP5 included, select 14.0.2000.0

  • for versions > 4.2SP5 select 14.0.5000.0

Update VM Java SDK: on 1st installation or if you change SAP-BI client version press this button to update WIP Java libraries. It’s important to do it

WIP4SAP Ports Used

 

If you want to connect WIP / VM to a SAP system you will find here the list of ports to open in the firewall

WIP4SAP Ports Used

This list is the default port list from the standard installation they may varry depending on the customization done to the BO environment. 

In addition to the above, we need the following port to be opened for the WIP SAP Services:

·         WipJavaPort : 38085 to 38095

·         WipJavaIdtPort : 38185 to 38195

Add-on Port

·         Default is  59282

WIP Port:-

·         Default is 59272

WIP Connect to JIRA

 

Prerequisites

Please consult WIP Install Guide for WIP prerequisites

WIP can connect to Jira Server (on premise installation) or to Jira Cloud.

WIP Jira License : you need a valid “WIP Jira Sync” License installed in order to start the WIP Tracker Service.

Jira Server

A valid WIP Web server installed on any port, https

A Jira admin user having access to the Jira REST API. To connect Jira to WIP, WIP will automatically create a web hook on the Jira side using the Jira credentials.

Jira Cloud

A valid WIP Web server installed on any port with a valid certificate (not support auto generated certificate)

A Jira admin user having access to the Jira REST API. To connect Jira to WIP, WIP will automatically create a web hook on the Jira side using the Jira credentials.

Link to a Jira cloud / Server

In the left menu navigate to “Issue Trackers”

 

Click “Create New Tracker” and select “Jira” to link to a Jira Cloud / Server.

Name: WIP Name of this specific tracker.

Url: the Jira URL that WIP will connect to.

Tracker Subtype: choose Cloud / Server.

Username: the Jira admin username & password.

For the cloud, you need to generate a token and paste this token in the password field. To generate the password token, please follow the following link: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

Click “Test Jira Tracker” to validate the tracker connection.

Click “Load Users From Jira” to load the users from your Jira tracker and map them to your WIP users (will discuss later in this document).

Click “Load Priorities From Jira” to load the Priorities From Jira and map them to Wip Priorities.

Test link to Jira tracker

Press the button “Test Jira Tracker”

Projects

Projects are defined to enable sync issues per project (will mainly depend on issues business unit) where each project can have one business unit which shouldn’t be replicated in another project.

To Create a Project see 2.1.5 Create Project

Map WIP users to JIRA users

Navigate to the Tracker To Users section to map your WIP users with their JIRA Users

Drag and drop WIP users to map Jira Users, Click “Save”

Map WIP Priorities to JIRA Priorities

Navigate to Priority Mapping Section,

Map all statuses in the left (Jira) with the WIP ones. If you have more statuses in Jira than in WIP you might need to map more than one WIP status, In that case the second one is called subsidiary.

Same as Map WIP users to JIRA users

Create Project

To Create a Project, first select a Jira Tracker and click “Edit”.

Navigate to the Projects list section and click “Create Project”. You can create multiple Projects in a single Jira tracker.

Sync Name: Project name in WIP.

Description: Project description in WIP.

WIP BU: choose the related Business unit from WIP.

JIRA Project: Put the related Project from JIRA.

Enabled: enable auto sync (if hook is registered).

JQL: is Jira query used in the JIRA web Hook. See How to write good JQL

Click “Save” to save the new Project to the Tracker

Click “Register Hook” to create Jira web hook to WIP that will sync all project issues updates to WIP and jira (2 way sync if enabled is checked).

Note: To Register a webHook in Jira Cloud, you need to run WIP Server in SSL (https) and use standard any port

Note2: If kanban board is selected for a jira project- issue created on board goes to Board
and
If scrum board is selected for a jira project- issue created on board goes toBacklog

Click “Sync NOW” to initially add issues from JIRA to WIP & from WIP to JIRA (2 way sync).

If some issues not auto-synced correctly see Issues Not Auto mapped correctly (issues in Sync)

Note: issues add to WIP with the appropriate data mapped and under the project’s Business unit.

Map WIP Statuses to Project Statuses

Navigate to “Project To WIP Status” Section,

Under WIP Objects column double click to show the dropdown and choose the appropriate mapped status in WIP.

Click “Save”

Map WIP Issue Types to Project Issue Types

Navigate to “Project To WIP Issue Types” Section,

Same as Map WIP Statuses to Project Statuses

NOTE: If we do not map few issue types, then they may not be synced to WIP.

Issues Not Auto mapped correctly (issues in Sync)

Sync Issue Case1:

If some issues are not synced and need some fixes to map

Navigate to “Sync Issues” Section to check these issues

Hover on Is Sync checkbox to get the reason

ex. “No Mapping Issue type found for ‘Epic’” then Navigate to Project to WIP Issue Types and map ‘Epic’ then Navigate back to Sync Issues you will find Issue Type mapped as per your mapping then click “Apply Sync”

Note: if you just checked “is Sync” and click “Apply Sync” it will sync the issue to default Issue Type

Sync Issue Case2:

In case of issues not syncing and you checked pending sync issues and found nothing pending there, do the following checks:

  1.  check the TrackerService is installed and that it is running

  2. Please use your wip database and run the following query to check if the data was already fetched from jira to our system: 
    SELECT * FROM [TrSyncTable]

  3. Please use your wip database and run the following query to check if issues was added to our WIP  issues: 
    SELECT *  FROM VmRelease

  4. Please check the business unit under which the issues was added that this business unit is allowed for your user

Install WIP Add-on

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/ or from the User Profile

 

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

Installation and Update

 

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

Opening Ports

The "WIP Addon" is installed on the different clients and is called by the "WIP Web Server" on port 59282 by default. You need to modify your firewall

  • create a inbound rule on the clients on port 59282

  • create a outbound rule on the server on port 59282 in restricted

Debuging

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