Skip to main content

Qlik Sense Documents

Qlik Sense documentation and resources.

Email Alert for Qlik Sense task failed (Very easy)

cancel
Showing results for 
Search instead for 
Did you mean: 
Anil_Babu_Samineni

Email Alert for Qlik Sense task failed (Very easy)

Hi Team,

This document can help about configuration for Task failure notification in Qlik Sense

Connector installation and configuration

This part only needs to be done once on all Qlik Sense nodes per environment.

Prerequisites: Anonymous authentication to the <Company> SMTP relay has been opened. 

1. Download the Qlik Web Connectors March 2020 Patch 1 (currently installed) from the Qlik download site.
Go to www.qlik.com to log on with a registered customer or partner account, select Services > Customer Downloads, and then select the Qlik Connectors tab.

2. Before you unzip the file, check that the folder is not blocked by Windows security. To unblock the zip file, right click on the file, select Properties, then click on Unblock in the General tab. Click Apply.

3. Unzip QlikWebConnectorsX.X.zip (where X. X - is the version name) and place the unzipped files in a folder on the root directory of one of the nodes Windows server D:QlikWebConnector

4. Start up the Web connectors server in manual mode to configure it: open 😧 QlikWebConnectors\QlikWebConnectors.exe
If successful the following window will open.

Qlik Web connector.png

5. Proceed to http://localhost:5555/web to configure the SMTP connector. Qlik SMTP connector is available on Connectors / Standard page. Click on the connector name to go to the connector Parameters page.


Fill in the details:


SMTP Server: Talk to windows team 
Port: 25
SSL Mode: None
To: [Your Email Address to test]
Subject: Qlik Sense Failure Notification
Message: Qlik Sense Says Hi !!
HTML ON
From Email: Your From Address 


Send a test email by clicking on Save Inputs & Run Table. You can see the result in Data Preview section and must receive the test email


6. Close the Web Connectors Page and the Qlik Web Connectors window to stop the connectors server.


7. Edit "Install Service. bat" file in D:QlikWebConnectors, Batch Files to configure the connectors as a service, so they auto start up with the Windows as follows:

REM *****************************
REM IMPORTANT - PLEASE READ:
REM * You should ensure than you have 'unblocked' the Qlik Web Connectors download zip file BEFORE unzipping it and running this.
REM * You need to change the following paths to match your .NET installation directory and QlikWebConnectorsSVC.exe location.
REM * You should run this file as Administrator (right click, 'Run as administrator').
REM *****************************
"%windir%\Microsoft.NET\Framework\v4.0.30319\installutil" "D:\QlikWebConnectors\QlikWebConnectorsSVC.exe"

pause


8. Save the batch file… Right click the Install Service bat file and select Run as administrator.

      a. The batch file installs the Qlik Web Connectors as a Windows Service.

Command Prompt.png

when the batch file finishes, press any key to close the command window

you should see an entry for Qlik Web connectors like

Services Status.PNG

9. From the Windows start menu, type Services to open the Services dialog.
      a Right click on the Qlik Web Connectors service entry
      b. In the Qlik Web Connectors Properties dialog, click on the Start under the General tab to start the service.
          Ensure that the Service status is Running.
          Warning: Close the Click Web Connectors before you complete this step. If they are running when you press start, you will get a message saying that the service has started and then stopped.
      c. Select the Recovery tab and set First failure to Restart the Service and set the time for Restart service after to zero (0) minutes. 

Apply the changes and click OK.


10. The Qlik Web Connectors should be available at http: //localhost:5555/
11. Install and configure the connectors on all other Qlik Sense nodes. The easiest way to do it:
      a. Stop the service and copy the folder D:QlikWebConnectors, to all other Qlik Sense nodes
      b. Register the service on each of the nodes (steps 8-10).
      c. Start the service which has been stopped at step (a).


12. Create new connection in every Qlik Sense environment not the nodes.
      i. Data load editor - Create new connection - REST
      ii. URL: Can be found from 5th point
     iii. Authentication Schema: Anonymous.
     iv. Skip server certificate validation: ON
     v. Query parameters:
          1. to: your emal for test
          2. subject: test
          3. message: test
     vi. Name: SendEmail
     vii. By default the connection name created via the Data load edit will be something like "SendEmail (<usemame>)". Remove the user name from the connection name via QMC.

Till above the connection setup is done.

How to setup the email alert for existing dashboard and newly creating dashboard?

1) Let's say, I have an Qlik Sense application called QSAppName.qvf {QSAppName is Dashboard Name} and this dashboard created task either daily/weekly/monthly etc.

2) To create alert, Again one application required

      a) Let's say, I've created an application called QSAppName_Failure_Notification.qvf 

      b) Go to Script / data load editor, And add the following script

LIB CONNECT TO 'SendEmail';// You can add multiple email's as well in the recipient with delimiter of semicolon (;)
Let vTo = 'to Address here';
Let vCc = 'CC Address here';
Let vSubject = 'QlikSense Dashboard Failure Notification';
Let vMessage = 'Your message'; // You can write in HTML also, If you likeEmailStatus:
SQL SELECT
"status",
"result",
"filesattached"
FROM CSV (header on, delimiter ",", quote """") "CSV_source"
WITH CONNECTION(
QUERY "to" "$(vTo)",
QUERY "cc" "$(vCc)",
QUERY "subject" "$(vSubject)",
QUERY "message" "$(vMessage)");

3) Create task for "QSAppName_Failure_Notification.qvf" on dependency of failure to "QSAppName.qvf"

Bingo, You achieved very powerful feature enjoy with your email's. I love to hear some question's, If any using Comment box 

 

Regards,

Anil Samineni

Labels (2)
Comments
AdamBSnotused
Partner - Contributor III
Partner - Contributor III

Thanks... adding to the above, I have a video on the same which can be found here

https://pomerolinsight.co.za/multi-media/ 

0 Likes
rockabs
Contributor III
Contributor III

@Anil_Babu_Samineni  This is cool stuff and really good !

0 Likes
karivenkatesh143
Contributor
Contributor

@Anil_Babu_Samineni What is the best practice when we have multi node setup with 12 nodes? Can we also do some web technologies to show more good in email?

0 Likes
Anil_Babu_Samineni

Hello, please refer 11th point where you find the same !

0 Likes
kdaniels-obrien
Partner - Creator
Partner - Creator

Great solution!! Does the STMP web connector require any additional licensing? 

0 Likes
Anil_Babu_Samineni

@kdaniels-obrien If you have already Qlik Enterprise, You no need to buy anything. Comes to SMTP, Which is your gateway from your client domain.

0 Likes
tandrisani
Contributor II
Contributor II

This is fantastic. Thank you so much!

0 Likes
rathorep
Contributor III
Contributor III

Hello, can we get attached log file in email when the task fails?

0 Likes
VaidhyaGanesan
Contributor II
Contributor II

@Anil_Babu_Samineni  - Thanks for spending time to write this. As per my understanding this solution work for 1 app. if i want to do the same for multiple apps/dashboard instead of recreating multiple alert apps, is there any solution to use single alert app for multiple dashboards

0 Likes
kdaniels-obrien
Partner - Creator
Partner - Creator

@VaidhyaGanesan Yes, you could just create a new trigger for each app you wish to be alerted about!

0 Likes
Version history
Last update:
‎2020-07-01 11:03 AM
Updated by: