UiPathOrch

Author(s)

• Yoshifumi Tsuda

Tags

UiPath Orchestrator RPA Automation PSDrive PSProvider Cloud OnPremises

Cmdlets

Import-OrchConfig New-OrchPSDrive Invoke-OrchApi Switch-OrchCurrentUser Get-OrchPSDrive Get-OrchProductVersion Resolve-OrchAuthError 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 Restart-OrchJob Resume-OrchJob Open-OrchJob Get-OrchLog Get-OrchAuditLog Get-OrchJobMedia Export-OrchJobMedia Remove-OrchJobMedia Get-OrchProcess Get-OrchProcessDetail New-OrchProcess Update-OrchProcess Copy-OrchProcess Compare-OrchProcess Remove-OrchProcess Edit-OrchProcess Update-OrchProcessVersion Reset-OrchProcessVersion Get-OrchProcessRequirement Get-OrchRobot Get-OrchUser Compare-OrchUser Get-OrchUserDetail 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-PmAuthenticationSetting Get-PmLicense Get-PmLicenseAllocation Get-PmLicenseInventory Get-PmLicenseContract Get-PmGroupLicense Add-PmGroupLicense Remove-PmGroupLicense Remove-PmGroupLicenseAllocation Remove-PmLicensedGroup Get-PmUserLicense Add-PmUserLicense Remove-PmUserLicense Remove-PmLicensedUser Get-OrchClassicRobot Get-OrchClassicEnvironment Get-OrchUserSession Get-OrchMachineSession Get-OrchUnattendedSession Clear-OrchInactiveSession Get-OrchTask Get-OrchTaskAcrossFolder Set-OrchTask Remove-OrchTask Enable-OrchMaintenanceMode Disable-OrchMaintenanceMode Get-OrchJobStats Get-OrchLicenseStats Get-OrchRole Set-OrchRole Remove-OrchRole Copy-OrchRole Compare-OrchRole Get-OrchCalendar Remove-OrchCalendar Copy-OrchCalendar Compare-OrchCalendar Get-OrchCalendarDate Add-OrchCalendarDate Remove-OrchCalendarDate Get-OrchPersonalWorkspace Remove-OrchPersonalWorkspace Get-OrchFolderUsage Get-OrchFolderUser Compare-OrchFolderUser Add-OrchFolderUser Copy-OrchFolderUser Move-OrchFolderUser Remove-OrchFolderUser Add-OrchRoleToFolderUser Remove-OrchRoleFromFolderUser Get-OrchMachine Update-OrchMachine New-OrchMachine Remove-OrchMachine Copy-OrchMachine Compare-OrchMachine Get-OrchMachineClientSecretId Add-OrchMachineClientSecret Remove-OrchMachineClientSecret Get-OrchFolderMachine Compare-OrchFolderMachine Add-OrchFolderMachine Copy-OrchFolderMachine Remove-OrchFolderMachine Enable-OrchFolderMachineInherit Disable-OrchFolderMachineInherit Get-OrchFolderMachineAccountMapping Enable-OrchFolderMachineAccountMapping Disable-OrchFolderMachineAccountMapping Get-OrchAsset Set-OrchAsset Copy-OrchAsset Compare-OrchAsset Move-OrchAsset Remove-OrchAsset Set-OrchCredentialAsset Get-OrchCredentialAsset Set-OrchSecretAsset Get-OrchSecretAsset Remove-OrchAssetUserValue Get-OrchCredentialStore Copy-OrchCredentialStore Compare-OrchCredentialStore Update-OrchCredentialStore Remove-OrchCredentialStore Get-OrchAssetLink Add-OrchAssetLink Remove-OrchAssetLink Get-OrchBucketLink Add-OrchBucketLink Remove-OrchBucketLink Get-OrchQueueLink Add-OrchQueueLink Remove-OrchQueueLink Get-OrchTrigger Get-OrchTriggerDetail New-OrchTrigger Update-OrchTrigger Remove-OrchTrigger Copy-OrchTrigger Compare-OrchTrigger Enable-OrchTrigger Disable-OrchTrigger Test-OrchTrigger Get-OrchApiTrigger New-OrchApiTrigger Update-OrchApiTrigger Remove-OrchApiTrigger Copy-OrchApiTrigger Compare-OrchApiTrigger Enable-OrchApiTrigger Disable-OrchApiTrigger Get-OrchEventTrigger Compare-OrchEventTrigger Remove-OrchEventTrigger Enable-OrchEventTrigger Disable-OrchEventTrigger Get-OrchQueue New-OrchQueue Update-OrchQueue Copy-OrchQueue Compare-OrchQueue Move-OrchQueue Remove-OrchQueue Get-OrchQueueItem Import-OrchQueueItem Redo-OrchQueueItem Copy-OrchQueueItem Remove-OrchQueueItem Get-OrchTestSet Compare-OrchTestSet Get-OrchTestSetDetail New-OrchTestSet Copy-OrchTestSet Remove-OrchTestSet Start-OrchTestSet Get-OrchTestCase Get-OrchTestCaseExecution Get-OrchTestCaseAssertion Remove-OrchTestCase Get-OrchTestSetExecution Stop-OrchTestSetExecution Get-OrchTestSetSchedule Compare-OrchTestSetSchedule New-OrchTestSetSchedule Update-OrchTestSetSchedule Copy-OrchTestSetSchedule Remove-OrchTestSetSchedule Enable-OrchTestSetSchedule Disable-OrchTestSetSchedule Get-OrchTestDataQueue Compare-OrchTestDataQueue New-OrchTestDataQueue Copy-OrchTestDataQueue Remove-OrchTestDataQueue Get-OrchTestDataQueueItem Import-OrchTestDataQueueItem Reset-OrchTestDataQueueItem Get-OrchAlert Get-OrchBucket New-OrchBucket Copy-OrchBucket Compare-OrchBucket Move-OrchBucket Update-OrchBucket Remove-OrchBucket Get-OrchBucketItem Copy-OrchBucketItem Export-OrchBucketItem Import-OrchBucketItem Remove-OrchBucketItem Get-OrchWebhook New-OrchWebhook Copy-OrchWebhook Compare-OrchWebhook Update-OrchWebhook Remove-OrchWebhook Enable-OrchWebhook Disable-OrchWebhook Get-OrchWebhookEventType Test-OrchWebhook Get-OrchSetting Set-OrchSetting Get-OrchExecutionSetting Get-OrchWebSetting Get-OrchAuthenticationSetting Get-OrchActivitySetting Get-OrchConnectionString Get-OrchLicense Get-OrchUpdateSetting Get-OrchActionCatalog Compare-OrchActionCatalog New-OrchActionCatalog Copy-OrchActionCatalog Remove-OrchActionCatalog Search-OrchDirectory Search-PmDirectory Resolve-PmDirectoryNameBulk Get-PmUser Update-PmUser Remove-PmUser New-PmUser Copy-PmUser Get-PmRobotAccount New-PmRobotAccount Set-PmRobotAccount Copy-PmRobotAccount Remove-PmRobotAccount Get-PmUserPreference Set-PmUserPreference Copy-PmUserPreference Get-PmNotificationSubscription Set-PmNotificationSubscription Copy-PmNotificationSubscription 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-PmAccessAllowedMember 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 Get-TmTestExecution Get-OrchHelp Clear-OrchCache Get-OrchConfigPath Edit-OrchConfig Set-OrchLocation Get-OrchLogLocation Open-OrchLogLocation New-OrchUserMappingCsv Test-OrchUserMappingCsv

Functions

Enable-OrchUserAttended Disable-OrchUserAttended Enable-OrchPersonalWorkspace Disable-OrchPersonalWorkspace Find-OrchFolderNoUserAssigned Get-OrchJobVideo Format-OrchQueueItem Format-OrchTestDataQueueItem

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

1.15.2

Fixed: a trigger copied out of a CLASSIC folder keeps its "Execute the process X times" count
too. 1.15.1 stopped the count being reset for modern-to-modern copies but kept resetting it
whenever the source folder was classic, on the untested assumption that a classic folder used
StartStrategy for something else. Measured on standalone 21.10.4, it does not: the Execution
Target radio writes the same field, Dynamic Allocation with X=1 reading back 1 and X=3 reading 3,
exactly as a modern folder does. The only classic-only value is -1, written by the "All Robots"
option, which modern folders have no equivalent for. So the assumption had been dropping the
count on precisely the classic-to-modern migrations it was meant to serve -- an MSI source is
where classic folders still live. The rule is now the measured one and no longer asks what kind
of folder the trigger came from: a positive count is carried across unchanged, and only a value
below 1 falls back to a single run, with a warning naming the trigger. The -StartStrategy help on
New-OrchTrigger and Update-OrchTrigger, which repeated the wrong claim, is corrected with it.

1.15.1

Fixed: a queue shared between folders could stay invisible in the destination for the rest of a
Copy-Item session, taking its queue trigger with it. Copying a folder tree, the first folder's
pass looks for its shared queue's counterpart in every destination folder the queue is linked
to, and caches what it finds there -- usually nothing, since those folders have not been copied
yet. Nothing invalidated that empty list afterwards, neither creating the queues on that
folder's own pass nor sharing the queue into it, so the folder stayed empty in the module's view
until the next Clear-OrchCache. Get-OrchQueue under-reported it, and the trigger stage of the
same run decided the queue did not exist and skipped the trigger with a warning rather than an
error, so the run looked successful while the migration was incomplete. Both paths now
invalidate the destination folder's entity list and the entity's link set. Assets and buckets
had the same defect and are fixed with it.

Fixed: a copied trigger no longer comes out running once when the source said "Execute the
process X times". Copy-Item and Copy-OrchTrigger overwrote StartStrategy with 1 for every
destination folder that is not classic. It is the job count the modern folder's web UI labels
"Execute the process X times": measured on Automation Suite 24.10.11, a trigger set to 3 reads
back 3, and writing 5 with Update-OrchTrigger makes the UI say "5 times". The source value is
now preserved; the reset survives only for a classic source folder, where the same field selects
the execution target rather than a count. New-OrchTrigger and Update-OrchTrigger now document
what the parameter actually sets.

1.15.0

Added: "UseProxy": false in a drive's Proxy block now connects directly, ignoring whatever proxy the
machine is configured with. There was no way to say that before. "Enabled": false means "do not use
the settings in this block", which leaves .NET free to fall back to the machine's proxy -- and
"Enabled": false is what the shipped configuration template contains, so nearly every user has been
inheriting a proxy their configuration never mentioned. Absent behaves as .NET's own default of
true, so no existing configuration changes behaviour, and "UseProxy": false takes precedence over
"Enabled".

Security: the PKCE sign-in now sends and verifies a state value. The loopback listener accepted any
callback carrying a code and exchanged it. PKCE protects a code stolen from us from being used by
someone else; it does nothing about someone else's code being delivered into our listener, which
ends with the drive authenticated as them -- the direction RFC 8252 requires state for. A callback
whose state is missing or different is now refused before the token exchange, since exchanging
first would already have put a token for the wrong principal in the session. The refusal explains
the likeliest cause, another sign-in sharing the redirect port, rather than leading with an attack.
Verified on standalone 24.10.0, Automation Cloud, and Automation Suite 24.10.11.

Fixed: the sign-in page no longer says you are connected when the token exchange failed. The
browser callback exchanges the sign-in for a token; when that exchange fails the error is left for
the caller to raise, but the page went on rendering the success card, announcing a connection that
does not exist, with only a missing user-name row as a hint. That page is the one signal an
operator has at that moment and it pointed the wrong way. It now says the sign-in worked but the
connection did not, and shows the underlying error.

Changed: a connection failure now names the proxy it went through and where that proxy came from.
UiPathOrch only overrides proxy settings when a drive enables them; otherwise the machine's own
proxy applies, so a request can go through a proxy the drive's configuration never mentions -- and
when it failed, the error named only an address it could not reach. Reported from the field as
"Could not connect to 127.0.0.1:10000", read reasonably as a port UiPathOrch wanted to listen on,
when in fact it was a local proxy agent. When the proxy was inherited rather than configured, the
message also says how to refuse it, and the sign-in page additionally shows the Proxy block itself.

Changed: sign-in advisories now appear on the browser page when the sign-in opened a browser, and
are not repeated on the console. The console has only ever been the fallback channel. A notice with
something to act on still leaves a one-line trace there, because the page is invisible to a
scheduled run, a transcript, or a session driven by an agent.

Changed: the Entra ID local-user advisory is decided at sign-in rather than two hops later, is
shown in the reader's language, matching Orchestrator's own banner wording in each of the seven
languages the module ships, and carries the "Learn more" link the web banner ends with.

Full release notes: https://github.com/UiPath-Services/UiPathOrch/blob/master/CHANGELOG.md