Find Answers
Qlik Community
Collaborate with over 60,000 Qlik technologists and members around the world to get answers to your questions, and maximize success.
Join Us
Contact
Find Answers
Join Qlik Community
Collaborate with over 60,000 Qlik technologists and members around the world to get answers to your questions, and maximize success.
Join Us
Get Support
Have a Question?
Search Qlik's Support knowledge database or request assisted support for your highly complex issues.
Submit a Case
Talk with a Representative
Critical Issues
Experiencing a serious product issue? Please Contact us by phone. Click here to view phone numbers and hours by region.
Contact UsWelcome Guest
Installed Qlik Products
My Environments
Log your environments to ensure faster and more targeted troubleshooting.
View Available Licenses
My Licenses
Understand your licenses to help you maximize your experience.
Knowledge
Understanding Qlik NPrinting APIs
Article Number: 000042381 | Last Modified: 2018/06/08Description
In this Support Techspert Thursdays session we will cover the following:
- Overview of NPrinting APIs
- Practical Scenarios
- See it work
- What to do if things go wrong
Resolution
Q&A - Understanding Qlik NPrinting APIs
Q: Right now we can only change the quality of the images for a publish task, is it possible to change the image quality on an OnDemand report using the API?
A: Based on the documentation of the November 2017 release, the image quality has to be defined on the task level from the console. Therefore you cannot change the image quality from the OnDemand API unfortunately.
Q: Can we modify the On-Demand Add on using the API?
A: If you mean the QlikView add-on for NPrinting On-demand, then unfortunately no. But the Qlik Sense extension for NPrinting On-demand, it is an open source project, so it is possible to modify its functions.
Q: How does Qlik pass the selections to NPrinting OnDemand
A: Here is a code example copied from the Qlik Sense Extension for NPrinting On-demand. You can find more context from https://github.com/bohua/nprinting-sense-on-demand/blob/master/nprinting-sense-on-demand.js.
Q: Is the Qlik sense extension is certified by Qlik ?
A: Based on the current information we have at Qlik Support, it is not added in the Extension Certification Pilot program. As the program is still undergoing, please stay tuned for the new information about the Extension Certification Pilot program
Q: Is this authentication based on user logged in? Would it allow for requests from multiple users with varying accesses irrespective of the user logged in?
A: Yes. In environment of the demo, it is based on the Windows user logged in. I haven’t tested to send in NTLM authentication from other platforms yet. But on the same demo environment, if I remove the Domain User from the NPrinting User settings, I will receive a authentication pop-up dialog from the Web Browser for my JavaScript. It means in theory it should be OK if you can manage to take care of the NTLM authentication in your code
Q: will there be regular updates to the NP APIs with each new release of QS and NP? Where will the release notes for the NP API be found?
A: Any changes in the APIs will be updated in the API reference. You may find the change of the API version there. And also at the same time, you will find more details about the API change from corresponding NPrinting release note.
You will find the release note from the same place where you download NPrinting installation packages at qlik.com.
Q: Right now we can only change the quality of the images for a publish task, is it possible to change the image quality on an OnDemand report using the API?
A: Based on the documentation of the November 2017 release, the image quality has to be defined on the task level from the console. Therefore you cannot change the image quality from the OnDemand API unfortunately.
Q: Can we modify the On-Demand Add on using the API?
A: If you mean the QlikView add-on for NPrinting On-demand, then unfortunately no. But the Qlik Sense extension for NPrinting On-demand, it is an open source project, so it is possible to modify its functions.
Q: How does Qlik pass the selections to NPrinting OnDemand
A: Here is a code example copied from the Qlik Sense Extension for NPrinting On-demand. You can find more context from https://github.com/bohua/nprinting-sense-on-demand/blob/master/nprinting-sense-on-demand.js.
var requestUrl = conn.server + 'api/v1/ondemand/requests';
var onDemandRequest = {
type: 'report',
config: {
type: 'report',
config: {
reportId: report,
outputFormat: format
outputFormat: format
},
selections: allFieldSelections,
// here's the sense connection on which we want to apply selections
connectionId: connectionId//'5c0af3f6-e65d-40d2-8f03-6025f8196ff'
selections: allFieldSelections,
// here's the sense connection on which we want to apply selections
connectionId: connectionId//'5c0af3f6-e65d-40d2-8f03-6025f8196ff'
};
return $.ajax({
return $.ajax({
url: requestUrl,
method: 'POST',
contentType: 'application/json',
data: JSON.stringify(onDemandRequest),
xhrFields: {
method: 'POST',
contentType: 'application/json',
data: JSON.stringify(onDemandRequest),
xhrFields: {
withCredentials: true
}
});
Q: Is the Qlik sense extension is certified by Qlik ?
A: Based on the current information we have at Qlik Support, it is not added in the Extension Certification Pilot program. As the program is still undergoing, please stay tuned for the new information about the Extension Certification Pilot program
Q: Is this authentication based on user logged in? Would it allow for requests from multiple users with varying accesses irrespective of the user logged in?
A: Yes. In environment of the demo, it is based on the Windows user logged in. I haven’t tested to send in NTLM authentication from other platforms yet. But on the same demo environment, if I remove the Domain User from the NPrinting User settings, I will receive a authentication pop-up dialog from the Web Browser for my JavaScript. It means in theory it should be OK if you can manage to take care of the NTLM authentication in your code
Q: will there be regular updates to the NP APIs with each new release of QS and NP? Where will the release notes for the NP API be found?
A: Any changes in the APIs will be updated in the API reference. You may find the change of the API version there. And also at the same time, you will find more details about the API change from corresponding NPrinting release note.
You will find the release note from the same place where you download NPrinting installation packages at qlik.com.
Get Answers
Find Answers
Get Support
Have a Question?
Search Qlik's Support Knowledge database or request assisted support for highly complex issues.
Submit a case
Talk with a Representative
Critical Issues
Experiencing a serious issue, please contact us by phone. View phone numbers and hours by region.