User Interface Configuration

Each form referenced by the name attribute of an <action> element in this file must be declared or defined in the <form-beans> section.

A form declaration is a <form-bean> sub element specifying just form name and type, but no properties.The form must then be defined in a separate forms configuration file.Externally defined forms can be referenced from within several struts configuration files.

A form definition additionally lists the form’s properties in <form-property> sub elements. A form directly defined in a struts-config.xml file cannot be referenced from within other files.

Forms of type com.siemens.webMgr.model.DynaLocaleForm must be defined externally. We recommend just to declare each form here, and to define it externally. For more details, see the chapter on forms configuration below.

Important attributes of the <form-bean> element are:

name – The unique identifier of the form. This value is used in the “name” attribute of <action> elements to reference the form.

type – The class name. Usually org.apache.struts.action.DynaActionForm or com.siemens.webMgr.model.DynaLocaleForm,

Action mappings are defined in <action> elements within a <action-mappings> parent. Each <action> element maps a module-relative URI to an action class that processes the request. The following attributes are important:

path - The requested URI.

type – The class name of the action. Web Center always uses the same action handler and delegates request specific tasks to the “controller JSP page”.

name – The name of the form bean to be used in this action. It references a <form-bean> element (see the section "Form Beans" in this chapter).

parameter – A general-purpose parameter used to pass extra information to the action handler and the controller JSP page. It contains a list of name-value pairs separated by ‘;’. Any leading and trailing white spaces around parameter names and values are discarded. The first and most important parameter is “jspPage”, which denotes the “controller JSP”. The action handler copies all other parameters into the request attributes and processes the JSP page. Thus, the “controller JSP” only evaluates the other parameters and their usage should be studied there. But there are some parameters used very often:

jspPage – The relative path of the “controller JSP” page.

object – The “main” object of this action, typically the object to be displayed or edited. For example, this will be the login user in self-service requests or the role going to be modified. The JSTL notation references the object by its attribute name in the session context, for example ${sessionScope['com.siemens.webMgr.selectedUser']}.

operation – The requested operation, for example “modify”. The operation is particularly important in case the action is triggered via a context menu. In that case, Web Center executes the action only if the logged in user has the access rights to perform the operation on the main object.

defaultSearchBase – The search base for LDAP search operations, especially used for requests to list users, roles or other objects.

elements – The object type to be searched for or a list of attributes in list operations, for example users, juniorRoles, roles.

resetPoint – A reset point (true) is an action to which the application can safely redirect to after processing a request to change the language or the font size. A reset point action must not perform any changes in the database, and should not rely on a specific session state.

history – Whether to include the action in the navigation history or not.

historyLabel – The message key of the label for the action’s navigation history entry. The default message key is navigationHistory.<actionPath>.

Each <action> element typically has a number of <forward> sub-elements. The action handler and in the Web Center case most often the “controller JSP” returns a forward value. The Struts framework forwards the navigation flow to the path of the matching <forward> element. There are two different path types. A path starting with a dot names a tiles definition and instructs the controller to build the HTTP response according to that definition; see the section "Tiles Definitions tiles-defs.xml" in this chapter for details. A path starting with a slash, on the other hand, identifies a Struts action and causes page execution to be continued with that action.

External plug-in resources can extend the Struts framework. Standard ones are the Tiles framework and a validator. Web Center also includes them and adds its own extensions.

The Web Center extensions are plug-ins for form, renderer and object configurations. Each is configured separately in a <plug-in> element like the following one for the form configuration:

<plug-in className="com.siemens.webMgr.config.FormConfigPlugIn"/>

The standard plug-ins support proprietary properties. Important are the ones where the definition files are listed.

You set the Tiles definition files in the property definitions-config as in the following sample snippet:

In order to modularize the configuration, Web Center uses a tiles-definition file per module (identity and user management, workflows, role management, and so on). To allow Tiles to support this configuration, you must set the property moduleAware to true.

The Struts validator is registered with the following configuration:

The property pathnames lists the validator configuration files.The validator plug-in is required since Web Center forms subclass the Struts class DynaValidatorActionForm.

A <definition> can define a template or a "tile".If it defines a template (or form), its “path” attribute will point to a JSP page that contains the layout of the template.If it defines a tile (or sheet), it refers to a named portion of a page or to a reusable component.

Definitions set attributes for a tile as <put> tags (see the section "Element <put>" in this chapter).

The following list shows the attributes of the <definition> element used in Web Center:

name – The unique identifier for this definition. By Web Center convention, this name should start with a period (".") to avoid naming conflicts with Struts configuration.

extends – The name of a definition that is used as the ancestor of this definition. All attributes from the ancestor are available to the new definition. Any attribute inherited from the ancestor can be overloaded by providing a new value.

path - The context-relative path to the resource used as the tile to insert. This tile will be inserted and a tiles context containing appropriate attributes will be available.

The <put> element is a child of a <definition> and describes an attribute of a definition. Its most important attributes are:

name – The unique identifier of the attribute to be set or replaced in the ancestor.

value – The value associated with this attribute.

Important <put> tags are:

action – The URL of the struts action to be performed when this form is submitted (for forms).

styleClass - The name of the CSS style class to be used for this form.

All JSP pages used by Web Center have a common basic tiles definition that is used to construct the final HTML page by a set of page tiles. The basic layout template is stored in jsp/view/forms/layoutPage.jsp.

The following picture gives an overview of the page areas. The content of the shaded areas is defined in separate JSP files that are included via <tiles:insert> or <c:import>.

The layout template contains the following areas:

An alternative way is to split the key visual in two part, top and bottom:

Changing the basic layout template may be a time-consuming task, since the entire body is an HTML table with partial percentage heights and widths.Removing an item may cause the page to be displayed incorrectly.Use an HTML analog and try the changes in an HTML editor before making any layout template modification.

Menu selectors are flags that control the visibility of menu items.For example, some menu items are visible only if the Professional Suite is installed.Each flag has a name; its value defines the conditions under which it is true.

The menus to be displayed in a navigation bar are described by a single menu bar definition. A menu bar is a list of menus, each menu a list of menu items.

The context menu for one or more tables is described by a single context menu definition. A context menu definition includes a list of context menu items.

A form toolbar defines a list of menu items to be visible in the toolbar above a form. The toolbar definition name is referred to in the Tiles definitions displaying the corresponding forms. The toolbar references a menu definition and specifies a list of menu items from that definition. Menu item selectors and menu access policies apply to each toolbar item as in the menu itself.

A list toolbar defines a list of context menu items to be visible in the toolbar above a list. The toolbar definition name is referred to in the Tiles definitions displaying the corresponding lists. The toolbar references a context menu definition and specifies a list of context menu items from that definition. Menu item selectors and menu access policies apply to each toolbar item as in the menu itself.

Note that tools are applied to entire entry lists. Therefore, the only context menu items suited out of the box for toolbars are those in context menu section “list”. Other context menu items usually require implementation of specific actions.

Start actions define the first page displayed to a user after a successful login. You could define a fixed page like the user search page, but this is an appropriate choice only if the user is allowed to read other user’s entries, and to select menu items on them.

After a successful login, therefore, Web Center forward to the Struts action getStartPage.do. The action handler searches for the first menu item in the start action list the user is allowed to perform, and forwards that item provided the item matches any of the action’s defined forwards. If no suitable item is found, the handler forwards “default”.

A <form-bean> element describes a generic form, which – in Web Center – is the content of a tile.

The form is populated with form widgets. They are configured in <form-property> elements. A widget has a text label and is usually related to an LDAP or other Bean attribute. It may be editable or read-only.

A table defines the form layout with a row index running from top to bottom and a column index running from left to right. The widgets may be grouped to form groups. The row- and column indices of such a group are related to the group origin, so they start with index 0. They do not interfere with indices from outside the form group.

The widget’s HTML code is inserted into the form by a “renderer”. Each widget is related to a data type, which is specified as a Java class. The data types used in Web Center have a default renderer that may be overwritten by a special field renderer for each individual widget.

The Java implementation class for a form bean derives from the org.apache.struts.action.ActionForm class. Nearly all form beans in Web Center are realized by the class com.siemens.webMgr.model.DynaLocaleForm.

Form beans and their classes are referenced by <form-bean> and <action> elements in struts-config.xml.

The following attributes are important:

name – The unique identifier for this form bean. Referenced by the <action> element in the Struts configuration to specify which form bean to use with its request. Required.

buttons – A sequence of buttonType:labelKey where buttonType must be the identifier of a button renderer configured in renderers-config.xml (submit, reset, cancel etc.) and labelKey the key for the button label. The items are separated by a ";". The attribute is also used to configure whether the form includes the due date control. To enable the control, add the name of the respective due date flag in webCenter.properties as first element to the button list. If you enable the flag, the form will include the due date control. Accepts expressions.

buttonGap – The distance (in pixels) between the bottom-most form property row and the submit buttons; default is 10.

A <form-bean> element can contain any number of the following sub-elements: <form-property>, <form-property-group>, <form-include>, <form-import>. The form bean may also contain a single <form-body> element.

A <form-bean> element may also consist of an only sub-element of type <form-property-list>.

The <form-body> element is intended to specify the location of the assignment panel (including the search panel) in an assignment form. Additional form properties may be placed above the assignment panel, or between assignment and button bar, or even to the left or right of the assignment panel.

The assignment properties of assignment forms are usually populated in file assignObjects.jsp. Other form properties are simply ignored. If you set the parameter “populateAdditionalFormFields” of the assignment action (in struts-config.xml) to “true”, however, the JSP will also fill all other form properties with values from the current object.

The <form-property> element describes a form field.

This element is only used when the "type" attribute of the enclosing "form-bean" element is org.apache.struts.action.DynaActionForm or a subclass thereof.

If the field is itself a table, insert a child element <data-property> for each table column (see the section "Data Property" in this chapter).

The important attributes compliant with the Struts schema are:

name - The name of the form field described by this element, most often the name of the LDAP attribute. Required. You can make use of placeholder names such as “$displayName”, which are defined in the object description of the corresponding object.

type – The fully-qualified Java class name of the field underlying this property, optionally followed by "[]" to indicate that the field is indexed. Required.

The following attributes are Web Center specific and extend the Struts configuration DTD:

checks – For form properties representing a table only: validations for editable table cells.

confirmation - The condition identifier and the message key of a confirmation message to be displayed when the form is submitted.

contextMenu - The tiles definition name of the context menu for a table, optionally followed by one or both of the modifiers “ms” and “list” to enable the multiselection and/or list section of the context menu. For form fields displaying object sets only.

contextMenuFlags – A list of conditions to be met by entries of a list. A condition defines one or more regular expressions to be matched by attribute values of an entry. Each condition has an identifier (a digit or a letter). The identifier is then assigned to menu items in the context menu definition. For regular expression syntax, confer to the documentation of Java class java.util.regex.Pattern.

dynaClass - The dyna class name for this property. This attribute is only necessary for form fields that define object sets, but not for usual attribute fields. See also the section "Data Property" in this chapter. Unless you write your own dyna class we recommend to leave this property unspecified since the default value (“com.siemens.webMgr.model.DirectoryEntryClass”) will do.

enabled – A boolean flag to enable or disable the property. The default value is "true" (enabled).

fieldRenderer – The reference to a renderer definition to be used for displaying this property; that is, for generating the HTML code of the widget. The renderer configuration file renderers-config.xml must contain an entry with this identifier. See the section "Renderers Configuration renderers-config.xml" in this chapter for details.

height – The height of the element in pixel. When defining a height take different screen resolutions into account.

hideIfEmpty – Indicates that the element is visible only if its value is not empty.

hideIfMatch – A regular expression. The form field is not visible if its value matches the expression (see documentation of Java class java.util.regex.Pattern).

hideOldIfEmpty – Supported by modification approval form only: Hide element for old value if old value is empty.

initialSortColumn – For form properties representing a table only: The name or index of the initial sort column.

label – The message key for the text to be displayed as form property label. The default value is “ldap.attribute.<form property name>”.

labelRenderer - The identifier string for the label renderer to be used. This attribute must be a valid entry in the renderer configuration file renderers-config.xml.

mandatory – A boolean flag to indicate whether or not the property is mandatory. The default value is "false" (not mandatory). Accepts expressions.

maxSize – The maximum number of elements to be displayed in a table. By default, all items returned by the underlying (possibly time and size limited) directory search operation are displayed. Some search operations, however, like the one for group members, are not limited.

messagePrefix – A message key prefix for form property value localization.

namingColumns – For form properties representing a table only: The comma-separated list of the names or indexes of the columns displaying the naming attributes; used for row identification in input validation error messages.

oneTimeEvents – For form properties representing a table only: events that may be triggered only once.

openAction – The Struts action to be invoked when clicking the open button of a table entry. The action may be optionally followed by a menu key and item saying that the open button should be only displayed to users that have the corresponding menu access right. Sample: /openRole.do:RoleMgt.summary. The property values accept expressions.

readonly – A Boolean flag to indicate whether the property may be edited (readonly = false). The default value is false. Accepts form expressions.

rendererProperties – A semicolon separated list of name/value pairs defining properties transparently passed to the field renderer. The properties can be referenced in HTML or Javascript code snippets. Property name and value must be separated by a colon. This is a convenient way to define custom renderer properties whose values vary with the form property. Sample: rendererProperties="targetId:accountsForm;tooltip:accounts.tooltip". The property values accept expressions.

secondarySortColumns – For form properties representing a list: The comma-separated list of column indexes or names defining the secondary sort criteria. The primary sort criterion is the selected column.

sets – A comma-separated list of set ids this property is part of. Used only for the attribute modification approval form.

size – The page size for tables. May be overridden by a corresponding Tiles definition.

sortable – For form properties representing a list: Whether the list is sortable (true) or not (false). Default: true.

spanX – The width or horizontal size of the element in number of grid cells. It is used to place the element in a virtual table grid. This attribute defines the number of table cells the element will cover in horizontal direction. The default number is 2.

spanY – The height or vertical size of the element in number of grid cells. It is used to place the element in a virtual table grid. This attribute defines the number of table cells the element will cover in vertical direction. Note that label columns are counted.

summary – The message key for the summary attribute of a table.

tooltip – The message key of a tool tip in text.properties. This form property only works if the associated renderer supports it, which is currently the case only for some checkbox renderers.

transient – Indicates that the form property is an artificial one not intended to be stored in the directory when saving an entry. Used for properties accepting the indexes of selected table items only.

use – The name of the form property accepting the indexes of selected items in a table.

visible – A boolean flag that indicates whether this property is to be displayed. It is used to hide properties depending on the installed license. Accepts expressions.

width – The width of the element in average char width (approx. 10) or pixel (depends on element type). We recommend that you specify the width of an element as a percentage, since fixed values can lead to undesirable results in different screen resolutions.

x – The relative position of the element in a row. The field is displayed to the left of all other fields with a higher x-value in the same row.

y – The vertical position of the element in coordinate points. It is used to place the element in a virtual table grid. This attribute defines the index of the table row where the upper left corner of the element is located. If omitted, the system appends this field to the same row as the previous one. A value of “+1” places the field in the next row.

Here is a sample for locating fields in a grid and setting field dimensions:

Field1 spans over two rows (spanY="2"), Field6 over three columns (spanX="6", label columns are counted!). The field positions and spans should be set as follows (provided the fields are listed as sub elements of the form in ascending order from Field1 to Field6):

Form properties can be aggregated to groups allowing a separate layout by placing them inside an element <form-property-group>. Note that fields within a property group are not aligned with fields in other property groups or outside any property group.

The <form-property-group> supports the following attributes:

ariaLabelPrefix – Whether to use the group label as ARIA label prefix for the form properties in the group.

groupRenderer – The reference to a renderer definition to be used for displaying the group of properties. The renderer configuration file “renderers-config.xml” must contain an entry with this identifier. See the section "Renderers Configuration renderers-config.xml" in this chapter for details.

hideIfEmpty – Indicates that the group is visible only if at least one of its properties has a non-empty value.

label – The message key for the text to be displayed as form property group label. The default value is “group.label.<form group name>”.

level – The group’s label level; highest and default level is 0. Only used for the attribute modification approval form.

name – The group name. The name must be unique within the form.

rendererProperties – A semicolon separated list of name/value pairs defining properties transparently passed to the group renderer. The properties can be referenced in HTML or Javascript code snippets. Property name and value must be separated by a colon. This is a convenient way to define custom renderer properties whose values vary with the form group. The property values accept expressions.

script – The name of a script file to be included within the HTTP response.

spanX – The width or horizontal size of the element in number of grid cells. It is used to place the group in a virtual table grid. This attribute defines the number of table cells the element will cover in horizontal direction. The default number is 2.

spanY – The height or vertical size of the element in number of grid cells. It is used to place the group in a virtual table grid. This attribute defines the number of table cells the element will cover in vertical direction. Note that label columns are counted.

visible – A boolean flag indicating whether this group is to be displayed. It is used to show or hide form groups depending on certain conditions. Accepts expressions.

x – The relative position of the element in a row. The group is displayed to the left of all other fields with a higher x-value in the same row.

y – The vertical position of the element in coordinate points. It is used to place the group in a virtual table grid. This attribute defines the index of the table row where the upper left corner of the element is located. If omitted, the system appends this field to the same row as the previous one. A value of “+1” places the group in the next row.

A form property list describes a form which displays a special kind of list like for example on a plug-in of the home page. It accepts up to three list properties as sub items.

<form-property-list> supports the following attributes:

fieldRenderer – The reference to a renderer definition to be used for displaying the list. The renderer configuration file “renderers-config.xml” must contain an entry with this identifier. See the section "Renderers Configuration renderers-config.xml" in this chapter for details.

icon – The icon to be displayed alongside each list entry; a file name relative to folder resources/images.

iconTitle – The message key for the icon tooltip.

name – The list name. The name must be unique within the form.

openAction – The Struts action to be invoked when clicking on a list item. The action may be optionally followed by a menu key and item saying that the action is only enabled for users that have the corresponding menu access right. Sample: /openRole.do:RoleMgt.summary.

openDescription – The message key for a description of the open action.

rendererProperties – A semicolon separated list of name/value pairs defining properties transparently passed to the list renderer. The properties can be referenced in HTML or Javascript code snippets. Property name and value must be separated by a colon. This is a convenient way to define custom renderer properties whose values vary with the property list. The property values accept expressions.

size – The number of elements to be displayed in the list. The preferred way is to specify the list size as a parameter of the corresponding Struts action.

sortIndexes – A comma-separated list of column indexes defining the sort order. Default is “0,1,2”.

A form may include another one. The fields and groups of the imported form are inserted immediately after the form field, group or import preceding the import statement. The imported form will start on a new line but is not automatically terminated with a new line. The included form may itself import another one.

The <form-import> element supports the following attributes:

name – The name of the form bean to be included.

The included form must be defined before it is imported.

Form includes are used to include a form into another one. It is used only for the attribute modification approval form.

The <form-include> element supports the following attributes:

name – The name of the form to be included.

objectTypes – A comma-separated list of object types the element applies to.

workflowPaths – A comma-separated list of regular expressions matching the workflow paths the element applies to.

For a detailed description see the chapter on attribute modification approval in the DirX Identity Web Center Customization Guide.

The element <data-property> is a sub element of the <form-property> of an object set to be displayed in a table. A <data-property> describes a single table column.

The following attributes are defined:

align – The HTML column alignment, one of left, right, center or justify.

cellRenderer - The renderer to be used for displaying the cell content of this column. This attribute must be a valid entry in the renderer configuration file renderers-config.xml. The attribute accepts expressions.

headerRenderer - The renderer to be used for displaying the content of the header cell for this column. This attribute must be a valid entry in the renderer configuration file renderers-config.xml.

label – The message key for the table column label. The default value is “ldap.attribute.<data property name>”.

mandatory – A Boolean flag for editable data properties indicating whether their values may be empty (false) or not (true). The default value is false. The attribute accepts expressions.

messagePrefix – A prefix for message keys related to this data property.

name - The name of the data property described by this element, most often the LDAP name of an attribute of the objects to be displayed. Required. You can make use of placeholder names such as “$displayName”, which are defined in the object description of the corresponding object.

readonly – A Boolean flag to indicate whether the property may be edited (readonly = false). The default value is true.

readonlyRow – A comma-separated list of cell values that cause the entire table row containg the cell to be read-only.

rendererProperties – A semicolon separated list of name/value pairs defining properties transparently passed to the field renderer. The properties can be referenced in HTML or Javascript code snippets. Property name and value must be separated by a colon. This is a convenient way to define custom renderer properties whose values vary with the form property. Sample: rendererProperties="targetId:accountsForm;tooltip:accounts.tooltip". The property values accept expressions.

sortable – Whether the column is sortable (true) or not (false). Default: true for read-only columns, false for editable columns.

sortIndexes - A list of column numbers representing the order of sorting when this column is selected. This attribute must be written as "columnNumber, columnNumber, …​". The indexing of columns starts with 0.

transient – Indicates that the data property is an artificial one not intended to be stored in the directory when saving an entry.

type – The fully-qualified Java class name of the field underlying this property, optionally followed by "[]" to indicate that the field is indexed. Required.

visible – A boolean flag indicating whether to display this column. Accepts expressions.

whitespace – The CSS property value that specifies how to handle white space in the values displayed in this column. Sample values are normal, pre and nowrap.

width – The width of the column in average char width (approx. 10) or pixel (depends on element type). We recommend that you specify the width of an element as a percentage, since fixed values can lead to undesirable results in different screen resolutions.

The element <list-property> is a sub-element of <form-property-list>. It describes a column in a property list.

<list-property> supports the following attributes:

cellRenderer – The renderer to be used for displaying the cell content of this column. This attribute must be a valid entry in the renderer configuration file renderers-config.xml.

label – The message key for the list column label. If no label is specified, the column is displayed without header.

messagePrefix – A prefix for message keys related to this data property.

name – The name of the form property described by this element, most often the LDAP name of an attribute of the objects to be displayed.Required.You can make use of placeholder names such as “$displayName”, which are defined in the object description of the corresponding object.

rendererProperties – A semicolon separated list of name/value pairs defining properties transparently passed to the list property renderer.The properties can be referenced in HTML or Javascript code snippets.Property name and value must be separated by a colon.This is a convenient way to define custom renderer properties whose values vary with the list property.The property values accept expressions.

type – The fully-qualified Java class name of the field underlying this property, optionally followed by "[]" to indicate that the field is indexed.Required.

whiteSpace – The CSS property value that specifies how to handle white space in the values displayed in this column.Sample values are normal, pre and nowrap.

width – The width of the column.We recommend that you specify the width as a percentage of the total list width, since fixed values can lead to undesirable results in different screen resolutions.

The renderer configuration defines all modules producing the final HTML code for a particular page element. They are referenced from various form bean configuration elements.

The root element <renderers> contains a <renderer> child element per renderer.

The file “defaultRenderer.properties” associates default renderers for commonly used object form property types, names, and editors.

The first file section, Data types, maps form property types to renderer identifiers. Form property types are class names assigned to attribute type of <form-property> elements in forms configuration files.

The second file section, Editors, maps editor class names to renderer identifiers. Editors are assigned to object properties in object descriptions.

The third file section, Properties, maps form property names to renderer identifiers. Form property names are class names assigned to attribute name of <form-property> elements in forms configuration files. If a property name is followed by an object type specification (<property name>@<object-type>, e.g. manager@ctxlocation), the assigned default renderer applies only to that object type. This way, you can assign different default renderers to the same property of different object types.

At runtime, the actual renderer for a form property is determined in the following order:

Form property attribute fieldRenderer

Form property name (section Properties)

Form property type (section Data types)

Forms used when performing a request workflow activity are not configured in forms configuration files but in request workflow definitions in the DirX Identity provisioning store. Types and field renderers for properties of these forms are looked up from property attributes type and editor in the corresponding object descriptions.

Note that the default renderer mappings are case sensitive. Class names, form property types and names, and renderer identifiers must exactly match their counterparts.

Any renderer implementation uses code snippets to render user interface elements. These snippets are located in the WEB-INF/snippets directory.

A code snippet is either a piece of HTML code (for example, the simple text field) or a JavaScript (for example, all table cell renderers) or both (for example, a calendar or table). A code snippet uses placeholders that the renderer class replaces with runtime values, thus finalizing the code before it is streamed to the client. The big advantage of these renderers is that the developer of the customized application can modify them to meet the customer’s requirements.

The element <object> describes a single DirX Identity service layer object.

The following attributes are defined:

id – The identifier for the object. This value is the name used in attribute names. Required.

nodeClass – The fully-qualified Java class name of the service layer object. Required.

dirClass – The type, i.e. the object description name, for this object. The list of valid object types can be viewed in the DirX Identity Manager when editing access policies.

masterClass – The fully-qualified Java class name of the object’s master node, which owns the object. This attribute is used especially for assignments (where the user entry class having the assignment is the master class). The attribute accepts several master classes, separated by commas.

def – Object elements may share the same combination of nodeClass and masterClass. In each a case, exactly one of the elements must be defined as default element by setting its def attribute to “true”.

set – The set name for this object. The default set name is obtained by appending an “s” to the object identifier. There are a couple of predefined set names, like “groups”, “roles” and “activities”, and a general purpose set name “GenericNodes”.

The element <relation> describes the attribute mapping for a particular object relation.It requires the following attributes:

name – The name of the relation.

value – The value of the relation.Note that it must start with a ‘.’.

The Web Center search panel supports searching for attributes with DN syntax, like user manager or a role owner.For example, you may search for all groups whose owner has a surname starting with “ab”.Web Center first searches for possible owners, that is users whose surname starts with “ab”.Then it searches for all groups whose owner matches one of the candidates found.Be aware that the final search result may be somewhat surprising since the first search may hit a size or time limit.

You can define some individual and some general options for the first search.

The root element of the XML document with a single child element <options> and a single child element <filters>.

The element defines global settings that apply to all DN attribute searches.

sizeLimit – The size limit for the search operations. Default: The size limit configured for the domain object.

timeLimit – The time limit for the search operations. Default: The time limit configured for the domain object.

accessPoliciesEnabled – Whether to apply access policies to the search results. Default: true.

isPresentSearchEnabled – Whether the searches support match rule isPresent. Deafult: false.

The element serves to group a set of <filter> elements.

The element maps the name of a search panel attribute and optionally the object set name to search parameters. The search parameters are specified in one or more child elements <search>. Each child element describes a search operation. The total search result is the sum all search results.

additionalFilter – A filter component that must be matched in addition to the filter components resulting from the search elements.

attributes – The comma-separated list of attribute names the filter applies to. Required.

objectSets – The comma-separated list of object sets the filter applies to.If left unspecified, the filter applies to all object sets without specific filter assignment.

The element defines the base object and a search filter.The search filter is applied in addition to the one entered by the user in the search panel.

base – The search base, without domain root.The domain root will be appended.Default: domain root.

filter – The search filter.Default: (objectclass=*).