Subscriptions

The management of subscriptions in the Kentik portal is discussed in the following topics:

• About Subscriptions
• Subscriptions Page
• Subscription Dialog
• Add or Edit Subscriptions

Note: To create a subscription directly from a portal module, see Portal View Sharing.

Subscriptions enable you to share information from the Kentik portal by emailing it on a recurring schedule to a specified set of recipients. You can set up a subscription in a couple of different ways:

• Subscription dialog: On the Subscriptions page, open the Subscription dialog by clicking the Add Subscription button, then fill in the fields (see Adding a Subscription).
• Share dialog: On any portal page with a Share button in the SubNav (see Portal Page Layout), click the button to open the Share dialog, then fill in the Subscription tab (see Sharing by Subscription). The portal modules in which you can set up a subscription are listed in Sharable Views.

The Subscriptions page is covered in the following topics:

• About the Subscriptions Page
• Subscriptions List

The Subscriptions page is home to the Subscriptions List, which shows your organization’s current subscriptions. To access the Subscriptions page, choose Settings from the main menu, then Report Subscriptions (under Sharing). While Member users can access the page and view subscriptions, only Administrators or above can add, edit, or remove report subscriptions (see About Users).

The Subscriptions page includes the following UI elements:

• Filter field: Filters the Subscriptions List to show only rows containing the entered text in the following columns: Title, Recipients.
• Add Subscription: A button that opens an Subscription Dialog where you can add a subscription; only visible to Administrators.
• Show/Hide Filters (filter icon): A button that toggles the Filters pane between expanded and collapsed.
• Search: A field that you can use to filter the Cloud Exports List. When text is entered, the list will show only rows containing that text in the Title or Recipients columns.
  Note: Filters added with the Filters pane will also appear in this field. You can remove a filter by clicking the X in its tag.
• Subscriptions List: A table listing your organization’s currently defined subscriptions (see Subscriptions List).

The Subscriptions List is a table that lists all existing report subscriptions for a given customer. By default, the list is ordered alphabetically by the Title column. To change the sort order of the list, click a heading to select a column, and click the resulting blue up or down arrow to choose the sort direction (ascending or descending).

The Subscriptions list provides the following information for each subscription:

• Title: The name of the report for which the subscription was created.
• Source: The kind of portal view (dashboard, saved view, etc.) from which the report was created (see Sharable Views).
• Frequency: The interval (Daily, Weekly, etc.) at which the report is sent to subscribers (see Schedule in Subscription Tab UI).
• Lookback: The time range covered by the subscription's report (see Lookback in Subscription Tab UI).
• Recipients: The email addresses assigned to this subscription. If there are too many addresses to fit, an ellipsis appears at the right of the field.
• Last Report Sent On: The date that the most recent report was sent to subscribers. Hover over the date for a tool tip with the full date-time (UTC).
• Last Edited: The date on which the subscription was last edited. Hover over the date for a tool tip with the full date-time (UTC).
• Created: The date on which the subscription was created. Hover over the date for a tool tip with the full date-time (UTC).

The following actions are available to admin-level users from the Actions menu, which you open by clicking the vertical ellipsis at the right of each row:

• Edit: Opens a Subscription Dialog that allows you to change the subscription information (see Editing a Subscription).
• Subscribe: Opens a dialog enabling you to confirm that you wish to be added to the subscription (using your Kentik-registered email address).
• Unsubscribe: If you’re subscribed to this subscription, this option opens a dialog enabling you to confirm that you wish to be removed from the subscription.
• Remove: Opens a confirming dialog that allows you to remove the subscription from your organization’s collection of subscriptions.

Adding or editing a subscription via the Subscriptions page involves specifying information in the fields of the Subscription dialog, which is covered in the following topics.

• Subscription Dialog UI
• Subscription Dialog Fields

Note: The Subscription dialog is visible only to admin-level users.

The Subscription dialog includes the following UI controls:

• Close: Click the X in the upper right corner to close the dialog. All elements will be restored to their values at the time the dialog was opened.
• Cancel: A button that cancels the add subscription or edit subscription operation and exit the dialog. All elements will be restored to their values at the time the dialog was opened.
• Share: A button that saves the dialog’s current settings and exits the dialog.

The fields of the Subscription dialog are the same as the fields on the Subscription tab of the Share dialog, which are covered in Subscription Tab UI.

Subscriptions are added and edited via the Subscriptions Page (Settings » Report Subscriptions). The add/edit process is covered in the following sections:

• Adding a Subscription
• Editing a Subscription
• Removing a Subscription

To add a new subscription:

1. Open the Subscriptions page (Settings » Report Subscriptions).
2. Click the Add Subscription button to open the Subscription dialog.
3. Specify the values of the fields in the dialog (see Subscription Dialog Fields).
4. Save the new subscription by clicking the Share button (lower right).

To edit the settings for an existing subscription:

1. Open the Subscriptions page (Settings » Report Subscriptions).
2. In the Subscriptions List, find the row corresponding to the subscription you’d like to edit, then click on the vertical ellipsis at the right of the row to open the Actions menu.
3. Choose Edit. The Subscription Settings dialog will open.
4. Edit the subscription settings by changing any fields that you'd like to modify (see Subscription Dialog Fields).
5. To save changes, click the Share button (lower right).

To remove a subscription from your organization’s list of subscriptions:

1. Open the Subscriptions page (Settings » Report Subscriptions).
2. In the Subscriptions List, find the row corresponding to the subscription you’d like to edit, then click on the vertical ellipsis at the right of the row to open the Actions menu.
3. Choose Remove, then click Remove in the resulting confirmation dialog.