Skip to main content

Set up reports

You can schedule reports that deliver select data to specified recipients via email or in the Polaris UI.

You configure a report to include data from a selected data cube, for a specified period of time. You can choose the delivery options for the report, and set the recipients to receive the report.

Prerequisites​

Users with AdministerReports or ManageReports permissions can set up reports in Polaris. For information on permissions that control who can access and manage reports, see Permissions reference.

Create a report​

Follow these steps to create a report:

  1. Click Reports in the left pane, then click New report:

    schedule report

    You can also create a report from a data cube. Click the Alerts and reports ellipsis in the top right corner of the page, then select Schedule report.

  2. Configure report options, then click Delivery options.

  3. Configure delivery options, then click Access options.

  4. Manage access to the report, then click Create report.

Configure report options​

The following table lists all of the options you can configure for a report:

FieldDescription
NameThe name of the report. The name appears on the Reports page and in emails.
DescriptionAn optional description for the report.
TimezoneThe timezone to apply to report production and delivery.
DeliveryDefines how often Polaris produces the report.
TimingDefines the timing of report production. The available options depend on the Delivery setting.
TimeframeControls the amount of data Polaris includes in the report. Setting this field to Previous day, for instance, results in Polaris including data for the previous day—defined from the day and time you define in Starting at.
Starting atThe starting point—day and time—for the data in the report. A message under the Timeframe field displays the period of time for which Polaris will capture data for the report.
ViewSelect a data cube for the report and click Set up view. You can add filters, dimensions and measures to restrict the data to include in the report.

Configure delivery options​

Follow these steps to configure delivery options for the report:

  1. Click the Delivery tab.
  2. By default, Polaris saves the report in the UI. You can select Email to email the report to specified recipients as well.
  3. If you select Email, you can additionally set the following options:
    • Attach a data file: Send the report data in an email attachment. If you don't select this option, Polaris includes the first 20 rows of the report in the email body, with a link to Polaris to view the entire report—see Example report email.
    • Add total row to file: Add a row to the email attachment that shows an overall total. You can't apply this option to JSON format attachments.
    • Format: Select the attachment format.
    • Amount to download: Select a download limit for users without the AccessDownloadLargeData permission attached to their user profile. See Permissions reference for more information on Polaris permissions.
    • Deliver to external emails: You can enter a comma-separated list of external email addresses to access the report. Set notification options for external users in the report's access options.

Manage access​

By default, all project users can view a newly created report. The report creator and users with the AdministerReports or ManageReports permission assigned to their profile can edit the report.

You can configure access to an individual report at a more granular level when you create or edit a report:

  1. Click the Access tab.

  2. Click Add people.

  3. Select one or more users and groups from the drop-down lists for the following access levels:

    • Can view: View the report. Users with this access level also need the AccessReports permission assigned to their profile.
    • Can edit: View and edit the report. Users with this access level also need the ManageReports or AdministerReports permission assigned to their profile.

    You can set notification options for external users if you added them in the Delivery step.

  4. Check the Email checkbox to send the report to the recipient by email. If you don't check the email box, recipients don’t receive the report by email but they can view the report in the Polaris UI.

In cases where different permissions on the individual level and the group level apply to the same user, Polaris applies the most privileged permission. For example, if an individual user has Can view access to a report, but they are a member of a group with Can edit access, they have permission to edit the report.

Example report email​

Polaris sent the following example email when a report was generated:

Report email

Polaris report emails automatically include the X-Auto-Response-Suppress: All header to suppress replies to email messages.

Manage reports​

You can click the ellipsis to the right of the report name on the Reports page to manage a report.

Select the corresponding option to edit, duplicate, or delete the report, toggle its active status, or add the report to a collection. Click the star icon on the right side of the report's row to add it to your favorites.

View report history​

You can view the history of generated reports in the Polaris UI.

Click Reports in the left pane to view the reports page, and click the name of a report to view its history page.

From this page, you can view more information about the report (the times the report has been produced) and its file attachments.

Learn more​

See the following topics for more information: