Welcome Packet & Resources

Knowledge Base
1

Welcome to ReportWORQ

If you are new to ReportWORQ here’s some information to help get you started.

Useful Links:

What does IT need to know?
ReportWORQ is a Microsoft Windows Server based application which is accessed by users via a Chromium based browser. Installation prerequisites can be found in the documentation here: Installation. In short, we recommend a 16-32 Gig of memory, 4 CPU cores and about 10 gig of hard drive space. Port 8300 should be open to allow users to connect remotely. The ReportWORQ Bootstrapper Windows Service should be set to Automatic and a service account should be applied if ReportWORQ will require network access (e.g. loading and saving files from network drives). If ReportWORQ will be sending reports via email then SMTP information will be required. If you are using Office365 for sending email then an App Registration for OAuth will also be required, details here: https://docs.reportworq.com/v4/docs/office365-oauth2.

Getting Started
A license key is required to use ReportWORQ. If you don’t have a license key then email support at the address above. After installation you may wish to review the online tutorial and video located at: quick-start

The short version to get started is:

  1. Enter the license key by choosing the licensing link in the bottom right footer

Navigate to the Integrations Section image

  1. Choose New Integration > Report Provider > Network Share
    Enter a location on the local drive or network where source reports are stored.
  2. Choose New Integration > Datasources > [select a datasource]
    This is the Planning System that you will be connecting your reports to.
  3. In the Distributor section enable File System and if applicable enable and configure Email

Navigate to the Job Editor image

  1. Choose the option to create a new Job
  2. Double-click the Job to open the Job editor
  3. In the reports tab Add a Source Report
  4. In the Distribution tab set a filename, choose an output format and destination
  5. Test the job in the test screen and download the output

You now have your first ReportWORQ job running and can begin adding parameters to burst reports.