Installation
  • 22 Jun 2022
  • 4 Minutes to read
  • Dark
    Light

Installation

  • Dark
    Light

Overview

ReportWORQ is installed using a simple Windows MSI Installer. The MSI installer contains both the ReportWORQ Client and Server components.  The ReportWORQ Server is installed as a Windows service and is set to a Manual stopped mode by default.  After installing the software, a connection is made to an Local or Cloud IBM Planning Analytics server, a Workday Adaptive Cloud instance, or other datasources as needed. ReportWORQ reads from and writes data to datasources via each vendor's respective REST API. The software is run as a rich client windows GUI application. The optional ReportWORQ Server runs as a Windows Service and is designed to execute ReportWORQ Jobs without any user interaction.

ReportWORQ can be downloaded from https://docs.reportworq.com/v4/docs/quickstart.  

Prerequisites

Licensing

A separate license key for the ReportWORQ Client and Server will be required to complete the installation. Additional information on licensing & registration can be found in the License Requirements topic.

Hardware Requirements

  • 4 core 2 gigahertz (GHz) or faster x86 or x64-bit processors
  • 16 gigabytes (GB) of installed RAM
    • More memory may be needed if you plan to work with large Excel reports
  • 1GB of disk space is typically more than sufficient unless you intend to store a large number of generated ReportWORQ job outputs (e.g., PDF and Excel files) on your local machine.
  • 1024x768 or higher screen resolution is strongly recommended

Software Requirements

  • Installation Permissions: Since ReportWORQ installs the product for all users on a machine, you need to have local administrative permissions to perform the installation on your computer.  Administrative permissions are also required if the .NET Framework needs to be installed.
  • Microsoft Windows 7, 8, 10, Server 2008 R2, 2012, 2012 R2 or 2016
    • 64 bit is recommended, 32 bit is supported
    • Note we strongly recommend applying all critical Microsoft updates and installing any available service packs before installing ReportWORQ.
  • Microsoft .NET 4.7.2
    • The installation package will attempt to download and install the 32-bit and 64-bit .NET Framework 4.7.2 if it is not already installed.  However, if your computer will not have access to the Internet during installation then you will need to install .NET Framework 4.7.2 before installing ReportWORQ.  Note that installing .NET Framework 4.7.2 will require a reboot.
  • Optional Software
    • Microsoft Excel
    • Adobe or other PDF Reader
    • Chrome Browser

Additional Prerequisites

ReportWORQ is designed to be configured with one or more connections to systems for refreshing data in Excel files.  Depending on your intended use of additional prerequisites and configuration may be required.  The following datasources and distribution integrations may require additional configuration:

Installation Steps

Installing ReportWORQ

  • Download the software installation package from https://docs.reportworq.com/v4/docs/quickstart.
  • Execute the Windows MSI installer and follow the steps in the installation wizard.
  • Launch ReportWORQ from the Windows Start menu or, if applicable, from the ReportWORQ ribbon in Microsoft Excel.
  • ReportWORQ will install the .NET Framework 4.7.2 if needed.  
    • Note: A restart will be required if the .NET Framework needs to be installed.
  • If the ReportWORQ Server is being used then start the ReportWORQ Windows Service.  Additionally, change the startup mode to automatic and provide a service account if needed.

Uninstalling ReportWORQ

To Uninstall the ReportWORQ software open Programs and Features in the Microsoft Windows Control Panel, locate ReportWORQ and choose uninstall. If you intend to reinstall ReportWORQ then do not delete the files remaining in the installation directory. Otherwise, it is safe delete any remaining files located in the installation directory.  

Upgrading ReportWORQ

Upgrading ReportWORQ is a simple process. ReportWORQ will retain all of the settings and license information so long as the new installation occurs in the same directory where  ReportWORQ was previously installed.  The ReportWORQ Windows Service is installed in a manual startup mode under the Local System Account.  Prior to uninstalling, review what account the ReportWORQ service is running under and then reapply this account and set the startup mode to Automatic if preferred.

  1. Review the ReportWORQ Windows Service and record what account the service is running under, and if the service is set to start up in Automatic or Manual mode.
  2. Uninstall ReportWORQ from Programs And Features in the Control Panel.
  3. Install the new version of ReportWORQ to the same directory.
  4. Open or refresh Windows Services and update the ReportWORQ Service's logon account and startup mode if necessary.
  5. Launch ReportWORQ.

Unattended Installations

It is possible to install or remove ReportWORQ using the command-line for the purposes of unattended or scripted installations. ReportWORQ will, by default, install to the following folder:

%PROGRAMFILES(x86)%\QueBIT\FrameWORQ\ReportWORQ\

If this default location is where you'd like to install the software, you can use this command from the folder containing the ReportWORQ_Installer executable file you are installing:

ReportWORQ_Installer_4.4.0.124.exe /s /v"/qn"

In all of the examples here, the ReportWORQ installation package file name that was downloaded was "ReportWORQ_Installer_4.4.0.124.exe". The "/s" flag here indicates that we want the install to be silent (no window appearing on screen) and the "/v" flag indicates that we have additional commands that we would like to specify for the Microsoft Installer (msi) file contained in the ReportWORQ installation package. Note that including the “.exe” in the name of the ReportWORQ executable file is required for this command to work.

To see the full list of commands supported by the downloaded ReportWORQ_Installer executable you can run this command from the command line:

ReportWORQ_Installer_4.4.0.124.exe /?

 To see the full list of MSI commands that can be referenced following the "/v" flag you can run this command:

msiexec /?

Other Sample Installation Commands

Install to a different folder:

ReportWORQ_Installer_4.4.0.124.exe /s /v"/qn INSTALLDIR=\"D:\Software\ReportWORQ\""

Install to a different folder and write the install log to a specific folder:

reportworq_installer_4.4.0.124.exe /s /v"/qn /l*v \"c:\temp\rw_install.log\" INSTALLDIR=\"D:\Software\ReportWORQ\""

Uninstalling ReportWORQ

The command to uninstall ReportWORQ in silent mode, with no restart, is the following:

msiexec /x {F6C98984-DFF4-4C24-BE12-8AA64B443E60} /qn /norestart

The code in brackets is the unique product code for ReportWORQ.

IMPORTANT: Be sure that Microsoft Excel is not running when running this command in silent mode, otherwise the uninstall may fail.


Was this article helpful?