Subscribe

UiPath Activities

The UiPath Activities Guide

UiPath.Alteryx.Activities.RunJob

The Run Job activity uses the Enqueue and Get Job to queue and run a (Job).

How it works

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Alteryx Scope activity to your project.
  3. Add the Run Job activity inside the Alteryx Scope activity.
  4. Enter values for the properties located in the body of the activity.

In the Body of the Activity

There are two ways to provide data for the (Answers) property.

  1. Create and enter a Answer[] variable.
  2. Use the Configure Answers dialog on the design canvas.

Using the Configure Answers dialog

To use the (Configure Answers) dialog you will need to do the following:

  1. Configure the (Design Connection) properties in the Alteryx Scope activity.
  2. Click the (Configure Answers) button on the Run Job design canvas.
  3. Enter in the (App ID) for your App and then click the Get Questions button. This will fetch the list of questions that will need answers for this application. Note that this is different form the (App ID) parameter that you set in the activity in the sense that it is only used to retrieve the list of questions.

You can then enter String or String variables for the individual answers. If values are configured in the (Answers) property as well as in Configure Answers dialog, then these will be merged and values in the Configure Answers will override those in the (Answers).

πŸ“˜

Note

The Wait input property and Job output property can affect each other. If the Job has not completed, only the JobId property of the (Job) output property will be populated, not the entire Job object.

By default the value of the (Wait (minutes)) property is 0, meaning that the activity will not wait for the job to complete and thus only the Job.JobId will have a value.

You can change this behavior by setting the (Wait (minutes)) to up to 15 minutes. If the job has completed in less than that time, the entire (Job) object will be populated.

Input

  • AppId - The ID of the app to execute. This field supports only Strings or String variables.
  • Priority - Priority to be set for the job. Enter a Priority or Priority variable.

πŸ“˜

Note

Possible values for the Priority field include "Low", "Medium", "High", "Critical", or "Default" (e.g. Priority.Low, Priority.Medium).

Options

  • Answers - The list of answers to execute the workflow with. Enter a Answer[] or Answer[] variable.
  • Wait - The time in minutes to wait for the job to complete. Enter a Int32 or Int32 variable.

πŸ“˜

Note

Maximum wait time is 15 minutes. Default is 0, in which case there is no wait. Outputs in the Job will populated only if job was completed within the wait time.

Output

  • Job - The Job object that is returned. Enter a Job or Job variable.

πŸ“˜

Note

If the Job has not completed, only the (JobId) property will be populated.

Properties

Common

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

  • BusinessEntityName - This field supports only Strings or String variables.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

  • ResponseStatus - The status of the request (success/failure information). This field supports only ResponseStatus variables.

Updated 2 months ago


Run Job


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.