Understanding Plugin URLs

External Reports in Metric Insights fetch images from source Reports of the supported BI services. Typically, in order to create an External Report, a URL to the source Report is required. It can be set manually or be generated automatically from a Template.

Purpose of Plugin URL Templates

  1. Admin > Collection & Storage > Data Sources. When a new Plugin Connection profile is created, the system requests certain required Parameters. They are required because they usually point to the location of some information in the source service. One of the typical required parameters is a server or endpoint. The given example is for Tableau. Required parameters for Tableau include Tableau server and Site ID.
  2. Admin > Plugins > Plugin URLs. If the URL is generated automatically, it requires a Template to indicate what variables should be included into the URL. Template typically includes variables related to the location of the data in the source system and the ID of the object to be fetched.
  3. Admin > Plugins > External Report Types. External Reports are fetched via the link to the source service. This link can be added manually or generated automatically. To enable automatic generation, go to Admin > Plugins > External Report Types > choose the corresponding Report Type or create one and enable Auto Generate URL.

Examples of Plugin URL Template Usage

When a new External Report is created (at New > External Report), the Plugin Connection Profile (source) and External Report ID (in the given example – Tableau Worksheet) should be selected to guide the system on what object should be fetched and where it can be found.

Here is a URL Template applied to this External Report: 

:server/t/:site/views/:ext_rep_id

The selection in the Plugin Data Source and Tableau Worksheet fields provides substitutions for corresponding variables. This is how the URL is automatically generated for the External Report.

Directions for Creating Plugin URL Template

Access Admin > Plugins > Plugin URLs

  1. [+ New Plugin URL Template]
  2. Choose the Plugin for which this Template is created from the drop-down list
  3. Name the template in the descriptive way. If there are multiple templates for one Plugin, their purpose should be stated in their names.
  4. Create a Template
  5. [Save]

In Case of Multiple Plugin URL Templates for One Plugin

If more than one URL template is created for a specific Plugin, the URL template field is displayed in the External Report Editor for this Report Type.