- Overview
- 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 activity 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
- Automation Ops Pipelines
- System
- Release notes
- About the System activity 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 activity 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
StartJob
Enables you to start a job on Orchestrator on a specified number of Robots. Please note that in order to execute this method in Studio, the Robot has to be connected to Orchestrator and the Robot role needs to also have the Create and Edit rights on jobs, as well as View on processes and environments. The method runs under the Robot which executes it.
Namespace: UiPath.Activities.System.API
Assembly: UiPath.System.Activities.Api (in UiPath.System.Activities.Api.dll)
 |  |
---|---|
StartJob(String) | Starts a job in Orchestrator based on the name of the process. |
StartJob(String, String) | Starts a job in Orchestrator based on the name of the process, from a specified folder path. |
StartJob(String, String) | Starts a job in Orchestrator, based on the name of the process and the ID of the job. |
StartJob(String, String, String) | Starts a job in Orchestrator, at a certain folder path, based on the name of the process and the ID of the job. |
StartJob(String, String, StartProcessDtoJobPriority,
Boolean, String) | Starts a job in Orchestrator, at a certain folder path, with a certain priority, while being able to choose if the job should be resumed, in case it was suspended. |
Starts a job in Orchestrator based on the name of the process.
string StartJob(
string processName
)
string StartJob(
string processName
)
processName
String- The display name of the process you want to use for the job as it appears in Orchestrator (it could be found in Additional Settings field of the process settings). For example, if the name of the package is "InvoiceScan" and you named the process "Invoice Scanner", the string in this field should be "Invoice Scanner".
Starts a job in Orchestrator based on the name of the process, from a specified folder path.
string StartJob(
string processName,
string folderPath
)
string StartJob(
string processName,
string folderPath
)
processName
String- The display name of the process you want to use for the job as it appears in Orchestrator (it could be found in Additional Settings field of the process settings). For example, if the name of the package is "InvoiceScan" and you named the process "Invoice Scanner", the string in this field should be "Invoice Scanner".
folderPath
String- The path of the folder where the specified process is located, if different
from the folder where the process is running. This field only supports
string values, with
/
as the separator to indicate subfolders. For example,"Finance/Accounts Payable"
.
Return value
The unique identifier for the started process.
Starts a job in Orchestrator, based on the name of the process and the ID of the job.
string StartJob(
string processName,
out string jobId
)
string StartJob(
string processName,
out string jobId
)
processName
String- The display name of the process you want to use for the job as it appears in Orchestrator (it could be found in Additional Settings field of the process settings). For example, if the name of the package is "InvoiceScan" and you named the process "Invoice Scanner", the string in this field should be "Invoice Scanner".
jobId
String- The unique identifier for the started job.
Return value
The unique identifier for the started process.
Starts a job in Orchestrator, at a certain folder path, based on the name of the process and the ID of the job.
string StartJob(
string processName,
out string jobId,
string folderPath
)
string StartJob(
string processName,
out string jobId,
string folderPath
)
processName
String- The display name of the process you want to use for the job as it appears in Orchestrator (it could be found in Additional Settings field of the process settings). For example, if the name of the package is "InvoiceScan" and you named the process "Invoice Scanner", the string in this field should be "Invoice Scanner".
jobId
String- The unique identifier for the started job.
folderPath
String- The path of the folder where the specified process is located, if different
from the folder where the process is running. This field only supports
string values, with
/
as the separator to indicate subfolders. For example,"Finance/Accounts Payable"
.
Return value
The unique identifier for the started process.
Starts a job in Orchestrator, at a certain folder path, with a certain priority, while being able to choose if the job should be resumed, in case it was suspended.
string StartJob(
string processName,
string folderPath,
StartProcessDtoJobPriority jobPriority,
bool resumeOnSameContext,
out string jobId
)
string StartJob(
string processName,
string folderPath,
StartProcessDtoJobPriority jobPriority,
bool resumeOnSameContext,
out string jobId
)
processName
String- The display name of the process you want to use for the job as it appears in Orchestrator (it could be found in Additional Settings field of the process settings). For example, if the name of the package is "InvoiceScan" and you named the process "Invoice Scanner", the string in this field should be "Invoice Scanner".
folderPath
String- The path of the folder where the specified process is located, if different
from the folder where the process is running. This field only supports
string values, with
/
as the separator to indicate subfolders. For example,"Finance/Accounts Payable"
. jobPriority
StartProcessDtoJobPriority
- Specifies the priority of the job. The available options are:
Low, Normal
, andHigh
. resumeOnSameContext
Boolean- Specifies whether to resume the initial machine and robot choice upon resumption of created jobs, if jobs are suspended.
jobId
String- The unique identifier for the started job.