Section 9. Settings
9.6 Menu Actions
Menu Selections and Menu Actions
New menu selections that appear as a right-click option on Devices or NAS screens can be created in the Menu Actions tab. Menu selections are a sequence of menu actions to complete a process.
The Menu Selection area will allow you to create a new right-click job menu for devices or NAS shares. Existing or new Menu Action entries should be dragged over to the desired Menu Selection item to complete the custom job process.
The Menu Action area will allow you to create the action(s) that will be downloaded and executed against devices or NAS shares. You can associate a single action or multiple actions with a Menu Selection object by dragging each Menu Action item over to the desired Menu Selection.
It is important to note that system menu selections and actions can only be viewed or copied, they are not editable.
Adding or copying a Menu Action
To add or copy a menu action: Above the Menu Action table, click Add or select an existing menu action and click Copy (or right-click and select Copy). Check Show System to view and select an existing system menu action.
SMART ACTIVE DIRECTORY MIGRATOR 9.2 USER GUIDE 67
Menu Action Name (Required): Enter a name for the menu action. The Menu Action Name cannot begin with
"BT-" which is used to identify system menu actions.
Menu Action 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 tabs. Global Variables can be added and used in the script.
Command Line: Allows you to define a Command line for the process on the Command and Rollback tabs. 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.
SMART ACTIVE DIRECTORY MIGRATOR 9.2 USER GUIDE 68
General tab: Mark or unmark the following checkboxes and enter the following options if adding or copying a PowerShell Script or Command Line:
Automatic Rollback: if checked, automatic rollback is added to the menu action.
Requires Cutover Credentials: if checked, the script or command line includes the
$CutoverCredentials_XXXXX parameters.
Requires Network Profile: if checked, the script or command line includes the $NetworkProfile_XXXXX parameters.
Requires Migration Options: if checked, the script or command line includes the
$MigrationOption_XXXXX parameters.
Requires Global Variables: if checked, the script or command line includes the Global Variables.
Timeout (Seconds): For PowerShell Script or Command Line, enter the number of seconds the process will be attempted before timing out.
Retry Count: For PowerShell Script or Command Line, enter the number of times the process will be retried.
Update Interval (Seconds): For PowerShell Script or Command Line, enter the number of seconds between process runs.
Command tab: Enter a PowerShell scrip to command line. 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 or PowerShell Script. Text is required.
Rollback tab: Enter a PowerShell scrip to command line. 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 or PowerShell Script. Text is required.
Download tab: Enter the following options if adding or copying a Download File menu action. When a new download job is created for a managed workstation, the specified file that is stored on the SMART AD Migrator server (c:\Program files\Binary Tree\ADMigrator\Downloads\) will be downloaded to c:\Program files\Binary Tree\ADMigrator 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 file characters and cannot use reserved file names:
map.usr, map.gg, ReACL-config.json.
Target Location: The target location of the download job. The Target Location cannot contain invalid file characters and cannot use reserved file names: map.usr, map.gg, ReACL-config.json.
Retry Count: For PowerShell Script or Command Line, enter the number of times the process will be retried.
Update Interval (Seconds): For PowerShell Script or Command Line, enter the number of seconds between process runs.
Timeout (Seconds): For PowerShell Script or Command Line, enter the number of seconds the process will be attempted before timing out.
The local download folder on an AD Migrator managed machine will be secured with permissions only for the BUILTIN\Administrators group.
SMART ACTIVE DIRECTORY MIGRATOR 9.2 USER GUIDE 69
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\ADMigrator Agent\Downloads\) on the Agent machine.
Adding or copying a Menu Selection
To add or copy a menu selection: above the Menu Selection table, click Add or select an existing menu selection and click Copy (or right-click and select Copy). Check Show System to view and select an existing system menu selection.
Cover adding menu actions to menu selections (drag and drop), expand, collapse, sequence.
Menu Selection Name (Required): Enter a name for the menu selection. The Menu Action Name must be unique.
Display Name: Enter the name that appears in the right-click menu on the Devices or NAS screen.
Object Type: Select one of the options from the drop-down list.
Device: The menu selection will appear in the right-click menu on the Devices screen.
NAS: The menu selection will appear in the right-click menu on the NAS screen.
SMART ACTIVE DIRECTORY MIGRATOR 9.2 USER GUIDE 70
Activity: Select one of the options from the drop-down list. The Activity determines what validations are applicable to the job, and which status columns are updated when the job runs. for example, a custom menu selection with the ReACL activity, it will have the same validations as the system ReACL menu selection.
Discovery: Gathers properties from the device.
ReACL: Updates device domain user profiles for use by the matching target user after cutover.
ReACLRollback: Rolls back all changes made by the ReACL process.
ReACLShare: Updates the NAS’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 device 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 device back to the source domain.
UploadLogs: Uploads log files from the AD Migrator Device Agent to the AD Migrator Web Server using Microsoft BITS.
Other (default): An activity not related to any system activity. No predefined validations are applicable.
By default, new menu selections are assigned as Other.
Menu Selection Type: This option is not editable. System types are read-only. User types can be edited.
Description: Enter a description for the menu action.
Adding Menu Actions to Menu Selections
Drag and drop system or custom menu actions from the Menu Action list to the menu selection in the Menu Selection list. Menu actions are listed in the order in which they will be executed. Drag and drop menu actions to reorder them.
Menu Actions can be viewed, copied, or removed by clicking the selecting the menu action and clicking the appropriate button or by right-clicking and selecting an option from the menu.
Activating Menu Selections
Only menu selections marked as Active will appear in the right-click menus. Click the Deactivate or Activate button to change the active status of the menu selection. Inactive menu selections can be displayed in the table by marking the Show Inactive check box. You may want to create a new menu selection, activate it, and then deactivate the system menu selection.