UiPathOrch

Author(s)

• Yoshifumi Tsuda

Cmdlets

Get-OrchLibrary Get-OrchLibraryVersion Remove-OrchLibrary Import-OrchLibrary Export-OrchLibrary Copy-OrchLibrary Get-OrchPackage Copy-OrchPackage Get-OrchPackageVersion Remove-OrchPackage Import-OrchPackage Export-OrchPackage Get-OrchJob Start-OrchJob Stop-OrchJob Open-OrchJob Get-OrchLog Get-OrchAuditLog Get-OrchJobMedia Export-OrchJobMedia Remove-OrchJobMedia Get-OrchProcess New-OrchProcess Update-OrchProcess Copy-OrchProcess Remove-OrchProcess Edit-OrchProcess Update-OrchProcessVersion Reset-OrchProcessVersion Get-OrchRobot Get-OrchUser Add-OrchUser Update-OrchUser Copy-OrchUser Remove-OrchUser Remove-OrchRoleFromUser Get-OrchCurrentUser Update-OrchCurrentUserURPassword Get-OrchLicenseNamedUser Get-OrchLicenseRuntime Enable-OrchLicenseRuntime Disable-OrchLicenseRuntime Get-OrchPmAuditLog Get-OrchPmLicensedUser Get-OrchPmLicensedGroup Remove-OrchPmLicensedGroup Add-OrchPmLicenseToPmLicensedGroup Remove-OrchPmAllocationFromPmLicensedGroup Remove-OrchPmLicenseFromPmLicensedGroup Get-OrchClassicRobot Get-OrchClassicEnvironment Get-OrchUserSession Get-OrchMachineSession Get-OrchUnattendedSession Enable-OrchMaintenanceMode Disable-OrchMaintenanceMode Get-OrchJobStats Get-OrchLicenseStats Get-OrchRole Set-OrchRole Remove-OrchRole Copy-OrchRole Get-OrchCalendar Remove-OrchCalendar Copy-OrchCalendar Add-OrchCalendarDate Remove-OrchCalendarDate Get-OrchPersonalWorkspace Remove-OrchPersonalWorkspace Get-OrchFolderUsage Get-OrchFolderUser Add-OrchFolderUser Copy-OrchFolderUser Move-OrchFolderUser Remove-OrchFolderUser Add-OrchRoleToFolderUser Remove-OrchRoleFromFolderUser Get-OrchMachine Update-OrchMachine New-OrchMachine Remove-OrchMachine Copy-OrchMachine Get-OrchMachineClientSecretId Add-OrchMachineClientSecret Remove-OrchMachineClientSecret Get-OrchFolderMachine Add-OrchFolderMachine Copy-OrchFolderMachine Remove-OrchFolderMachine Enable-OrchFolderMachineInherit Disable-OrchFolderMachineInherit Get-OrchFolderMachineAccountMapping Enable-OrchFolderMachineAccountMapping Disable-OrchFolderMachineAccountMapping Get-OrchAsset Set-OrchAsset Copy-OrchAsset Remove-OrchAsset Set-OrchCredentialAsset Get-OrchCredentialStore Copy-OrchCredentialStore Remove-OrchCredentialStore Get-OrchAssetLink Add-OrchAssetLink Get-OrchTrigger New-OrchTrigger Update-OrchTrigger Remove-OrchTrigger Copy-OrchTrigger Enable-OrchTrigger Disable-OrchTrigger Get-OrchApiTrigger Remove-OrchApiTrigger Copy-OrchApiTrigger Enable-OrchApiTrigger Disable-OrchApiTrigger Get-OrchQueue New-OrchQueue Update-OrchQueue Copy-OrchQueue Remove-OrchQueue Get-OrchQueueItem Import-OrchQueueItem Redo-OrchQueueItem Get-OrchTestSet Copy-OrchTestSet Remove-OrchTestSet Start-OrchTestSet Get-OrchTestCase Get-OrchTestCaseExecution Remove-OrchTestCase Get-OrchTestSetExecution Stop-OrchTestSetExecution Get-OrchTestSetSchedule Copy-OrchTestSetSchedule Remove-OrchTestSetSchedule Enable-OrchTestSetSchedule Disable-OrchTestSetSchedule Get-OrchTestDataQueue Copy-OrchTestDataQueue Remove-OrchTestDataQueue Get-OrchTestDataQueueItem Reset-OrchTestDataQueueItem Get-OrchAlert Get-OrchBucket New-OrchBucket Copy-OrchBucket Remove-OrchBucket Get-OrchBucketItem Get-OrchWebhook Copy-OrchWebhook Remove-OrchWebhook Enable-OrchWebhook Disable-OrchWebhook Get-OrchSetting Get-OrchExecutionSetting Get-OrchWebSetting Get-OrchAuthenticationSetting Get-OrchActivitySetting Get-OrchConnectionString Get-OrchLicense Get-OrchUpdateSetting Get-OrchActionCatalog Copy-OrchActionCatalog Remove-OrchActionCatalog Search-OrchDirectory Search-OrchPmDirectory Resolve-OrchPmDirectoryNameBulk Get-OrchPmUser Update-OrchPmUser Remove-OrchPmUser New-OrchPmUserBulk Copy-OrchPmUser Get-OrchPmRobotAccount Set-OrchPmRobotAccount Copy-OrchPmRobotAccount Remove-OrchPmRobotAccount Get-OrchPmGroup New-OrchPmGroup Remove-OrchPmGroup Get-OrchPmGroupMember Add-OrchPmGroupMember Move-OrchPmGroupMember Remove-OrchPmGroupMember Get-OrchPmExternalApiResource Get-OrchPmExternalApplication Get-DuRole Get-DuUser Get-DuDocumentType Get-DuClassifier Get-DuExtractor Get-TmConfiguration Get-TmProjectSetting Get-TmProjectPermission Get-TmServerInfo Get-TmRequirement Remove-TmRequirement Get-TmTestCase Remove-TmTestCase Get-TmTestSet Remove-TmTestSet Clear-OrchCache Edit-OrchConfig Get-OrchPSDrive Set-OrchLocation

Functions

Get-OrchTestDataQueueItemTable Enable-OrchUserAttended Disable-OrchUserAttended Enable-OrchPersonalWorkspace Disable-OrchPersonalWorkspace Find-OrchFolderNoUserAssigned Get-OrchJobVideo

Dependencies

This module has no dependencies.

Release Notes

- Improved Get-OrchTrigger cmdlet:
 - Fixed an issue where the ExecutorRobots property of triggers could not be retrieved. This required calling an additional endpoint:
   GET /odata/ProcessSchedules/UiPath.Server.Configuration.OData.GetRobotIdsForSchedule(key={processScheduleId})

 - When the -ExpandDetails or -ExportCsv switch parameter is specified, the above endpoint is called along with following endpoint. The behavior of calling this endpoint remains unchanged from previous versions:
   GET /odata/ProcessSchedules({processScheduleId})

 - As part of this fix, the CSV file output by Get-OrchTrigger -ExportCsv now include an ExecutorRobots column. Additionally, the MachineRobots column is now serialized in a more appropriate format.

 - Triggers are no longer retrieved from personal workspace folders when the Orchestrator Web API version is below 12, as attempting to do so would result in an error.

- Improved New-OrchTrigger and Update-OrchTrigger cmdlets:
 - Added the -ExecutorRobots parameter, allowing better reflection of trigger dynamic allocation and account mapping information.

 - Enhanced the completers for the -ExecutorRobots and -MachineRobots parameters.
   - For New-OrchTrigger, the completers display available combinations of values, and multiple values can be specified using a comma-separated format.
   - For Update-OrchTrigger, the completers show the values configured for the specified triggers.

- Improved Copy-OrchTrigger and Copy-Item cmdlets:
 - Improved the ability to copy trigger dynamic allocation and account mapping information. However, to fully copy these, the destination folder must have the appropriate robots and sessions configured.

 - Fixed an issue where copying a trigger with a StopProcessDate in the past would fail. Now, if the date is in the past, it is removed, and the trigger is copied with Enabled set to false.

 - When copying queue triggers, the operation now fails if a queue with the same name does not exist in the destination folder.

 - The Copy-Item cmdlet now copies entities in alphabetical order by their names.

- Fixed an issue in the Copy-OrchCalendar cmdlet where all calendars were copied regardless of the value specified in the -Name parameter.

- Improved Add-OrchFolderMachine cmdlet:
 - When the target folder is a personal workspace folder, the cmdlet now skips processing. For example, when adding a machine to all folders directly under the root, unnecessary errors are no longer output:

   PS Orch1:\> Add-OrchFolderMachine -Path * MyMachine

- Improved Get-ChildItem cmdlet (alias: dir):
 - When the Orchestrator API version is outdated and does not return the FolderType property, this cmdlet now sets this property to either Personal or Standard (simulated). This is useful when writing .ps1 scripts to process folders.

- Addressed an issue where inappropriate warnings about OAuth scopes were output when connecting to Orchestrator without OAuth support using a username and password.

- Added three cmdlets for searching the directory service. Each cmdlet corresponds to a different endpoint:
 - Search-OrchDirectory cmdlet
   Endpoint: GET /api/DirectoryService/SearchForUsersAndGroups

 - Search-OrchPmDirectory cmdlet
   Endpoint: GET /api/Directory/Search/{partitionGlobalId}

 - Resolve-OrchPmDirectoryNameBulk cmdlet
   Endpoint: POST /api/Directory/BulkResolveByName/{partitionGlobalId}