Configure Subscriptions

Subscriptions are used to export discoveries, presentations, publications, and tabulations and share them with a distribution list on a scheduled basis.

Once you've saved your file, open the Subscribe dialog and configure your new subscription.

Note: Subscriptions are only available with the Enterprise Edition license.

Warning: When subscribing to content and distributing it to other users, the subscription runs as the initiating user. This means that the recipient of the distribution receives the same as the initiating user and may, therefore, see unsecured data. If you want to distribute data dynamically, sending different data from the same report to different users, you can instead configure dynamic distribution of publications. In this case, the recipient will only see data they have permission to see.

Open the Subscribe dialog

In the Discover, Publish, and Tabulate apps, the Subscribe button can be found on the status bar (right-hand side), above the canvas:

If you open a discovery in the Viewer Client using a direct URL link or link-back from a publication, the Subscribe button is typically found in the:

  • Visualization panel - The option opened from the Hamburger Menu at the top-left (this panel is similar to the Present Runtime Menu below).
  • Dashboard Menu - The Navigation Bar along the top of the browser:

In Present, the subscribe button can only be found in the Present runtime menu (accessed from the Hamburger menu) when the presentation is running:

Subscribe dialog

You can work through the tabs in the Subscribe dialog to configure the subscription. This includes naming and describing your subscription, configuring the schedule for the subscription job, and configuring the list of recipients and method of distribution.

Details

  • Name: Supply a name for your subscription. By default, the subscription name is based on the file name.
  • Message: Add a message that describes the purpose of the subscription. You may include "Shortcut keys" in your message. These variables will be replaced with an actual value on generation, for example, [L] will incorporate a Link to the content.

Content Selections

Note: The Content Selections field is only available in Discover, Present, Tabulate, and the Viewer Client.

If the file contains slicers, you can use the Content Selections drop-down to indicate which slicer selections to include in the exported content:

  • Default slicer values: The default slicer value will be used for the subscription.
  • Current slicer values: Presentations only. The value displayed at runtime when the subscription was started is the value that will be used in the subscription.

Selection

Note: The Selection tab is only available in Tabulate.

Type:

  • Print Area: Select the Print Area for the subscription.
  • Custom: Select custom, and then select one or more Custom Print Areas (Visual Areas, Discovery Areas, or Print Areas) from the multi-select drop-down for the subscription.

Schedule

Configure the Schedule for the subscription job:

  • On Demand: Select On Demand to trigger the schedule either when the underlying data model is reprocessed or through an API call.
  • <Preset>: Select one of the Preset options, such as "Every Monday at 9am," to create a simple, repeat schedule for your subscription.

    • Tip: If you select one of the "starting today" options, but only after the 9 AM start time, you can indicate that you also want to run this schedule today by selecting the Run Now checkbox in the Advanced settings.

  • Select the Advanced checkbox at the bottom of the dialog to create a custom schedule using the advanced options.

Note: Pyramid uses your time zone for the time and date settings by default. If you want to check that it has selected your time zone correctly, or you want to schedule times and dates in a different time zone, use the Timezone option in the Advanced settings.

Note: With the Advanced checkbox selected, you can configure either a Recurring schedule or an On Demand schedule.

Recurring Schedule

Recurring schedules run on a regular frequency. Once you select the frequency of the schedule, you can set it to run at specified intervals; for example, every Monday, every quarter, or every two weeks:

  • Run Now: Select this checkbox to run the schedule immediately.
  • Hourly: Run the job every x hours and y minutes, starting from the specified Start time and date.
  • Daily: Run the job either on the selected Specific Days or every x days (Days Interval).
  • Weekly: Run the job every x weeks on the selected Days.
  • Monthly: Run the job every x quarter, month, or all, based on the following pattern:
    • Week and Days: Run the schedule during the specified week of the given months, on a given day.
    • Calendar Days: Run the schedule on a given calendar day or on the last day of the month.
    • Workdays: Run the schedule on a specific working day (Days) during the month, or on the last working day of the Month.
Start and End

For each recurring schedule option:

  • Start: The date and time when the job starts running. All schedules need a Start date and time.
  • End: Optional. The date and time when the job will stop running. If no end date and time are given, the schedule will continue running indefinitely.
Timezone
  • Timezone: The timezone that your schedule should occur in. This is particularly important when building publications for a global audience.

On Demand Schedule

On Demand Schedules are used to trigger the rendering of specified publications, alerts, and subscriptions when the underlying data model is reprocessed or when the schedule is prompted using an API.

To configure on demand scheduling for the subscriptions, choose On Demand from the Schedule tab, either from the regular settings or the advanced settings. You must also configure on demand subscriptions for the relevant data models using the Master Flow or API.

  • Click here to learn more about configuring the schedule.

Distribution

Limit to fully successful results only

Select the Limit to fully successful results only checkbox to prevent automatic distribution where content was not built completely successfully; that is, where a scheduled build "finished with errors" (or is a "Partial Success" in the language of the Task Manager):

  • Where this option is not selected (default), the output is built and automatically distributed according to the schedule. The broken item is simply excluded from the output.
  • Where this option is selected, the output is built with the missing broken item but it is not automatically distributed. You can still view the built output in the Schedule Manager, but it is not distributed.

Basic options

Use the checkboxes to subscribe as yourself:

  • Bulletin Board: Receive subscribed output through the Pyramid Bulletin Board.
  • Email: Receive subscribed output by Email.

Advanced options

Where available, select the Advanced checkbox at the bottom of the dialog to create a custom distribution using the advanced options:

  • Bulletin Board: Distribute to a list of users or groups using the Pyramid Bulletin Board.
  • Email: Distribute to a list of email addresses. Note: You have an option to include a link to the content item.
  • Phone: Distribute to a list of users using SMS.
  • Channel: Distribute to a channel Webhook. Note: You have an option to include a link to the content item.

You can distribute the subscription to multiple destinations, but the selected destinations must include one of either Bulletin Board or Email. This is because phone and channel distribution do not involve sending the subscription output (the actual exported report). The output itself can only be sent through the Bulletin Board or email.

  • Click here to learn more about Advanced Distribution configuration.

Output

From the Output tab, choose the required output type, then set your preferences for that selected output. The options on this tab are typically the same in the Print and Export dialog.

Note: There is no option to spool the print job, because this is not relevant for scheduled subscriptions.

Header \ Footer

Note: The Header \ Footer tab is only available in Discover or in the Viewer when subscribing to a discovery. It is also only shown if one of the relevant Output types is selected.

The options are used to configure the output report's headers and footers:

Enable Headers or Footers

  • To enable headers, select the Header checkbox.
  • To enable footers, select the Footer checkbox (purple arrow above).

Configure Headers or Footers

  • Header \ Footer Area Height: Set the area height (in pixels) of the header or footer.
  • Font Style: Select the font formatting options, including font type, size, text color (using the Color Picker), and emphasis (bold, italic, or underline).
  • Add Element to Header: Use the buttons to copy a variable representing a page number, time, date, report name, or user name into the Left, Center, or Right Section of the header or footer. By default, each is added to the Left Section field, but you can select either Center Section or Right Section to copy the variable into that field instead.
  • Sections: Add content to the Left, Center, or Right of the header or footer using the fields: Left Section, Center Section, or Right Section.

Note: The Header \ Footer tab is identical to the one in the Print & Export dialog in Discover.

  • Click here to learn more about configuring headers and footers from the Discover help.

Commit the Schedule

Once you've configured its details, click Subscribe to create the subscription.