August 3, 2018
The ReportWORQ server runs as a Windows service. It is a program that runs all the time in the background waiting for requests. A request specifies a ReportWORQ job to run and when a request is made, the service opens Excel and runs the job. When the job is complete a notification email is sent to one or more people. The email recipients are specified in the request file as well.
For everything to work properly a couple of things need to be configured. The first is the server’s configuration file. The configuration file is called QueBIT.ReportWORQServer.Monitor.exe.config and it is located wherever the application was installed. (C:\Program Files(x86)\QueBIT\FrameWORQ by default).
Details of the configuration are in the documentation that came with your ReportWORQ installation but there are a few settings that can use some discussion. The first is “rollingDateFileLogger”, specifically the “severity” setting. This specifies what the ReportWORQ server will log. The default setting “Info” gives basic information. In the event something happens – a report does not run, or you receive an error, say – you want to log more detailed information in order to troubleshoot. In that case, you can set the severity to “Debug”. When you have the information, make sure you set it back to Info as log files can get quite large if kept on the Debug setting.
The second setting is “TM1AddInLocation”. This is the location of Perspectives, which ReportWORQ uses to interact with TM1. Be sure to use the folder appropriate for your version of Excel – 32 or 64 bit. 32 bit uses the bin folder and 64 bit uses the bin64 folder. We sometimes get support calls because the wrong folder was specified and ReportWORQ cannot load Perspectives.
The third setting is “PollingLocation”. This is the location where ReportWORQ server expects requests to come. The request itself is a text file with an .rwjob extension. Details of the file are described in the documentation or in other articles on this site.
Now that we have gone over the configuration we can move to the service itself. This can be found in the Services applet. The way you access Services depends on your version of Windows but generally you can click on the Start button and type in “services.msc”. In the ReportWORQ Server properties, enter the “Log on as” user. This is the user that the service and Excel will run as. The user should be a normal user who can log onto the computer, open Excel and run the ReportWORQ add-in manually. This user should also have the network permissions necessary for ReportWORQ to function normally. This means having access to network shares that contain report files and where job output will be sent. Generally, organizations will create a user for this purpose. You may install the ReportWORQ server and find that jobs do not run as you expect. An easy way to start troubleshooting the issue is to log into the computer as the user that the service runs as. Open Excel and try to run the job manually. If you encounter any issues you can fix them and the service should start working as it should.
Every time you make a change to either the configuration file or to the service properties be sure to restart the service so it can pick up the change.