This Wiki is out of date. Please view the current documentation at https://wiki.recastsoftware.com
RCT Builder is an automation engine that allows for the creation of strings of RCT 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 RCT Builder and how to use them.
First, select the “New Action” Button:
This will add a new saved tool under the “Saved Actions” list.
Configure Action Properties:
Next, select the Start Node in the Tool Creator to populate the Action Properties box. There are several options to choose from that will help you design how you would like your tool to run:
The “View” field is where you select how the results of your RCT Builder tool will display; either Single Grid, Two Grid, or Tabbed.
Depending on what action you are trying to take, different result displays may be more desirable from a user experience perspective than others. Tabbed Results is a nice fallback option for most tools, as it will show a result for each step of your RCT Builder tool. View options do not have an effect on the successful or unsuccessful technical operation of RCT Builder tools, just how the results are displayed.
The “Name” field lets you set the name of your RCT Builder Tool, be sure to save using the save button at the top after giving your tool a name so it populates in the Saved Actions list.
Next, we will configure the Action Type and Display. These two fields let you tell ConfigMgr what properties you would like your tool to take effect on and how to identify the objects that you run your tools against. It also lets you configure parameters for all the different steps of your RCT Builder tool, so this is an important step. First, choose the action type:
- Generic: for all RCT Builder Tools acting on functions not related to users or devices
- Device (with or without Resource ID): For tools acting on devices. These tools will be available anywhere RCT device tools are available. The Resource ID in this case 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 RCT user tools are available. The Resource ID in this case is ConfigMgr’s unique identifier for a user object.
Then, select the display. These display options change based on the Action Type you select, giving you options appropriate for each action type. In this step, you are telling RCT how you would like to identify the ConfigMgr object you are running your tool against. For example, if you were running a tool against a device, you might select “Computer Name” to display the results.
Configure Custom Input Parameters:
For some tools, you may want to give the option to select from custom input parameters. There are many different scenarios where this might be advantageous, but here are a few examples:
- Choosing a collection to put a device into
- Choosing whether or not to force a full inventory cycle upon completion
- Having an admin input a PowerShell script to run
Regardless of the purpose, you can configure the details of your input parameters in this section.
1. Choose whether your input parameters should display as a drop-down list, checkbox, or text box:
2. Add your selection to the tool to save and configure the parameters. You can configure multiple sets of input parameters by adding or removing parameter displays with the “Add” and “Remove” buttons.
3. Select the parameter from the list to start configuring:
- The Display Name is how your parameter will be labeled when running the RCT Runner tool.
- The Variable Name is the parameter you will map in the steps of your action, it will not be seen by someone running the tool.
- Width options: specifies how wide the display of the list or Checkbox should be in pixels.
- Read Only, Required, Hidden, Default Focus, Skip Checks, etc let you specify response options when the admin running chooses what to input.
- Options for Default Values/List Items are available as well:
Finally, input the parameters you wish the admin running this tool to choose from:
- For List: separate choices by line (Enter/Return key)
- For CheckBox and Text: Specify what kind of default value you want chosen from to populate the box labels.
Use the Available Action search box or drill-down menu to find the actions you want for your tool. Then, drag and drop these actions to the Tool Creator.
Next, direct the flow of actions from the Start Node to your first action step by selecting the circle edge and dragging it to the first box:
RCT Builder will auto-select the edge arrow in blue and populate the item properties fields below. Configuring and setting parameters will tell ConfigMgr what properties of the object you run RCT Builder tools on to change:
First, let’s map the Target Input Parameters:
- You can map parameters as a constant value or to a specific property or step. Constant values will need to be specified, whereas Parameter Mapped values can be pulled from any step of your 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.
RCT Builder has the ability to set and work with conditional responses. You can set RCT Builder to skip certain actions based on the results from previous actions. There are several logical terms to choose from:
Once you add a logical condition, you can specify the input value to associate. In this example, I set an “Equal to” condition from the Computer name to a name of a device “XYZ.”
If the conditions are true, RCT Runner will execute the next step according to your workflow. If not, the next step (and any subsequent in the chain) will be skipped.
Once complete, be sure to save the tool you have created. If you’re running RCT Enterprise’s Recast Server, your RCT Builder tools are automatically saved and can be assigned with the Role-Based Permissions section of Recast Server.