Automation

The Recast Builder interface consists of a central canvas surrounded by three panels.

On the left

A. My Right Click Tools panel: Displays the icons for adding a new action, saving the current action, and deleting saved actions. Saved actions and pre-built templates are accessible from the panel according to where they were created in the Configuration Manager console. If, for example, Recast Builder is accessed from Devices, tools for editing devices will be displayed.

On the right

B. Recast Actions panel: This searchable list displays hundreds of available actions by category. For a full list of available actions, see the Recast Actions Catalog.

In the center

C. Canvas: Drag and drop your saved Right Click Tools, pre-built templates, and Recast Actions onto this area to work with them. The Start Node represents the object selected when running the action, such as a device or user.

D. Viewfinder: Use this box to move around the canvas and to adjust settings including the zoom level, centering and fill.

At the bottom

E. Properties and parameters: Different sections appear at the bottom of the interface depending on what is selected on the canvas.

Action Properties: Configure View, Name, Display and Action Type options for your custom tools.
See Configure Action Properties.

Target Input Parameters: Map a parameter to a constant value or to a specific property or step.
See Map Target Input Parameters.

Custom Input Parameters: Provide users with input options before an action runs. Common uses include choosing a collection to which a device will be added, choosing whether to force a full inventory cycle upon completion, and having an admin input a PowerShell script.
See Set Custom Input Parameters.

Conditional Responses: Set conditional responses to skip actions based on the results of previous actions.
See Set Conditional Responses.

To create a new custom tool in the My Right Click Tools list, click the New Action button (+ sign).

Recast offers a set of pre-built actions to get you started with Builder. These workflows are made up of a sequence of actions, and can be used as-is or as a starting point for creating your own custom Right Click Tools. For a description of the tasks included in each pre-built sequence of actions, see Recast Builder Actions.

Pre-built actions are listed in the My Right Click Tools panel. The Builder Actions displayed will vary depending on where you've opened Builder in your Configuration Manager console. For example, when Builder is accessed from Users, the templates that include user management actions will appear.

Drag-and-drop the templates onto the canvas to view and/or edit the actions they include. Pre-built actions often require some configuration in Builder. For instructions, see Configure Builder Actions.

In addition to the pre-built actions available within Builder, you'll also find a growing collection of Recast actions and workflows in our Community Recast Automation Repository. You can import any of the templates from this shared library into Builder.

You can add any of the actions listed in the Recast Actions panel to create an automated workflow. For a list of all the available actions, see the Recast Actions Catalog.

To add actions to an automation sequence:

1. Use the Recast Actions search box or drill-down menu to select the desired actions. 

2. Drag-and-drop each action onto the canvas area.

3. Order the sequence of actions from the Start Node to the first action by selecting the circle edge and dragging it to the first box.

Builder will auto-select the Edge arrow in blue and populate the item properties in the Selected Edge section. Setting parameters will tell Configuration Manager which properties to change on the targeted object.

Choose Action Properties to determine the design and configuration of a Recast Builder action.

To choose action properties:

1. On the canvas, click the Start Node (the object the user will click on to run the tool).

2. Under Action Properties, specify the View, Name, Display and Action Type, which are described below.

View

The View field determines how the results of a Right Click Tools Builder tool will display. View options do not affect the technical operation of Right Click Tools Builder tools — they only affect how results are displayed.

View Options:

• Single Grid Results
• Two Grid Results
• Tabbed Results: Shows a result for each step of the tool

Name

Name sets the name of the Recast Builder tool. After entering a new tool name, click the Save icon in the My Right Click Tools panel.

Display

Display sets the Configuration Manager object that the Right Click Tools Builder tool is run against. Options differ according to the selected Action Type.

Example: For a tool run against a device, Computer Name would be an appropriate display option.

Action Type

The Action Type sets the properties on which the tool will take action.

Action Type Options:

• Generic: For all Right Click Tools 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 Right Click Tools device tools are available. The Resource ID is Configuration Manager'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 Configuration Manager's unique identifier for a user object.

Input Parameters can be used to offer administrators and end users with options before an action is run.

Examples of custom inputs:

• 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.

To add an input parameter:

Under Custom Input Parameters, select an option from the drop-down list and click Add.

Parameter Options

• Boolean: Prompts the user running the action with an option to check or uncheck the parameter mapped to the Boolean.
• DateTime: Prompts the user running the action with an option to select the date and time.
• Integer: Prompts the user running the action with an option to set an integer value. You also have the option to set a default, minimum, and maximum value.
• TimeSpan: Prompts the user running the action with an option to set a length of time. A default value can be set, if needed.
• String: Provides two options - List or Textbox. This will prompt the user running the action to select or input a string.

List

Textbox

To remove an input parameter:

Under Custom Input Parameters, select a listed item and click Remove.

Parameters can be mapped to a constant value or a specific property or step. Constant values must be specified, whereas Parameter Mapping 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. 

• Use a Constant value to hard code a value.
• Use Parameter Mapping for actions where you need to pull inputs from the user or where the properties of the object should change.

To map to a constant value:

Under Target Input Parameters, select Constant.

To map to a property or step:

Under Target Input Parameters, select Parameter Mapping, then select the Node and the Parameter from the drop-down lists.

Right Click Tools Builder lets you set conditional responses, allowing you to skip actions based on the results from previous actions. If the conditions are true, Recast 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.

Logical term options:  And, Or, Less Than, Less Than or Equal To, Equal To, Greater Than, Greater Than or Equal To

To add a conditional response:

1. On the canvas, click on the edge (arrow) that connects the two actions between which you want to add a condition.

2. In the Condition section, click the New Condition icon (+ sign) and select a logical term from the drop-down list.

3. Associate the condition with a specific Output and/or input Value.

    In this example, an "Equal To" condition has been set from the Computer Name to the name of device "XYZ".

Recast Builder Actions can help you quickly automate a workflow in your environment. These pre-built sequences of actions are designed to get you started using Recast Builder, introduce you to some of the automation features available in Builder, and help you start making tools on your own.

As of v5.1.2305.507, pre-built actions can be accessed from within Recast Builder, removing the need to import them into the interface. These actions will only appear in Builder, upon upgrade or with a fresh install, for deployments that do not already have existing Builder actions in place. To learn more, see Configure Recast Builder Actions.

Disclaimer: These Builder actions are provided on the basis that they can be edited, changed, and shared, but not sold. While every available effort has been made to be sure they work well and do what was intended, we can't anticipate the requirements of every conceivable Configuration Manager environment, so download/use at your own risk — no guarantees of function, support, or that they won't break something. As with everything, test first.

All Client Policies

This Builder action runs through all the Configuration Manager's client policies. This is great for new or recently re-built computers to force them to check into Configuration Manager.

This tool completes the following steps:

• Ping computer
• Machine Policy Retrieval and Evaluation Cycle
• Discovery Data Collection Cycle
• Hardware Inventory Cycle
• Software Inventory Cycle
• Send Unsent State Messages Cycle
• Software Updates Scan Cycle
• Application Deployment Evaluation Cycle
• State Message Cache Cleanup
• Windows Installer Source List Update Cycle
• Software Inventory Cycle
• File Collection Cycle
• Software Updates Deployment Evaluation Cycle

For v5 Releases: Now available in Builder, All Client Policies 5.xml

Add an AD User to an AD Group 

This Builder action lets you add an AD user to an AD group from a list of groups.

For v5 Releases: Now available in Builder, Add To Group 5.xml

For instructions on setting up this template in Builder, see Configure Starter Pack Templates in Recast Builder.

BitLocker Recovery Password from Device

This Builder action grabs the BitLocker Recovery Password from any drive on a device. This uses a custom input parameter to allow users to choose what drive they want to grab the recovery password from.

This tool completes the following step:

• Get Recovery Password From Device

For v5 Releases: Now available in Builder, BitLocker Recovery Password 5.xml

Compare Two Users' AD Groups

This Builder action lets you compare the group memberships of two AD users. This action is particularly useful if, for example, you have a new team member and want to compare their group memberships to those of an existing team member.

This tool completes the following steps:

• Gets AD group membership for a selected user
• Prompts you to enter the AD username that you'd like to compare against the selected user
• Shows you group memberships for both users in tabbed results 

For v5 Releases: Now available in Builder, Compare AD Groups 5.xml

User Account Retire Protocol

This Builder action automates a common task — taking steps when a person leaves an organization to secure their account credentials and prepare the account for retirement. It's easily adaptable to other user-based tasks as well, and is a nice jumping-off point for Recast Builder.

This tool completes the following steps:

• Prompts the admin running the tool to input a new password for the account
• Resets the password for the account to this password
• Disables the account
• Moves the account to a new OU
  

In the Target Input Parameters panel, you must specify a valid OU in your environment as a Constant value. 

Format Example: OU=RecastUsers,DC=demo,DC=recastsoftware,DC=com

For v5 Releases: Now available in Builder, User Account Retire Protocol 5.xml

For instructions on setting up this template in Builder, see Configure Recast Builder Actions.

Reboot if Pending Restart Exists

This Builder action allows you to force a restart on systems that have a pending reboot scheduled, without requiring you to query for pending reboot data in advance. It's a friendly way to help your end users who hate to restart stay updated and compliant without requiring any personal intervention.

This tool completes the following steps:

• Ping Computer
• If Ping is successful, Check System Information Collection for Pending Restart Information
• If Pending Restart Exists, force a Reboot with a 5-minute timer and a user pop-up message: "Your computer needs to restart, please save and close in the next 5 minutes."

For v5 Releases: Now available in Builder, Reboot If Pending Restart Exists 5.xml

Video Overview

Fix Encryption Method

This Builder action automates the process of adding TPM and Numerical Key Protectors to BitLocker. It includes all the necessary precursor steps and enough intelligence to complete this task without admin intervention.

This tool completes the following steps:

• Stop MBAM Service
• Decrypt C: Drive
• A PowerShell Script with Progress Stream on to monitor the progress of the decryption, and proceed when successfully completed. (Here is the script)

   #Wait for Decrypt Finish   Write-Output "Waiting on Decrypt...."   $encryption = Get-WmiObject -Namespace root/cimv2/security/microsoftvolumeencryption -Class win32_encryptablevolume -Filter {DriveLetter = 'C:'}   $Percent = ($encryption.GetConversionStatus()).EncryptionPercentage   While($Percent -ne '0'){   Start-Sleep -Seconds 10  $encryption = Get-WmiObject -Namespace root/cimv2/security/microsoftvolumeencryption -Class win32_encryptablevolume -Filter {DriveLetter = 'C:'}  $Percent = ($encryption.GetConversionStatus()).EncryptionPercentage  Write-Progress -activity "Decryption Progress" -PercentComplete $Percent -status "Decryption RProgress"  }

• A Registry change to override the encryption method
• Add the TPM Key Protector
• Add the Numerical Password Key Protector
• Encrypt C:

For v5 Releases: Now available in Builder

For v4 Releases: Fix Encryption Method.xml

Video Overview

Re-Enroll Agent

There are times when a Recast Agent attempts to connect to a Recast Management Server, but is unable. You'll see a warning in the Recast Management Server telling you that there is an Agent that is trying to connect, but it is not approved. This occurs most often if you delete the Agent from the Recast Management Server manually. Because the Agent information is deleted, there is no way to approve this Agent. 

To resolve the problem, use this Builder action to re-enroll the Recast Agent.

The tool completes the following steps:

• Deletes the agent.sqlite file located in this folder:

Version 5.x Recast Agent: C:\ProgramData\Recast Software\Recast Agent

Version 4.x Recast Agent: C:\Windows\System32\config\systemprofile\AppData\Roaming\Recast Software\Recast Agent

• Restarts the Recast Agent service

For v5 Releases: Now available in Builder

For v4 Releases: Re-Enroll Agent.xml

Grant Remote Access

This Builder action is used to grant a specific AD user remote access to a device by adding the user to the local "Remote Desktop Users" group on the device. 

The tool completes the following steps:

• Asks for the AD Username
• Adds the AD Username entered to the "Remote Desktop Users" local group. 

For v5 Releases: Now available in Builder, Grant Remote Access 5.xml 

For instructions on setting up this template in Builder, see Configure Recast Builder Actions.

As of Recast Software Version 5.1.2305.507, pre-built Recast templates can be accessed from within Recast Builder, eliminating the need to import them from the Recast Builder Actions page. These templates appear upon upgrade or with a fresh install for deployments that do not already have existing Builder templates in place.

For a description of the actions included in each pre-built template, see Recast Builder Actions.
For more information on configuring properties, parameters, and conditions, see the Recast Builder Overview.

You'll find pre-built Recast actions listed in the My Right Click Tools panel. Drag-and-drop them on to the canvas to view the sequence of included steps and edit their properties and parameters.

Some pre-built templates require a bit of configuration in Recast Builder before they can be run. 

User Account Retire Protocol 

For this Recast action, the Start Node represents the user account selected in Configuration Manager before running the action. The edges (aka the arrows) are preconfigured to link the Start Node to the Reset Password, Disable Account and Move Account to Container actions.

To configure the action:

1. Select the Start Node on the canvas.

Under Action Properties, view or edit the default settings and name the tool:

• View: Tabbed Results
• Name: For example, User Account Retire Protocol
• Display: User Name
• Action Type: User

Under Custom Input Parameters, view or edit the default settings:

• Display Name: Input a New Password
• Variable Name: TextBoxValue
• Minimum Length: 1
• Maximum Length: 20

2. Select the edge linking the Disable Account and Move Account to Container actions.

Under Target Input Parameters, update the ADPath as a Constant value.

ADPath Format Example: ADPath=RecastUsers,DC=demo,DC=recastsoftware,DC=com

NOTE: The ADPath is case sensitive.

Video Overview

Grant Remote Access 

To configure the action:

1. Select the Start Node on the canvas.

Under Action Properties, view or edit the default settings:

• View: Two Grid Results
• Name: For example, Grant Remote Access
• Display: Computer Name
• Action Type: Device with Resource ID

2. Select the edge linking the Start Node and Add Local Group Member actions.

3. Under Target Input Parameters, update the User Domain as a Constant value.

Video Overview

Add an AD User to an AD Group

To configure the action:

1. Select the Start Node on the canvas.

Under Action Properties, view or edit the default settings:

• View: Tabbed Results
• Name: For example, Add To Group
• Display: User Name
• Action Type: User with Resource ID

Under Custom Input Parameters, add any AD Groups beyond the Finance, Marketing and Remote Desktop default groups.

Video Overview

A list of all the actions available from the Recast Actions panel in the Builder interface.

Recast Runner executes actions created with Recast Builder. Builder actions can only be run with the user account accessing the Configuration Manager console or by routing over the Recast Proxy service account.

To execute a Builder Action with Recast Runner:

1. Right-click in your Configuration Manager console and select Recast Automation > Recast Runner.

2. In the RCT Runner - Run Action dialog, select an action and click Next.

3. Choose to run the action immediately or according to a schedule and click Finish.