- 17 Oct 2022
- 3 Minutes to read
- Updated on 17 Oct 2022
- 3 Minutes to read
This quick start guide will provide a high-level overview of the ReportWORQ User Interface and several common use cases. Before starting this guide be sure to complete the Installation & Configuration Guide which includes configuring Source Report Providers, Datasources and Distribution Providers as needed.
The ReportWORQ sidebar is split into two sections with the top portion providing access to product functionality and the bottom portion for administrative tasks and configuration.
Activity - The activity section allows the user to run jobs, monitor running jobs, review and release jobs that have been held for delivery, review job history and process writeback input forms.
Edit Jobs - This section provides a navigation tree and tabbed editor for organizing, creating, editing, and testing jobs.
Address Book - The address book provides a mechanism for creating contacts with personalized distribution details and custom properties. Bursted jobs may use this information as part of the personalized distribution process.
Scheduling - The scheduler allows jobs to be scheduled and run at specific intervals.
Settings - The settings page covers environmental configuration such as the server port and SSL Settings.
Integrations - The Integrations page provides a single place to manage the many connections that ReportWORQ will need to load source reports, refresh data, distribute reports, and integrate with 3rd party systems.
Accounts - The accounts page allows for the creation of users and management of ReportWORQ Administrators.
Software Versions - The software versions page is used to download and upgrade the ReportWORQ software.
Quick Start Tutorial
This guide will cover certain use cases using the tutorial files below. The Tutorial P&L.xlsx file in the tutorial includes a formatted P&L report which will be used for distribution and a Data worksheet which will serve as the demonstration database for refreshing data in this report. The data in the report is based on a filter that is located in cell D2 and known by the named range RNGLOCATION. Upon changing the value in this cell to another valid location, the data throughout the report will load for that specific location. In production scenarios, this data would have been loaded from a supported enterprise planning system such as IBM Planning Analytics or Workday Adaptive Planning. For this example, the report is simply using VLOOKUP formulas to load the correct data for that location. Inspect the data cells in the report to see these formulas. There are several other key pieces of information outside of the print range in addition to the filter cell. For example, the email address for the person who owns this location is located in RNGEMAIL, and commentary about the data in the report is located in ranges RNGREVENUE, RNGINCREASE & RNGDECREASE. These named ranges will be useful when it's time to distribute the report.
To use these tutorial files first download the zip file above and extract the folder either on the server or a network location that is accessible by ReportWORQ. The folder containing these files will need to be configured as a Source Report Provider in the integrations screen. If a source report provider already exists then simply extract these files into the existing configured location.
Tutorial Data source
This article will cover how ReportWORQ parameters can be driven dynamically using metadata and queries against configured datasource providers. To demonstrate this functionality the P&L Report file will need to be configured as an OleDB datasource.
Perform the following steps to create this datasource:
- Navigate to the Integrations page and choose New Integration > OleDB Provider
- Set the name to TutorialSystem
- Set the connection string (update the path below):
Provider=Microsoft.ACE.OLEDB.12.0;Data Source=path_to_tutorial_files\Tutoral P&L.xlsx;Extended Properties="Excel 12.0;HDR=YES;"
- Set the Test Query:
SELECT * FROM [Regions$]
- Test and Save the datasource.
If the Microsoft.ACE.OLEDB.12 provider is not registered then download and install the Microsoft Access Database Engine 2010 Redistributable from https://www.microsoft.com/en-us/download/details.aspx?id=13255