Configuring push reports

Configuring push reports requires you to build a custom report to send to users, a schedule on which to send the report, an email template that formats the email you send to users, and a push report configuration that unifies the previous items.

1. Build the custom reports you want to send.

   For detailed information, see Custom reports.

   Note: Push reports can contain tabular reports only. Line charts, bar graphs, and other data visualizations are not supported in push reports.
2. Create a schedule that determines how frequent the report will be sent.

   See Sampling schedules for more information.

3. On the Reporting > Reports > Push Reports > Email screen, configure between 1 and 3 of the following templates to use as part of your push report:
   • Main email — The primary template, which details the message to send, as well as the embedded custom report (if you want to embed a report in the email).
   • Attachment email — Create a second template to send a report as an attachment. You can do this even if you also embed the report in the main email template. The attachment can be either HTML or XML, so you must specify the appropriate extension (.html, .xls, or .xlsx) in the subject header. Do not use images in this template. Excel does not display the report properly if the template contains an image.
     Note: Some report formatting is not replicated in attachments. Always test push reports as described later in this topic to be sure reports meet our needs. You might decide to use only the main email, and not attachments.

   • Status report — To receive status emails about the success of the push report distribution, create a new template for that email or use the default Push Status Report template.

   For detailed information about creating email templates, including formatting options, see Templates.

4. To the roles that should receive push reports, assign the Receive Push Reports built in classic setup reporting permission in Admin Suite.
   Restriction: Primary and secondary roles must have the Receive Push Reports built in classic setup reporting permission to receive the Push Report. For more information, see Roles.
5. Configure the push report object that unifies the templates and schedule you created previously:

   1. Open the Reporting > Reports > Push Reports > Push Reports screen.

   2. Click New Push Report.

   3. Select the Schedule you configured in a previous step.

   4. Give the push report a unique Name.

   5. By default, push reports are not sent if there is no data to send. If you want empty reports sent, turn on the Send empty report property.
      Note: From Address — the source email sender — is an auto-generated value and shown on this screen as a read-only field.

   6. Optionally, in the Reply To Address property enter an email address to which users can reply when they have questions.

   7. If your custom report uses the $DATE$ attribute as a placeholder for the current date, enter a Date Format to use for that attribute, where yyyy is the 4-digit year, yy is the 2-digit year, MM is the month, dd is the day, HH is the hour in 24-hour format, mm is the minutes in the hour, and ss is the seconds in the minute.

      For example, you could enter MM-dd-yy. If you leave this property empty, yyyy-MM-dd is used by default.

   8. Select the Main email template you configured in a previous step.

   9. To add the custom report as an attachment, select the Attachment email template you configured in a previous step.

   10. In the Recipients property, choose which roles and users should receive the report.

   11. Optionally, add email addresses in the CC Address and BCC Address properties for people that should be copied and blind copied on the email distribution.

       Note: Do not enter CC and BCC email addresses for people that you also added in the Recipients property. Doing so send multiple emails with the same reports to those people. Additionally, note that CC and BCC email addresses receive a separate email for every address in the Recipients property.
   12. To receive a status report containing information about which accounts received and did not receive the push report, enter one or more email addresses in the Status report receiver(s) property.
   13. To send status reports, select a Status report template.

       Select either the default Push Status Report template or a template you configured for this purpose in a previous step.

   14. To send the status report only when email could not be delivered, turn on the On missed accounts only property.
   15. Click Save.
6. Complete the following steps for each custom report to include in the email:

   1. On the Reporting > Reports > Push Reports > Push Reports screen, select the push report you created in the previous step.

   2. Click AnalyticsReport usage.
   3. In the Analytics Report property, select a custom report to send in the user email.

   4. In the Workspace property, select the role to use for filtering the report.

      If users have more than 1 role, this property specifies which role to use. If a user does not have the role you select, or if you select None, the user's primary role is used. For more information about primary and secondary roles, see Roles.

   5. Click Save.

      The ViewStateInfo section populates with additional properties that allow you to filter the report, based on the plugins attribute of the optionbox-filter element defined in the custom report.

   6. Optionally, select values for any of the properties added in the ViewStateInfo property.

   7. To override the custom report's label defined in the email template, enter an Email Template label.

      Use this option to use the same custom report more than once in the push report, but with different ViewStateInfo selections. In that scenario, the Email Template label differentiates the reports for the user.

   8. Click Save.
7. Preview the report before sending it to users:

   1. On the Reporting > Reports > Push Reports > Push Reports screen, select the push report you want to send.

   2. Click Preview Push Report.

   3. Enter your email address in the Preview Email property.

      Experience Cloud sends the preview email only to this address.

   4. In the Scope property, select a user account to define the scope of the preview report.

      Permissions on that account define what data is shown, allowing you to see how the report looks to various users.

   5. Click Save.

      Experience Cloud sends the push report to the specified email address immediately.

8. To send the push report now, complete the following steps. Otherwise, Experience Cloud sends the report according to the schedule you configured in a previous step.

   1. On the Reporting > Reports > Push Reports > Push Reports screen, select the push report to send.

   2. At the bottom of the screen, turn on the Confirm property and then click Push Report Immediately!.

Executed reports list

The Reporting > Reports > Push Reports > Executed Reports screen lists the 50 most recently-executed push reports, along with the following information for each execution:

• The name of the push report.
• The type of execution: Scheduled, Manually, or Preview.
• If the type is Preview, the preview email address.
• If the type is Scheduled, the time the push report was scheduled to be executed.
• The time the push report was actually executed. This can differ from the scheduled time, such as if the server was down during the scheduled time, or if the execution was queued due to load issues.
• All accounts to which the push report was configured to send, along with a status message. Any error messages encountered for an account are displayed after that account.

If you have skipped or failed accounts in the execution, you can set them back to Ready status by turning on the Confirm property, and then clicking Reset skipped and failed.

To re-run the execution for all accounts with the Ready status, select the task in the list, turn on the Confirm property, and then click Restart this execution. This is useful to use with the Reset skipped and failed action immediately after a push report was executed, since it allows you to resend the push report only to accounts that were skipped or failed.