Chat now with support
Chat with Support

Identity Manager 8.1 - Configuration Guide

About this guide One Identity Manager software architecture Customizing the One Identity Manager default configuration Adjusting the One Identity Manager base configuration One Identity Manager schema basics Editing the user interface
Object definitions for the user interface User interface navigation Forms for the user interface Statistics in One Identity Manager Extending the Launchpad Task definitions for the user interface Applications for configuring the user interface Icons and images for configuring the user interface Using predefined database queries
Localization in One Identity Manager Process orchestration in One Identity Manager
Setting up Job servers in Designer Configuring the One Identity Manager Service Handling processes in One Identity Manager
Tracking changes with process monitoring Conditional compilation using preprocessor conditions Scripts in One Identity Manager Reports in One Identity Manager Adding custom tables or columns to the One Identity Manager schema Web service integration SOAP Web Service One Identity Manager as SPML provisioning service provider Processing DBQueue tasks Appendix: Configuration files of the One Identity Manager Service

Report parameters

A report can contain several parameters that are determined when the report is created or when an email notification is generated and passed to the report. The generated report is then displayed or send by email to the subscriber corresponding to the report subscription set up. The user can query the report parameters before the report is displayed. This means, you can, for example, limit the time period or pass specific departments for displaying the report.

Report parameters are grouped internally into parameter sets. A separate parameter set is automatically created for very report, every subscribable report, and every report subscription. The parameters and their settings are passed down in the sequence report->subscribable report->report subscriptions.

Figure 36: Report Parameter Inheritance

You can configure report parameters at several places.

Parameters for reports

Define the report parameters to use when you create the report in the Report Editor. This is where you specify which report parameters are viewable or writable and which are already predefined in a subscribable report.

Parameters for subscribable reports

When you add a subscribable report viewable parameters are displayed in the Manager. You can make further changes to these report parameters assuming they can be overwritten. That means, you specify which report parameters can be viewed or overwritten by Web Portal users and define parameter values.

Parameters for report subscriptions

Report parameters labeled as viewable and editable in subscribable reports, are shown to Web Portal users when they are setting up their personal report subscriptions. If the report parameters are editable, Web Portal users can modify the values in them.

NOTE: You must define all report parameters in the report that are to be available to users, for example, when the report is displayed, when subscribable reports are generated in the Manager or in Web Portal report subscriptions.

Detailed information about this topic

Editing report parameters

To edit report parameters

  1. Open the report in the Report Editor.
  2. Select the Parameters tab in the properties dialog box.
  3. Select the report parameter from Defined queries.

    - OR -

    Click Add.

    Creates a new report parameter.

  4. Edit the report parameter properties.

To delete a report parameter

  1. Open the report in the Report Editor.
  2. Select the Parameters tab in the properties dialog box.
  3. Select the report parameter from Defined queries.
  4. Click Delete.
Related Topics

General parameter settings

To edit general parameter settings

  1. Open the report in the Report Editor.
  2. Select the Parameters tab in the properties dialog box.
  3. In the Defined parameters list, select the report parameter and then the General tab.
Property Meaning
Parameter name

Name of the parameter.

NOTE: The name must agree with the name of the parameter in the data query.

Parameter type

Type of parameter. The following are available:

Fixed Fixed parameter values are used.
User prompt The user must select a parameter value through a user prompt.
Calculation The parameter value is calculates at runtime when the report is created.

Other settings are shown or hidden depending on the type.

Display name User-friendly name for the report parameter Translate the given text using the button.
Description Detailed description of the report parameter Translate the given text using the button.
Sort order Position of the report parameter in the subscribable report view and in the Web Portal.
Mandatory parameter You must enter value in this report parameter.
Viewable Specifies whether the report parameters is displayed.
Can be overwritten Specifies whether the report parameter can be overwritten.
Related Topics

Defining the parameter values

Specify the parameter value and define the parameter value characteristics. Other input is shown or hidden depending on the parameter definition values.

To edit parameter definitions

  1. Open the report in the Report Editor.
  2. Select the Parameters tab in the properties dialog box.
  3. In the Defined parameters list, select the report parameter and then the Value definition tab.

NOTE: The Parameter value and Default value are affected by the parameter value definition. On the one hand, you can see this through dynamic customization of the controls for selecting a parameter value, or on the other hand, through the default value and the dynamic customization of the selectable values themselves. It is therefore recommended that you edit these values last.

Table 179: Value definition properties
Property Meaning
Data type Data type for the report parameter.
Value range

Specifies whether the report parameter value has to be within a given range.

If Yes, the input fields Parameter value (from), Parameter value (to) and Default value (from), Default value (to) are displayed.

Multivalue

The report parameter can have multiple values. You can select more than one value.

Multiline

The report parameter can have more than one line, which means that line breaks are allowed.

Data source Type of data source. You can select the values None, Table, List of permitted values.
Table column (query) (Only for data source Table) Table column for selecting the value You can select a value from this table column. You can select several values from this column if the report parameter is multi-value, as well.
Display template

The display template for displaying table entries in the administration tool result lists are displayed. If a customer specific display template exists it is used instead of the default display template.

Syntax: %column name%

Condition (query)

(Only for data source Table) Limiting condition (WHERE clause) for selecting the value through a table column. You can select a value from the result set. You can select several values from this set if the report parameter is multi-value, as well.

You can reference other report parameters in the condition using the following syntax:

$PC(<Parametername>)$

Example:

UID_Database = $PC(UID)$

where UID is the name of the referenced report parameter.

List of permitted values (Only for data source List of permitted values) Lists the permitted values in this report parameter in the notation value=description. If no = is specified, the entry counts as a value and description.
Overwrite empty value Specified whether an empty report parameter overwrites the default value.
Example value The example value is used to create a report preview.
Default value Report parameter default value. This is used, for example, if the Web Portal user does not specify a parameter value.
Related Topics
Related Documents