No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
README.md
demo-install.md
install.md Update install.md May 21, 2018

README.md

senseexcel-reporting

Sense Excel Reporting Installation Process

All about Sense Excel and Sense Excel Reporting also on YouTube-Channel

https://www.youtube.com/channel/UCgQWl9J6OHOstFNPTKfLr5w SenseExcelYoutube

TABLE OF CONTENTS

  1. PREPARE SERVER

  2. PREPARE INSTALLATION FILES

  3. INSTALL CONNECTOR

  4. INSTALL EXTENSION

  5. EDIT CONNECTOR CONFIGURATION FILE

  6. ADD LICENSE INFORMATION

  7. ADD ANALYTIC CONNECTION

  8. ADD VIRTUAL PROXY

  9. ADD SECURITY RULES

  10. VALIDATE CONNECTOR IS RUNNING

  11. SET THE SER CONNECTOR TO RUN AS A SERVICE

1. PREPARE SERVER

  1. Confirm Qlik Sense Server version. November 2017 or later is required.

  2. Please install the NET Core Runtime prior to this installation. Click to Download

  3. Create the following sub-directories within your Qlik Share directories.

\Reporting

\Reporting\SERReports

2. PREPARE INSTALLATION FILES

  1. Unzip Sense Excel Reporting.zip to the \Reporting directory

Install Files

3. INSTALL CONNECTOR

  1. Execute InstallConnector.bat from the \Reporting directory.

Install Connector

  1. Security keys will be created in the %appdata%\Roaming\senseexcel\reporting directory.

  2. Restart Qlik Repository Services and all sub-processes.

4. INSTALL EXTENSION

Install the ser-ext-ondemand extension on the Qlik Sense server.

QMC> MANAGE RESOURCES > EXTENSIONS + Import + Choose File

\Reporting\Extension\ser-ext-ondemand.zip

Install Extension

5. EDIT CONNECTOR CONFIGURATION FILE

In a typical installation, this file will not need to be changed.

In limited cases there may need to be changes to parameters such as directory paths or server identification parameters. For additional information consult the example file \Reporting\Connector\config.hjson.example.

If changes to this configuration are necessary, perform the following steps.

  1. Open the following file using Notepad or other text editor:

\Reporting\Connector\config.hjson.

  1. To update directory paths.

By default all directory paths are relative. If fixed directory paths are required they can be updated in the following parameters.

workingDir: %temp%\senseexcelreportingser

EnginePath: \Reporting\Engine\SenseExcelReporting.exe

cert: %appdata%\senseexcel\reporting\serconnector.pem

privateKey: %appdata%\senseexcel\reporting\serconnector_private.key

  1. To update Server identification parameters.

bindingHost: localhost

serverUri: https://localhost/ser

  1. Save and close config.hjson file.

  2. Restart SER Connector.

  3. Restart Qlik Sense Repository Service and all sub-processes.

6. ADD LICENSE INFORMATION

There are two steps to this process.

  1. Create a license.txt file. Choose an approach from below based on your organization's Qlik Sense licensing strategy.

  2. Create a content library on the QMC and upload the license.txt file

Token Licensing

  1. Open a new text file.

  2. Copy and paste your LEF information.

  3. Delete any spaces at end of each line.

  4. Save file with name license.txt.

Named Licensing

  1. Open a new text file.

  2. Copy and paste your LEF information.

  3. Append the LEF information with the DOMAIN\user information for each user. See the example below.

License Example.

  1. The FROM:TO info is optional. This will put a start and end date on your specified users. Use the format YYYY-MM-DD.

  2. Delete any spaces at end of each line.

  3. Save file with name license.txt.

Add License Content Library and Upload License Information

A Content Library needs to be added to the Qlik Sense server for license management services.

  1. QMC > Content Libraries > +Create New > senseexcel

Content Library

  1. Check the Advanced Property on the right side of the screen.

In the Conditions Box add the value below

!user.IsAnonymous

Content Library Advanced

  1. Hit the Apply Button

  2. Check the Contents Property under Associated Items

  3. Upload the license.txt file.

7. ADD ANALYTIC CONNECTION

This process creates a new Analytic Connection in the QMC to allow the Sense Excel Reporting processes to bind with the Qlik Sense Engine.

Define the name, Host, Port, Reconnect Timeout and Reg Timeout parameters. The name value IS CASE SENSITIVE and must be exactly SER.

QMC > MANAGE CONTENT > Analytic Connections > + Create New

Setting Value
Name SER
Host localhost
Port 50059
Reconnect Timeout 30
Request Timeout 30

Analytic Connection

8. ADD VIRTUAL PROXY

In this section you will define a new Virtual Proxy and then link it to the Main Proxy. This process is done to allow user and session information to be securely communicated between the Sense Excel Reporting Engine and the Qlik Sense Server.

This operation MUST be done in a particular order.

Add

Create the Virtual Proxy via the QMC’s Virtual Proxy menu first. To ensure that the links will work properly DO NOT utilize the Create New Virtual Proxy technique within the QMC Proxy Menu.

QMC > CONFIGURE SYSTEM > Virtual proxies > + Create new

Check the following Properties on the right side of your screen.

Identification

Authentication

Load Balancing

Advanced

IDENTIFICATION

Setting Value
Description ser
Prefix ser
Session inactivity timeout 30
Session cookie header name X-Qlik-Session-ser

Open the file %appdata%/senseexcel/reporting/serconnector.pem in a text editor.

Copy the full contents and paste them into the JWT certificate area shown below.

AUTHENTICATION

Setting Value
Anonymous access mode No anonymous user
Authentication method JWT
JWT certificate -----BEGIN CERTIFICATE-----
JWT attribute for user ID UserId
JWT attribute value for user directory UserDirectory

Virtual Proxy

LOAD BALANCING

Load Balancing nodes > Server node > +Add New Server node > Central

ADVANCED

Host white list > Add New Value > YOUR SERVER NAME

LINK PROXIES

This step is performed last to ensure that the link between the Central Proxy and the newly created ser Virtual proxy will work properly.

QMC > Proxies > Virual Proxies, Central (Default) > Associate Items > Virtual Proxies > SER > +Add > Link Existing > ser

Virtual Proxy

9. ADD SECURITY RULES

These security rules are defined to allow the Sense Excel processes to interact properly with the Qlik Sense engine. All parameters are CASE SENSITIVE.

Shared Content

QMC > MANAGE RESOURCES > Security Rules > + Create new

IDENTIFICATION

Setting Value
Name _sharedcontent
Description

BASIC

Setting Value
Resource Filter SharedContent_*
Actions Read, Update, Change Owner
User name =
Value YOUR QLIK USER NAME

ADVANCED

Setting Value
Conditions ((user.name="YOUR QLIK USER NAME"))
Context Both in hub and QMC

Validate Rule > Add Rule

Shared Content Security Rule

SER License

QMC > MANAGE RESOURCES > Security Rules > + Create new > SER License

IDENTIFICATION

Setting Value
Name SER License
Create Rule from Template Unspecified
Disabled Leave Unchecked
Description

BASIC

Setting Value
Resource Filter License_*
Actions Read

ADVANCED

Add the below value manually into the Conditions table:

Setting Value
Conditions !user.IsAnononymous()
Context Both in hub and QMC

Validate Rule > Add Rule

SER License Security Rule

SER Scheduler

QMC > MANAGE RESOURCES > Security Rules > + Create new > SER Scheduler

IDENTIFICATION

Setting Value
Disabled Leave Unchecked
Name SER Scheduler
Create Rule From Template App Access
Description

BASIC

Setting Value
Resource Filter App_*
Actions Read
User name
Value ser_scheduler
AND
user userDirectory =
value INTERNAL

ADVANCED

Setting Value
Conditions ((user.name="ser_scheduler" and user.userDirectory="INTERNAL"))

Validate Rule > Add Rule

SER Scheduler Security Rule

10. VALIDATE CONNECTOR IS RUNNING

  1. Execute the RunConnector.bat batch file from the \Reporting directory. Do not run as Administrator.

  2. If the connector is running successfully, the console window will display the following text on the last line.

The Ser.ConAai.SSEtoSER service is now running, press Control+C to exit.

Install Connector

  1. Go to services.msc and restart the Qlik Repository Database Service. This will prompt for a restart of every Qlik service.

11. SET THE SER CONNECTOR TO RUN AS A SERVICE

  1. Open a command prompt.

  2. Navigate to the \Reporting\Connector directory

  3. Execute the following command dotnet SerConAai.dll action:install as Administrator

SER Connector as a Service

  1. Open Services.msc

  2. Change the owner of the “Qlik Connector for SER” to the This User account.

  3. Use the same user account that is used to open your Qlik Sense services.

SER Service Update Credentials

  1. Restart the service.

  2. Restart the Qlik Repository Service and all sub-processes.