Subscriptions

Subscriptions are used to enable Kentik Dashboards to be sent as reports to recipients via email. The management of subscriptions in the Kentik portal is discussed in the following topics:

• Subscriptions Page
• Subscription Admin Dialogs
• Add or Edit Subscription

The Subscriptions page is home to the Subscription List, which lists your organization’s current subscriptions. To access the Subscriptions page, choose Admin from the Kentik navbar, then Subscriptions from the sidebar at left. The page is covered in the following topics:

• Subscriptions Page UI
• Subscription List

The Subscriptions page includes the following UI elements:

• Filter field: Filters the Subscription List to show only rows containing the entered text in the following columns: Title, Recipients.
• Add Subscription button: Opens an Add Subscription dialog where you can add a subscription (see Subscription Admin Dialogs).
• Subscription List: A table listing your organization’s currently defined subscriptions (see Subscription List).

The Subscription List is a table that lists all existing subscriptions for a given customer. The table provides the following information and options for each subscription:

• Title: The name of the report for which the subscription was created. Click on a name to go to the Edit Subscription page for the corresponding subscription.
• Frequency: The interval (Daily, Weekly, or Monthly) at which the report is sent to subscribers.
• Lookback: The time range covered by the subscription’s report.
• Recipients: The email addresses of subscribers. A single address will be shown in the field. If there are additional subscribers there will be an ellipsis at the right of the field. Hover over the field to open a tool tip containing all of the email addresses.
• Last Report: Date that the most recent report was sent to subscribers.
• 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).
• Remove: Opens a confirming dialog that allows you to remove the subscription.

Click on a column heading to sort the list (ascending or descending).

Adding or editing a subscription via the Kentik portal involves specifying information in the fields of the subscription admin dialogs, which are covered in the following topics.

• About Subscription Dialogs
• Subscription Dialogs UI
• Subscription Field Definitions

Note: Subscription admin dialogs are visible only to users whose level is Administrator.

Subscription admin dialogs are used to collect and display subscription information. The required information is entered into the fields of either of the following dialogs:

• Add Subscription when creating a new subscription.
• Edit Subscription when editing an existing subscription.

The Add Subscription and Edit Subscription dialogs share the same layout and the following common UI elements:

• Close button: 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.
• Remove button (Edit Subscription dialog only): Remove the subscription from your organization’s collection of Kentik-registered subscriptions. This button is only present if the subscription being edited was manually added.
• Cancel button: Cancel 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.
• Add Subscription button (Add Subscription dialog only): Save settings for the new subscription and exit the dialog.
• Save button (Edit Subscription dialog only): Save changes to subscription settings and exit the dialog.

The following fields of the subscription admin dialogs are used to configure a subscription:

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

• Adding a Subscription
• Editing a Subscription

To add a new subscription to Kentik Detect:

1. Open the Subscriptions page (choose Admin from the Kentik navbar, then Subscriptions from the sidebar at left).
2. Click the Add Subscription button to open the Add Subscription dialog.
3. Specify the values of the fields in the dialog (see Subscription Field Definitions).
4. Save the new subscription by clicking the Add Subscription button (lower right).

To edit the settings for an existing subscription:

1. Open the Subscriptions page (choose Admin from the Kentik navbar, then Subscriptions from the sidebar at left).
2. In the Subscription List, click in the row of the subscription that you’d like to edit. The Edit Subscription dialog will open.
3. Edit the subscription settings by changing any fields that you’d like to modify (see Subscription Field Definitions).
4. To save changes, click the Save button (lower right).

To remove the subscription from your organization’s collection of subscriptions, click Remove (lower left).