Chat now with support
Chat with Support

Identity Manager 9.2.1 - Configuration Guide

About this guide One Identity Manager software architecture Customizing the One Identity Manager default configuration Customizing the One Identity Manager base configuration One Identity Manager schema basics
Overview of the One Identity Manager schema Table types and default columns in the One Identity Manager data model Notes on editing table definitions and column definitions Table definitions Column definitions Table relations Dynamic foreign key Supporting file groups
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
Mapping processes in One Identity Manager Setting up Job servers
The One Identity Manager Service functionality Tracking changes with process monitoring Conditional compilation using preprocessor conditions Scripts in One Identity Manager
Visual Basic .NET scripts usage Notes on message output Notes on using date values Tips for using PowerShell scripts Using dollar ($) notation Using base objects Calling functions Pre-scripts for use in processes and process steps Using session services Using #LD notation Script library Support for processing scripts in the Script Editor Creating and editing scripts in the Script Editor Copying scripts in the Script Editor Testing scripts in the Script Editor Testing script compilation in the Script Editor Overriding scripts Permissions for running scripts Editing and testing script code with the System Debugger Extended debugging in the Object Browser
One Identity Manager query language Reports in One Identity Manager Adding custom tables or columns to the One Identity Manager schema Web service integration One Identity Manager as SCIM 2.0 service provider Processing DBQueue tasks One Identity Manager Service configuration files

Editing report parameters

You can edit existing report parameters or create new ones. This is where you specify which report parameters are viewable or writable and which are already predefined in a subscribable report.

To edit report parameters

  1. In the Report Editor, select the report in the report list and then Edit properties from the context menu.

    This opens the property dialog.

  2. Select the Parameters tab in the properties dialog.

  3. Select the report parameter from Defined queries.

    - OR -

    Click Add.

    Creates a new report parameter.

  4. Edit the report parameter properties.

    • On the General tab, enter the main properties of the parameter.

    • On the Value definition tab, set the parameter value and define how the parameter value looks. Other input is shown or hidden depending on the parameter definition values.

    • On the Value calculation tab, edit the following settings for calculating parameter values.

  5. Save the changes.

To delete a report parameter

  1. In the Report Editor, select the report in the report list and then Edit properties from the context menu.

    This opens the property dialog.

  2. Select the Parameters tab in the properties dialog.

  3. Select the report parameter from Defined queries.

  4. Click Delete.

  5. Save the changes.

Related topics

General parameter settings

Enter the following settings for the parameter.

Table 162: General parameter settings
Property Description

Parameter name

Parameter name.

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

Parameter type

Type of parameter. Permitted values are:

  • Fixed: Fixed parameter values are used. On the Value definition tab, enter the parameter value.

  • User prompt: The user must select a parameter value in the user prompt at runtime.

  • Calculation: The parameter value is calculated at runtime when the report is created. On the Value calculation tab, enter the table column and the condition for calculating the value.

Other settings are shown or hidden depending on the type.

Display name

User friendly name for the parameter. To display language dependent display names, translate the given text with the button.

Description

Text field for additional explanation.Translate the given text with the button.

Sort order

Position of the parameter in the subscribable report view and in the Web Portal.

Mandatory parameter

Specifies whether this is a mandatory parameter. You must give a value for a mandatory parameter.

Viewable

Specifies whether the parameter is shown when a report subscription is set up in the Web Portal.

Can be overwritten

Specifies whether the parameter can be overwritten by Web Portal users when a report subscription is created.

Related topics

Parameter value definitions

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

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 163: Value definition

Property

Description

Data type

Parameter data type.

Date add-on

Additional information about calculating date and time data for displaying in the user interface. The value can be edited if the Date data type is selected.

Value range

Specifies whether the report parameter value has to be within a given range. If Yes, additional fields appear.

Multivalue

Specifies whether the parameter accepts multiple values. If Yes, users can select multiple value from a list.

Multiline

Specifies whether the parameter contents can have multiple lines. If Yes, line breaks are permitted.

Data source

Type of data source. Permitted values are:

  • None: The user can give any value.

  • Table: The user selects a value from a specified table column.

  • List of permitted values: The user selects a value from a predefined list.

You may require additional data depending on the data source.

Table column (query)

Additional data for the data source Table.

Table column for selecting the parameter value. The user can select a value from this table column. If the parameter is multi-value, you can select several values from this column as well.

Display pattern

Additional data for the data source Table.

Display pattern for table elements in lists in %column% notation. The ?? operator is permitted. This means, when one column's value is empty, another column's value is displayed.

Example: %column1??column2??column3%

Type of display

Specifies how data for the value query is displayed. For example, data from a hierarchical table can be displayed either hierarchically or in a list without a hierarchy.

Permitted values are:

  • Hierarchical: (Default) The data is displayed hierarchically.

  • List: The data is displayed in a list.

  • Inherited: The setting is inherited.

Condition (query)

Additional data for the data source Table.

Limiting condition (Where clause) for selecting the parameter value using a table column. The user can select a value from the result set. If the parameter is multi-value, you can select several values from this result set as well.

You can reference other 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

Additional data for the data source List of permitted values.

List of values permitted in this parameter in the value=display name notation. If an = is no given, the entry counts as both value and display name.

Example: 1=internal 2=external

To display language dependent display names, translate each display name using the button.

Overwrite empty value

Specifies whether an empty parameter value overwrites the default value.

If this option is disabled, the default value is overwritten if a parameter value is not given.

Example value

Example of the parameter. The example value is used to create a report preview.

If a value range is given, the Example value (from) and the Example value (to) are displayed.

Default value

Default value of the parameter. This is used if the user does not specify a parameter value and the Overwrite empty value option is not set.

If a value range is given, the Default value (from) and the Default value (to) are displayed.

Related topics

Settings for calculating values

Edit the following settings for calculating parameter values.

Table 164: Scripts for calculating values

Property

Description

Table column (calc.)

Additional input for Calculated parameter type.

Table column for selecting the parameter value. The parameter value is determined at runtime when the report is created.

Condition (calc.)

Additional input for Calculated parameter type.

Limiting condition (where clause) for selecting the value through a table column. The parameter value is determined at runtime when the report is created. If the parameter is multivalue as well, several values may be found.

If a condition is not given and the parameter is not multivalue, the first value is used that is determined by the table column. If the parameter is multivalue and a condition is not given, all determined values are used.

Valuation script

Script in VB.Net syntax for modifying the parameter value. The script can be used as a formatting script and the existing parameter value modified or reset the parameter value.

Validation script

Script in VB.Net syntax for checking permitted values of parameters. Create a script that checks the user input.

Data dependencies script

Script in VB.Net syntax. The script allows parameter settings to be configured depending on the data. It is run during initialization and when values are changed. For example, the script can be used to dynamically determine whether a parameter is read-only or mandatory.

Example:

The P2 parameter should be a mandatory field when the P1 parameter has the value Mandatory field. The following script must be stored with the P1 parameter:

ParameterSet("P2").IsMandatory = (Value IsNot Nothing AndAlso Value.ToString() = "Mandatory")

Tips for handling scripts internally

The parameter's script properties always generate a script with the notation:

public void OnPropertyChanged_<UID parameter>(DialogParameterSet ParameterSet, DialogParameter Parameter)

{ ... }

public void Valid_<UID parameter>(DialogParameterSet ParameterSet, DialogParameter Parameter)

{ ... }

public void Valid_<UID parameter>(DialogParameterSet ParameterSet, DialogParameter Parameter)

{ ... }

The current value of the parameter is passed on the Value member variables and the parameter itself on the Entity variable. DialogParameterSet and DialogParameter are passed as arguments to the method. These are not the entities but the parameter classes from the VI.DB.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating