Providing report templates

You have the option to provide report templates with your Community Connector. Report templates can help users to quickly understand the capabilities of your connector if they are unfamiliar with the data source.. It also gives the users a foundation to build on rather than starting from a blank report. To use this feature, you have to first design the template in Data Studio and then add it to your connector manifest.

How to create a report template

To create a report template for your Community Connector:

  1. Create a new report in Data Studio.
  2. Add your connector as the data source.
  3. Add charts, tables, elements, etc. to the report and design it to your liking.
  4. Give the report a name that will be useful for users.
  5. Get a shareable link.

How to add the report template to the connector manifest

You can get the report ID from the report's URL and add it to the connector manifest as a template. Open the report to use as a template in Data Studio and inspect the URL for the report. The part between reporting/ and /page is the report ID. For example, in the following URL, 0B1a5IAKYIVtTcWxCbWJkc2Q1M1k is the report ID:

You can now add this report as a template in the manifest of your Community Connector:

  "dataStudio": {
    "templates": {
      "default": "0B1a5IAKYIVtTcWxCbWJkc2Q1M1k"

Behavior of templates

If your connector's manifest has an entry for the template key, during the connector configuration screen, Data Studio will provide a checkbox to allow the user to select whether or not they want to use the default template. The checkbox is selected by default.