topic Re: Nprinting API response error message in Qlik NPrinting

Nprinting API response error message

mbrouwer — Tue, 07 Sep 2021 11:50:54 GMT

Is there an option to get more information from the API after an on demand report has failed?
Would like to see a functional or technical error message. i.e. No data found for filter combination. Or some other message other than just status = "failed"

We are using:
POST https://help.qlik.com/en-US/nprinting/May2021/APIs/NP+API/index.html?page=40
GET https://help.qlik.com/en-US/nprinting/May2021/APIs/NP+API/index.html?page=42

Re: Nprinting API response error message

Lech_Miszkiewicz — Tue, 07 Sep 2021 13:19:35 GMT

I am not sure if i understand..

since you are using ondemand request data combination should be determined by user selections and results hence you dont need such response from nprinting as you can get one directly from qlik sense either through visualisation or api

Re: Nprinting API response error message

Ruggero_Piccoli — Tue, 07 Sep 2021 14:28:25 GMT

Hi,

You can use Audit Trail APIs. For example export the audit table as a JSON CSV file https://help.qlik.com/en-US/nprinting/May2021/APIs/NP+API/index.html?page=11, parse it and retrieve the error messages.

Best Regards,

Ruggero

Re: Nprinting API response error message

mbrouwer — Fri, 07 Jan 2022 15:49:20 GMT

Hi Ruggero,
I have looked at the results of the audit trail. Both event and logs are not logging tomething about the error if a On-Demand-Request has failed.

This is the only thing i get from a event request

{

"id": "7f27b495-c9b3-4cdd-bf83-ee5184eeee36",

"userId": null,

"userName": null,

"ipAddress": null,

"source": null,

"target": "OnDemandRequest",

"targetId": "24ac0319-2e42-4ec5-883e-19a2366c4b28",

"targetName": "Vslg Goederenbeweging per artikel (per uitgever)",

"appId": "552589af-e68b-43d3-9b2b-bfceceec4768",

"eventTime": "2022-01-07T14:17:31.726879Z",

"action": "Failed",

"description": "On-demand request '24ac0319-2e42-4ec5-883e-19a2366c4b28' failed for report 'Vslg Goederenbeweging per artikel (per uitgever)'",

"data": {

"format": "XLSX",

"reportId": "813e00fc-b8e2-4b19-b00d-579cddcfbc3e",

"reportTitle": "Vslg Goederenbeweging per artikel (per uitgever)",

"requestSourceType": "OnDemand"

"dataType": "OnDemandRequest"

And this is the only information within the log request

2022-01-07T14:17:31.726726879Z OnDemandRequest.Failed OnDemandRequest 24ac0319-2e42-4ec5-883e-19a2366c4b28 Vslg Goederenbeweging per artikel (per uitgever) Failed 552589af-e68b-43d3-9b2b-bfceceec4768 On-demand request '24ac0319-2e42-4ec5-883e-19a2366c4b28' failed for report 'Vslg Goederenbeweging per artikel (per uitgever)' {"format": "XLSX", "reportId": "813e00fc-b8e2-4b19-b00d-579cddcfbc3e", "reportTitle": "Vslg Goederenbeweging per artikel (per uitgever)", "requestSourceType": "OnDemand"} OnDemandRequest

There should be a way to detmine what went wrong !?

I hope you can help me.

Regards
Marcel

Re: Nprinting API response error message

Frank_S — Fri, 07 Jan 2022 15:57:11 GMT

@mbrouwer

The error/failure is 'after' sending the API call.
In this case you would want to investigate what the issue with the On Demand report is.

The fact that the report failed based on your API call indicates a possible issue with perhaps the report design, possible locked fields (always one selected or other unsupported QS item) or other filter problem.

Try executing the report directly via the QS hub with the same parameters used in your API call.

Here is one article that might help...

https://community.qlik.com/t5/Knowledge/How-to-manage-Qlik-Sense-NPrinting-On-Demand-quot-Request-Failed/ta-p/1717625

Re: Nprinting API response error message

Lech_Miszkiewicz — Fri, 07 Jan 2022 22:44:53 GMT

I agree with Frank,

This error usually indicates issues with report itself and "Always one selected value" is usually a reason. We keep forgetting about fields which are hidden and set to always one selected values: like toggles, selectors etc...

Re: Nprinting API response error message

mbrouwer — Tue, 11 Jan 2022 11:41:56 GMT

Thanks Frank and Lech.
Indeed the error is after the on demand request api call. The most common reason why there is a failure of the report is because the user gave a selection (period of time) where there are no facts.
In that case I want to give the user a functional message i.e. "The selection does not provides any data" or give the user an empty report. But now the user is calling telling that his report failed.

regards,
Marcel

Re: Nprinting API response error message

Frank_S — Tue, 11 Jan 2022 19:37:14 GMT

Hi @mbrouwer

If it is a 'request failed' message then check the article I sent.

Here it is again for your convenience.

https://community.qlik.com/t5/Knowledge/How-to-manage-Qlik-Sense-NPrinting-On-Demand-quot-Request-Failed/ta-p/1717625

If there is a different error, then that might require a remote session.

Request failed could also be due to unsupported items as well so you should also check your QVF.

@Ruggero_Piccoli I don't believe custom messages are possible that @mbrouwer is suggesting correct? Do you have any thoughts about his question? Thx in advance.

Re: Nprinting API response error message

Ruggero_Piccoli — Wed, 12 Jan 2022 07:39:07 GMT

Hi @Frank_S ,

I think this could be something like a new feature request, an improvement, to be proposed in https://community.qlik.com/t5/Labels-page/bd-p/Category_Labels?categoryId=qlik-ideas&corenode=boards&labelText=Qlik%20NPrinting&nodetype=boards. It is not possible for a user to customize the error messages and I don't know if this specific error can be captured when it happens in order to display a more specific message. This need to be evaluated by the developers team.

Best Regards,

Ruggero

Re: Nprinting API response error message

mbrouwer — Wed, 12 Jan 2022 07:58:28 GMT

That should be very nice. Is will save us a lot of questions from customers and time of our development team to investigate if there is a technical problem or are there simply no facts for the report with the combination of filters given.
Regards,
Marcel

Re: Nprinting API response error message

mbrouwer — Thu, 13 Jan 2022 08:07:46 GMT

Hi Ruggero, do I have to take action by posting this as a feature request ? Or is it something you can/will do?
Thanks

Re: Nprinting API response error message

Frank_S — Thu, 13 Jan 2022 18:06:34 GMT

@mbrouwer

This is something you may action directly by placing an 'idea' in the link Ruggero provided.

For your convenience, here again is the link

Ideas | Qlik Community

Kind regards...

Re: Nprinting API response error message

mbrouwer — Fri, 14 Jan 2022 15:36:00 GMT

Sorry,
I'm logged in with my account, but I don't see a 'suggest an idea' button.

(Submitting an Idea - Qlik Community - 1684014)

It's working now . On the detail page after a search it wasn't visable

Re: Nprinting API response error message

Frank_S — Fri, 14 Jan 2022 16:54:53 GMT

Hi @mbrouwer

The 'suggest an idea' button should be visible here:

If you are not seeing this button and you are logged in, please us the chat bot found on the bottom right corner of https://qlik.com or start a customer support request to investigate any permissions issues you might be experiencing with our web pages.

Kind regards...