Actions
Custom Actions and Tasks
New Custom Actions that appear in the Actions menu can be created on the Actions screen. Actions are a sequence of Tasks to complete a process.
The Actions screen will allow you to create a new Custom Actions that can be performed against Accounts, Computers or File Shares. Existing or new tasks can be added to a the desired Custom Action and then ordered as necessary to complete the custom process.
It is important to note that System actions and tasks can only be viewed or copied, they are not editable.
Adding or copying aN Action
To add or copy an action: Below the table, click New or select an existing Custom Action and click Copy. Check Show System to view and select any existing Systemactions.
- Action Name (Required): Enter a name for the Custom Action. The Action Name must be unique.
- Description: Enter a description for the action.
- Action Display Name: Enter the name that appears in the Actions menu.
- Action Target: Select one of the options from the drop-down list.
- Computer: The Action will appear in the Actions menu on the Computers screen.
- File Share: The Action will appear in the Actions menu on the File share screen.
- User: The action will appear in the Actions menu on the Users screen.
- Contact: The action will appear in the Actions menu on the Contacts screen.
- Resource Mailbox: The action will appear in the Actions menu on the Resources screen.
- Group: The action will appear in the Actions menu on the Groups screen.
- Admin Agent: The action will appear in the Actions menu on the Admin Agents screen.
- Action Type: Select one of the options from the drop-down list. The Action Type determines what validations are applicable to the job, and which status columns are updated when the job runs. For example, a Custom Action with the ReACL type, will have the same validations as the System ReACL action.
- Other (default): An action not related to any System action. No predefined validations are applicable. By default, new Actions are assigned as type Other.
- Discovery: Gathers properties from the computer.
- ReACL: Updates computer domain user profiles for use by the matching target user after cutover.
- ReACLRollback: Rolls back all changes made by the ReACLShare process.
- ReACLShare: Updates the File Share’s domain user profiles for use by the matching target user after cutover.
- ReACLRollbackShare: Rolls back all changes made by the ReACL process.
- Cutover: Moves a computer from the source domain to the new target domain.
- Cleanup: Removes the Source SIDs after the Cutover process completes.
- CleanupShare: Removes the Source SIDs after the Cutover process completes.
- ExplicitRollback: Rejoins a computer back to the source domain.
- UploadLogs: Uploads log files from the Migrator Pro for Active Directory Agent to the Migrator Pro for Active Directory Server using Microsoft BITS.
- Menu Selection Type: This option is not editable. System types are read-only. User types can be edited.
Adding or copying a Task
To add or copy a task: Below the Tasks table, click New or select an existing task and click Copy. Check Show System to view and select an existing Systemtask.
- Task Name (Required): Enter a name for the task. The Task Name cannot begin with "BT-" which is used to identify system tasks.
-
Task Type (Required): Select one of the options from the drop-down list.
- PowerShell Script: Allows you to define a PowerShell script for the process on the Command and Rollback screens. Global Variables can be added and used in the script.
- Command Line: Allows you to define a Command Line command for the process on the Command and Rollback screen. Global Variables can be added and used in the command line.
- Download File: Downloads a file to the predefined Downloads folder.
- Description: Enter a description for the menu action.
- General : Mark or unmark the following checkboxes and enter the following options if adding or copying a PowerShell script or Command Line command:
- Automatic Rollback: if checked, automatic rollback is added to the task.
- Requires Cutover Credentials: if checked, the PowerShell script or Command Line command includes the $CutoverCredentials_XXXXX parameters.
- Requires Network Profile: if checked, the PowerShell script or Command Line command includes the $NetworkProfile_XXXXX parameters.
- Requires Migration Options: if checked, the PowerShell script or Command Line command includes the $MigrationOption_XXXXX parameters.
- Requires Global Variables: if checked, the PowerShell script or Command Line command includes the Global Variables.
- Requires Offline Domain Join: if checked, PowerShell script or Command Line command includes the Offline Domain Join parameters.
- Run On Admin Agent: if checked, the PowerShell script or Command Line command can only be used on Admin Agents computers.
- Timeout (Seconds): For PowerShell script or Command Line command, enter the number of seconds the process will be attempted before timing out.
- Retry Count: For the PowerShell script or Command Line command, enter the number of times the process will be retried.
- Update Interval (Seconds): For PowerShell script or Command Line command, enter the number of seconds between process runs.
- Script: Enter a PowerShell script or Command Line command. If creating a PowerShell script, click Starter Script to populate the entry box with the basic framework of a script. Enter or edit the Command Line command or PowerShell script. Text is required. The return value of the script or command will determine success or failure.
- Rollback: Enter a PowerShell script or Command Line command to run in case of failure/Rollback. Ideally this would undo the effects of the above script. If creating a PowerShell script, click Starter Script to populate the entry box with the basic framework of a script. Enter or edit the Command Line command or PowerShell script. Text is required. The return value of the script of command will determine success or failure.
- Download: Enter the following options if adding or copying a Download File task. When a new download job is created for a managed workstation, the specified file that is stored on the Migrator Pro for Active Directory Server (by deafault: c:\Program files\Binary Tree\ADPro\Downloads\) will be downloaded to c:\Program files\Binary Tree\ADPro Agent\Downloads\ on the workstation’s local disk.
- File Name (required): The file name. Based on the File Location for Download Jobs used during installation The File Name cannot contain invalid filepath characters and cannot use the following reserved file names: map.usr, map.gg, and ReACL-config.json.
- Target Location: The Target Location of the download job. The Target Location cannot contain invalid filepath characters and cannot use the following reserved file names: map.usr, map.gg, ReACL-config.json. A Target Location is required if the File Name contains environment variables.
- Retry Count: For PowerShell script or Command Line commands, enter the number of times the process will be retried.
- Update Interval (Seconds): For PowerShell scripts or Command Line commands, enter the number of seconds between process runs.
- Timeout (Seconds): For PowerShell scripts or Command Line commands, enter the number of seconds the process will be attempted before timing out.
The local download folder on an Migrator Pro for Active Directory managed machine will be secured with permissions only for the BUILTIN\Administrators group.
 |
If rights other than BUILTIN\Administrators are required then the administrator will need to make a change on the local downloads folder (c:\Program files\Binary Tree\ADPro Agent\Downloads\) on the Agent machine. |
Adding Tasks to Actions
To add a Task to an Action: Select a Task in the Tasks table, select an Action in the Select Action drop-down menu and click the Add To button.
Under a given Action the Tasks are listed in the order in which they will be executed. Drag and drop tasks to reorder them. Tasks can be viewed, copied, or removed by selecting the tasks and clicking the appropriate button.
Tasks marked as "Run On Admin Agent" can be added to Computer, User, Room, Contact, or Group Object Type menu selections (File Share is not supported). Tasks designed to run on computers or File shares can be added to Computer or File Share Object Type Actions only.
Activating Actions
Only Actions marked as Active will appear in the Actions menus. Select an Action in the table and click the Disable or Enable button to change the active status of the Action. Inactive actions can be displayed in the table by clicking the Show Disabled button. You may want to create a new action, enable it, and then disable the corresponding System action.