Report Generator

Exposing the report generator turns one of your report templates into a public page. Other people open a link, supply the documents the template asks for, and get the finished report back — without a QAnswer account and without being able to change the template itself.

Open the assistant, go to the Expose tab and select the Report Generator card. The page that opens is a six-step guide.

Note
If the assistant's organization does not have the Expose add-on, this guide opens read-only: an "Expose add-on required" notice appears at the top and every step is greyed out. See The Expose add-on.
Warning
You need a saved template before you start. A brand-new Report Generator assistant has none, and steps 3 and 4 stay blocked until one is chosen — they show "You need to choose a template…". Build and save one first on the assistant's own Report Generator page.
The report generator guide, showing the Language and Select Template steps

Step 1 — Language

Choose the language the public page is displayed in — its labels, buttons and placeholder text. Until a language is chosen, the share link in step 6 stays disabled with the message "choose a language in step 1".

Step 2 — Select Template

Pick which of your saved templates to publish. The field is a searchable list; type to filter it, or use the arrows to step through the templates one at a time.

The Select Template list open, showing the saved templates for this assistant
  • Only one template is exposed per link. To publish a second template, come back and generate another link for it.
  • Templates carry a chip showing their kind, so you can tell a legacy template from a newer one at a glance.
Note
Choosing a template unlocks steps 3 and 4, which are specific to that template.

Step 3 — Description (optional)

A short explanation shown to whoever opens the link — what the report covers and what they are expected to supply.

The Description step of the report generator guide
Warning
The description belongs to the assistant, not to this one template. Editing it here also changes what the assistant's other integrations show.

Step 4 — Template Data

This is the step unique to the report generator. Your assistant's data connectors are listed, and for each one you decide how it behaves in the published template:

The Template Data step, listing a Document connector set to Include
  • Required — the person running the report must upload their own data for this connector before it will run. Use this for the input the report is about — a contract, a report to summarise.
  • Include — your own data in this connector is available to the published report. Use this for reference material you want everyone's report to draw on.
  • Exclude — the connector is not reachable from the published template at all. Use this for anything confidential.

With several connectors, the bulk actions set them all at once — Require All, Include All or Exclude All — and the ⋯ menu on each row offers the same choices per connector.

Warning
Press Save under the connector list. Nothing you change in this step takes effect until you do.

Step 5 — Choose your access

Nobody can open the link until you decide who is allowed in:

The Choose your access step of the report generator guide
  • Public — anyone with the link can run the report, without logging in or an API key.
  • Logged-in users — the link works, but only after the visitor signs in to QAnswer. Useful for sharing inside a company.
  • Only with an API key — the assistant stays private and the link carries an API key that lets visitors in. Select it to take a published report generator offline again: a link without a key stops working.

With Only with an API key selected, the key controls appear right under the option:

  • Use an existing API key lists the assistant's keys that can be used here; expired keys and Read and write keys are left out. It only appears if you have write access to the assistant and such a key exists.
  • To make a new key, type a name in API key name and press Generate key.
  • The chosen key is then shown masked, with a copy button, and Use another key brings the picker back. QAnswer remembers the key in your browser and selects it again the next time you open the guide.
  • Keep the API key out of the exported code (advanced) removes the key from the link. The link then only works in this browser, where the key is kept in local storage.

Switching to Public or Logged-in users sets the key aside, since none is needed then; it comes back if you return to Only with an API key.

Note
Below the options, a status message says whether the integration is ready, for example "Ready: anyone can use this integration, no API key needed.", or what is still missing, such as "Not ready yet: select or create an API key above."
Warning
Access is an assistant-level setting. Changing it here also changes it for the assistant's other interfaces and for every third-party integration.
Note
This step only controls anonymous, public access. To share with named users, teams or organisations, use the Share dialog in the assistant's top bar.

Step 6 — Share

Once a language, a template and an access type are all set, the link appears. Use the copy icon beside it, or the arrow to open it in a new tab.

The Share step showing the generated public report generator link

Until all three are set, this step shows a warning instead of a link, naming what is still missing — "choose a language in step 1", "choose a template in step 2", or a reminder to pick an access type.

Note
The link carries the template id and a duplicate flag. Each visitor works on their own copy of the template, so running the public report never modifies the original you published.