Configuring Web Interface commands
"Commands" in a Web Interface menu perform a specific task, such as displaying property pages for a directory object, searching for objects that meet certain conditions or assigning a certain value to a certain attribute of a directory object. You can select a command, and customize its action or associated pages.
To select a Web Interface command for customization
-
On the Web Interface home page, click Customization, then click Customization Tasks.
Alternatively, on the Navigation bar, expand Customization, then click Directory Objects.
-
In the list of menus on the List Existing Menus page, click the name of the menu that includes the command you want to select.
-
In the list of commands, click the name of the command.
Viewing or modifying the properties of a Web Interface command
Active Roles administrators can modify the properties of Web Interface commands. The properties of a command depend on the command type (Form Task, Page View Task, Search Task, or Set Attribute Task).
All commands have common properties, such as the name and description of the command. In addition, each command has a number of properties determined by the command type. As such:
-
The Page View Task-specific properties identify the page to display.
-
The Search Task-specific properties determine search criteria and configuration of the list of search results.
-
The Set Attribute Task-specific properties specify the attributes to set and the value to assign to a specific command.
For more information on these command types, see Properties of a Web Interface command.
To view or modify the properties of a Web Interface command
-
On the Web Interface home page, click Customization, then click Customization Tasks.
-
In the list of menus on the List Existing Menus page, click the name of the menu that includes the desired command.
-
In the list of commands found on the menu, click the name of the desired command.
-
Modify the properties of the command, if needed, and click Save.
-
Click Reload to publish your changes.
Creating or selecting a Web Interface form for a command
Form Task commands are always associated with a form, and are used to open that form. When configuring a Form Task command, you can either create a new form for it, or associate an existing form.
To create a new Web Interface form and associate it with a command
-
On the Web Interface home page, click Customization, then click Customization Tasks.
-
Select a command of the Form Task type.
-
In the right pane, click Link with New Form.
-
Select the type of the form to create:
-
Edit Properties: Creates a form used to view or modify object properties.
-
New Object: Creates a form used to create new objects.
-
Rename: Creates a form used to rename objects.
-
Click Next.
-
Specify the general properties of the form, such as the name and description.
-
If you have selected New Object as the type of the form, select the type of objects you want to create by using the form.
-
Click Finish.
-
Click Reload to publish your changes.
You can also associate a command with a form that already exists in the configuration of the Web Interface site.
To associate a command with an existing Web Interface form
-
On the Web Interface home page, click Customization, then click Customization Tasks.
-
Select a command of the Form Task type.
-
In the right pane, click Link with Existing Form.
-
In the list of existing forms, click the form you want to link with the command.
NOTE: The list of existing forms includes only the forms that are applicable to the object type the command is intended for. For example, when you select a command from the menu for the User object type, the list only includes the forms that are applicable to User objects.
TIP: Consider the following when assigning a form to a command:
-
Instead of linking a different form to a command, you can modify the form that is already associated with the command.
-
If necessary, you can configure a command so as to have no form associated with it: in the list on the Link with Existing Form page, click <no assigned form>, then click Save.
-
To publish your changes, click Save, then Reload.
Properties of a Web Interface command
Every command has a number of properties that determine behavior of the command. The command properties vary depending upon the command type:
-
Form Task: This command type is intended to display forms. When you click a command of this type, the Web Interface opens the form that is associated with that command. Then, depending on the type of the form, you can view or change the data shown on the form for an existing object or enter data on the form for creating a new object. The identifier of the form is part of the command properties (see Form Task properties).
-
Search Task: This command type is intended to search for objects in the directory and display search results. When you click a command of this type, the Web Interface performs a search based on the conditions specified in the command’s properties (see Search Task properties), and displays a list of search results. Then, you can click an object in the list to open the pages for managing that object.
-
Page View Task: Commands of this type are intended to display custom pages. When you click a Page View Task command, the Web Interface opens the page identified by the address (URL) that is part of the command properties (see Page View Task properties). For instructions on how to create custom pages, see Active Roles SDK documentation.
-
Set Attribute Task: A command of this type is intended to assign a certain value to a certain attribute of a directory object. The properties of the command specify the attribute and the value to assign to that attribute (see Set Attribute Task properties). The command can be configured to display a confirmation message prior to changing the attribute.
All commands have common properties, such as the name and description. In addition, each command has a number of properties determined by the command type.
