Plugin URL Editor

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 > 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 > Advanced > 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 > Advanced > External Report Types > choose the corresponding report type or create one > set the Auto generate URL field to 'yes'.
  3. Admin > Advanced > 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.
Examples of Plugin URL Template Usage

When a new External Report is created (at New > External Report > Report Type), 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 Connection Profile and Tableau Worksheet fields provides substitutions for corresponding variables. This is how the URL is automatically generated for the External Report.

Directions for creating a Plugin URL Template
  1. Access Admin > Advanced > Plugin URLs. The list of Plugin URL templates previously created in the system opens.
  2. At the bottom of the screen click [+ New Plugin URL Template].
  3. Choose the Plugin for which this template is created from the drop-down list.
  4. Name the template in the descriptive way. If there are multiple templates for one plugin, their purpose should be stated in their names.
  5. Create a Template.
  6. Save your entries.

In case of multiple Plugin URL Templates for one plugin

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

Plugin Template Parameters for supported services

The actual variable names that can be used are dependent on the plugin data source. See the table with available variables for supported plugins.

However, you can also use :ext_report_name, and :ext_report_id that get replaced with corresponding values in the Reports List for the given external report.

Plugin Name Required Parameter Name in UI Plugin Variable Name in the URL Template
1010 data gateway gateway
Infer Dates (True/False) guessDates
Adobe Analytics Web Service Shared Secret wssecret
Web Service User Name wsusername
Apple iTunes Store Vendor ID vendor_id
Atlassian Confluence Domain domain
Atlassian Jira Endpoint endpoint
Basecamp 2 User ID userid
Beckon Account URL accountUrl
API Key apiKey
CoolaData project project
token token
CSV Root location rootLocation
Druid Coordinator node server
Elasticsearch Endpoint endpoint
Index index
Facebook Graph API token token
Flat File column_delimiter column_delimiter
discard_directory discard_directory
files_contain_headers files_contain_headers
source_file_directory source_file_directory
Fogbugz domain domain
Google AdWords Client Customer ID client_customer_id
Developer Token developer_token
token token
Google Analytics Profile ID profile
token token
Google BigQuery job_id_prefix job_id_prefix
token token
Google Calendar token token
Google Spreadsheet token token
Graphite host host
Hadoop Pig fs.default.name fs.default.name
hadoop.tmp.dir hadoop.tmp.dir
mapred.job.tracker mapred.job.tracker
mode mode
Hubspot token token
IBM Cognos Cognos URL dispatcher_url
Namespace namespace
Server server
IBM Coremetrics Client ID client_id
Marketo Endpoint endpoint
Secret
User ID user_id
Microsoft SSRS Report Server URL report_server_url
server server
Microstrategy Endpoint endpoint
Project project
Mixpanel API Key api_key
API Secret api_secret
MongoDB Database Name dbname
Path to mongo mongo.executable.path
OLAP uri uri
Qlik Sense Click through server srv_url
server server
User domain user_domain
Qlikview Click through server srv_url
server server
RSS RSS Feed Url url
Salesforce token token
Salesforce SOQL token token
SAP Business Objects auth.type auth.type
cms cms
Script Script to run (absolute path) executable
Sisense Server server
Splunk host host
port port
SugarCRM Endpoint endpoint
Tableau Site ID site
Tableau server server
Treasure Data apiKey apiKey
database database
Uptime Robot API Key apikey
Zendesk domain domain

0 Comments

Add your comment

E-Mail me when someone replies to this comment