Installation

This section explains how to install and configure the SenseOps Writeback Extension.

Deployment Options

SenseOps Writeback supports both file-based and database-based writeback scenarios.
The installation approach varies slightly depending on the destination type.

File-Based Writeback

For file-based destinations (such as CSV, TXT, or QVD):

• Download the Writeback Extension from the SenseOps Portal using your credentials.
• Upload the extension to the Qlik Management Console (QMC).
• Once uploaded, the extension can be directly used within Qlik Sense applications for file-based writeback.

No additional Writeback server setup is required for file-based writeback.

Database-Based Writeback

For database destinations:

• In addition to uploading the Writeback extension to Qlik Sense, the Writeback server must be installed and configured.
• Database connectivity, credentials, and destination mappings are managed through the Writeback server.
• Follow the installation and server configuration steps outlined below to enable database-based writeback.

Prerequisites

Before installing the Writeback Extension, ensure that the following requirements are met. The prerequisites outlined in this section are applicable to both Qlik Sense Enterprise and Qlik Sense SaaS environments.

Windows Server

• Writeback can be installed on an existing Qlik Sense node or on a new Windows Server.
• Supported operating system: Windows Server 2022 or later.
• Local administrator rights are required for the installation.

Software & Dependencies

• Ensure the latest SenseOps Writeback Installer Package is available.
• Node.js version 18 or later must be installed on the server before deployment.

Network & Port Configuration

• The Writeback Server runs on port 4001.
• Ensure port 4001 is free and accessible.
• The Writeback service should be reachable by Writeback users outside the system.

Qlik Connectivity

The following Qlik Sense certificates are required:

• client.pem
• client_key.pem
• root.pem

Additional requirements:

• If Writeback is installed on a separate server, ensure the following ports are accessible:
  • 4243 – Qlik Proxy
  • 4747 – Qlik Engine
• Qlik Root Admin user details are required for Writeback activities.

Database Connectivity

• The Writeback database server must be accessible from the Writeback server.

Installing Writeback

1. Extract the Package: Extract the contents of the downloaded package to the designated directory: C:\QlikSenseShare\Tools. You will find the Extension and Server files within the extracted folder.

2. Install the Extension in Qlik Sense:

• Navigate to the Qlik Management Console (QMC).
• Go to the "Extensions" section.
• Upload the extension zip file (found in the extracted package) to install the Writeback extension in Qlik Sense.

3. Server Setup:

• Open server folder, check for the install.bat file.
• Now open the server folder in command prompt with admin access and run install.bat. Once you run this command, you can see the output as shown in the screenshot below.

• Once you open Windows Services, you can see SenseOps Writeback running.
• Now open localhost:4001/settings in browser and complete the below server setup.

4. Configure the Writeback Server:

• Ensure that port 4001 is available and accessible for the Writeback server to operate correctly.
• Open the Writeback server interface. You will find four main configuration sections: Qlik configuration, connection, Proxy, others.

a. Qlik Configuration: Configure the connection to your Qlik Sense environment. You can choose between Qlik Enterprise or Qlik SaaS configuration:

i. Qlik Enterprise Configuration:

• Provide the following details:
• Qlik host: Enter the hostname of your Qlik Sense server (e.g., localhost or a custom host).
• Qlik repository port: The default port is 4242.
• Qlik proxy port: The default port is 4243.
• Websocket port: The default port is 4747.
• Qlik root admin: Enter the username of the Qlik Root Admin.
• Client Cert, Client Key Cert, Root Cert: Upload the respective Qlik certificates.

ii. Qlik SaaS Configuration:

Before configuring the details, you must have the Client id and IDP subject from Qlik SaaS OAuth. To obtain these details, follow the steps below.

To generate a Client Id, follow these steps:

1. Log in to Qlik SaaS Administration.

2. Go to Administration, then click on OAuth.

3. Select Create new in the top-right corner.

4. Fill in the details below,

• Client type: Since it is a web integration - select Web, other available types "Single-page app".
• Name: Give an appropriate name for the OAuth.
• Description: Add the description for the OAuth.
• Scope: Specifically select user_default, apps, app.data:export,users scopes.
• Add redirectURLs: Add the redirecting URLs for the OAuth.
• Add allowed origins: Add the paths that are allowed to access this OAuth. For example - http://localhost:4001.
• Check Allow Machine to Machine (M2M) and Allow M2M user impersonation.

• Finally click on Create button to create web integration and get Client Id.

  

• Then click on the three dots to the left of the created OAuth, select Change consent method. Check Trusted - authentication using the OAuth client will skip the consent prompt and click Change consent method.

  

• Go to Manage users, hover over your user name, you will get the IDP Subject.

  

Provide the following details for Saas configuration:

• HTTPS port: The default port is 443.
• Qlik user mail: Enter the email address of the Qlik user.
• IDP Subject: Enter the IDP subject which you copied from above username.
• Qlik tenant host: Enter the Qlik tenant host.
• Client ID: Enter the Client ID from OAuth.
• Once you have all the above details, fill in the form shown below, test the connection and Save it.

b. Connection:

• Configure the database connection: Click on New connection and select the type of database connection you want to establish.

---

• Fill in the required details for the database connection, test the connection, and save it.

c. Proxy: The default proxy port 4001 is pre-configured.

d. Other: In the "Other" configurations, configure the mail settings by selecting the Mail dropdown.

• For SMTP configuration, you should have an app password, as mentioned in the prerequisites. To generate an app password for a Google account, follow this link: https://support.google.com/mail/answer/185833?hl=en.

• To generate an app password for a Microsoft account, go to https://mysignins.microsoft.com/security-info and log in to your Microsoft account. Then, follow this link: https://support.microsoft.com/en-us/account-billing/how-to-get-and-use-app-passwords-5896ed9b-4263-e681-128a-a6f2979a7944.

Once you have generated an app password, proceed to configure the settings.

• Fill in the mail configuration details and save them.