New Version installation

To install the Writeback Extension, follow these steps:

Note

This installation process is applicable for extension downloaded after Aug-2025

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 as below screenshot.

• Once open the Windows service and you can see "SenseOps Writeback" is running in your service.
• 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 get that follow the below steps.

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 on 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 a appropriate name of 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 path that are allowed to access thig 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 three dots at left of 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 on 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 get all the above details, fill the below shown form, 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.