A command of any type has the following properties:
- Name The text that labels the command on the menu. This text is what Web Interface users view in the Command pane.
- Description Any text to help identify the command in a list of commands. An administrator can view this text in addition to the command name when selecting a command to add, remove, or modify.
- ToolTip The text that is displayed when the mouse pointer is positioned over the command in the Command pane.
- Command Type The type of the command is specified when the command is created, and cannot be changed.
Form Task properties
A command of the Form Task type has the Form name property in addition to the common properties. This property identifies the form that the command is intended to open. When a Form Task command is initially created, it is not associated with any form, so the Form name property is not set. When you associate the command with a certain form, the Form name property is set to the name of the form.
Search Task properties
A command of the Search Task type has a number of properties in addition to the common properties. You can specify search conditions (LDAP search filter), define where to search for directory objects (scope of the search), and choose the object properties to be displayed in the list of search results.
The Base DN property specifies the distinguished name of the container where to begin the search. The search is performed only on this container and objects that exist below it in the directory tree. This property can be set to one of the following:
- Currently selected object When the user clicks the command on the menu for a given object, the Web Interface uses the distinguished name of that object as the Based DN property. For example, suppose the command is on the menu for the organizational unit object type. When the user selects an organizational unit and clicks the command, the Web Interface searches the selected organizational unit.
- This DN The command causes the Web Interface to search the object that has the specified distinguished name, regardless of what object is actually selected. For example, suppose the command is on the menu for the user object type, and the Base DN property is explicitly set to the distinguished name of a certain organizational unit. In this case, when a user account is selected in the Web Interface, the command appears on the menu and clicking the command begins the search in that organizational unit.