en-US/UiPathOrch-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OrchJobVideo</command:name> <command:verb>Get</command:verb> <command:noun>OrchJobVideo</command:noun> <maml:description> <maml:para>Gets jobs with video recordings attached.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OrchJobVideo cmdlet retrieves jobs that have video recordings attached from the Orchestrator environment. This cmdlet is useful for monitoring and auditing job executions where screen recording was enabled, providing visual evidence of automation processes for debugging, compliance, or training purposes.</maml:para> <maml:para>This cmdlet is implemented as a function that calls the Get-OrchJob cmdlet and searches for jobs from the past week that have a video attached.</maml:para> <maml:para>Video recordings are captured during job execution when the appropriate recording settings are configured in Orchestrator. These recordings provide valuable insights into robot behavior, UI interactions, and process execution flow.</maml:para> <maml:para>The cmdlet operates on folder entities, which means you must either navigate to a target folder using Set-Location (cd) or specify target folders using the -Path, -Recurse, or -Depth parameters. This allows you to search for jobs with video recordings across different organizational folders.</maml:para> <maml:para>The cmdlet supports pagination through -Skip and -First parameters to manage large result sets efficiently. Use -Recurse to search through subfolder hierarchies for a comprehensive view of video-enabled job executions.</maml:para> <maml:para>Primary Endpoint: GET /odata/Jobs</maml:para> <maml:para>OAuth required scopes: OR.Jobs or OR.Jobs.Read</maml:para> <maml:para>Required permissions: Jobs.View</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OrchJobVideo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target folder. If not specified, the current folder will be targeted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Specifies that the operation should include the target folder and all its subfolders.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>First</maml:name> <maml:description> <maml:para>Gets only the specified number of objects. Enter the number of objects to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by this cmdlet. The default value is Continue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>First</maml:name> <maml:description> <maml:para>Gets only the specified number of objects. Enter the number of objects to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the target folder. If not specified, the current folder will be targeted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Specifies that the operation should include the target folder and all its subfolders.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Determines how PowerShell responds to progress updates generated by this cmdlet. The default value is Continue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This cmdlet requires navigation to a specific folder or use of the -Path parameter to specify target folders. It operates on folder entities within the Orchestrator hierarchy.</maml:para> <maml:para>Video recording must be enabled in Orchestrator settings and configured for specific processes to capture job execution videos. If no results are returned, verify that video recording is enabled and that jobs have been executed with recording active.</maml:para> <maml:para>The cmdlet is particularly useful for: - Debugging failed automation processes</maml:para> <maml:para>- Training and documentation purposes</maml:para> <maml:para>- Compliance and audit requirements</maml:para> <maml:para>- Process optimization through visual analysis</maml:para> <maml:para> </maml:para> <maml:para>Use -Recurse to search through nested folder structures, and -First/-Skip for pagination when dealing with large numbers of recorded jobs.</maml:para> <maml:para>Video files are typically stored in Orchestrator's media storage and can be accessed through the returned job objects for download or viewing.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para>Primary Endpoint: Function implementation (uses Get-OrchJob which calls GET /odata/Jobs) OAuth required scopes: [PLACEHOLDER - requires verification] Required permissions: [PLACEHOLDER - requires verification]</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS Orch1:\Shared> Get-OrchJobVideo</dev:code> <dev:remarks> <maml:para>Retrieves all jobs with video recordings from the current folder. Requires navigation to a specific folder before execution.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS Orch1:\Shared> Get-OrchJobVideo | ConvertTo-Json -Depth 2</dev:code> <dev:remarks> <maml:para>Displays detailed job video properties in JSON format, showing complete job information and video metadata structure.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-OrchJobVideo -Path Orch1:\ -Recurse</dev:code> <dev:remarks> <maml:para>Recursively searches for jobs with video recordings across all folders in the Orch1: drive, including subfolders.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-OrchJobVideo -Path Orch1:\Shared -First 10</dev:code> <dev:remarks> <maml:para>Retrieves the first 10 jobs with video recordings from the Production folder. Useful for managing large result sets.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-OrchJobVideo -Path Orch1:\Production, Orch1:\Development</dev:code> <dev:remarks> <maml:para>Retrieves jobs with video recordings from multiple specified folders simultaneously.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OrchTestDataQueueItemTable</command:name> <command:verb>Get</command:verb> <command:noun>OrchTestDataQueueItemTable</command:noun> <maml:description> <maml:para>Gets test data queue items in expanded table format from UiPath Orchestrator.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-OrchTestDataQueueItemTable` cmdlet retrieves test data queue items from UiPath Orchestrator and displays them in an expanded table format. This cmdlet is implemented as a function that transforms the internal JSON format of test data into a readable table structure.</maml:para> <maml:para>While `Get-OrchTestDataQueueItem` returns test data in internal JSON format that cannot be displayed as a table, this cmdlet specifically addresses that limitation by expanding variable-format test data into a structured table presentation. This makes it ideal for viewing, analyzing, and reporting on test data content.</maml:para> <maml:para>This is a folder entity operation cmdlet that requires either navigating to a specific folder containing test data queues or using the -Path or -Recurse parameters to specify target folders. The cmdlet dynamically adapts to the schema of the test data, displaying all columns and values in a user-friendly table format.</maml:para> <maml:para>The cmdlet is particularly useful for data-driven testing scenarios where test data has varying column structures, as it can handle and display any test data schema by expanding the JSON content into appropriate table columns.</maml:para> <maml:para>When specifying the -Path and -Recurse parameters, place them immediately after the cmdlet name. This placement ensures that autocomplete for subsequent parameters functions correctly.</maml:para> <maml:para>Primary Endpoint: Function implementation (uses Get-OrchTestDataQueueItem internally which calls GET /odata/TestDataQueueItems)</maml:para> <maml:para>OAuth required scopes: OR.TestData.Read</maml:para> <maml:para>Required permissions: Folders.View, TestData.View (for test data queue item access)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OrchTestDataQueueItemTable</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder path containing test data queues. If not specified, the current location is used. This parameter accepts pipeline input and supports wildcards for specifying multiple paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Current location</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Includes test data queue items from subfolders when retrieving items. This is a folder entity operation parameter that allows scanning multiple folders for test data.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Specifies how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. Valid values are: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the folder path containing test data queues. If not specified, the current location is used. This parameter accepts pipeline input and supports wildcards for specifying multiple paths.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Current location</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Includes test data queue items from subfolders when retrieving items. This is a folder entity operation parameter that allows scanning multiple folders for test data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>Specifies how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. Valid values are: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- This is a folder entity operation cmdlet that requires navigation to a test data folder or use of -Path/-Recurse parameters</maml:para> <maml:para>- This cmdlet is implemented as a function that transforms internal JSON test data into table format</maml:para> <maml:para>- Unlike Get-OrchTestDataQueueItem which returns JSON format, this cmdlet provides user-friendly table output</maml:para> <maml:para>- The table format dynamically adapts to the test data schema, displaying all available columns</maml:para> <maml:para>- The cmdlet handles variable-format test data by expanding JSON content into appropriate table columns</maml:para> <maml:para>- Use ConvertTo-Json to explore the complete structure including table formatting metadata</maml:para> <maml:para>- The IsConsumed property indicates whether test data items have been used in test execution</maml:para> <maml:para>- This cmdlet is essential for data-driven testing scenarios where readable test data presentation is needed</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para>Primary Endpoint: GET /odata/TestDataQueues OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Read Required permissions: TestDataQueues.View</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS Orch1:\Shared> Get-OrchTestDataQueueItemTable</dev:code> <dev:remarks> <maml:para>Gets test data queue items from the current folder and displays them in expanded table format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS Orch1:\Shared> Get-OrchTestDataQueueItemTable TestDataQueue</dev:code> <dev:remarks> <maml:para>Gets test data items from the specified queue named "TestDataQueue" in table format using positional parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS Orch1:\Shared> Get-OrchTestDataQueueItemTable *Test*</dev:code> <dev:remarks> <maml:para>Gets test data items from queues whose names contain "Test" and displays them in table format using wildcard matching.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS Orch1:\> Get-OrchTestDataQueueItemTable -Recurse</dev:code> <dev:remarks> <maml:para>Gets test data queue items from the current folder and all subfolders recursively, displaying them in expanded table format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-OrchTestDataQueueItemTable -Path Orch1:\Production</dev:code> <dev:remarks> <maml:para>Gets test data items from the Production folder in table format, demonstrating execution from any location.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS Orch1:\Shared> Get-OrchTestDataQueueItemTable | ConvertTo-Json -Depth 2</dev:code> <dev:remarks> <maml:para>Gets test data in table format and displays the complete structure including table metadata in JSON format for detailed analysis.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-OrchTestDataQueueItem</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-OrchTestDataQueue</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_UiPathOrch</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |