Activities
latest
false
- Overview
- Automation Ops Pipelines
- Callout
- Complex Scenarios
- Credentials
- Data Service
- Form
- Release Notes
- Project compatibility
- Real Time Forms
- Updating form data
- Running forms using JavaScript
- Customizing Forms Using CSS
- Conditional components
- Adding multiple components on the same row in Columns
- Using the Data Table component
- Get File/Folder path
- Reading cell values from a Data Grid component
- Displaying PDF files
- Displaying images in forms
- Scrolling through Data Grids
- Using Dev Tools with forms
- Calculate form component values
- Managing dates in forms
- Opening hyperlinks inside forms
- Displaying a default tab in forms
- Displaying the full label of a component
- Searching long strings in drop-down lists
- About the pre 23.4 Form experience
- Project Compatibility
- Real Time Forms
- Dynamic Checkboxes
- Conditional Dropdowns
- Displaying a Default Tab
- Displaying Images
- Displaying PDF Files
- Displaying the Full Label
- Dynamic HTML Elements
- Managing Dates
- Searching Long Strings in Drop-downs
- Customizing Forms Using Local CSS Files
- Executing Do Block On Checkbox Change
- Customizing Columns Width
- Updating Form Data
- Resetting Collection Data
- Advanced Logic
- Executing Do Block on Dropdown Option Change
- Reading Cell Values From a Data Grid Component
- Conditional Components
- Scrolling Through Data Grid Components
- Using the Grid Component
- Dev Tools
- Calculated Value
- Dynamic Dropdowns
- Switching Tabs With Button Click
- Opening Hyperlinks Inside Form
- FTP
- IPC
- Persistence
- Release Notes
- Project Compatibility
- About the Persistence Activities Package
- Bulk Form Designer
- Start Job And Get Reference
- Wait for Job and Resume
- Add Queue Item And Get Reference
- Wait For Queue Item And Resume
- Wait for Form Task and Resume
- Resume After Delay
- Assign Tasks
- Create External Task
- Wait For External Task and Resume
- Complete Task
- Forward Task
- Get Form Tasks
- Get Task Data
- Add Task Comment
- Update Task Labels
- Create App Task
- Wait for App Task and Resume
- Working with App tasks
- Building Your First Form Action
- Advanced Controls for Drop-downs
- Embedding Objects in Form Actions
- Allowing Users to Upload Files to the Storage Bucket
- Adding Advanced Logic Using Java Script
- Setting a Default Tab
- Removing the Delete button from Edit Grid using custom CSS
- Customizing Edit Grid templates
- Using buttons to trigger custom logic
- Using an External Form Layout
- Dynamically expanding form components at runtime
- Sample Workflows
- System
- Release Notes
- About the System Activities Package
- Project Compatibility
- RegEx Builder Wizard
- Is Text Matching
- Find Matching Patterns
- Modify Text
- Modify Date
- Replace Matching Patterns
- Text to Left/Right
- Add Data Column
- Add Data Row
- Build Data Table
- Clear Data Table
- Get Row Item
- Update Row Item
- Merge Data Table
- Output Data Table
- Remove Data Column
- Remove Data Row
- For Each Row in Data Table
- Generate Data Table From Text
- Create List
- Append Item to List
- Read List Item
- Update List Item
- Add Log Fields
- Comment Out / Disabled Activities
- Comment
- Change Type
- Log Message
- Remove Log Fields
- Invoke Com Method
- Format Value
- Lookup Data Table
- Filter Data Table
- Sort Data Table
- Remove Duplicate Rows
- Join Data Tables
- Report Status
- Append Line
- Compress/Zip Files
- Copy File
- Copy Folder
- Create Folder
- Create File
- Delete
- File Exists
- Folder Exists
- Extract/Unzip Files
- Wait for Download
- File Change Trigger
- For Each File in Folder
- For Each Folder in Folder
- Delete File
- Delete Folder
- Move File
- Move Folder
- Rename Folder
- Rename File
- Path Exists
- Read Text File
- Write Text File
- Get File Info
- Get Folder Info
- Get Processes
- Get Username/Password
- Kill Process
- Beep
- Get Environment Folder
- Get Environment Variable
- Invoke Power Shell
- Input Dialog
- Message Box
- Browse for File
- Browse for Folder
- Invoke VBScript
- Process End Trigger
- Process Start Trigger
- File Change Trigger V3
- Trigger Scope
- Repeat Number of Times
- Text to Upper/Lowercase
- Set Environment Variable
- For Each
- Break / Exit Loop
- Retry Scope
- Check True
- Check False
- Workflow Placeholder
- Invoke Workflow File
- Launch Workflow Interactive
- Invoke Code
- Continue / Skip Current
- Multiple Assign
- Invoke Process
- Run Parallel Process
- While
- Do While
- Repeat Number Of Times
- Raise Alert
- Orchestrator HTTP Request
- Get Asset
- Get Credential / Get Orchestrator Credential
- Set Asset
- Set Credential
- Get Jobs
- Get Current Job Info
- Start Job
- Stop Job
- Add Queue Item
- Add Transaction Item
- Delete Queue Items
- Get Queue Items
- Get Transaction Item
- Postpone Transaction Item
- Set Transaction Progress
- Set Transaction Status
- Should Stop
- Wait Queue Item
- Bulk Add Queue Items
- Write Storage Text
- Upload Storage File
- List Storage Files
- Read Storage Text
- Download Storage File
- Delete Storage File
- Custom Input
- Append Item to Collection
- Build Collection
- Collection to Data Table
- Exists in Collection
- Filter Collection
- Merge Collections
- Remove From Collection
- Reset Timer
- Resume Timer
- Start Timer
- Stop Timer
- Timeout Scope
- Manual Trigger
- When New Item Added to Queue
- Stop Local Triggers
- Run Local Triggers
- Repeat Trigger
- Time Trigger
- Disable Local Trigger
- Enable Local Trigger
- Notify Global Variable Changed
- Global Variable Changed Trigger
- Extract Text
- Find and Replace
- Return
- Extract Date and Time from Text
- Change Case for Text
- Add or Subtract from Date
- Download file from URL
- Format Date as Text
- Split Text
- Combine text
- AddDataRow
- AddQueueItem
- AddTransactionItem
- AppendLine
- BulkAddQueueItems
- ClearDataTable
- CompressZipFiles
- CopyFile
- CreateFile
- CreateFolder
- DeleteFileOrFolder
- DeleteQueueItems
- DeleteStorageFile
- DownloadStorageFile
- ExtractUnzipFiles
- FilterDataTable
- GetAsset
- GetCredential
- GetJobs
- GetQueueItem
- GetQueueItems
- GetResourceForLocalPath
- GetRowItem
- GetTransactionItem
- InvokeProcess
- JoinDataTables
- ListStorageFiles
- LookUpDataTable
- MergeDataTable
- MoveFile
- OrchestratorHTTPRequest
- OutputDataTable
- PathExists
- PostponeTransactionItem
- ReadStorageText
- ReadTextFile
- RemoveDataColumn
- RemoveDuplicateRows
- Replace
- SetAsset
- SetCredential
- SetTransactionProgress
- SetTransactionStatus
- SortDataTable
- StartJob
- StopJob
- UpdateRowItem
- UploadStorageFile
- WaitQueueItem
- WriteStorageText
- WriteTextFile
- Testing
- Release Notes
- Project Compatibility
- About the Testing Activities Package
- Project Settings
- Add Test Data Queue Item
- Address
- Attach Document
- Bulk Add Test Data Queue Items
- Delete Test Data Queue Items
- Get Test Data Queue Item
- Get Test Data Queue Items
- Given Name
- Last Name
- Random Date
- Random Number
- Random String
- Random Value
- Verify Control Attribute
- Verify Expression
- Verify Expression With Operator
- Verify Range
- Address
- AddTestDataQueueItem
- AttachDocument
- BulkAddTestDataQueueItems
- DeleteTestDataQueueItems
- GetTestDataQueueItem
- GetTestDataQueueItems
- GivenName
- LastName
- RandomDate
- RandomNumber
- RandomString
- RandomValue
- VerifyAreEqual
- VerifyAreNotEqual
- VerifyContains
- VerifyExpression
- VerifyExpressionWithOperator
- VerifyIsGreater
- VerifyIsGreaterOrEqual
- VerifyIsLess
- VerifyIsLessOrEqual
- VerifyIsRegexMatch
- VerifyRange
- Workflow Events
- Workflow Foundation
Workflow Activities
Last updated Feb 23, 2024
Invoke Power Shell
UiPath.Core.Activities.InvokePowerShell
The Invoke Power Shell activity executes a PowerShell command or script with specified input parameters.
Note: Antivirus policies that
restrict PowerShell access may prevent the use of PowerShell-related activities. For
example, you cannot use Invoke Workflow File and Invoke Power Shell when rule
ID 6151 is enabled in McAfee Endpoint Security.
- Command Text - The PowerShell command to be executed. This value can be the name of a cmdlet or the text of a PowerShell Script.
Common
- ContinueOnError - Specifies if the
automation should continue even when the activity throws an error. This field only
supports Boolean values (True, False). The default value is False. As a result, if the
field is blank and an error is thrown, the execution of the project stops. If the value is
set to True, the execution of the project continues regardless of any error.
Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
- DisplayName - The display name of the activity.
Input
- Parameters - A dictionary of
PowerShell command parameters. A specific command (cmdlet) or script can be used.
- Specific command: When you invoke a
specific command, the name of the parameter should match the name of the command’s
parameter.
For example, if you use
Get-Command -Module CimCmdlets
as an input, the input value must beGet-Command
and the parameter should be namedModule
with the value set to"CimCmdlets"
. - Script: At the start of the script
you need to specify the type of the parameter. Optionally, you can also make a
parameter mandatory to enforce a script to always be called with the parameter set by
the caller.
For example, the following script takes two parameters, one of type string, and another of type int:
Param( [Parameter(Mandatory=$true)] [string]$Name, [int]$Age )
Param( [Parameter(Mandatory=$true)] [string]$Name, [int]$Age )These parameters can then be referenced in the script by adding$
in front of the parameter name.
- Specific command: When you invoke a
specific command, the name of the parameter should match the name of the command’s
parameter.
- Input: - A collection of PSObjects
that are passed to the writer of the pipeline used to execute the command. Can be the
output of another InvokePowerShell activity. You can reference piped input in a script by
using
$input
.Note: This variable is created implicitly by PowerShell. Defining variables or parameters namedinput
may generate errors or may result in conflicts. It is recommended for the terminput
to be reserved for piping.
Misc
- Execution mode - Select a version
of PowerShell in which to execute the command or script provided. This is only available
for Windows projects, Windows-Legacy projects target Windows PowerShell 5.1 (32-bit)
version.
The following options are available:
- PowerShell 7.2 (64-bit) - Uses
PowerShell Core shell based on
.NET6
. In this version, PowerShell is hosted within the .NET 6 runtime. Any data used is directly accessible by the activity, and can be imported in the workflow. - PowerShell 5.1 (64-bit) - Uses
the 64-bit Windows PowerShell executable. In this version, PowerShell is bundled with
Windows, and is located by default in
C:\Windows\System32\WindowsPowerShell\v1.0\
. In this execution mode, PowerShell is remoted locally on the machine using the preinstalled shell. Remoting introduces the need to serialize and deserialize information between different .NET runtimes, and as such objects which can not be reconstructed are wrapped within aPSObject
orPSCustomObject
. - PowerShell 5.1 (32-bit) - Uses
the 32-bit Windows PowerShell executable. In this version, PowerShell is bundled with
Windows, and is located by default in
C:\Windows\SysWOW64\WindowsPowerShell\v1.0\
). In this execution mode, PowerShell is remoted locally on the machine using the preinstalled shell. Remoting introduces the need to serialize and deserialize information between different .NET runtimes, as such objects which can not be reconstructed are wrapped within aPSObject
orPSCustomObject
.PSObject
andPSCustomObjects
hold information about the overall structure of the original object and can be used to reconstruct the objects manually.
- PowerShell 7.2 (64-bit) - Uses
PowerShell Core shell based on
- IsScript - Specifies if the command text is a script or a direct command. Piping, Variables, and Parameters can be used with a single command or script.
- PowerShellVariables - A dictionary
of named objects that represent variables used within the current session of the
InvokePowerShell activity. A PowerShell command or script can retrieve information from
In
andIn/Out
variables and can setOut
variables. To reference variables in your script, use the variable identifier character$
to denote that the text after is a variable name. Example:$firstVariable
.Note: Variable names are not case sensitive. - Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
- TypeArgument - Sets the type of the output variable.
Output
- Output - A collection of TypeArgument objects returned by the execution of the command. Can be used to pipe several InvokePowerShell activities.