November 7, 2018
Getting Started with ReportWORQ
This article is designed for anyone new to ReportWORQ, whether you’ve just purchased the product or beginning the 30-day trial. This article will cover everything you need to know to get to running your first ReportWORQ job.
After logging in you will see the installation and documentation downloads for ReportWORQ Client and Server. The ReportWORQ server is not required and it is recommended that new installations begin with the ReportWORQ Client then introduce the ReportWORQ Server after some Jobs have been created.
ReportWORQ Client and Server require separate license keys which need to be activated after installing. If you do not have a license key, simply fill out the form on the download site to obtain a copy of your license key.
Installing and Activating ReportWORQ Client
Both ReportWORQ Client and Server are installed through standard Windows MSI and EXE installers. Before installing you must manually uninstall any previous versions. After the installation simply launch Microsoft Excel and the ReportWORQ Ribbon will appear.
Connect to a TM1 instance through Perspectives or PAX as a TM1 Admin. TM1 Admin access is required on first launch to create the ReportWORQ control cubes and security objects. After connecting you will need to enter and activate a license key to access ReportWORQ functionality. Navigate to the license screen and enter your license key, name, email and company name then choose Activate. ReportWORQ will attempt to activate the license key automatically with the license server, however if there is no internet connection you’ll need to use the Activate Manually option. Make sure that all fields are filled out then choose Activate Manually and follow the steps on the screen.
Congratulations you are now ready to create your first ReportWORQ Job.
Installing ReportWORQ Server
The ReportWORQ server requires additional manual steps for configuration. The ReportWORQ Server is only required for remote execution of jobs and it is recommended that this installation is only performed when this functionality is needed.
If you already had the ReportWORQ Server installed it would be a good idea to save off a copy of the configuration file as the uninstall will delete this file. The ReportWORQ server config file can be replaced after installing the new version. If this is a new installation, then navigate to the server configuration file which is located in the installation directory. Open this file in a text editor and fill out all required fields. The following represents the minimum changes required in order to start the ReportWORQ Service.
Default configuration file path:
Set the TM1AddInLocation to the location of your tm1p.xla. Be sure to use the bin64 directory if installing into a 64-bit Excel
<add key=”TM1AddInLocation” value=”C:\Program Files\ibm\cognos\tm1_64\bin\tm1p.xla” />
Set the PollingLocation to a local folder that will be monitored for ReportWORQ trigger files. Make sure this directory exists.
<add key=”PollingLocation” value=”C:\ReportWORQ Requests\” />
Set the following settings to log onto the server where the ReportWORQ Control Cubes are stored. Note that the User and Password fields are encrypted using the encryption tool located at:
C:\Program Files\QueBIT\FrameWORQ\ReportWORQ\Encryption Tools\PasswordEncryptor.exe
<add key=”TM1SecurityMode” value=”1″ />
<add key=”CAMNamespace” value=”CognosExpress” />
<add key=”TM1Server” value=”Planning Sample” />
<add key=”TM1User” value=”xxxxx==” />
<add key=”TM1Password” value=”xxxxxxx=” />
Set the following settings to log onto the smtp server which is required to send job execution notifications. Note that the User and Password fields are encrypted using the encryption tool described above.
<add key=”SMTPServer” value=”smtp.server.com” />
<add key=”SMTPPort” value=”587″ />
<add key=”SMTPUseSSL” value=”true” />
<add key=”SMTPUser” value=”xxxx=” />
<add key=”SMTPPassword” value=”xxxx=” />
<add key=”SMTPNotifySubject” value=”Results of ReportWORQ Server Request” />
<add key=”SMTPNotifyFrom” value=”email@example.com” />
Once this is complete save a copy of the file outside of the installation directory for future installations.
The next step is to enter the ReportWORQ Server License key, which can be done by running the Install License.bat file in the installation directory:
Default license application file path:
C:\Program Files\QueBIT\FrameWORQ\ReportWORQ\Install License.bat
Finally, it is time to start the ReportWORQ server in Windows Services. If everything is in order you can drop a job trigger file into the PollingLocation path that was specified in the config file and then the ReportWORQ Server will execute the job. If there is an error, it will be written to the log file in the server logs directory.