NPrinting can be run as a Windows service to execute scheduled jobs, External XML Requests, and On-Demand reports. The NPrinting service does not require any user to be logged on to the machine to run because it does not run on a user session. The service may also start up without any manual intervention every time the machine is re-started if the "Start Type" is set to "Automatic" because it is a Windows service.
QlikView NPrinting Service can be configured to use:
- NPrinting NSQ files which contain the tasks and scheduled jobs you want to execute
- Folders that contains NSQ files. All NPrinting projects saved in the configured folders will be executed
- It is no longer necessary to insert On-Demand NSQ files or to have at least one NPrinting project (.nsq file) in the list. The list can be left empty.
Before you start you need a Windows account that must:
- Be dedicated and not shared with any other Windows Server Service. For example, do not use the QlikView service account to run the NPrinting service
- Have the "Logon as a Service" privilege. This will be automatically assigned during the NPrinting installation. Ensure that the corresponding bullet in the NPrinting Management Console is green. If the user does not have the "Logon as a service" privilege, the NPrinting Service Config Window will give the privilege. If the privilege is revoked later, the NPrinting Service will not be able to start.
- Be a Local Machine Administrator
If you are configuring multiple QlikView NPrinting Servers you must create a Windows account for each one.
QlikView NPrinting Server needs a fully licensed version of QlikView Local Client (Desktop). You can activate QlikView Local Client by inserting a license code and control number or by manually assigning a Named User CAL from a QlikView Server. Dynamically leased licenses and Personal Edition are not supported. To activate, or check, the QlikView Local Client license, find the QlikView executable file (tipically in C:\Program Files\QlikView\Qv.exe), right click while pressing SHIFT and CTRL and select "Run as Different User". Insert the credentials of the Windows user dedicated to the NPrinting Service and check that QlikView Local Client is activated. This is one of the most frequent causes of issues with the Service.
You can assign a source folder to NPrinting Service for External XML Request reporting. NPrinting Service regularly checks for new XML files with the .request extension in the defined source folder, parses any new ones it finds, executes the contained instructions, and changes the .request extension to .processed. It then writes information into a new file about what Task(s) or Job(s) were run and their outcomes. Finally it names this new file the same as the original but with a .result extension. You can find detailed information on the syntax of these XML files and how the process works in this tutorial: How to Execute NPrinting Reports by External XML Request.
- You must be logged in as an administrator to configure the NPrinting Service
- The service will no start if the chosen .nsq file is no longer valid. For instance, when the .nsq is saved with a client with a different version than that of the server.
When you install QlikView NPrinting Server the GUI is also installed for configuring automated report generation and distribution. Launch QlikView NPrinting Server GUI by clicking on its desktop or taskbar icon or searching for NPrintingSvcConfig.exe and double clicking on it.
Permit NPrinting Service Config to Make Changes
The first thing that happens when you start QlikView NPrinting Server GUI is that the User Account Control window pops up. Click on the Yes button to proceed.
Stop the NPrinting Service
The Service page is selected by default. You will need to stop the service, if it is running, in order to be able to configure it. Skip this step if the service is stopped or if you are configuring it for the first time.
Adding NPrinting Project Files
- Click on the Add File button
All paths to NPrinting files located on computers different from the one running NPrinting Service must be in the UNC (Uniform Naming Convention) format. For instance \\Server\NPrinting\Templates is good, but Z:\NPrinting\Templates will not work. That is because Windows does not support mapped drivers in Session 0.
Select NPrinting Project Files
- Browse to C:\NPrintingTraining\NPrintingFiles\ and select NPrintingTraining.nsq
- Click on the Open button
Adding an NPrinting Project Folder
It is also possible to add an entire folder. All NPrinting projects (.nsq files) contained in the folder will be scheduled. You can specify an empty folder and add .nsq files to that folder as and when they are ready. The Jobs in all the nsq files in that folder will be automatically executed as scheduled. This could be useful in case you do not want developers to access the server configuration.
- The Service page is pre-selected
- Click on the Add Folder button
Adding an NPrinting project (.nsq file) is not mandatory. The Service will start even if the list is empty. This is useful if you plan to use NPrinting On-Demand. When the NPrinting Service receives an On-Demand request, it automatically retrieves the required .nsq. For instance, when the .nsq is saved with a Client of a different version from that of the Server.
It is not necessary to add an .nsq file and it's containing folder although everything will work fine and the schedules will be executed correctly if you do.
Select NPrinting Project Folder
- Find the folder you wish to add
- Confirm by pressing Select Folder button
Enable External Requests
- If you want to use the service for External Request reporting, put a checkmark in the Enable external requests box
- Click the browse button to specify the folder NPrinting needs to check for external XML request files.
If you start the service but a specified .nsq is no longer available, you will get an error message in the log and the service will continue to work. This means that you can continue to use External Requests and On-Demand without a .nsq file specified in the Management Console.
Select Source Folder
- Browse to C:\NPrintingTraining\ and select the ExternalRequestsXML folder. Use Make New Folder if necessary
- Click on the Select Folder button
Enter Log-on Account Info
- Enter the Windows User ID of a computer administrator in the New Account field. It is best to create a user reserved for NPrinting Service. The user must have "Login as a service" privileges
- Enter the corresponding Password
- Click on the Test button to validate the User Account and Password
Conclude Configuration and Install
1. Select how you want NPrinting Service to start:
- Automatic: starts every time the computer is re-started
- Manual: you will need to open the NPrinting Management Console to start the service. Use the NPrinting Management Console so you can check that all parameters are correctly configured.
- Disabled: you will need to enable it again in order to run the service
2. The second and the third Service configuration status indicators must be green before clicking on the Install button to install the service. The first status indicator can be green or a yellow triangle in case you didn't add any NPrinting project.
Note: You will have to click on the Stop button to change these settings and manually restart the service when you have finished by clicking on the Start button.
Start Up Service so It Will Execute Your Schedules
- Click on Start to start the service. It will now automatically run scheduled jobs
- Click on OK to save your NPrinting Service settings
- Select Log settings from the panel
- Type or select the log files path and name.
- Path is the folder where Service logs will be saved. Select an easy-to-find folder.
- Service log file name is the name of the Service log file. The default file name follows the scheme YearMonthDay_NPrintingSvc.log (e.g. 20140821_NPrintingSvc.log). NPrinting Server will create a new log file each day. You need to delete these files manually when they are no longer required. There is no feature to delete old log files automatically. We suggest you insert something in the name that lets you to easily distinguish Server log files from Designer log files. Please send us a copy of these logs when seeking assistance.
When starting, the service adds two different log messages to the log file; one for starting the On-Demand thread and the other for the External Request thread.