Reports: Adding a prompt to a report, metric, filter, or custom group

A prompt is a question the system presents to a user during report execution. How the user answers the question determines what data is displayed on the report when the results are returned from your data source. Prompts are an effective way to design a single report that can support a broad user audience, since each user can designate the specific information that they want to see.

To get started creating a prompt, see About prompts.

You need to know what type of prompt you will be using when deciding where and how to add it to a report. You can add a prompt directly to a report, or indirectly by adding the prompt to a metric or filter. For example, object prompts are most commonly placed directly on a report, but can also be placed in the condition part of a metric's definition in the Metric Editor, depending on the type of object in the object prompt.

Use the following table when considering how and where to add a prompt to a report, metric, filter, or custom group:

Filter Type	Add to Report Editor: Template Definition Pane	Add to Report Editor: Report Filter Pane	Add to Report Editor: Page-by Pane	Add to Metric Editor: Definition Pane	Add to Filter Editor: Filter Definition Pane	Add to Custom Group Editor: Custom Group Definition Pane
Filter Definition Prompts
"Choose from all attributes in a hierarchy" prompt	No	Yes	No	No	Yes	Yes
"Qualify on an attribute" prompt	No	Yes	No	No	Yes	Yes
"Choose from an attribute element list" prompt	No	Yes	No	No	Yes	Yes
"Qualify on a metric" prompt	No	Yes	No	No	Yes	Yes
Object Prompts
Object prompt of attributes	Yes	No	Yes	Yes	Added as part of an advanced qualification or the level of a set qualification	Added as part of an advanced qualification or the level of a set qualification
Object prompt of metrics	Yes	No	Yes	Yes	Added as part of a set qualification, and any place that accepts metrics	Added as part of a set qualification, and any place that accepts metrics
Object prompt of filters	No	Yes	No	Yes	Yes	Yes
Value Prompts
Date prompt	No	No	No	No	Added as part of an attribute form qualification, on an attribute form of Date data type	Added as part of an attribute form qualification, on an attribute form of Date data type
Numeric prompt, Long prompt, or Big Decimal prompt	No	No	No	Yes	Added as part of a set qualification, on an attribute form of a text data type	Added as part of a set qualification, on an attribute form of a text data type
Text prompt	No	No	No	No	Added as part of an attribute form qualification, on an attribute form of a text data type	Added as part of an attribute form qualification, on an attribute form of a text data type
Level Prompts	No	No	No	Yes	No	No

	Add to Report Editor: Template Definition Pane	Add to Report Editor: Report Filter Pane	Add to Report Editor: Page-by Pane	Add to Metric Editor: Definition Pane	Add to Filter Editor: Filter Definition Pane	Add to Custom Group Editor: Custom Group Definition Pane
Where to find steps to add prompt to report	Adding a prompt to the Template definition pane in the Report Editor	Adding a prompt to the Report Filter pane in the Report Editor	Adding a prompt to the Page-by pane in the Report Editor	Adding a prompt to a metric's definition in the Metric Editor	About adding a prompt to a filter's definition in the Filter Editor	Adding a prompt to a custom group's definition