Job Submission

You can submit jobs from within KeyShot by installing the integrated submission script, or you can submit them from the Monitor. The instructions for installing the integrated submission script can be found further down this page.

job_options adv_options

To submit from within KeyShot, open the scripting console (Window -> Scripting Console) and then run the script


Submission Options

The general Deadline options are explained in the Job Submission documentation, and the Draft/Integration options are explained in the Draft and Integration documentation. The KeyShot specific options are:

  • KeyShot File: The KeyShot file to be rendered.
  • Output File: The filename of the image(s) to be rendered.
  • Include All Render Layers: If enabled, all Render Layers will be rendered.
  • Include Alpha: If Enabled, include the alpha pass in the rendered file.
  • Override Render Passes: If enabled, the render passes selected in the submitter will be used instead of those defined within the scene.
  • Quality To Render By: Determine whether to render based on the Maximum Number of Samples, Maximum Time, or a combination of both.

Plug-in Configuration

You can configure the KeyShot plug-in settings from the Monitor. While in super user mode, select Tools -> Configure Plugins and select the KeyShot plug-in from the list on the left.


Render Executables

  • KeyShot Executable: The path to the KeyShot executable file used for rendering. Enter alternative paths on separate lines. Different executable paths can be configured for each version installed on your render nodes.

Integrated Submission Script Setup

The following procedures describe how to install the integrated KeyShot submission script. This script allows for submitting KeyShot render jobs to Deadline directly from within the KeyShot GUI. The script and the following installation procedure has been tested with KeyShot 6 and later.

Submitter Installer

Manual Installation

  • Within KeyShot open the Script Console (Window -> Scripting Console).
  • On the Scripts tab of the Script Console import the file located at <repository>/submission/KeyShot/Client.


Which versions of KeyShot are supported?

KeyShot 6 and later is supported.

Error Messages and Meanings

This is a collection of known KeyShot error messages and their meanings, as well as possible solutions. We want to keep this list as up to date as possible, so if you run into an error message that isn’t listed here, please email Deadline Support and let us know.

Currently, no error messages have been reported for this plug-in.