|Table of Contents|
Jobs can be submitted from WranglerView using the items under the Submit menu. Selecting one will launch a modal submission dialog with the standard framework and job-specific parameters. Specify the fields and then press the "Submit" button to submit the job to the Qube! Supervisor.
Submissions for specific applications, such as Maya and Nuke, are explained in detail in their own sectionsections. Please refer to that documentation for submissions to individual applications. This page documents the complete a large set of parameters, which may not be needed or be exactly the same for individual applications; individual submission targets do not necessarily expose all the parameters defined here.
There is a common set of buttons located at the bottom of the Submission Dialog.
- Set Defaults: Store as defaults in the User Preferences for that Jobtype, the values listed in the current submission dialog. The interface will use those values the next time the dialog is opened. This allows you to specify common fields like Priority or Executable that should always be the same value.
- Clear Defaults: Remove any stored defaults for that Jobtype submission dialog
- Expert Mode: Toggle button to display or hide export and non-default values from the submission dialog to reduce clutter when there are a lot of parameters. The current state of this toggle is stored in the Preferences Dialog.
- Save [Disk Icon]: Store the current properties of the job from the dialog as a file (by default an XML file). This can be used to submit through the WranglerView at a later time with "Submit->File…" or from the command line with the
qbsubcommand, or via the API.
- Cancel: Cancel the job submission and close the dialog.
- Submit: Submit the job with the specified parameters to the Qube! Supervisor.
Basic Parameters for all Jobs
- Name: name used for the job, usually artist specified.
- Priority: priority of the job. A number between 1 and 9999. Lower numbers mean higher priority.
- CPUsInstances: The number of processes (or subjobs/instances) to run the job with at the same time. When rendering, this equates to the number of frames being rendered at the same time.
- Max Instances: (Expert Mode only) The maximum number of additional instances to run using smartShare. The default of -1 means "unlimited"; a setting of 0 (zero) disables smartShare expansion for this job.
Render Thread and Job Reservation Controls
This section is located near the top of the submission UI, and is collapsed when 'Expert Mode' is not selected. For applications that do not support setting the number of threads, this section is not visible at all.
Use Slots=Threads only on farms where the workers are configured to have as many slots as they have cores; they will show 0/8 or 0/16 in the Slots when they're empty, where the 0/N number is the number of free slots. This is the default configuration in Qube!
The other common configuration is all the worker set to only ever accept 1 job, where they show 0/1 in the Slots column in the UI. Do not use Slots=Threads in this configuration, since none of your workers will have enough free slots to accept the job.
Thread Control Behavior
Checking Use All Cores for applications or renderers that support auto-detection of the number of cores installed on a worker host will set the renderer's appropriate control to enable this feature. In the case of a Maya job, it sets renderThreads=0; for the Mentalray renderer, it sets autoRenderThreads=True. It will try to "do the right thing" for each application where this control is visible.
As you change the Specific Thread Count control the reservations value will automatically update.
Parameters for Cmdline Jobs
- Command: The command to run on the Worker. Paths and syntax should be what the Worker's OS expects, not the submitting machine.
- Shell (Linux/OS X): Specify the shell to use when executing the command line on the Worker. Only visible in Expert Mode.
Parameters for Cmdrange Jobs
- Command: Same as the Cmdline Job, though it will substitute the following strings based on the frame being executed for the given task.
- Range: The frame range to execute.
- Individual Frames
- Chunks with n Frames
- Split into n Partitions
- Ordering: Specify whether tasks should be executed in ascending, descending, or binary sort (first, last, middle, split the middle values, …) order.
Parameters for SimpleCmd Jobs
- All the fields for either Cmdline or Cmdrange jobs (see above), plus
- Cmd Template: String used to construct the command line along with the rest of the job parameters. Python string representations are used, e.g. %(val)s to represent the string value from "val". If listed, %(argv)s places all optional arguments at that location instead of at the end. This constructs a command line that is then used by the Cmdline or Cmdrange jobtypes on the Workers. See above for the string replace values for CmdRange.
- Executable – path to the renderer or executable to run. Unless it is in the path on the Worker's environment, this needs to be set to an absolute path (to where the executable is located on the Worker)
Preview Frames Submission
Qube Worker Selection
Qube Advanced Job Control
Qube Job Environment
Qube Output Parsing and Validation
- regex_highlights: Regular expression for highlighting information messages from stdout/stderr
- regex_errors: Regular expression for identifying fatal errors from stdout/stderr
- regex_outputPaths: Regular expression for identifying outputPaths of images from stdout/stderr
- regex_maxLines: Maximum number of lines to store for regex matched patterns for stdout/stderr
- validate_fileMinSize: Minimum size for identified outputPaths (in bytes). [0 disables test]
- generateMovie: add linked job to generate movie from output images. It will launch a second submission dialog to convert the images to a movie. This addresses the common action chain of rendering images and then converting those images into a Quicktime or similar movie. Note: This function will only work on jobtypes that retrieve the output image filenames into Qube (Maya, 3dsMax, Softimage, AfterEffects, etc).
- Login: login username for Shotgun
- Task: Shotgun task
- Project: Shotgun project
- Shot/Asset: Shotgun shot/asset
- Version Name: Shotgun version template. Performs variable substitution using python format %(key)s to get the value. The dict keys are prefixed with "job.", "package.", and "shotgun." respectively.
- Description: Shotgun description. Performs variable substitution using python format %(key)s to get the value. The dict keys are prefixed with "job.", "package.", and "shotgun." respectively.
- Account: Arbitrary accounting or project data (user-specified)
- Kind: Arbitrary typing information that can be used to identify the job - see How to restrict a host to only one instance of a given kind of job, but still allow other jobs
- Job Notes: Freeform text for making notes on this job
For this to work, the regex_outputPaths submission parameter needs to be specified for it to parse the stdout/stderr of the job for images, or manually specifying the job frame's path (in Python the paths are represented by jobFrame['resultPackage']['outputPaths']).