NPrinting On-Demand: Supported Environments & Minimum Requirements

    Supported Environments

    QlikView application using QlikView Desktop or by opening a QlikView document through AccessPoint using ON Demand Ajax Components.


    Note: this document applies to NPrinting 16.0 and higher


    Ajax application (AccessPoint using Ajax On Demand Component)

    Architecture

     

    Report requests and downloads are performed using three On Demand ajax extension object components:

    NPrinting Report, NPrinting Task and NPrinting Queue.

    Requirements

    NPrinting Server

     

    a. If there are two different machines, one dedicated to QlikView Server and the other to NPrinting Server:

        QlikView server machine:

    • QlikView Server (version 11.20 SR 3 or 4 is required with IE 10. Version 11.20 SR 5 or higher is required with IE 11)

        NPrinting Server machine:

    • A valid active NPrinting Server license with On-Demand license enabled
    • .NET framework 4.5 or higher
    • QlikView Desktop (version 11.20 SR 3 or 4 is required with IE 10. Version 11.20 SR 5 or higher is required with IE 11)

    b. If both QlikView Server and NPrinting Server are installed on the same machine, all the above requirements must be satisfied.


    Note: Qlik 12.0000 is NOT supported with NPrinting 16.x.x.x

    Web Client

    • Web browser compatible with QV11 Ajax client

     

    Installation

     

    NPrinting Server machine:

     

    QlikView server machine (if different from NPrinting Server machine):

     

    NPrinting Designer:

     

    NPrinting Report Object

     

    When the user clicks on this button, the corresponding report is queued for processing. More than one NPrinting Report button can be added to a document.

     

    NPrinting Report (Ajax On Demand Component) configuration parameters:

     

    Appearance

    • Text: the text of the button.  It can be an arbitrary QlikView expression (starting with “=”).

    • Text font: the font of the text on the button

    • Text color: the color of the text on the button

    • Button color: the color of the button

    • Flat style: the style of the button. If “System” is used, colors and flatness will be overridden by system settings

    • Border color: the color of the button border

    • Border size: the size of the button border

     

    Filter

    • Use current selections: if true, the current selections of documents will be used as a custom filter by the service.

    • Additional saved filters: a set of additional NPrinting saved filters to use as filters. They must exist in the NPrinting Project file. They must be written in row-CSV format. This property may be an arbitrary QlikView expression (starting with “=”, e.g. “=GetFieldSelections(FilterID,',')”'), in this case it will be evaluated before submission of the request to the server.

    On-Demand Server

    • *Hostname: is the DNS name of the WS endpoint. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated before submission of the request to the server.

    • Web service port: is the TCP port of the WS endpoint. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated before submission of the request to the server.

    • Use SSL: if checked, secure SSL protocol is used. If unchecked, insecure SSL protocol is used. The NPrinting WS endpoint must be configured accordingly. When SSL is enabled, hostname must be set to the same DNS and port as registered in the SSL certificate.

    Report

    • Friendly name: the name of the report as it appears in the queue. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated before submission of the request to the server.

    • *NPrinting Project path: the full path of the NPrinting Project .nsq file. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • *Report Id: the Id of the existing NPrinting report that the extension will request. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • *Connection Id: the existing NPrinting connection to use for applying the current selections. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • *Output format: the file format you want to receive. It must agree with those supported by the corresponding NPrinting report. If “UseExpression” is selected, the expression written in the “Output format expression” field is evaluated and the result is used as the report format.

    • Output format expression: an arbitrary QlikView expression (starting with “=”) which produces a valid Output Format string. It is evaluated before submission of the request to the server.

    • Compression: select “none” to download the report in native format, select “zip” to download the report in a compressed Zip archive. If “UseExpression” is selected the expression written in “Compression expression” field is evaluated and the result is used as the report format.

    • Compression expression: an arbitrary QlikView expression (starting with “=”) which produces a valid Compression format (“none” or “zip”). It is evaluated before submission of the request to the server.

     

    NPrinting Task Object

     

    When the user clicks on this button, the corresponding task is queued for processing. More than one NPrinting Task button can be added to a document.

     

    Appearance

    • Text: the text on the button. It can be an arbitrary QlikView expression (starting with “=”).

    • Text font: the font for the text on the button

    • Text color: the color of the text on the button

    • Button color: the color of the button

    • Flat style: the style of the button. If “System” is used, colors and flatness will be overridden by system settings

    • Border color: the color of the button border

    • Border size: the size of the button border

     

    Filter

    • Use current selections: if true, the current selections of documents will be used as custom filters by the service.

    • Additional saved filters: a set of additional NPrinting filters saved to be used as filters. They must exist in the NPrinting Project. They must be written in row-CSV format. This property may be an arbitrary QlikView expression (starting with “=”, e.g. “=GetFieldSelections(FilterID,',')”'), in this case, it will be evaluated before submission of the request to the server.

    On-Demand Server

    • *Hostname: is the DNS name of the WS endpoint. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • Web service port: is the TCP port of the WS endpoint. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • Use SSL: if checked, secure SSL protocol is used. If unchecked, insecure SSL protocol is used. The NPrinting WS must be configured accordingly. When SSL is enabled, hostname must be set to the same DNS and port as registered in the SSL certificate.

    Report

    • Friendly name: the name of the report as it appears in the queue. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated before submission of the request to the server.

    • *NPrinting Project path: the full path of the NPrinting Project .nsq file. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • *Task Id: the Id of the existing NPrinting task that the extension will request. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • *Connection Id: the existing NPrinting connection to use for applying current selections. It can be an arbitrary QlikView expression (starting with “=”), it is evaluated on every click.

    • *Additional recipients: a set of additional NPrinting recipients to be added to the task. They must exists in the NSQ. They must be written in row-CSV format. This property may be an arbitrary QlikView expression (starting with “=”, e.g. “=getfieldselections(FullName,',')” ), in this case, it will be evaluated before submission of the request to the server.

    NOTE: Items above prefaced with a " * " are required items to be configured.

     

    NPrinting Queue Object

     

    NPrinting queue is a ajax object that will show all requests in descending order (most recent equest at the top of the list).

    A single NPrinting queue object is needed as it shows the requests of all NPrinting report and task objects. If more than one NPrinting Queue object is used, all of them will show the same information.


    It is possible to remove individual elements or clear the entire queue by opening the queue and removing elements or by selecting the “Delete all” button.

     

    When requesting a report, the NPrinting queue will show:

    • the current number of reports and tasks being processed, if any

    • the sum of  “not yet downloaded completed reports” and “not yet viewed completed tasks”.


    On opening the queue, you will see each request and its state (processing, done, not found, failed, aborted, error).


    When a new report is available, the queue button will change color accordingly with success style settings, if errors occurs the failure style settings are applied.

     

    NPrinting Queue configuration parameters:

     

    Appearance

    • Text: the text on the button. It can be an arbitrary QlikView expression (starting with “=”).

    • Text font: the font of the text on the button

    • Text color: the color of the text on the button

    • Button color: the color of the button

    • Flat style: the style of the button. If “System” is used, colors and flatness will be overridden by system settings

    • Border color: the color of the button border

    • Border size: the size of the button border

     

    (*): you can specify colors using QlikView formulas. E.g. =White()

     

    Alerts

    • Success text color: the text color used to indicate that one or more tasks or reports have been completed successfully. If blank a default color is used.

    • Success button color: the button  color used to indicate that one or more tasks or reports have been completed successfully. If blank a default color is used.

    • Failure text color: the text color used to indicate that one or more tasks or reports have been completed with errors. If blank a default color is used.

    • Failure button color: the button color used to indicate that one or more tasks or reports have been completed with errors. If blank a default color is used.

    Minimum browser requirements to generate NPrinting On-Demand reports:


    • Internet Explorer: IE 10 or higher
    • Chrome: 40 or higher
    • Safari: 6 or higher
    • FireFox: 45 or higher


    Post installation checks

     

    NPrinting Extensions interact with the service through HTTP endpoint. HTTP endpoint must be enabled (see “How to configure On-Demand service endpoints”).

    WS endpoint is not required by NPrinting Extensions and if it is not required by other clients (i.e. Custom Objects), it should be disabled.

     

    SSL is supported by NPrinting Extensions and can be enabled in the HTTP endpoint.

    The HTTP endpoint is enabled and SSL is disabled in the default NPrinting Server installation.


    NOTE: NPrinting On Demand does NOT support reverse proxy server configurations nor software/hardware web load balancers at this time. It is currently designed to work with http or https in a non load-balanced front environment where ports 9000 and 9001 are left open for use with NPrinting On Demand Exclusively.