Utilities Script

Modified on Wed, 25 Sep at 9:44 PM

 Starting in version v2025.14.1.x, commonly used PowerShell scripts have been packaged with ManagementStudio, making them more easily accessible in ESM, Datamining Report Buttons, Portal Pages, etc. This script is located at:

Admin\PowerShell Scripts\ManagementStudio\Internal [Global]\Utilities

It is internally named MSUtilities.

Script Arguments

When the Utilities script is called, it is generally passed three arguments (sometimes two):

  1. Action – Examples: ClearDeployUnitSlot, UnlockSurvey, MoveToProcess.
  2. Module – Examples: AP, UM, DV (e.g., UserMigrations, Applications, Devices).
  3. Additional Information – For example, a SurveyId in the case of UnlockSurvey. The specific items to run the action on are typically provided by the button, such as a Portal Button using the logged-in User.

Use Cases

Clear a Deployment Unit Slot

Allow a user to clear their own Deployment Unit Slot via a Portal Page button. Create a button that targets the Utilities script, and set the arguments as follows:

  • Arguments:
    • Arg 1: ClearDeployUnitSlot
    • Arg 2: ModuleType (e.g., 'UM' for UserMigrations)
    • Arg 3: Not required

Unlock Portal Form (Survey)

Allow a user to unlock a previously completed Portal Form (Survey). Create a button that targets the Utilities script, and set the arguments as follows:

  • Arguments:
    • Arg 1: UnlockPortalForm
    • Arg 2: ModuleType (e.g., 'UM' for UserMigrations)
    • Arg 3: SurveyId (e.g., 99)

Move to Process

Allow a user to move an Application (or other object) to a new process. This is particularly useful as a Web Button on a Datamining Report, enabling an Application Owner to move an Application to a new process.

  • Arguments:
    • Arg 1: MoveToProcess
    • Arg 2: ModuleType (e.g., 'AP' for Applications)
    • Arg 3: ProcessName (e.g., '5. Complete\Live')

This script offers a streamlined way to automate key management actions in the system, making it easier to handle tasks through predefined buttons and interfaces.