Draft

Job Submission

There are many ways to submit Draft jobs to Deadline. As always, you can simply submit a Draft job from within the Monitor from the Submit menu. In addition, we’ve also added a right-click job script to the Monitor, which will allow you to submit a Draft job based on an existing job. This will pull over output information from the original job, and fill in Draft parameters automatically where possible.

../_images/sub_draft.png

On top of the Monitor scripts, you can also get set up to submit Draft jobs directly from Shotgun. This will again pull over as much information as possible, this time from the Shotgun database, in order to pre-fill several of the Draft parameter fields. See the Integrated Submission Script Setup section below for more details on this.

We’ve also added a Draft section to all of our other submitters. Submitting a Draft job from any of these uses our Draft Event Plug-in to submit a Draft job based on the job currently being submitted (this is similar in concept to the right-click job script described above). The Draft job will get automatically created upon completion of the original job.

Submission Options

The general Deadline options are available in the Draft submitters, and are explained in the Job Submission documentation. Draft-specific options are explained below. It should be noted, however, that given the nature of Draft scripts, not all of these parameters will be used by all scripts. They can even feasibly be used for different purposes than listed here.

  • Draft Script: This is the Draft script (or Template) that you want to run.
  • Input File: Indicates where the input file(s) for the Draft Script can be found. What kind of file this is will depend entirely on the Draft Script itself. Passed to the Draft script as ‘inFile’.
  • Output Folder: Indicates where the output file(s) of the Draft Script will be placed. Can be a relative path, in which case it will be relative to the input. This is passed to the Draft script as ‘outFolder’.
  • Output File Name: As above, the type of file this is will depend entirely on the selected Draft Script. Passed to the Draft script as ‘outFile’.
  • Frame List: The list of Frames that the Draft Script should work with. Passed to the Draft Script as ‘frameList’, ‘firstFrame’, and ‘lastFrame’.
  • User: The name of the user that is submitting the job. Typically used by the Draft script for frame annotations. Passed to the Draft script as ‘username’.
  • Entity: The name of the entity being submitted. Typically used by the Draft script for frame annotations. Passed to the Draft script as ‘entity’.
  • Version: The version of the entity being submitted. Typically used by the Draft script for frame annotations. Passed to the Draft script as ‘version’.
  • Additional Args: Any additional command line arguments that you wish to pass to the Draft script should be listed here. Appended to arguments listed above.

Plug-in Configuration

The Draft plug-in does not require any configuration.

Integrated Submission Script Setup

All of our integrated submission scripts have been updated to have a Draft section, in order to submit dependent Draft jobs. In addition to this, we also have created scripts to allow you to submit a Draft job directly from Shotgun.

Shotgun Action Menu Item

The best way to install the Draft Submission menu item in Shotgun is to use the automated setup script included in the Monitor. To access this, select Scripts -> Install Integration Submission Scripts from the Monitor’s menu. From there, click the ‘Install’ button next to the Draft entry.

It should be noted that this functionality is currently only available on the Windows version, and requires administrator privileges to run successfully. It should also be noted that while this script will create the ‘Submit Draft Job’ entry in Shotgun for everyone to see, this must still be done on each machine that will be submitting Draft jobs.

FAQ

There are no FAQ entries at this time.