Integrated Submitter Installation (Advanced)


This guide will walk you through the installation of the integrated submitters, which can be used to submit jobs from within your application (3ds Max, Maya, Nuke, etc). These should be installed on any machines you wish to submit jobs from. Note that jobs can also be submitted from the Submit menu in the Monitor. See the Submitting Jobs documentation for more information.

At this point, you should already have the Database and Repository installed, and the Client software installed. If you do not, please see the Database and Repository Installation (Advanced) and Client Installation (Advanced) documentation for installation instructions. You also need to have the software that you will be submitting from installed as well (3ds Max, Maya, Nuke, etc).

Installing The Submitters

The submitter installers can be found in the submission folder in the Deadline Repository. Open the folder for the application you want to install the submitter for (3dsmax, Maya, Nuke, etc), and then open the Installers folder. There will be an installer for each operating system that the current application runs on.

Simply run the appropriate installer then follow the step as follows. Note that these steps are similar for each application and each operating system.

windows_client_dir windows_repo_dir

The Deadline Client Bin Directory page shows what DEADLINE_PATH is currently set to. This value is originally set by the Client installer, and is used by the submission scripts to find the Client’s bin directory so that it can find the Repository and submit jobs. You can change the DEADLINE_PATH value here if it’s incorrect or if it doesn’t exist, and the submitter installer will give you the option to make the change permanent.

The next page will show the Repository directory that the Client is currently connected to, which is where the submission scripts are installed from. If this path is incorrect, you can change it here.

windows_components windows_install_dir

Select the components you wish to install (the installer will try to auto select the versions it detects), and then verify the install location for each one.

After configuring these, press Next to continue with the installation.

Silent Installation

The Submitter installers can be run in command line mode or unattended mode on each operating system. Note though that on Mac OS X, you must run the script that can be found in the Contents/MacOS folder, which is inside the Mac Submitter Installer package.

To run in command line mode, pass the “–mode text” command line option to the installer. For example, on Linux:

./ --mode text

To run in silent mode, pass the “–mode unattended” command line option to the installer. For example, on Windows:

Maya-submitter-windows-installer.exe --mode unattended

To get a list of all available command line options, pass the “–help” command line option to the installer. For example, on Mac OS X:

/ --help

Note that there are quite a few Submitter installer options that are only available from the command line, which you can view when running the –help command. These options include:

  • --enable-components: Select the components which you would like to enable (programs installed in default locations will be auto selected)
  • --disable-components: Select the components which you would like to disable (programs installed in default locations will be auto selected)
  • --destDir###: The destination directories for the components (will be defaulted to if installed in default locations)

An example batch script that puts these all together:

@echo off
.\Maya-submitter-windows-installer.exe --mode unattended --disable-components Maya2014
.\3dsMax-submitter-windows-installer.exe --mode unattended
    --enable-components 3dsMax2011,3dsMax2015
    --disable-components 3dsMax2012,3dsMax2013,3dsMax2014
    --destDir2011 "C:\3dsMax2011_64"
.\Nuke-submitter-windows-installer.exe --mode unattended

This script installs the submitters for Maya (ignoring Maya 2014), 3ds Max(2011 and 2015 only, with 2011 in an unusual directory) and Nuke (default settings)

Change the DEADLINE_PATH Value

The DEADLINE_PATH value is a system setting that the Integrated Submission scripts use to determine where the Deadline Client is installed to, and what the Repository path is. This value is set by the Client installer, and if you’ve installed more than one version of Deadline on your machine, it’s possible that this value could be incorrect.

You can use a Submitter installer to change the DEADLINE_PATH value without installing anything by following these steps:

  • Run any submitter installer and set the DEADLINE_PATH value on the Deadline Client Bin Directory page.
  • Skip past the Repository Directory page.
  • Uncheck all options on the Components page.
  • Click Next on the Ready to Install page.

The installer will then update the DEADLINE_PATH variable without actually installing anything.