Create your first automation in just a few minutes.Try Studio Web →
by Internal Labs
1
Tool
<100
Summary
Summary
PowerShell Drive and Cmdlets for managing Orchestrator.
Overview
Overview
Caution: Previously, executing Remove-OrchPersonalWorkspace
without specifying parameters would remove all personal workspaces. This has been fixed at 0.9.6.1 so that it now requires either the -Name or -OwnerName parameter to be specified.
This PowerShell module UiPathOrch enables you to mount multiple Orchestrator tenants as PSDrives, allowing you to navigate through their folders using commands like cd, dir, mkdir, rmdir within the pwsh console. Beyond simple folder navigation, it facilitates the manipulation of various entities through a range of cmdlets and wildcards. Notably, this module functions even in environments where Studio/Assistant is not installed.
Please be aware that this module is still in development and has not undergone comprehensive testing.
How to Install
https://learn.microsoft.com/ja-jp/powershell/scripting/install/installing-powershell-on-windows
PS> Install-Module UiPathOrch
PS> Import-Module UiPathOrch
PS> Import-Package UiPathOrch,PSReadLine
Now you can use Orch1: drive to manage Orchestrator. PSReadLine module is needed for enabling auto-completion with [Tabl] or [Ctrl+Space] key.
Detailed install steps are explained in the PDFs attached in the Resources section.
How to list all cmdlets in UiPathOrch:
PS> Get-Command -Module UiPathOrch
How to confirm the OAuth scopes needed in the UiPath config file for each cmdlet:
Import-Module
.PS> Get-Help <cmdlet name>
How to specify the target folder:
PS C:\> Get-OrchAsset -Path Orch1:\Shared,Orch2:\Shared
PS C:\> cd Orch1:\Shared
PS Orch1:\Shared> Get-OrchAsset
How to operate all the folder entities in the tenant:
PS Orch1:\Shared> Get-OrchAsset -Recurse
How to confirm which entities are targeted:
PS Orch1:\Shared> Get-OrchAsset -Recurse my*
How to Navigate to the Installation Folder:
PS> Set-OrchLocation
How to update the UiPathOrch module
PS> Update-Module UiPathOrch
Documents
Features
Features
-Path
parameter.Tenant entities:
Folder entities:
Platform Management:
Document Understanding:
Test Manager:
Additional Information
Additional Information
Dependencies
None