Include Prompt Values in a Report

Aside from static reports that always return the same criteria each time they are run, more dynamic reports can also be created that will prompt the user to enter specific criteria values upon running the report. Report owners can set at least one of the report's criteria to different types of prompts, such as selecting an action, a user or role, and a date to determine when a particular action or event occurred.

To include a prompt in the report run criteria, choose the Prompt option when defining criteria that provide the option in a drop-down.

Note

Entering a question mark (?) will often auto-populate the prompt syntax for that particular parameter type.

RapidIdentity will automatically insert the appropriate prompt field syntax for that criteria definition in the report criteria field.

Note

You can change the suggested text to appear on the Prompt's label by modifying the text between the first two | characters.

Now, when the report is run, a sidebar will appear requesting information in order to run the report based on this prompt value definition.

With these values defined, Run the report. You can also Save the report to use again later if desired.

Prompt Parameter Types

The possible types of prompt parameters are as follows:

Note

The parameter types are case-sensitive. For example, RapidIdentity will not acknowledge Date as DATE. These can be entered manually in formats such as action.displayName = %Prompt|Action|LIST|% or by using the Prompt drop-down option when applicable.

• LIST - RapidIdentity provides a list of possible choices for the user to select from

• USER - Enter the name of a user or role

• LDAP - Enter an LDAP attribute to use for the report query

• DATE - Select a date range or individual date

• CHOOSER - Enter a value for RapidIdentity to search against

• NONE - No pre-determined format for this parameter value. The user would be required to type in a value to be used for the report query

Prompt Parameters

To define a parameter that will prompt the user for criteria values, use the autocomplete function to choose which parameter will require a prompted value and the expression by which to qualify it. Then enter a ? to automatically populate a prompt value for that field type.

For example, to add a date range by which to search for a certain argument in a report, begin with the timestamp parameter.

1. Enter timestamp and, as this will be the beginning of the date range to search, use >.

2. Type ? to automatically populate the recommended value for that field type. Note the structure: Prompt|Date Occurred (Begin)|Date%. The Date Occurred (Begin) label was determined by the possible values available with a timestamp > query, and the Date element represents the type of prompt the user will be presented with when the report is run.

3. Finish the range argument by adding AND timestamp > ? to pull Prompt|Date Occurred (End)|Date%, which will prompt the user for the end of the date range. Add the rest of the argument for the report.

4. To test the report, click Run Report. RapidIdentity provides a field with a suggestion of time ranges, or the user can choose Custom to select an exact date from a calendar picker.