What is the Tool Editor?
The Tool Editor is used for creating, modifying, and testing ADHQ Lite tools. Before we get into how exactly the Tool Editor works, let's start by going over some terminology:
- Operations are the basic building blocks of ADHQ Lite Tools. An operation is a small set of controls that can be used to modify a group of related Active Directory attributes.
- A control is an input field that links to an AD Attribute. Controls come in several different flavours, including checkboxes, radio buttons, text fields, grids, time controls, etc.
- Operation Groups
- Within ADHQ Lite Tools, operations are collected into operation groups. An operation group is primarily a way to organize operations visually.
- ADHQ Lite Tool
- A tool is a collection of operation groups. The default values for controls in any of ADHQ Lite's builtin tools can be overriden in custom workspaces.
The following sections of this article will describe the different parts of the Tool Editor interface, with an eye toward how you can use the editor to customize ADHQ Lite tools for your environment.
Tool Editor Layout
The Operation Tree displays a hierarchical view of the currently selected tool in the Tool List. The tool appears at the top of the tree and below that, Operation Groups, Operations, and Controls appear. Selecting an item in this tree will show its properties in the Property Pane and highlight the item with a red border in the Tool Preview pane.
The Operation Tree has a toolbar in the upper right corner containing the following buttons:
|New Group||Add a new Operation Group to the tool. The new group will be added at the bottom of the tool.|
|New Operation||Click this button to launch the Add Operation Dialog for adding operations to the currently selected Operation Group. Select one or more operations from the group, then click OK to add them to your tool. The operations in the Add Operation Dialog are organized in default groups. If you'd like to insert your selected operations into these same groups in your tool, select the Group line in addition to the Operations (Ctrl + Lt Click). When you click OK, the operations you selected will be inserted into groups of the same name in your tool.|
|Delete||Remove the selected Operation Group or Operation from the tree.|
|Move Up||Move the selected Operation Group or Operation up toward the top of the tool. Operations cannot be moved outside of their Operation Group.|
|Move Down||Move the selected Operation Group or Operation down toward the bottom of the tool. Operations cannot be moved outside of their Operation Group.|
The Properties Pane is located immediately below the Operation tree and contains all of the properties for the currently selected Tool, Operation Group, Operation, or Control. The following tables describe the properties for each type of object:
|Name||The name of the tool. This is the name shown in the Tool List.|
|Description||A description of the tool.|
|Display Title||The display title of a tool is the text that appears at the top of the tool window in large font when the tool is launched. If no display title is specified, the tool name will appear here.|
|Hide Tool UI||Choose to hide the tool interface from the user by checking this checkbox..
Note: This box should remain cleared unless the tool has all settings filled within the Tool Editor, as you will not have an opportunity to fill out the settings at run time.
|Hide Tool Output||Hide the tool output from the user. This can be useful for tools that do not provide useful feedback to the user. For example, the Open Home Page tool for Users simply opens the user's website in a browser. No additional feedback is required, so this property is checked.|
|Output||This group of options controls what happens after a tool is ran. The first option Use Global Output is selected by default and uses the output settings set in the Tool Output page of the options dialog from the file menu. If unselected, the tool will use the settings set below, including saving the tool output and automatically sending an email.|
Operation Group Properties
|Name||The name of the operation group, as it will appear in the tool during execution.|
|Description||A description of the operation group.|
|Hide||Hide the operation group in the Tool UI. The group will not be displayed during execution, but its operations will still be executed.|
|Expanded||Show the group in its expanded state. Regardless of this setting, the user will be able to collapse/expand the group by clicking the icon on the right side of the group's title bar.|
|Show Subtitles||Display child Operations in groupboxes with title bars. This is entirely a visual property.|
|Name||The name of the operation, as it will appear in the tool during execution.|
|Description||A description of the operation.|
|Hide||Hide this operation, but use the default settings of its controls. The operation will not be displayed during execution, but its settings will be used to modify the object.|
|Name||The name of the control. This is a read-only property used to identify the control.|
|Description||A description of the tool.|
|Label||Change the label text for this control.|
|Disable||Disable this control, but use its default setting. The control will be displayed in a disabled state during execution, and its settings will be used to modify the object.|
|Required||Make this control a required field. This will force the user to supply input for the control during execution.|
|Auto Generate||Specify a template to automatically generate the text for this control as other fields are changed in the tool interface. For example, if you set the Auto-generate template for the Display Name field to
This is friendlier than simply putting
The Properties Pane also has a small description field along the bottom of the pane. This is used to show a short description of the selected property. If you ever forget what a property does, select it and look in this area to get a quick reminder.
The Preview Pane displays a preview of the tool as it will appear for the user during execution. Selecting a Operation Group, Operation, or Control here will select it in the Operation Tree and load its properties into the Property Pane. In the preview pane, you can interact with the tool just as you will during execution. In this way, you can set up default values for each of the Controls.
For instance, if you wanted your Add User tool to set the user's Display Name with their First Name followed by their Last Name, you could enter the template
%FirstName%%LastName% into the Display Name control. Then, you could lock down the Display Name control by checking its Disable property in the Property Pane.