What's new ⬇ Download Reportworq
⬇ Guide PDF

How reporting works#

Early release. This feature is in early release, so its screens and behavior may change. Tell us what you think with Send feedback. See Early release features and Send feedback.

Reportworq reporting is a chain of four stages. Each stage has one job, and each hands something finished to the next. If you keep the chain in mind, every other page in this guide has an obvious place.

The chain on one page#

  1. DATA SOURCES        a planning cube, a SQL database, a workbook
          |
          v
  2. DATA MODEL          one or more sources shaped into named VIEWS
          |
          v
  3. REPORTS             built on views, placed on a web report
          |              or in an Excel workbook
          |
          +-----------------------------+
          |                             |
          v                             v
  4a. VIEWED LIVE                4b. SENT BY A DISTRIBUTION JOB
      by an author or                refreshed, personalized and
      administrator                  delivered as static output
                                     (PDF, Excel, email, and so on)
                                           |
                                           v
                                     READERS receive it
Stage What it is Who works here Where to learn more
1. Data sources The systems that hold your numbers. You connect them once. Administrators and authors Connect a data source
2. Data model A governed layer that reads one or more sources and shapes them into curated views with clean, business-friendly field names. Authors Data models
3. Reports The tables, crosstabs, charts and maps that read a view. They sit on a web report or in an Excel workbook. Authors The web report studio
4a. Viewing live Opening a web report to see current data, filter it and download it. Authors and administrators The viewer
4b. Sending A distribution job refreshes the workbook, personalizes it and delivers it. Authors and administrators build it; readers receive it Web reports in distribution jobs

Stage by stage#

1. Data sources#

A source is a connection to a system of record, such as a planning cube or a SQL database, or a file that lives in your workspace. You connect each source once and every model can then use it. Nothing about a source changes when you build a model on it.

2. The data model#

A data model reads one or more sources and turns them into views. A view is one query plus a curated set of fields, and each field has a stable name that survives changes in the source. Several sources can feed one model, and views can be joined across sources. The model is also where you decide which views report authors can see.

Start with Data models, then go to the page for what you need:

3. Building reports#

A report reads a view and shows it as a list, a crosstab, a chart or a map. Reports are placed on a web report, an Excel-like page you edit in the browser, or in an Excel workbook that you build with the Excel add-in. The two meet in the same studio. New > New Web Report starts a web report.

Start with The web report studio and The Excel add-in and the studio, then:

4a. Viewing live reports#

Opening a web report in Viewing mode shows it with current data. A person viewing can change what the report shows (filters, expanding and collapsing, drilling to source rows) but not how it is built, and nothing they change is saved. From the viewer you can download the report or split it into parts by a filter. See The viewer and Download, burst and save as.

4b. Sending with a distribution job#

A distribution job is how a report reaches the people who need it. The job refreshes the report with current data, personalizes it for each recipient if you ask it to, and delivers the result by email, a shared folder or another destination. What recipients get is static: a file that shows the numbers as of the run.

A web report reaches a job in one of two ways. The route to prefer is to convert it to an Excel workbook, which the job then refreshes in place on every run. See A web report as a job source, Convert to Excel and Key cell formats and what a job keeps. For the job itself, see the distribution job lifecycle and the distribution overview.

Live and static#

Viewed live Sent by a job
What you get A web report drawn with current data A file (PDF, Excel and so on) as of the run
Who sees it Authors and administrators Anyone you choose, including people with no Reportworq sign-in
Can the person change it? They can filter and drill, but nothing is saved No, it is a finished file
When the data is read Each time the report opens or refreshes Each time the job runs

Readers never see web reports. Web reports are working tools for the people who build and analyze. A reader receives the static output of a job. This is by design, so a reader never has to learn the studio and never sees a half-finished report.

Two kinds of splitting exist, and they do not mix. The viewer's Burst pane is a lightweight way for an analyst to cut one live report into parts for themselves. A distribution job is the author's full bursting, and it produces static content for the people on a burst set. A job does not carry the live report's filters. To learn the job side, see What is bursting.

Who can do what#

Role What they do in this chain
Administrator Connects data sources, manages the license, and can do everything an author can
Author Builds data models, builds web reports and workbooks, views them live, and builds and runs distribution jobs
Reader Receives job output. Does not open the studio or web reports

What needs a license#

Capability License
Data models, web reports, viewing, downloading, and using web reports in jobs No separate license for web reports
Professional reports Not released yet; this documentation is in preparation for the next release. They need a license that includes them. Without it the controls stay on screen but are disabled and read Professional reports are coming soon.
A job that uses a professional report on an unlicensed server The job fails and keeps no file, with the message "Nothing was distributed: the web report '' uses a professional report, which this license does not include."

An administrator can see which features the license grants on Settings > Configuration > License. See Licensing.

Going deeper. Some of these features are in early release. See Early release features and Send feedback. If something does not behave as described, see Troubleshooting and limits.

Feedback on this page

Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.

Email feedback on this page

Or write to support@reportworq.com directly.