Create External Report from Sigma

This article details how to create an External Report to visualize data from Sigma in Metric Insights.

PREREQUISITES:

Enabling Export Permissions

The user account associated with the API Token must have Export permissions to be able to create objects from Sigma workbooks, workbook pages, or workbook elements in Metric Insights.

These permissions can be enabled under Administration > User Types.

1. Add New External Report

Access New > External Report > Sigma

  1. Provide a descriptive phrase in Name
  2. Specify Category into which External Report will be placed
  3. Define whether content has to be updated manually or automatically
    • For "Automatically Collected", specify a Report Image Trigger 
  4. Choose Sigma Plugin Connection Profile 
  5. Select Element for External Report
  6. [Next: define details]

2. Specify Report Details

  1. Show Report in defaults to "External Webpage".
    • For "Viewer", select Show "In iframe" or "As static image" option
    • NOTE: When opting to display the Report as a Static Image, make sure to Collect Image before going to Viewer.
  2. Optionally, configure filtering via [Manage Filters]
    • NOTE: Sigma supports two types of filters: Filters and Controls; however, only Controls can be used in Metric Insights. In order to use regular Filters in Metric Insights, convert them to Controls.
  3. Optionally, [Edit URL] to modify the URL by appending a question mark (?) followed by any filter or parameter settings
  4. Optionally, [Test URL] to test how the Report will be displayed on External Webpage or in Viewer, depending on the display option selected in the previous step
  5. Select Report Image option:
    • "Always collect all instances of external report": collect all images and cache them on a schedule
    • "On Demand: only when needed for distribution": individual images are only collected when they need to be included in an email

3. Collect Image and Publish

  1. [Collect Image]
  2. [Enable & Publish]