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 Get-OrchUserPrivilege Add-OrchUser Update-OrchUser Copy-OrchUser Remove-OrchUser Remove-OrchRoleFromUser Get-OrchCurrentUser Update-OrchCurrentUserURPassword Get-OrchLicenseNamedUser Get-OrchLicenseRuntime Enable-OrchLicenseRuntime Disable-OrchLicenseRuntime Get-PmAuditLog Get-PmLicensedUser Get-PmLicensedGroup Remove-PmLicensedGroup Add-PmLicenseToPmLicensedGroup Remove-PmAllocationFromPmLicensedGroup Remove-PmLicenseFromPmLicensedGroup 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 Copy-OrchQueueItem Remove-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-PmDirectory Resolve-PmDirectoryNameBulk Get-PmUser Update-PmUser Remove-PmUser New-PmUser Copy-PmUser Get-PmRobotAccount Set-PmRobotAccount Copy-PmRobotAccount Remove-PmRobotAccount Get-PmGroup New-PmGroup Copy-PmGroup Remove-PmGroup Get-PmGroupMember Add-PmGroupMember Move-PmGroupMember Remove-PmGroupMember Get-PmExternalApiResource Get-PmExternalApplication Copy-PmExternalApplication Remove-PmExternalApplication Get-DuRole Get-DuDocumentType Get-DuClassifier Get-DuExtractor Get-DuUser Add-DuUser Remove-DuRoleFromDuUser 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 Open-OrchLogLocation

Functions

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

Dependencies

This module has no dependencies.

Release Notes

- Folder cache was not properly cleared in some cases after executing Clear-OrchCache, or after creating or deleting folders. This issue was introduced in version 0.9.12.2.

- Copy-Item and Copy-OrchQueue failed to copy queues from Automation Cloud to MSI Orchestrator. This issue was introduced in version 0.9.10.7.

- New cmdlets Copy-OrchQueueItem and Remove-OrchQueueItem have been added.
 - Copy-OrchQueueItem copies all queue items with the status New to a queue with the same name in a different folder, and outputs the items that were successfully copied. The output can be piped to Remove-OrchQueueItem to remove those items from the source queue, preventing duplicate transaction processing.

 - Remove-OrchQueueItem outputs any items that failed to be removed. These can be exported to a CSV file using Export-Csv, and later re-imported to retry deletion. To use Remove-OrchQueueItem independently, specify the queue name and the IDs of the items to remove.

- Below is an example of using the Copy-OrchQueueItem and Remove-OrchQueueItem cmdlets:
 - To move items from the MyQueue queue in the \Shared folder to a queue with the same name in the \dst folder:
   PS Orch1\Shared> Copy-OrchQueueItem MyQueue \dst | Remove-OrchQueueItem | Export-Csv c:itemsToRemove.csv -Encoding utf8BOM

 - To move items from all queues in one tenant to the corresponding queues in another tenant with the same folder structure:
   PS Orch1:\> Copy-OrchQueueItem -Recurse * Orch2:\ | Remove-OrchQueueItem | Export-Csv c:itemsToRemove.csv -Encoding utf8BOM

- Note: The Copy-OrchQueueItem cmdlet does not copy the queues themselves. If the destination folder does not contain a queue with the same name, you need to copy the queues beforehand using the Copy-OrchQueue cmdlet. Keep in mind that Copy-OrchQueue copies only the queue definitions. It does not copy the items contained in the queues.
 - To copy all queues in the \Shared folder to the \dst folder:
   PS Orch1\Shared> Copy-OrchQueue * \dst

 - To copy all queues in a tenant to another tenant that has the same folder structure:
   PS Orch1:\> Copy-OrchQueue -Recurse * Orch2:\

- To ensure safe operation, it is strongly recommended to disable triggers and stop automation processes in both source and destination folders before copying queue items.
 - To disable all triggers in both Orch1: and Orch2::
   PS> Disable-OrchTrigger -Path Orch1:\,Orch2:\ -Recurse *