Skip to content

Getting Started

Prerequisites for SenseOps UI Builder

SenseOps UI Builder can be installed like any other mashup in Qlik Sense via QMC (Qlik Management Console). Before installation, ensure you have the following:

  • Windows user with local Administrator access (where Qlik Sense Server is installed).

  • Qlik Sense User Credentials with RootAdmin access.

  • Postgres DB (No installation needed, since QS repository database itself can be utilized).

  • SenseOps UI Builder will run on port 4000, and the same should be available.

UI-Builder Extension Installation

  1. Log in to the https://account.senseops.com/login portal and download the SenseOpsUIBuilder_(Version_month) package. It will be downloaded in a zip format. The following files will be available upon unzipping:

  2. SenseOpsUIBuilderMashup_(version).zip - SenseOps UIBuilder extension file

  3. SenseOpsUIBuilderServerApi.zip - SenseOps UIBuilder server file

  4. Create a UIBuilder folder and move the extracted folder to it. Refer to the below path:

  5. Go to \\SenseOps\UIBuilder\ (create the folder if it does not exist) and paste all the copied zip folders here.

Screenshot

Enterprise Installation

Step 1: Log in to the Qlik Management Console (QMC) and navigate to Extensions.

Step 2: Import the SenseOpsUIBuilderMashup_(version).zip file from the path \\SenseOps\UIBuilder\.

Screenshot

The user will now see the UIBuilder extension in the Qlik hub under SenseOps extensions.

UI-Builder Server Installation

  1. Unzip the SenseOpsUIBuilderServer_Dec2024 folder. Open the folder in the command prompt with administrator privileges. Run the command node ui-builder.js. The user will receive a local server [default server: http://localhost:4000]. Open that server in a browser.

Screenshot

Qlik Enterprise Configuration

Step 1: Open the Qlik Enterprise dev-hub, where the UI Builder extension will appear in Mashups.

Screenshot

Step 2: Click on UI Builder Extension. The user can now see the mashup Editor. Click on View as shown in the image below.

Screenshot

Step 3: The user can now see the page in the browser. Click on "Click Here" to continue.

Image title

Step 4 - Qlik Config: The Qlik configuration page appears. Select the Client Service type as "Mashup" and click "Save" for the next step.

Image title

Step 5: The user receives a popup message indicating that the Qlik configuration was successful. Restart the SenseOpsUIBuilder services with admin rights, and the next step page appears.

Image title

Step 6 - Database Config: The user will be redirected to fill out the database form. Click the "Click here" button to continue.

Image title

The user can use an existing Postgres database with Qlik Repository to construct a database or use a different Postgres instance available.

  • Database Host Name: localhost or custom hostname.
  • Database Port No: 4432 or custom port.
  • Database Username: Your PostgreSQL username.
  • Database Password: Qlik Sense repository password or PostgreSQL password.

Screenshot

  • Click Save to create the SenseOps UI Builder repository in PostgreSQL. You can also create a custom database name by selecting Custom Database.

Step 7: Restart the SenseOpsUIBuilder services with admin rights.

Screenshot

Installation is successful. Now the user is all set to build their solution through Qlik Enterprise.

Qlik SaaS Configuration

Step 1: After completing the Server Installation, open http://localhost:4000. The following page will appear. Click on "Click here".

Screenshot

Step 2 - Qlik Config: The Qlik configuration page will appear. Set the Client Service type to "WebApp" and enter the following details:

  • Click on "SaaS Environment".
  • Host Name: localhost or custom hostname.
  • Port: 443.
  • Qlik Web Integration Token: Input the token. To learn how to generate the token, refer to the Qlik Web Integration Token Generation section.

Screenshot

  • After entering the details, click Save.

  • You will receive a popup confirming that the changes have been applied successfully. Restart the SenseOpsUIBuilder services with admin rights.

Screenshot

Step 3 - Database config: Follow Step 6 from the Enterprise configuration for this.

Step 4: Having created a database, restart the SenseOpsUIBuilder services with admin rights.

Screenshot

Installation is successful. Now the user is all set to build their solution through Qlik SaaS.

Qlik Web Integration Token Generation

Step 1: Access Qlik SaaS Administration

  • Log in to Qlik SaaS with Administrator credentials.
  • Click on Administration from the right sidebar.
  • Select Web and then click on Create new.

Screenshot

Step 2: Create a Web Integration Token

  • Provide a name for the integration and add the origin, then click Create.

Screenshot

  • After creating the token, copy the generated ID and paste it into the Qlik Web Integration Token field in the Qlik SaaS configuration.