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

User interface form properties

Table 43: User interface form properties
Property Meaning

Form name

The form name is used to quickly select interface forms, for example, in the Designer.

TIP: The form name is displayed in the administration tool as extra navigation information.

Form definition

Form definition linked to the user interface form.

NOTE: Use next to the input field to link in a new form definition for the interface form.

Caption

Caption shown on the user interface form. The caption is used to represent the user interface form in the task view and in the form context menu of the user interface. Translate the given text using the button.

Online help link

The form's help key for navigating to the relevant chapter in the online help.

Description

Detailed description of the user interface form.

TIP: The description is shown as a tooltip in the task view.

Icon

Icon marks the user interface form in the user interface.

Sort order

The sort order determines the position of the interface form in the task view and in the form’s context menu in the administration tools.

NOTE: When you enter objects in the Manager, the user interface form of the Edit form type is always displayed with the lowest sort order.

Preprocessor condition

User interface forms can be given a preprocessor condition. This means that an interface form is only available when the preprocessor condition is fulfilled.

NOTE: In the Designer, you can find an overview of existing preprocessor dependencies in the One Identity Manager Schema > Preprocessor dependencies category.

Control deactivation

Specifies which buttons in the toolbar are to be disabled in the front-ends

Permitted values are:

  • Insert object: The button is disabled.

  • Update object: The button is disabled.

  • Delete Object: The button is disabled.

  • Commit to database: The button is disabled

Deactivated

Use this option to label interface forms that should not be shown in the user interface.

NOTE: This change is also permitted for user interface forms in the default user interface and is not overwritten on schema installation.

Disabled by preprocessor

If an object definition is excluded through a preprocessor condition, this option is set by the Database Compiler.

Show modal

Specifies whether the form is displayed in a separate dialog. Used by wizards for entering data.

Open on new tab

The form is opened on a new tab.

Configuration

The configuration is used to limit the tables and columns on display. Templates for the configuration data definition are found in the pop-up list XML templates.

In the Properties section, you can transfer special properties of the form that were implemented during form development. For example, the report name and special report parameters can be passed to the report interface form by using this section.

Insert values

Insert values are only of relevance to interface forms of the Edit form type. With them you can specify the default values for the columns that are assigned when a new object is added. The input is in VB.Net syntax.

Related topics

Form definitions and form templates

Form definitions and form templates make up the basis of interface form design. Form definitions contain information about the data that will appear on the forms such as, tables, and columns as well as titles for form tabs and root nodes in hierarchically ordered elements (ChildRelationControl, membership tree) for the form templates defined in the form archives.

Detailed information about this topic

Form templates

You can find all the form templates in the Designer in the User interface > Forms > Form templates category. It is not usually necessary to define your own form templates.

To display a form template for a user interface form

  1. In the Designer, select the User interface > Forms > User interface forms category.

  2. Select the user interface form in the Form Editor.

  3. In the edit view, in Properties, select the Form template tab.

Table 44: Form template properties
Property Meaning

Form source type

Source of the form template.

Permitted values are:

  • Form: For displaying a form from a form archive.

  • Assembly: For displaying controls. It is not necessary to build a form, because the control is displayed directly as form.

Assembly name

Name of the assembly file.

Class

Full type name of the control.

Form template name

The form template name is necessary for loading the form template from the form archive.

TIP: The form template name is shown in the administration tools as additional navigation information.

Form archive

Name of the form archive (Forms.*.dll), containing the form template.

Description

Detailed description of the form template.

Alternative form template

It might be necessary to use different form templates of display the interface form, for example, to show an the One Identity Manager web interface or in an administration tool.

The form templates can be linked in order to avoid adding a form definition and an interface form for each form template. For this, you need to assign an alternative form template to the form template. This alternative form template is used when the conditions for displaying the original template are not fulfilled. The form template referenced is determined in order to display the interface form. The form template given in the form definition is checked for existence in the form archive and to see if it labeled for the correct display purposes. If these conditions are not fulfilled then the alternative form template is tested for suitability. The form template that fulfills the conditions is used for the user interface display.

Form type

Type of form.

Enabled for

Specifies the intended use of the form template. Permitted values are:

  • Visible in graphical interface

  • Visible in web applications

  • TimeTrace supported

  • Multiobject editing possible

  • Deferred operation possible

  • Application server not supported

Table 45: Form types and their usage
Form type Usage

Info (I)

Forms of the Info type are only used to display information. Changes to data on these forms cannot be saved. These forms automatically omitted by the automatic form selection in quick edit mode.

Edit (E)

Forms of the Edit type are used to edit data. This is the first form to be loaded by the automatic form selection in quick edit mode.

Grid (G)

Forms of the Grid type are used to display data in tabular form.

MemberRelation (M)

Forms of the MemberRelation type are used to display the data in an assignment list (many-to-many relations).

Report (R)

Forms of the Report type are used to display data in a report form.

Virtual (V)

Forms of the Virtual type are not available in the forms menu. This form type is used to show editors in the Designer.

Wizard (W)

Forms of the Wizard type are used to enter data by means of a wizard. The forms are displayed in a modal dialog window.

Designer properties (P)

Form of the Designer properties type are used to edit data in the Designer.

Related topics

Form definitions

You can find form definitions in the Designer in the User interface > Forms > Form definitions category. It is not normally necessary to define your own form definitions.

To display a form template for a user interface form

  1. In the Designer, select the User interface > Forms > User interface forms category.

  2. In the Form Editor, select the user interface form.

  3. In the edit view in Properties, select the Form definition tab.

Table 46: Form definition properties
Property Meaning

Form definition name

Name of the form definition. This name is used for displaying the form definition in the Designer.

Form template

Name of the form template to load from the form archive. A form template can be used by several form definitions, such as the form templates for displaying membership trees or the form template for displaying reports. Use the button next to the input field to integrate a new form template in the form definition.

Base form for form sequence

By entering a form definition as a base for a sequence of forms, you can create a group of form definitions for one object definition. All form sequence form definitions contain the same base form. The definition of the interface form can only be made for this base form. When the interface form is loaded in the display, the referenced form definitions for all other form definitions in the form sequence are also loaded. You can navigate arbitrarily within the form sequence without leaving the scope of the interface form.

Description

Detailed description of the form.

Configuration

The configuration data is used to describe the form properties. The definition of the form properties is written in XML notation.

Required tables

A form definition can be assigned additional tables that are used to display data.

NOTE: If one of the given tables is disabled by a preprocessor condition then the form definition is also considered to be disabled and the corresponding interface form is not shown in the user interface.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating