Form definitions and form templates make up the basis of interface form design. Form definitions contain information about the data that will appear in the forms, for example, 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 (Forms.*.vif).
About this guide
One Identity Manager software architecture
Working with objects in One Identity Manager
Inserting, modifying, and deleting an object in One Identity Manager
Customizing the One Identity Manager default configuration
Reloading changes dynamically
Locking and unlocking individual properties for editing
System configuration reports
Customizing the One Identity Manager base configuration
Overview of the database settings
Changing database connection data
Database configuration for a test, development, or productive environment
Language settings for displaying and maintaining the data
Default country for determining working hours and public holidays
Configuration parameters for system 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
Editing the user interface
Table types in One Identity Manager
Column definitions
Database views of the View type
Database views of the proxy type
Database views of the Union type
Database views of the Read-only type
Table scripts
Working with a globally unique identifier module
Defining unique columns for tables
Specifying deferred deletion for objects
Editing table definitions
Table definition properties
Displaying the table definition Customizer
Templates for generating values
Table relations
Dynamic foreign key
Supporting file groups
Editing value templates
Preventing a change to a column
Restricting performance of value templates
Example of local value templates within an object
Example of cross-object value templates
Limiting column lengths
Defining decimal places for displaying values
Using predefined formatting types
Creating formatting scripts
Column dependencies for setting values
Permitted column values
Specifying requirements for MVP columns
Defining bitmasks
Configuring columns for full-text search
Scripts for conditionally displaying and editing columns
Editing column definitions
Column definition properties
Object definitions for the user interface
Localization in One Identity Manager
Selection criteria for object definitions
Using the captions for object definitions
Creating and editing object definitions
Object definition properties
User interface navigation
Navigation elements
Recommendations for editing menu navigation
Tips for working with the User Interface Editor
Selecting the user interface navigation view for editing
Forms for the user interface
Loading a complete user interface navigation
Loading menu navigation using an application
Direct loading of menu items
Loading menu items using permissions groups
Loading menu navigation using a where clause
Simulating user interface navigation during editing
Copying existing user interface navigation for new permissions groups
Creating a new user interface navigation
Copying menu items
Creating new menu items
Creating new menu categories
Assigning menu items to applications
Assigning menu items to permissions groups
General menu item properties
Creating database queries for data-dependent menu items
Editing lists
Using links in the navigation
Using variables in the navigation
Recommendations for editing forms
Editing user interface forms
Statistics in One Identity Manager
Tips for working with the Form Editor
Disabling user interface forms
Copying user interface forms
Creating user interface forms
Assigning user interface forms to applications
Assigning user interface forms to permissions groups
Assigning user interface forms to object definitions
Effects of object definitions when displaying interface forms
Assigning user interface forms to menu items
Displaying custom columns and tables on main data forms
Forms for custom extensions
Hierarchical display of data on assignment forms
Replacing default forms with custom forms
User interface form properties
Form definitions and form templates
Working with overview forms
Creating and editing statistic definitions
Disabling statistics definition
Including statistics in the user interface
Diagram types for visualizing statistics
Examples of statistic definitions
Extending the Launchpad
Recommendations for extending the Launchpad
Actions for the Launchpad
Creating new menu items and actions for the Launchpad
Task definitions for the user interface
Creating and editing task definitions
Disabling task definitions
Script for conditional displaying of tasks
Properties of task definitions
Applications for configuring the user interface
Icons and images for configuring the user interface
Using predefined database queries
Working in different time zones
Determining working hours
Editing country information
Process orchestration in One Identity Manager
Setting countries and states
Specifying the standard hours for countries and states/provinces/counties
Displaying public holidays for countries and states
Editing countries
Editing states
Country properties
State properties
Public holiday properties
Language-dependent data representation
Basic rules for using language-dependent data
Flagging columns for translation
Using the text memory for translation
Displaying translations in the Language Editor
Showing usage of a translation
Editing translations of a single table
Editing all translations
Changing translation keys
Importing translations from the language pack
Mapping processes in One Identity Manager
The One Identity Manager Service functionality
Editing processes with the Process Editor
Defining processes
Setting up Job servers
Creating and editing processes
Copying processes
Creating and editing process steps
Copying single process steps
Copying process steps within a process
Searching for entries within processes
Comparing processes
Exporting and importing processes
Process properties
Process step properties
Process step parameters
Events for processes
Permissions for triggering processes
Simulating process generation
Checking the validity of a process
Compiling processes
Using process-specific and global variables for the process definition
Thresholds for handling processes
Specifying the executing server
Notifications about process step handling
Running processes automatically
Displaying process plan status
Starting a process plan immediately
Creating and editing process plans
Process plan properties
Overview of process components
Handling processes with the One Identity Manager Service
Parallel processing of processes by the One Identity Manager Service
Running external processes with the StdioProcessor
Configuring the One Identity Manager Service
Tracking changes with process monitoring
One Identity Manager Service configuration files
Customizing the One Identity Manager Service configuration for a Job server
Template for the configuration file
Selecting module types and editing parameters
Validating the configuration file
Process collection module
Job destination module
Configuration module
Logwriter module
Dispatcher module
Connection module
HTTP authentication module
Module plugins
HTTPLogPlugin
ScheduleCommandPlugin
RequestWatchDogPlugin
PerformanceCounterPlugin
DebugMailPlugin
ShareInfoPlugin
RemoteConnectPlugin
DatabaseAgentPlugin
File module with private key
Basic rules for process monitoring
Logging data changes
Logging process information during process handling
Conditional compilation using preprocessor conditions
Editing process information for processes
Editing process information for process steps
Editing process information for events
Recording messages in the process history
Process tracking for DBQueue Processor operations
Archiving and deleting records
Preprocessor-relevant configuration parameters
Preprocessor conditions in objects
Preprocessor conditions in VB.Net expressions
Evaluation of preprocessor conditions during compilation
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
One Identity Manager query language
Accessing local object columns
Accessing columns of an object connected by a relation
Accessing the old column value
Accessing the display value of a column
Accessing references in comments
Accessing metavalues of the local object
Accessing objects' display values
Using base objects
Calling functions
Pre-scripts for use in processes and process steps
Using session services
Querying configuration parameters
Testing for the existence of certain database entries
Querying session object global variables
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
Loading the script library
Tips for editing script code in the System Debugger
Logging database queries and object actions
Testing script code in the System Debugger
Extended debugging in the Object Browser
Testing scripts in the System Debugger
Testing templates and formatting scripts in the System Debugger
Testing methods in the System Debugger
Testing table scripts in the System Debugger
Saving changes to the database
Language elements of the One Identity Manager query language
Formulating queries in the One Identity Manager query language
Reports in One Identity Manager
Query header
Where clauses
Search clauses
Select clauses
Order by clauses
Paging clauses
Display value clauses
Query parameter clauses
Query hints
Conditions
Comparing columns
Comparison by means of IN and NOT IN clauses
Compare date differences
Compare date ranges
Compare fixed values
Comparing parameters
Using preformatted Where clauses
Working with the Report Editor
Adding custom tables or columns to the One Identity Manager schema
Menu items in Report Editor
Views in the Report Editor
Report Editor program settings
Logging database queries
Creating and editing reports in the Report Editor
Editing general report properties
Creating and editing data sources
Data retrieval using SQL queries
Data retrieval using database views
Data retrieval using an object
Data retrieval using single object history
Data retrieval using multiple object history
Data retrieval using historical assignments
Data query for simulation data
Report parameters
Editing report parameters
Editing general parameter settings
Editing parameter value definitions
Settings for calculating values
Using virtual data sources
Editing the report form
Example of a simple report with data grouping
Translating reports
Embedding reports in the user interface
Generating and exporting reports on a cyclical basis
Creating new tables
Extending tables
Defining columns
Web service integration
Creating simple columns
Creating foreign key columns
Creating dynamic foreign keys
Creating new columns for database views with type view
Advanced configuration of columns
Creating database views with read-only type
Creating database views with Union type
Creating new assignment tables
Creating indexes
Removing custom schema extensions
Permissions for schema extensions
Change labels for the schema extensions
Adding schema extensions to the database
Recommendations for advanced configuration of custom schema extensions
Managing custom database objects within the database
Binding a web service
One Identity Manager as SCIM 2.0 service provider
Generic web service call
Direct web service call
Self-defined web service call
Creating web service solutions with the Web Service Integration Wizard
Modifying a web service solution
Deleting a web service solution
Endpoints and base URL
SCIM plugin features
Authenticating SCIM clients
Authenticating SCIM plugins in One Identity Manager
Special features of generating the SCIM schema
SCIM plugin requests
Processing DBQueue tasks
DBQueue Processor configuration for test, development, or productive environments
Configuring notification behavior for DBQueue Processor initialization
Reinitializing the DBQueue Processor
Bulk processing in the DBQueue Processor
Processing DBQueue Processor tasks by the Database Agent Service
One Identity Manager Service configuration files
Form definitions and form templates
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
-
In the Designer, select the User interface > Forms > User interface forms category.
-
Select the user interface form in the Form Editor.
-
In the edit view, in Properties, select the Form template tab.
| Property | Meaning |
|---|---|
|
Form source type |
Source of the form template. Permitted values are:
|
|
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.*.vif), 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:
|
| 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. |
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
-
In the Designer, select the User interface > Forms > User interface forms category.
-
In the Form Editor, select the user interface form.
-
In the edit view in Properties, select the Form definition tab.
| 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 |
|
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. |
button next to the input field to integrate a new form template in the form definition.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.
Example: 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="MNBaseColumnName" value="UID_ADSGroup" IsMandatory="True" />
<Property name="MNTableName" value="DepartmentHasADSGroup" IsMandatory="True" />
...
</Properties>
</ComponentDefinition>
...
</ComponentDefinitions>
</DialogFormDefinition>
Displaying relations
| 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: <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%'" /> |
|
|
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: <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 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> |