Chat now with support
Chat with Support

Identity Manager 9.2 - 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 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 Windows 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

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

Configuration data for displaying many-to-many and object relations on forms

Form properties are specified by the form definition configuration data. The definition of the form properties is written in XML notation.

Recommendations regarding XML notation.

  • Pass multiple line values in one element.

    Example:

    <Property Name="WhereClause">IsITShopOnly=0 and HasReadOnlyMemberships=0</Property>

  • Describe single values in an attribute.

    Example:

    <Property Name="MNTableName" Value="DepartmentHasADSGroup" />

  • To avoid masking XML special characters (<,>,&,",'), pass the value in a CData element.

    Example:

    <Property Name="WhereClause"><![CDATA[UID_UNSGroupB3 <> $UID_UNSGroupB3$]]></Property>

Example: Configuration data structure

<FormPatch FormatVersion="2.0">

<Patches>

<Component Name="MemberRelation1">

<Properties>

<Property Name="MNBaseColumnName" Value="UID_Department" />

<Property Name="MNTableName" Value="DepartmentHasADSGroup" />

<Property Name="RootFilterTableName" Value="ADSDomain" />

<Property Name="RootFilterMemberWhereClause">UID_ADSDomain='%UID_ADSDomain%'</Property>

<Property Name="WhereClause">IsITShopOnly=0 and HasReadOnlyMemberships=0</Property>

</Properties>

</Component>

<Patches>

</FormPatch>

Displaying relations
Table 47: Properties of relation definitions
Component Property Meaning

All

 

Valid for all maps.

 

WhereClause

Limited condition for applying to the displayed objects (member, child).

The expression %column% can be used in the WhereClause to reference values of the base object.

$ expressions are permitted to reach other values from the base object, for example $FK(UID_ADSContainer).UID_ADSDomain$.

Example:

<Property name="WhereClause" value="IsITShopOnly=0" />

 

EditWhereClause

Edit condition. The elements that match the condition can be edited. All other elements are also displayed but cannot be edited.

Example:

<Property name="EditWhereClause" value="XMarkedForDeletion=0" />

MemberRelation1-MemberRelationN

 

Displaying M:N relations

Example:

<Component Name="MemberRelation1">

 

MNTableName

M:N table.

Example:

<Property name="MNTableName" value="OrgHasADSGroup" />

 

MNBaseColumnName

Column of the M:N table that points to the base object.

Example:

<Property name="MNBaseColumnName" value="UID_ADSGroup" />

 

RootFilterTableName

Table for filtering assignable elements from users. If defined, the control element shows a menu with objects from this table. If, for example,

Example:

<Property name="RootFilterTableName" Type="String" value="OrgRoot" />

 

RootFilterWhereClause

Condition for filtering elements of the RootFilterTableName in the menu.

Example:

<Property name="RootFilterWhereClause" Type="String" value="UID_OrgRoot in (select UID_OrgRoot from Org) and exists (select 1 from OrgRootAssign where IsDirectAssignmentAllowed = 1 and UID_OrgRoot=OrgRoot.UID_OrgRoot and UID_BaseTreeAssign='ADS-AsgnBT-ADSGroup')" />

 

RootFilterMemberWhereClause

Condition formatted after selecting a base object and attached to the WhereClause. The condition must always contains a column relation to the base object.

Example:

<Property name="RootFilterMemberWhereClause" Type="String" value="UID_OrgRoot=N'%UID_OrgRoot%'" />

 

ShowExtendedProperties

Specifies whether many-to-many tables with additional columns are offered an additional Extended properties context menu item on the assignment form. You use the context menu item to navigate to the detailed form where you can edit the extended properties.

Example:

<Property name="ShowExtendedProperties" value="True" />

 

HierarchyDetailsMode

Specifies whether the long display pattern (DialogTable.DisplayPatternLong) is used for displaying hierarchically.

Example:

<Property name="HierarchyDetailsMode" value="UseDisplayLong"/>

ChildRelation1- ChildRelationN

 

Displaying parent-child relations.

Example:

<Component Name="ChildRelation1">

 

CRTableName

Table in which child objects are mapped.

Example:

<Property name="CRTableName" value="ADSAccount" />

 

CRColumnName

Child table foreign key that points to the base object.

Example:

<Property name="CRColumnName" value="UID_Person" />

 

ShowForeign

Specifies whether foreign assignments (object assigned to another object) can be displayed.

Example:

<Property name="ShowForeign" value="True" />

GenericRelation1-GenericN

 

Displaying dynamic many-to-many relations.

Example:

<Component Name="GenericRelation1">

 

MNTableName

M:N table.

Example

<Property name="MNTableName" value="ADSPolicyAppliesTo"/>

 

MNBaseColumnName

Column of the M:N table that points to the base object.

Example:

<Property name="MNBaseColumnName" value="ObjectKeyAppliesTo" />

 

MNMembersColumnName

Column of the M:N table that points to the members.

Example:

<Property name="MNMembersColumnName" value="UID_ADSPolicy" />

 

MembersTableName

Tables whose objects must be assigned.

Example:

<Property name="MembersTableName" value="ADSPolicy"/>

Using tabs

Use the components TabPage to display tabs for the mapped relations. Usually tabs are used for forms that map multiple relations, such as FrmCommonTwoMemberRelation or FrmCommonTwoChildRelation. TabPage1 maps the tab for Relation1, TabePage2 maps the tab for Relation2.

Table 48: Properties of tab definitions
Component Property Meaning

TabPage1-TabPageN

 

Displays 1-n tabs for each relation to be shown.

Example:

<Component Name="TabPage1">

 

Caption

Tab captions. Table names or any string can be used as captions.

Example:

<Property name="Caption" value="Department"/>

 

CaptionTranslationSource

Source for translating the tab names.

value="DatabaseSchema" finds the table captions translation from the One Identity Manager schema table given under Caption.

value="TranslationAddOnSource" finds the translation from the text store.

Example:

<Properties>

<Property name="Caption" value="Department"/>

<Property name="CaptionTranslationSource" value="DatabaseSchema" />

</Properties>

<Properties>

<Property name="Caption" value="is member of"/>

<Property name="CaptionTranslationSource" value="TranslationAddOnSource" />

</Properties>

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating