Scheduled reports

Users can configure scheduled reports to be delivered regularly in-application or via email. Scheduled report configurations support all existing data export formats, such as CSV, JSON, and Excel as email attachments. Additionally, report configurations support email delivery to external, non-Pivot users.

Access and setup

The scheduled reports feature is available during the free trial period, but for commercial usage, access requires a specially configured Pivot license. If you are unable to set up the correct permissions to manage this feature, please contact an Imply representative.

Access to viewing, creating, and administering report configurations is handled via Pivot's role-based access control. Note that in order to configure report emails to be delivered with attachments, users will also need to have permission to download/export data.

Creating a report

Creating a new report configuration can be initiated from either a data cube view or the reports feed view:

report creation button in data cube view

Fig. 1 Creating a report from the data cube view

new report button in reports feed

Fig. 2 Creating a report from the reports feed

Configuring the report content

When creating a new report from a data cube, the report will be configured to match the data cube view's filters and shown dimensions. When creating a new report from the feed view, users will be directed to set up the data cube view.

report creation setup

Fig. 3 Configuring the report content

Delivery frequency & Timeframe

Users can easily configure how often and when reports should be delivered. Options are flexible, allowing for both date and day-of-week based delivery times, as well as custom delivery frequencies.

The timeframe determines the reporting time window - the data that will be delivered with every report. It operates similarly to the time filter in the data cube view. For any period, users can choose whether to look at the current period or period-to-date, or for the full previous period. In other words, selecting "Current week" will deliver data starting at Monday at 00:00 until the report delivery time, whereas "Previous week" will always deliver data for the previous week from Monday at 00:00 to Monday at 00:00.

Configuring recipients and delivery options

report creation delivery options

Fig. 3 Configuring recipients and delivery options

Recipients

Pivot users can be added as either viewers or editors when configuring a report. All recipients will be able to view report delivery instances, and users granted edit access will also be able to modify the report configuration. When Pivot is configured for email delivery, external email addresses can also be added as recipients, allowing users to easily share reports with external stakeholders.

Delivery options

Delivery options allow you to configure how report instances will be sent and what content they will contain. Report instances will always appear in the reports feed ("In-app notification"). When Pivot is appropriately configured, reports can also be delivered via email, with the option to attach a data file in any of the supported data export formats.

Advanced usage

Reports and restricted data cube access

Reports configured against data cubes with PII masks or subset filters will properly apply these filters to any generated report data.

Reports configured against data cubes using filter tokens will run as the report creator and apply that user's filter token expression to all data. Users with the AdministerScheduledReports permission can manage ownership on report configurations.

Custom email delivery

Reports can be configured to customize the email template used for delivery. To do so, add an entry in the emailTemplates block named reports:

emailTemplates:
  - name: 'reports'
    subject: '${title}',
    html: |
      <html>
      <head/>
      <body>
        <h2>${title}</h2>
        <dl>
          <dt>Description</dt>
          <dd>${description}</dd>

          <dt>Time frame</dt>
          <dd>${timeFrame}</dd>

          <dt>Filters</dt>
          <dd>${filter}</dd>
        </dl>
        <p>
          <a href="${link}">Open interactive report</a>
        </p>
        <p>
          ${data}
        </p>
      </html>

The following interpolation properties are available for use in both the email's subject and body:

Property Description
title The report's title
description The report's description
timeFrame The time window for the report data
filter The data cube filters applied to the report data
data A preview of the report data rendered as an HTML table
link A link to a Pivot data cube view for the report instance. This requires the linkHostName config setting to be configured
Overview

Tutorial

Deploy

Administer

Manage Data

Query Data

Visualize

Configure

Special UI Features

Misc