alterryx (version 0.5.0)

running_jobs: Queue Job for an App

Description

Each app has a set of questions that require an answer in order to be run. The answers to the app questions are formatted using build_answers. To see the required questions for an app use get_app_questions.

Use queue_job to queue a job for an app. A job is a single run of an app run according to the answers submitted.

Usage

queue_job(app, answers, priority = "low", track_job = FALSE,
  sleep = 10, timeout = 3600, gallery = get_gallery())
build_answers(name_value, ...)

Arguments

app

A single alteryx_app returned from get_app

answers

Answers to required app questions created using build_answers

priority

Assign a priority level to jobs to control which jobs are run by each worker, or to reserve specific workers for higher priority requests. When running a workflow, users (if enabled by the Server Admin) can select a priority level of 'low', 'medium', 'high', or 'critical' to ensure certain jobs always take priority over others. If multiple jobs are queued, jobs run in priority order starting with the highest priority.

track_job

If TRUE this function will not return a value until the job completes on Alteryx Gallery

sleep

Amount of time to wait between job polls. Ignored if track_job = FALSE

timeout

Maximum amount of time to track job. Ignored if track_job = FALSE

gallery

URL for your Alteryx Gallery

name_value

list containing an app question name and value pair

...

Additional name_value pairs

Value

An alteryx job with status "Queued"

See Also

Use get_app to find apps to queue.

Once a job has been queued, use get_job to poll the job and check its status.

Examples

# NOT RUN {
first_question <- list(name = "a", value = "1")
second_question <- list(name = "b", value = "2")
answers <- build_answers(first_question, second_question)

new_job <- queue_job(app, answers)
# }
# NOT RUN {
# }