Stay organized with collections
Save and categorize content based on your preferences.
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:
Create a new report in Data Studio.
Add your connector as the data source.
Add charts, tables, elements, etc. to the report and design it to your
liking.
Give the report a name that will be useful for users.
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:
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eReport templates offer users pre-built reports to quickly understand a connector's capabilities and data source.\u003c/p\u003e\n"],["\u003cp\u003eTemplates are best suited for connectors with fixed schemas, and unpredictable behavior may occur with variable or multiple schemas.\u003c/p\u003e\n"],["\u003cp\u003eTo create a template, design a report in Data Studio, get a shareable link, and add the report ID to your connector manifest.\u003c/p\u003e\n"],["\u003cp\u003eData Studio displays a checkbox during connector configuration, allowing users to choose whether to utilize the default template.\u003c/p\u003e\n"],["\u003cp\u003eThorough testing is recommended to ensure the connector and template function as intended.\u003c/p\u003e\n"]]],[],null,["# Providing report templates\n\n| **Caution:** Report templates work best for connectors with fixed schemas that do not change with connector configurations. If you add a template to a connector with variable or multiple schema, the report behavior will be unpredictable.\n\nYou have the option to provide report templates with your Community Connector.\nReport templates can help users to quickly understand the capabilities of your\nconnector if they are unfamiliar with the data source.. It also gives the users\na foundation to build on rather than starting from a blank report. To use this\nfeature, you have to first design the template in Data Studio and then add it to\nyour connector [manifest](/looker-studio/connector/manifest).\n\nHow to create a report template\n-------------------------------\n\nTo create a report template for your Community Connector:\n\n1. Create a new report in Data Studio.\n2. Add your connector as the data source.\n3. Add charts, tables, elements, etc. to the report and design it to your liking.\n4. Give the report a name that will be useful for users.\n5. [Get a shareable link](https://support.google.com/looker-studio/answer/7459147#get-a-shareable-link).\n\n| **Caution:** G Suite accounts may have sharing limited within the domain. In such cases, you should create the report template using a non-G Suite account.\n\nHow to add the report template to the connector manifest\n--------------------------------------------------------\n\nYou can get the report ID from the report's URL and add it to the connector\nmanifest as a template. Open the report to use as a template in Data Studio and\ninspect the URL for the report. The part between `reporting/` and `/page` is the\nreport ID. For example, in the following URL, `0B1a5IAKYIVtTcWxCbWJkc2Q1M1k` is\nthe report ID: \n\n```\nhttps://looker-studio.google.com/c/org/UTgoe29uR0C3F1FBAYBSww/reporting/0B1a5IAKYIVtTcWxCbWJkc2Q1M1k/page/9QoH\n```\n\nYou can now add this report as a template in the manifest of your Community\nConnector: \n\n {\n \"dataStudio\": {\n ...\n \"templates\": {\n \"default\": \"0B1a5IAKYIVtTcWxCbWJkc2Q1M1k\"\n }\n }\n }\n\nBehavior of templates\n---------------------\n\nIf your connector's manifest has an entry for the `template` key, during the\nconnector configuration screen, Data Studio will provide a checkbox to allow the\nuser to select whether or not they want to use the default template. The\ncheckbox is selected by default.\n| **Note:** You should test this behavior to ensure that your Community Connector and the template work as expected."]]
