Form properties are specified by the form definition configuration data. The definition of the form properties is written in XML notation.
<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>
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"/> |
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.
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> |
There is a special control element for displaying the overview form in the user interface. The information to be displayed on the overview form is configured with menu items. The menu items are represented as form elements that are linked to each other on the overview form. A hierarchical structure of menu items is also included in the interface configuration.
The basis is formed by a menu item with the Main form element item type. This menu item specifies the main element on the overview form. An interface form that links to this menu item has to configured in order for it to be displayed in the application. The main form element is always displayed in the middle of the overview form.
The other menu item such as fixed, data-dependent, link or statistic menu items are configured under the menu item for the main form element. These menu items are grouped around the main form element on the overview form as additional form elements.
The color and positioning of the form elements on the overview as well as the properties that are shown, are specified by layout information for the menu items.
Figure 17: Example of Elements in an Overview Form
The display text of the menu item, the display text for the objects to be shown and the menu item icon are displayed in the header of a form element. Other data represents the object properties and values. There is a tooltip for each property showing a description for use. Some form element entries are highlighted in color when you click on them with the mouse. You can jump to the referenced object by clicking on the entry with the mouse.
If the form element is used for mapping lists, the items are displayed with their names.The number of items is shown in the form element header. There is an icon in the header for showing and hiding the items. There is an icon in the header for showing and hiding the items. There is no tooltip for list items.
Icon | Meaning |
---|---|
Show list items. | |
Hide list items. |
|
NOTE: Objects marker for deletion are struck through on the overview form. |
The Overview Form Editor helps you to create overview forms. The Overview Form Editor performs the following steps to create the overview form.
Figure 18: Design View in the Overview Form Editor
To create a new overview form
Property | Meaning | ||
---|---|---|---|
Menu item | Name of the menu item You should assign descriptive names here if possible. These are then propagated in the child structures. | ||
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 | ||
Object | Object definition for which the form should be displayed. | ||
Parent menu item | Parent menu item for grouping together the overview forms; usually a menu category. | ||
product assignment | Application in which the form will be shown. | ||
Group assignment | Permissions group for which the form will be shown. | ||
Display columns |
Columns to be displayed on the main form element.
|
This displays the overview form design in the Overview Form Editor. You can continue editing the overview form.
To add more form elements to the overview form
Select User interface | Forms | Overview forms in Designer.
Select the view Object relations.
All the object foreign key relations (FK), object child relations (CR), and object member relations (M:N) are displayed.
Create list element reference: A menu item is created with the Link item type and a reference to a menu item for display as a list.
The menu item’s master data is automatically generated by the Overview Form Editor. The form element is display in the Overview Form Editor's design view.
The following special features apply when you create form elements using the Create list element reference and Create reference to data element context menus.
|
TIP: Use the Create element context menu to create more menu items, links or statistics as form elements in the design view of the Overview Form Editor. In this case, enter the master data for the menu item, link or statistics manually. |
© 2021 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy