Right Click Tools Builder
What it does
Right Click Tools Builder is an automation engine that allows for the creation of strings of Right Click Tools actions, including all of the different Right Click Tools, PowerShell scripts, Registry Edits, WMI Calls, and more. These customized tools can then be saved and shared with role-based permissions. This guide will help you to understand the functions of Right Click Tools Builder and how to use them.
Right Click Tools Builder is available in a number of console locations. To open it, right click in the console and navigate to Recast Right Click Tools > Right Click Tools Builder:
First, select the "New Action" Button:
- This will create a new saved tool under the "My Right Click Tools" list.
Configuring Action Properties
Next, select the Start Node in the Tool Creator to populate the Action Properties box. The options in the Actions Properties section help with the design and configuration on the new tool.
The "View" field is used to determine how the results of an Right Click Tools Builder tool will be displayed. Options include, Single Grid, Two Grid or Tabbed.
- Different result displays may be more more desirable from a user experience perspective than others.
- Tabbed Results: shows a result for each step of the tool.
- View options do not have an effect on the successful or unsuccessful technical operation of Right Click Tools Builder tools; they only affect the way in which results are displayed.
The "Name" field determines the name of the Right Click Tools Builder tool. The save button in the upper left will populate newly named tools in the My Right Click Tools list.
The "Display" field option is used to identify the ConfigMgr object that the Right Click Tools Builder tool is being run against. Optionss change based on the selected Action Type.
- For a tool run against a device, the "Computer Name" option would be an appropriate display option.
The "Action" field option is used to specify what properties the tool will take action upon.
- Generic: for all Right Click Tools Builder Tools acting on functions not related to users or devices.
- Device (with our without resource ID): for tools acting on devices. These tools will be available anywhere Right Click Tools device tools are available. The Resource ID is ConfigMgr's unique identifier for a computer object.
- User (with or without Resource ID): for tools acting on users. These tools will be available anywhere Right Click Tools user tools are available. The Resource ID is ConfigMgr's unique identifier for a user object.
Custom Input Parameters
Input Parameters can be used to provide users with options prior to tool execution time. Examples include:
- Choosing a collection to which a device will be added.
- Choosing whether or not to force a full inventory cycle upon completion.
- Having an admin input a PowerShell script.
First, select an input parameter type by choosing from the dropdown and clicking "Add". Options include:
- The Boolean input parameter lets you choose...
- The DateTime input parameter lets you choose...
- The Integer input parameter lets you choose...
- The String input parameter give you two options - List or Textbox...
- The TimeSpan input parameter lets you choose...
Adding Recast Actions
Use the Recast Actions search box or drill-down menu to find relevant tool actions. Drag actions from the Recast Actions menu into the tool creator to add them to an existing tool.
![Right Click Tools Builder design](media/Right Click Toolsdesign_nav.PNG)
Next, direct the flow of actions from the Start node to the first action step by selecting the circle edge and dragging it to the first box:
Right Click Tools Builder will auto-select the edge arrow in blue and populate the item properties field below. Configuring and setting parameters will tell ConfigMgr what properties to change on the targeted object:
Mapping Target Input Parameters
Parameters can be mapped to a constant value or a specific property or step. Constant values must be specified, whereas Parameter Mapped values can be pulled from any step of the existing tool to any property of the action being taken:
- This should be done for every parameter appropriate for the actions you are trying to take. A good rule of thumb here is to map parameters for actions where you need to pull input from the user or the properties of the object should change. Use constant values to hard code a value.
Right Click Tools Builder has the ability to set and work with conditional responses. Right Click Tools Builder can be configured to skip certain actions based on the results from previous actions. There are several logical term choices:
Once a logical condition has been added, input values can be associated. For example, an "Equal To" condition has been set from the Computer Name to a name of device "XYZ":
- If the conditions are true, Right Click Tools Runner will execute the next step according to the specified workflow. If not, the next step (and any subsequent step in the chain) will be skipped.
Saving and Sharing Tools
Once complete, be sure to save newly created tools. With the Right Click Tools Enterprise Server, Right Click Tools Builder tools are automatically saved and can be configured with Role-Based Permissions
This feature is available to Enterprise customers. Learn more about Workflow Automation here.