Asking for User Input into a Filter Definition

You can allow the user who executes a filtered report to select certain aspects of the filter's definition. This lets each individual user define the report results they see. To do this, you include a prompt in the filter's definition.

You can add an existing prompt, or you can create a embedded prompt. An embedded prompt is created when you define a report, filter, or custom group. These embedded filters are saved with the definition of the report, filter, or custom group, and therefore cannot be used on any other object. You can use a prompt in:

• Attribute qualifications. Attribute qualifications filter on an attribute's form (ID, description, and so on) or on elements of the attribute. When you create an attribute qualification, you can allow a user to:

  • Type the value to compare an attribute form to. For example, a filter on the Region attribute's description form can contain a value prompt. When the report is run, the user types a region's name to answer the prompt. For steps, see Attribute Form Qualification.
  • Create the qualification, by selecting the attribute forms to qualify on, the operator, and the value or attribute elements to compare to. For example, a filter on the Region attribute can contain a qualification prompt. When the report is run, the user can select the description form, the Equals operator, and a region name to answer the prompt. For steps, see Attribute Form Qualification.
  • Select an attribute from a list of hierarchies. The user can then select the elements to filter for, or can create a qualification on an attribute form. For example, a filter contains a hierarchy prompt. When the report is run, the prompt displays all the hierarchies in the project. The user can select the Region attribute, the description form, and a value to compare it to. For steps, see Filtering data based on attribute forms: Attribute form qualification.
  • Select from a list of attribute elements. For example, a filter on the Region attribute can contain an element prompt, which lists all the regions when the report is run. For steps, see Attribute Element List Qualification.

• Metric qualifications. Metric qualifications create a set of attributes based on the metrics associated with those attributes. When you create a metric qualification, you can allow a user to:

  • Type the value to compare the metric value to. For example, a filter on the Revenue metric can contain a value prompt. When the report is run, the user types a value to answer the prompt. For steps, see Metric Set Qualification.
  • Create the qualification, by selecting the metric, the operator, and the metric value to compare to. For example, a filter on the Revenue metric can contain a qualification prompt. When the report is run, the user can select the Greater Than Operator and type a value to answer the prompt. For steps, see Metric Set Qualification.
• Shortcut-to-a-report qualifications, which use the results of one report as a filter inside another report. You can add a prompt to allow a user to select from a list of reports. For steps, see Shortcut-to-a-Report Qualification.
• Shortcut-to-a-filter qualifications, which use an existing filter, either as is or with additional conditions, on a report. You can add a prompt to allow a user to select from a list of filters. For steps, see Shortcut-to-a-Filter Qualification.

For background information on prompts, including examples, steps to create them, and a more detailed description of embedded vs. stand-alone prompts, see About Prompts.