Securely store and load usernames and passwords.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| CredentialName | In | InArgument<String> |
|||
| OrchestratorCredentialName | In | InArgument<String> |
|||
| TimeoutInSeconds | In | InArgument<Int32> |
|||
| Credential | Out | OutArgument<UiPath.Core.Activities.PasswordCredentials> |
✓ | ||
| OrchestratorFolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| AutosubmitTimeoutSeconds | property | Int32 |
|
| CredentialsSource | property | UiPath.Activities.CredentialSource |
Pauses adding Business Transaction logs for the operations to the ongoing transaction.
No members extracted.
Resumes adding Business Transaction logs for the operations to the ongoing transaction.
No members extracted.
Initiates any type of job (Agent, Agentic process, RPA workflows, API workflow, Testing process, etc.) via Orchestrator to be picked up by any available robots. It allows for flexible configuration of the execution mode (Do not wait, Wait for job completion or Suspend execution until job completion). It returns output arguments unless started in the Do not wait mode.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FolderPath | In | InArgument<String> |
|||
| ProcessName | In | InArgument<String> |
✓ | ||
| ContinueOnError | In | InArgument<Boolean> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| Machine | In | InArgument<String> |
|||
| Account | In | InArgument<String> |
|||
| Job | Out | OutArgument<UiPath.Core.Activities.OrchestratorJob> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| ExecutionMode | property | UiPath.Activities.Jobs.JobExecutionMode |
|
| FailWhenFaulted | property | Boolean |
Sends an email notification via the Orchestrator API
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Subject | In | InArgument<String> |
✓ | ||
| Body | In | InArgument<String> |
✓ | ||
| Recipients | In | InArgument<IEnumerable<String>> |
✓ | ||
| Cc | In | InArgument<IEnumerable<String>> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Use this activity to download any file from a given URL.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Url | In | InArgument<String> |
✓ | ||
| FileName | In | InArgument<String> |
|||
| ConflictResolution | In | InArgument<UiPath.Activities.FileOperations.FileConflictBehavior> |
|||
| Timeout | In | InArgument<Nullable<Int32>> |
|||
| UserAgentHeader | In | InArgument<String> |
|||
| ResponseAttachment | Out | OutArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Allows to add or subtract a specified unit of time from the source date.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AmountOfTime | In | InArgument<Int32> |
|||
| Source | In | InArgument<DateTime> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SelectedOperation | property | UiPath.Activities.Date.AddOrSubtractFromDate.DateOperations |
|
| UnitOfTime | property | UiPath.Core.Activities.DateTimeUtilities.UnitsOfTime |
Format the source DateTime variable in a text (string).
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Format | In | InArgument<String> |
✓ | ||
| Source | In | InArgument<DateTime> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| LocalizationCode | property | Globalization.CultureInfo |
Select the desired letter case to convert the text to
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Source | In | InArgument<String> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ChangeCaseOptions | property | UiPath.Activities.Text.ChangeCaseOptions |
Combines text from a given collection, with the provided separator
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Source | In | InArgument<IEnumerable<String>> |
|||
| Separator | In | InArgument<String> |
✓ |
Extracts date and time from the given input text matching the specified format and outputs it as a variable.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Format | In | InArgument<String> |
✓ | ||
| Results | Out | OutArgument<IEnumerable<DateTime>> |
|||
| Source | In | InArgument<String> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| LocalizationCode | property | Globalization.CultureInfo |
Extracts text from the given input matching the specified criteria. The following extraction options are available: value between two strings, e-mail addresses, urls, and text from HTML code.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| StartingText | In | InArgument<String> |
|||
| EndingText | In | InArgument<String> |
|||
| Results | Out | OutArgument<IEnumerable<String>> |
|||
| Source | In | InArgument<String> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ExtractOptions | property | UiPath.Activities.Text.TextExtractOptions |
|
| IgnoreDuplicates | property | Boolean |
|
| MatchCase | property | Boolean |
|
| ExtractBaseURLOnly | property | Boolean |
Search for a specified text and replace all occurrences with a new text.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ValueToFind | In | InArgument<String> |
|||
| ReplaceWith | In | InArgument<String> |
|||
| Source | In | InArgument<String> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| MatchCase | property | Boolean |
Split the source text into a list of substrings based on a specified separator
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Separator | In | InArgument<String> |
✓ | ||
| Results | Out | OutArgument<IEnumerable<String>> |
|||
| Source | In | InArgument<String> |
✓ |
Appends one or more items at the end of the specified collection.
No members extracted.
Create a collection of items that have the same type as the first specified element.
No members extracted.
Checks if the given Item exists in the collection
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Collection | In | InArgument<ICollection<T>> |
✓ | ||
| Item | In | InArgument<T> |
✓ | ||
| Exists | Out | OutArgument<Boolean> |
|||
| Index | Out | OutArgument<Int32> |
Filter a collection based on custom conditions
No members extracted.
Combine collections in a new collection that contains all the elements
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Collection | In | InArgument<ICollection<T>> |
✓ | ||
| SecondCollection | In | InArgument<ICollection<T>> |
✓ |
Remove the specified element from a collection
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Collection | In | InArgument<ICollection<T>> |
✓ | ||
| Item | In | InArgument<T> |
|||
| Index | In | InArgument<Int32> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| RemoveAllElements | property | Boolean |
Adds an item at the end of the specified list.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| List | In | InArgument<IList<T>> |
✓ | ||
| ItemToAppend | In | InArgument<T> |
✓ | ||
| ItemIndex | Out | OutArgument<Int32> |
Retrieves the value of a specific item in a list.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Activity_ReadListItem_Property_List_DisplayName | In | InArgument<IList<T>> |
✓ | ||
| Activity_ReadListItem_Property_ItemIndex_DisplayName | In | InArgument<Int32> |
✓ | ||
| Activity_ReadListItem_Property_Values_DisplayName | Out | OutArgument<T> |
Updates the value of a specific item in a list. Add a Read list item activity after it to ensure you are using the updated value going forward.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Activity_UpdateListItem_Property_List_DisplayName | In | InArgument<IList<T>> |
✓ | ||
| Activity_UpdateListItem_Property_Value_DisplayName | In | InArgument<T> |
✓ | ||
| Activity_UpdateListItem_Property_ItemIndex_DisplayName | In | InArgument<Int32> |
✓ |
Creates a new empty list.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| NewList | Out | OutArgument<IList<T>> |
✓ |
Displays an HTML file that sends data back to the workflow.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| URI | In | InArgument<String> |
✓ | ||
| Result | Out | OutArgument<String> |
|||
| Width | In | InArgument<Int32> |
|||
| Height | In | InArgument<Int32> |
|||
| TopMost | In | InArgument<Boolean> |
True |
Displays a dialog box that prompts the user with a label message and an input field.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Title | In | InArgument<String> |
|||
| Label | In | InArgument<String> |
|||
| Options | In | InArgument<String[]> |
|||
| OptionsString | In | InArgument<String> |
|||
| TopMost | In | InArgument<Boolean> |
False |
||
| Result | Out | OutArgument |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| IsPassword | property | Boolean |
Opens a dialog box at runtime to browse for a file and select it to use in the task.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| InitialDirectory | In | InArgument<String> |
|||
| Multiselect | In | InArgument<Boolean> |
|||
| SelectedFile | Out | OutArgument<String> |
|||
| SelectedFiles | Out | OutArgument<IEnumerable<String>> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Filter | property | String |
Opens a dialog box at runtime to select a folder to use later.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| SelectedFolder | Out | OutArgument<String> |
Generates a simple tone on the speaker.
No members extracted.
Copies a specified folder to another location
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| From | In | InArgument<String> |
|||
| FromResource | In | InArgument<UiPath.Platform.ResourceHandling.IResource> |
|||
| To | In | InArgument<String> |
|||
| ToResource | In | InArgument<UiPath.Platform.ResourceHandling.IResource> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Overwrite | property | Boolean |
|
| IncludeSubfolders | property | Boolean |
Deletes a specified file.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ |
Deletes a specified folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ | ||
| Recursive | In | InArgument<Boolean> |
Checks if the specified file exists and returns True if the file exists, False if it does not.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ | ||
| Exists | Out | OutArgument<Boolean> |
Checks if the specified folder exists and returns True if the folder exists, False if it does not.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ | ||
| Exists | Out | OutArgument<Boolean> |
Repeats the contained activities once for each file in a specified folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Folder | In | InArgument<String> |
✓ | ||
| Filter | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| IncludeSubDirectories | property | Boolean |
|
| SkipFolderWithoutPermission | property | Boolean |
|
| OrderBy | property | UiPath.Core.Activities.ForEachFileOrderByOptions |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<IO.FileInfo, Int32> |
Repeats the contained activities once for each child folder in the specified folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Folder | In | InArgument<String> |
✓ | ||
| FilterByName | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| IncludeSubFolders | property | Boolean |
|
| SkipFoldersWithoutPermission | property | Boolean |
|
| OrderBy | property | UiPath.Core.Activities.ForEachFolderOrderByOptions |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<IO.DirectoryInfo, Int32> |
Retrieves the properties of a specified file and saves the information for later use in the project.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FilePath | In | InArgument<String> |
✓ | ||
| Output | Out | OutArgument<IO.FileInfo> |
Retrieves the properties of a specified folder and saves the information for later use in the project.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FolderPath | In | InArgument<String> |
✓ | ||
| Output | Out | OutArgument<IO.DirectoryInfo> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ThrowIfNotExists | property | Boolean |
Moves a specified folder to another location.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| From | In | InArgument<String> |
✓ | ||
| To | In | InArgument<String> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Overwrite | property | Boolean |
Renames the selected file
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FilePath | In | InArgument<String> |
✓ | ||
| FileResource | In | InArgument<UiPath.Platform.ResourceHandling.IResource> |
✓ | ||
| NewName | In | InArgument<String> |
✓ | ||
| OutputFileResource | Out | OutArgument<UiPath.Platform.ResourceHandling.IResource> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| KeepExtension | property | Boolean |
Renames the selected folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FolderPath | In | InArgument<String> |
✓ | ||
| NewName | In | InArgument<String> |
✓ |
Monitors changes on a specified file or folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ | ||
| FileNameFilter | In | InArgument<String> |
|||
| NotifyFilters | In | InArgument<IO.NotifyFilters> |
✓ | ||
| ChangeType | In | InArgument<IO.WatcherChangeTypes> |
✓ | ||
| IncludeSubdirectories | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Enabled | property | Boolean |
Executes a PowerShell command with specified input parameters.
No members extracted.
Trigger which fires when a global variable's value has changed.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VariableName | In | InArgument<Object> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Enabled | property | Boolean |
Forces a global variable changed notification to be sent to all subscribers.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| VariableName | In | InArgument<Object> |
✓ |
A container activity that allows management of triggers and handler activities.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SchedulingMode | property | UiPath.Core.Activities.ActionSchedulingMode |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Triggers | child | List<Activity> |
|
| Action | child | ActivityDelegate |
Executes a specified VBScript, optionally passing it a list of input parameters.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| FileName | In | InArgument<String> |
✓ | ||
| RunInBatchMode | In | InArgument<Boolean> |
|||
| WaitForOutput | In | InArgument<Boolean> |
|||
| KillOnTimeout | In | InArgument<Boolean> |
|||
| UnicodeSupport | In | InArgument<Boolean> |
|||
| Result | Out | OutArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Arguments | property | List<InArgument<String>> |
Monitors termination of a specified Windows process.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ProcessName | In | InArgument<String> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Enabled | property | Boolean |
Monitors launch of a specified Windows process.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ProcessName | In | InArgument<String> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Enabled | property | Boolean |
Invokes a method of a specified COM object.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| MethodName | In | InArgument<String> |
|||
| ProgID | In | InArgument<String> |
|||
| CLSID | In | InArgument<String> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingFlags | property | Reflection.BindingFlags |
|
| Arguments | property | Dictionary<String, Argument> |
Sets multiple variables or arguments values in one activity
No members extracted.
Updates a text value using modifications including find and replace, trim, and combining (concatentating) with another text value.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| SourceText | In | InArgument<String> |
✓ | ||
| OutputText | Out | OutArgument<String> |
✓ |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction |
Else If activity chooses between different paths based on a series of conditions being true or false.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Condition | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ElseIfs | property | ComponentModel.BindingList<UiPath.Core.Activities.IfElseIfBlock> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Then | child | Activity |
|
| Else | child | Activity |
Creates a DataTable according to a specified schema.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DataTable | Out | OutArgument<Data.DataTable> |
Converts a Collection to a DataTable.
No members extracted.
Executes an action once for each row in the DataTable provided.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DataTable | In | InArgument<Data.DataTable> |
✓ | ||
| Values | In | InArgument<Collections.IEnumerable> |
|||
| MaxIterations | In | InArgument<Int32> |
|||
| CurrentIndex | Out | OutArgument<Int32> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<T> |
|
| Condition | child | Activity<Boolean> |
Gets the path to the specified system special folder.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FolderPath | Out | OutArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SpecialFolder | property | Environment.SpecialFolder |
Gets the contents of the specified environment variable.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Variable | In | InArgument<String> |
✓ | ||
| VariableValue | Out | OutArgument<String> |
Gets the list of all running processes.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Processes | Out | OutArgument<Collection<Diagnostics.Process>> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Terminates a specified process.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ProcessName | In | InArgument<String> |
✓ | ||
| Process | In | InArgument<Diagnostics.Process> |
✓ | ||
| AppliesTo | In | InArgument<UiPath.Core.Activities.KillProcessApplyOn> |
Mono.Cecil.CustomAttributeArgument |
||
| ContinueOnError | In | InArgument<Boolean> |
Set Environment Variable
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Name | In | InArgument<String> |
✓ | ||
| Value | In | InArgument<String> |
✓ |
Copies a specified file to another location.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
|||
| Destination | In | InArgument<String> |
|||
| PathResource | In | InArgument<UiPath.Platform.ResourceHandling.IResource> |
|||
| DestinationResource | In | InArgument<UiPath.Platform.ResourceHandling.IResource> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Overwrite | property | Boolean |
Creates a folder in the specified location.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ | ||
| ContinueOnError | In | InArgument<Boolean> |
|||
| Output | Out | OutArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
Creates a file in the specified location.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
|||
| PathResource | In | InArgument<UiPath.Platform.ResourceHandling.IResource> |
|||
| Name | In | InArgument<String> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| Output | Out | OutArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
Deletes the file or folder in the specified location.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ | ||
| ResourceFile | In | InArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
✓ | ||
| ContinueOnError | In | InArgument<Boolean> |
Checks if the specified path exists. The path can represent a file path or a directory path.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
✓ | ||
| Exists | Out | OutArgument<Boolean> |
|||
| Resource | Out | OutArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| PathType | property | UiPath.Core.Activities.PathType |
Copies all the characters from a specified text file.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FileName | In | InArgument<String> |
✓ | ||
| File | In | InArgument<UiPath.Platform.ResourceHandling.IResource> |
✓ | ||
| Encoding | In | InArgument<String> |
|||
| Content | Out | OutArgument<String> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Copies a text and pastes it in a text file replacing any existing data in the file.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FileName | In | InArgument<String> |
✓ | ||
| File | In | InArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
✓ | ||
| Encoding | In | InArgument<String> |
|||
| Text | In | InArgument<String> |
✓ | ||
| Output | Out | OutArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Helps you add custom alerts in Orchestrator, with a selected severity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Notification | In | InArgument<String> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Severity | property | UiPath.Core.Activities.AlertSeverity |
Performs HTTP requests to the Orchestrator API by authenticating under the robot it is executed on.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| RelativeEndpoint | In | InArgument<String> |
|||
| JSONPayload | In | InArgument<String> |
|||
| StatusCode | Out | OutArgument<Int32> |
|||
| ResponseHeaders | Out | OutArgument<Dictionary<String, String>> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Method | property | UiPath.Core.Activities.OrchestratorAPIHttpMethods |
Gets a specified secret asset by using a provided Asset Name. If the secret asset is not global, it must be assigned to the local robot in order to be retrieved.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AssetName | In | InArgument<String> |
|||
| Secret | Out | OutArgument<Security.SecureString> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Value | Out | OutArgument |
|||
| AssetName | In | InArgument<String> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| CacheStrategy | property | UiPath.Core.Activities.CacheStrategyEnum |
Gets a specified credential asset by using a provided Asset Name. If the credential asset is not global, it must be assigned to the local robot in order to be retrieved.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Username | Out | OutArgument<String> |
|||
| Password | Out | OutArgument<Security.SecureString> |
|||
| AssetName | In | InArgument<String> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| CacheStrategy | property | UiPath.Core.Activities.CacheStrategyEnum |
Updates the value of an indicated asset, that is already available in Orchestrator, be it a global or a Per Robot asset.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AssetName | In | InArgument<String> |
✓ | ||
| Value | In | InArgument<Object> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
Updates the value of an indicated secret asset, that is already available in Orchestrator, be it a global or a Per Robot asset.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AssetName | In | InArgument<String> |
✓ | ||
| SecretValue | In | InArgument<String> |
✓ | ||
| SecureSecretValue | In | InArgument<Security.SecureString> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
Updates the value of an indicated credential asset, that is already available in Orchestrator, be it a global or a Per Robot asset.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| CredentialName | In | InArgument<String> |
✓ | ||
| UserName | In | InArgument<String> |
✓ | ||
| Password | In | InArgument<String> |
✓ | ||
| SecurePassword | In | InArgument<Security.SecureString> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
Retrieves a list of Orchestrator jobs according to a custom filter, using the Orchestrator API.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Filter | In | InArgument<String> |
|||
| Top | In | InArgument<Int32> |
|||
| Skip | In | InArgument<Int32> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| FilterBuilder | property | UiPath.Activities.Jobs.JobFilterSettings |
Initiates a new job via Orchestrator to be picked up by any available robots. It immediately continues the execution without waiting for the job to finish. It does not return output arguments.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ProcessName | In | InArgument<String> |
✓ | ||
| NumberOfRobots | In | InArgument<Int32> |
|||
| ModernFolder | In | InArgument<Boolean> |
True |
||
| ArgumentsVariable | In | InArgument<Dictionary<String, Object>> |
|||
| JobPriority | In | InArgument<UiPath.Orchestrator.Client.Models.StartProcessDtoJobPriority> |
|||
| ResumeOnSameContext | In | InArgument<Boolean> |
|||
| Key | Out | OutArgument<String> |
|||
| JobId | Out | OutArgument<String> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| Arguments | property | Dictionary<String, Argument> |
Stops or kills a job on Orchestrator.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Job | In | InArgument<UiPath.Core.Activities.OrchestratorJob> |
✓ | ||
| Strategy | In | InArgument<UiPath.Core.Activities.StopStrategy> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Adds a new item in the queue. The status of the item will be New.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Reference | In | InArgument<String> |
|||
| QueueType | In | InArgument<String> |
✓ | ||
| ItemInformationCollection | In | InArgument<Dictionary<String, Object>> |
|||
| DeferDate | In | InArgument<DateTime> |
|||
| DueDate | In | InArgument<DateTime> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| FolderPath | In | InArgument<String> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| ItemInformation | property | Dictionary<String, InArgument> |
|
| Priority | property | UiPath.Core.QueueItemPriority |
Adds a new item in the queue and starts a transaction. The status of the item will be set to InProgress. Returns the item as a QueueItem variable.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Reference | In | InArgument<String> |
|||
| FolderPath | In | InArgument<String> |
|||
| QueueType | In | InArgument<String> |
✓ | ||
| ContinueOnError | In | InArgument<Boolean> |
False |
||
| TimeoutMS | In | InArgument<Int32> |
|||
| TransactionItem | Out | OutArgument<UiPath.Core.QueueItem> |
|||
| SpecificData | Out | OutArgument |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TransactionInformation | property | Dictionary<String, InArgument> |
|
| BindingsKey | property | String |
Adds a collection of items from a Data Table to a queue. The status of the items will be New.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| QueueItemsDataTable | In | InArgument<Data.DataTable> |
✓ | ||
| QueueName | In | InArgument<String> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| CommitType | property | UiPath.Core.Activities.BulkAddQueueItems.CommitTypeEnum |
Deletes items with the New state from a specified queue.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| QueueItems | In | InArgument<IEnumerable<UiPath.Core.QueueItem>> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Gets an item from the queue so that you can process it (start the transaction) and sets its status to In Progress.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FolderPath | In | InArgument<String> |
|||
| QueueType | In | InArgument<String> |
✓ | ||
| ContinueOnError | In | InArgument<Boolean> |
False |
||
| TimeoutMS | In | InArgument<Int32> |
|||
| Reference | In | InArgument<String> |
|||
| TransactionItem | Out | OutArgument<UiPath.Core.QueueItem> |
|||
| SpecificData | Out | OutArgument |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| FilterStrategy | property | UiPath.Core.Activities.ReferenceFilterStrategy |
Retrieves a list of transactions from an indicated queue, according to multiple filters, such as creation date, priority, state and reference.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| QueueName | In | InArgument<String> |
✓ | ||
| Reference | In | InArgument<String> |
|||
| From | In | InArgument<Nullable<DateTime>> |
|||
| To | In | InArgument<Nullable<DateTime>> |
|||
| Duration | In | InArgument<Nullable<Int32>> |
|||
| Top | In | InArgument<Int32> |
|||
| Skip | In | InArgument<Int32> |
|||
| Filter | In | InArgument<String> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| FilterStrategy | property | UiPath.Core.Activities.ReferenceFilterStrategy |
|
| QueueItemStates | property | UiPath.Core.Activities.QueueItemStates |
|
| FilterBuilder | property | UiPath.Activities.Queues.QueueItemFilterSettings |
|
| FilterByCurrentRobot | property | Boolean |
Adds time parameters between which a transaction must be processed (not before Postpone Date and no later than Deadline Date).
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DeferDate | In | InArgument<DateTime> |
|||
| DueDate | In | InArgument<DateTime> |
|||
| TransactionItem | In | InArgument<UiPath.Core.QueueItem> |
✓ | ||
| ContinueOnError | In | InArgument<Boolean> |
False |
||
| TimeoutMS | In | InArgument<Int32> |
Start a job when a new item is added to the specified queue.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TransactionItem | Out | OutArgument<UiPath.Core.QueueItem> |
|||
| ExtractedQueueItem | Out | OutArgument |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| FolderPath | property | String |
|
| QueueName | property | String |
|
| BindingsKey | property | String |
Helps you create custom progress statuses for your In Progress transactions.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TransactionItem | In | InArgument<UiPath.Core.QueueItem> |
✓ | ||
| Progress | In | InArgument<String> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Sets the status of a transaction item to Failed or Successful.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TransactionItem | In | InArgument<UiPath.Core.QueueItem> |
✓ | ||
| Status | In | InArgument<UiPath.Core.ProcessingStatus> |
|||
| OutputVariable | In | InArgument<Dictionary<String, Object>> |
|||
| AnalyticsVariable | In | InArgument<Dictionary<String, Object>> |
|||
| Reason | In | InArgument<String> |
|||
| Details | In | InArgument<String> |
|||
| ErrorType | In | InArgument<UiPath.Core.Activities.ErrorType> |
|||
| AssociatedFilePath | In | InArgument<String> |
|||
| ContinueOnError | In | InArgument<Boolean> |
False |
||
| TimeoutMS | In | InArgument<Int32> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Output | property | Dictionary<String, InArgument> |
|
| Analytics | property | Dictionary<String, InArgument> |
Waits for an item in the queue to be available so that you can process it (start the transaction) and sets its status to In Progress.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| QueueName | In | InArgument<String> |
✓ | ||
| PollTimeMS | In | InArgument<Int32> |
|||
| Reference | In | InArgument<String> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| FilterStrategy | property | UiPath.Core.Activities.ReferenceFilterStrategy |
Checks if Stop was triggered in UiPath Orchestrator.
No members extracted.
Change the data type of a variable.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Activity_ChangeType_Property_SourceValue_DisplayName | In | InArgument<Object> |
✓ | ||
| Activity_ChangeType_Property_ConvertedValue_DisplayName | Out | OutArgument<T> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Format | property | IFormatProvider |
Ends the current workflow and resumes the process immediately after the point where the workflow was invoked. Compatible with Robots version 23.8 and above.
No members extracted.
Creates a scope with limited execution time. It throws a System.TimeoutException in case of timeout.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ThrowExceptionAfter | In | InArgument<TimeSpan> |
✓ | ||
| TimeoutMessage | In | InArgument<String> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<Activity> |
Adds custom log fields to each Log Message.
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Fields | property | Dictionary<String, InArgument> |
Starts the specified process within the current robot execution. It does not wait for the invoked process to finish before resuming the execution. It does not return output arguments. It only works in attended scenarios.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ProcessName | In | InArgument<String> |
✓ | ||
| FolderPath | In | InArgument<String> |
|||
| EntryPointPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TargetSession | property | UiPath.Core.Activities.InvokeProcessTargetSession |
|
| Arguments | property | Dictionary<String, InArgument> |
|
| UsePackage | property | Boolean |
Exits the Loop activity (For Each, While, Do While) or Trigger Scope activity in which it is placed and continues the workflow execution with the activity that follows it
No members extracted.
Skips the current iteration in a Loop activity (For Each, While, Do While) and continues the execution with the next iteration.
No members extracted.
Starts the specified process within the current robot execution. It waits for the invoked process to finish before resuming the execution. It returns output arguments.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ProcessName | In | InArgument<String> |
✓ | ||
| FolderPath | In | InArgument<String> |
|||
| EntryPointPath | In | InArgument<String> |
|||
| OutputArguments | Out | OutArgument<Dictionary<String, Object>> |
|||
| Timeout | In | InArgument<TimeSpan> |
|||
| LogEntry | In | InArgument<UiPath.Core.Activities.LogEntryType> |
|||
| LogExit | In | InArgument<UiPath.Core.Activities.LogExitType> |
|||
| ArgumentsVariable | In | InArgument<Dictionary<String, Object>> |
|||
| Level | In | InArgument<UiPath.Core.Activities.LogLevel> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| TargetSession | property | UiPath.Core.Activities.InvokeProcessTargetSession |
|
| UsePackage | property | Boolean |
|
| Arguments | property | Dictionary<String, Argument> |
Synchronously invokes a specified workflow, optionally passing it a list of input arguments.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| WorkflowFileName | In | InArgument<String> |
✓ | ||
| Timeout | In | InArgument<TimeSpan> |
|||
| LogEntry | In | InArgument<UiPath.Core.Activities.LogEntryType> |
|||
| LogExit | In | InArgument<UiPath.Core.Activities.LogExitType> |
|||
| ArgumentsVariable | In | InArgument<Dictionary<String, Object>> |
|||
| Level | In | InArgument<UiPath.Core.Activities.LogLevel> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TargetSession | property | UiPath.Core.Activities.InvokeWorkflowTargetSession |
|
| UnSafe | property | Boolean |
|
| Arguments | property | Dictionary<String, Argument> |
Performs an activity or a series of activities on each element of an enumeration.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Values | In | InArgument<Collections.IEnumerable> |
✓ | ||
| MaxIterations | In | InArgument<Int32> |
|||
| CurrentIndex | Out | OutArgument<Int32> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<T> |
|
| Condition | child | Activity<Boolean> |
Associates a specific format to a generic value that can be used with .ToString and Parse operations. The available formats are Number, DateTime, Currency and Percentage.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Value | InOut | InOutArgument<UiPath.Core.GenericValue> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Format | property | IFormatProvider |
Executes contained activities first and then loops if the condition is True
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| MaxIterations | In | InArgument<Int32> |
|||
| CurrentIndex | Out | OutArgument<Int32> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | Activity |
|
| Condition | child | Activity<Boolean> |
Executes contained activities while the condition is True
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| MaxIterations | In | InArgument<Int32> |
|||
| CurrentIndex | Out | OutArgument<Int32> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | Activity |
|
| Condition | child | Activity<Boolean> |
Writes the specified diagnostic message at the specified level. These messages are also sent to Orchestrator and displayed in the Logs page.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Message | In | InArgument<Object> |
✓ | ||
| Level | In | InArgument<UiPath.Core.Activities.LogLevel> |
Removes custom log fields to each Log Message.
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Fields | property | List<InArgument<String>> |
Displays a custom status in the UiPath Assistant for the process that is running.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| StatusText | In | InArgument<Object> |
✓ |
Retries the contained activities as long as the condition is not met or an error is thrown.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| NumberOfRetries | In | InArgument<Int32> |
|||
| RetryInterval | In | InArgument<TimeSpan> |
|||
| LogRetriedExceptions | In | InArgument<Boolean> |
|||
| RetriedExceptionsLogLevel | In | InArgument<UiPath.Core.Activities.LogLevel> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| ActivityBody | child | ActivityDelegate |
|
| Condition | child | ActivityFunc<Boolean> |
Enables a local trigger.
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TriggerId | property | String |
Disables a local trigger.
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TriggerId | property | String |
This trigger will fire an event after each interval.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Interval | In | InArgument<TimeSpan> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Enabled | property | Boolean |
This activity initialises and starts all local triggers that listen for events on the user’s machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| WorkflowFileName | In | InArgument<String> |
✓ | ||
| Timeout | In | InArgument<TimeSpan> |
|||
| LogEntry | In | InArgument<UiPath.Core.Activities.LogEntryType> |
|||
| LogExit | In | InArgument<UiPath.Core.Activities.LogExitType> |
|||
| ArgumentsVariable | In | InArgument<Dictionary<String, Object>> |
|||
| Level | In | InArgument<UiPath.Core.Activities.LogLevel> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TargetSession | property | UiPath.Core.Activities.InvokeWorkflowTargetSession |
|
| UnSafe | property | Boolean |
|
| Arguments | property | Dictionary<String, Argument> |
This activity stops all local triggers that listen for events on the user’s machine.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ShouldStop | Out | OutArgument<Boolean> |
Contains job info such as Process name, Workflow name, User Name, User Email and Timestamp.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Result | Out | OutArgument<UiPath.Core.Activities.CurrentJobInfo> |
Schedule a recurrent time to start a job.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Result | Out | OutArgument<UiPath.Core.Activities.CurrentJobInfo> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TimeZone | property | String |
|
| Frequency | property | UiPath.Core.Activities.TimeTrigger.TimeFrequency |
|
| MinuteByMinuteRepeat | property | Nullable<Int32> |
|
| HourlyRepeat | property | Nullable<Int32> |
|
| HourlyStartingMinutes | property | Nullable<Int32> |
|
| DailyRepeat | property | Nullable<Int32> |
|
| DailyStartingTime | property | Nullable<DateTime> |
|
| WeeklyDaysToRunOn | property | List<DayOfWeek> |
|
| WeeklyStartingTime | property | Nullable<DateTime> |
|
| MonthlyRepeat | property | Nullable<Int32> |
|
| MonthDaySelection | property | UiPath.Core.Activities.TimeTrigger.MonthDaySelectionType |
|
| DaysOfMonthToRunOn | property | List<String> |
|
| MonthlyDaysToRunOn | property | List<DayOfWeek> |
|
| MonthlyStartingTime | property | Nullable<DateTime> |
|
| CronExpression | property | String |
Adds a placeholder into the workflow.
No members extracted.
Displays a message box with a specified text and buttons.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Text | In | InArgument<Object> |
✓ | ||
| AutoCloseAfter | In | InArgument<TimeSpan> |
|||
| Buttons | In | InArgument<UiPath.Core.Activities.ButtonOptions> |
|||
| Caption | In | InArgument<String> |
|||
| TopMost | In | InArgument<Boolean> |
|||
| ChosenButton | Out | OutArgument<String> |
Evaluate Business Rule
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| BusinessRule | In | InArgument<String> |
✓ | ||
| ArgumentsVariable | In | InArgument<Dictionary<String, Object>> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| FolderPath | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| BindingsKey | property | String |
|
| Arguments | property | Dictionary<String, Argument> |
Sets the status of the current Process Trace and close it. Do not set a status if the Process Trace extends beyond this Task scope.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Status | In | InArgument<UiPath.Activities.ProcessTracking.TraceStatus> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TraceGuid | property | String |
Sets the status of a Task.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Status | In | InArgument<UiPath.Activities.ProcessTracking.TaskStatus> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TaskGuid | property | String |
Adds a new object to the task. This object will appear as metadata information on the task in Process Mining.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ObjectInteraction | In | InArgument<UiPath.Activities.ProcessTracking.PTSObjectInteraction> |
|||
| ObjectType | In | InArgument<String> |
✓ | ||
| ObjectId | In | InArgument<String> |
✓ | ||
| ObjectPropertiesV2 | In | InArgument<Dictionary<String, Object>> |
|||
| ObjectProperties | In | InArgument<Dictionary<String, String>> |
Enables Process Tracking. This will track the execution of a Sequence as a Task in Process Mining. You can configure this scope using properties panel and control how the execution gets tracked as part of a Task and Process within Process Mining.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ProcessCaseName | In | InArgument<String> |
|||
| TaskName | In | InArgument<String> |
|||
| ProcessCaseNameToSwitchTo | In | InArgument<String> |
|||
| ObjectId | In | InArgument<String> |
|||
| ObjectType | In | InArgument<String> |
|||
| ObjectInteraction | In | InArgument<UiPath.Activities.ProcessTracking.PTSObjectInteraction> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ProcessLogMode | property | UiPath.Activities.ProcessTracking.ProcessTrackingMode |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Sequence | child | Activity |