Chat now with support
Chat with Support

Identity Manager 8.0 - Configuration Guide

One Identity Manager Software Architecture Working with the Designer Customizing the One Identity Manager Default Configuration Checking Data Consistency Compiling a One Identity Manager Database Working with Change Labels Basic System Configuration Data
One Identity Manager Authentication Module Database Connection Data Configuration Parameters for System Configuration Setting up the Mail Notification System Enabling More Languages for Displaying and Maintaining Data Displaying Country Information Setting Up and Configuring Schedules Password Policies in One Identity Manager Reloading Changes Dynamically TimeTrace Databases Machine Roles and Server Functions Files for Software Update Operating Systems in Use System Configuration Reports Using Predefined Database Queries Managing Custom Database Objects within a Database
The One Identity Manager Data Model Granting One Identity Manager Schema Permissions Working with the User Interface
Object definitions for the User Interface User Interface Navigation Forms for the User Interface Statistics in the 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 Language Dependent Data Representation
Process Orchestration in One Identity Manager
Declaring the Job Server One Identity Manager Service Configuration Handling Processes in the One Identity Manager
Tracking Changes with Process Monitoring Conditional Compilation using Preprocessor Conditions One Identity Manager Scripts Maintaining Mail Templates Reports in the One Identity Manager Custom schema extensions Transporting One Identity Manager Schema Customizations Importing Data Web Service Integration SOAP Web Service One Identity Manager as SPML Provisioning Service Provider Searching for Errors in the One Identity Manager Processing DBQueue Tasks One Identity Manager Configuration Files

Forms for Custom Extensions

One Identity Manager provides a set of form templates and definitions in the default installation. These can be used for easily creating your own forms.

An other way to create custom forms is to make custom form archives available. Normally, default forms in One Identity Manager are replaced with self developed forms.

Table 158: Form Templates and Definitions for Custom Extensions
Form Template

Form Definition

Usage

FrmCommonChildRelationGrid

VI_Common_ChildRelation_Grid

For editing many-to-many relations with extended properties in the form of a table.

FrmCommonOneChild
AndMemberRelation

FrmCommonOneMember AndChildRelation

A custom form must be created on which the data to be configured is displayed.

Assigns many-to-many relations and object relations (parent/child relations) on one form. Two tabs for displaying the data are shown on the form.

FrmCommonOneChildRelation

A custom form must be created on which the data to be configured is displayed.

Mapping object relations (Parent/ChildRelation).

If several objects relations are represented on a form, the form templates "FrmCommonTwoChildRelation", "FrmCommonThreeChildRelation" can be used instead. One tab is shown per object relation.

FrmCommonOneDynamicRelation

A custom form must be created on which the data to be configured is displayed.

Displays dynamic many-to-many relations whose assigned object is referenced through a dynamic Permitted dynamic objects are found in the table DialogValidDynamicRef. A menu is provided for choosing the object type.

FrmCommonOneGenericRelation

A custom form must be created on which the data to be configured is displayed.

Displaying dynamic many-to-many relations.

  • Base object can be referenced through a dynamic key

    - OR -

  • Assigned object is referenced through a dynamic key. In this case, the property "MembersTableName" is defined in the form configuration.

FrmCommonOneMemberRelation

A custom form must be created on which the data to be configured is displayed.

Assigning many-to-many relations.

If several many-to-many relations are represented on a form, the form templates "FrmCommonTwoMemberRelation", "FrmCommonFourMemberRelation", "FrmCommonFiveMemberRelation" can be used instead. On tab is shown per many-to-many table.

FrmElementNavigation

VI_ElementNavigation

For displaying the overview form.

frmGeneric

VI_Generic_MasterData

For editing object master data.

ReportForm

VI_Report

For displaying reports.

WizardForm

VI_Wizard

For including wizards. The forms are displayed in a modal dialog window.

Detailed information about this topic

Custom Master Data Forms

Displaying Columns in Custom Tables

To display custom database table in the administration tool user interfaces and edit the master data:

  • Create a user interface form with the form definition "VI_Generic_MasterData". This form definition allocates the control element for editing master data in the user interface.
  • Change the order of the input fields on the form using the sort order of the database columns. Columns with a sort order of less that one are not displayed.
  • Achieve a better overview of the input fields by grouping database columns. Each group has its own tab. The name of the tag corresponds to the group.
  • Columns whose data contents can be multiline are displayed in a multiline field on the generic form. Label these columns as multiline.
Displaying Custom Columns in Predefined Tables

Separate tabs can be shown for custom column extensions to default tables on the predefined master data forms. The points listed above apply to predefined master data forms using the form definition "VI_Generic_MasterData".

Otherwise the following prerequisites are required for using this functionality:

  • Master data form already has tabs. Simple master data forms without tabs are not extended.
  • Change the order of the input fields on the form using the sort order of the database columns. Columns with a sort order of less that one are not displayed.
  • Database columns are grouped. Each group has its own tab. The name of the tag corresponds to the group. If no group is given, a tab is shown with the name "Custom".
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 form properties is written in XML notation.

Example of the Configuration Data Structure

<DialogFormDefinition FormatVersion="1.0">

<ComponentDefinitions>

<ComponentDefinition Name="TabPage1" Type="VI.Components.TabPage">

<Properties>

<Property Name="Caption" Value="Department"/>

<Property Name="CaptionTranslationSource" Value="DatabaseSchema" />

</Properties>

</ComponentDefinition>

...

<ComponentDefinition Name="MemberRelation1" Type="VI.Components.MemberRelation">

<Properties>

<Property Name="DisplayPattern" Value="" />

<Property Name="MNBaseColumnName" Value="UID_ADSGroup" IsMandatory="True" />

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

...

</Properties>

</ComponentDefinition>

...

</ComponentDefinitions>

</DialogFormDefinition>

Displaying Relations
Table 159: 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" />

 

DisplayPattern

Display pattern for finding the display value of the element. Default is the table display template.

Example

<Property Name="DisplayPattern" Value="%cn% %info%" />

  DisplayFlatPattern

Special display pattern used for displaying a form's lists with a flat design. Flat displaying is used if there is no hierarchy or the list limit is used. Default is DisplayPattern.

Example

<Property Name="DisplayFlatPattern" Value="%cn% %info%" />

  RootNodeCaption

Root node caption. The default is taken from the schema.

  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

<ComponentDefinition Name="MemberRelation1" Type="VI.Components.MemberRelation">

  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%'" />

ChildRelation1- ChildRelationN  

Displaying parent-child relations.

Example

<ComponentDefinition Name="ChildRelation1" Type="VI.Components.MemberRelation">

  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

<ComponentDefinition Name="GenericRelation1" Type="VI.Components.MemberRelation">

  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 with several relations to display, for example, "FrmCommonTwoMemberRelation" or "FrmCommonTwoChildRelation".. TabPage1 maps the tab for Relation1, TabePage2 maps the tab for Relation2.

Table 160: Properties of Tab Definitions
Component Property Meaning
TabPage1-TabPageN

 

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

Example

<ComponentDefinition Name="TabPage1" Type="VI.Components.TabPage">

 

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

Replacing Default Forms with Custom Forms

Self developed form templates can be provided for custom forms in a form archive (*CustomForms.*.vif). You need to add the form template, form definition and interface form with help of the Form Editor if you want to display your custom forms in the user interface.

A wizard is available to swap a default form with all its dependencies for a custom form. The wizard creates the interface form with the form definition and the form template. The properties of the new form are taken from the form it is replacing. The necessary assignments (object definition, menu item, permissions group and application) are created for the new form and the replaced form is disabled.

To replace custom forms with all dependencies

  1. Select User Interface | Forms | User interface forms in the Designer.
  2. Select hierarchical representation of the form overview. Set the menu option Options | Tree/list view to do this.
  3. Select the form template of the form to replace in the top layer of the hierarchy in the form overview and start the wizard from the context menu Replace by....
  4. Click Next.
  5. Select the form archive (*.CustomForms.*.vif) and the form template for the new interface form.
  6. Click Next.
  7. Check the names of the form definition and the user interface form.

    The names that are suggested are made up from the customer prefix and the name of the form being replaced. Use F2 to change the name and the enter button to accept the changes.

  8. Click Next.
  9. Select the permissions group to which to assign the new interface form. Use the button to create a new permissions group.
  10. Click Next.
  11. The settings for form replacement are summarized. To replace the form, click Finish.

    The wizard is closed after replacement is complete. The new form is displayed in the Form Editor form overview after the wizard is complete and you can continue editing it. The replaced form is disabled and can therefore no longer available in the user interface.

Related Topics
Related Documents