The Shotgun+Rush integration allows you to automatically submit rendered Versions to Shotgun complete with thumbnail, links to frames, and other metadata.
Built on top of the standard ShotgunIO render integration spec, the integration allows you to easily customize how the integration works for your studio. Once enabled, when you submit a new job, just select a Shotgun Task or entity that the job is for, choose a name for the Version (or select one of the default naming options), and submit. Rush will create the new Version immediately in Shotgun and update its status as the job runs and completes. This way you can see exactly what the status of your pending Versions are right from Shotgun.
The initial Shotgun Version entity will have the following fields set when the job is submitted:
- Version Name
- Frame Range
- **Job ID
When the job completes, the Version is updated with additional information including:
- Status (updated)
- First Frame
- Last Frame
- Frame Count
- Path to Frames
- ** Total Render Time
- ** Avg Frame Time
Installation & Configuration
Rush uses the ShotgunIO framework to communicate with Shotgun. ShotgunIO is a render-queue-specific wrapper to the Shotgun API that allows studios to configure their settings and optionally modify the behavior of the integration in a central place outside of the Rush codebase. ShotgunIO must be in installed and accessible to Rush in order for the configuration to work. The ShotgunIO documentation is available here.
You can configure which Version fields in Shotgun should store each piece of information. Generally the defaults should be fine for most studios, however if you need to store information in a non-standard field, you can easily change these defaults.
Some information doesn't have a corresponding standard field by default in Shotgun. You can create your own fields to track this information and specify what those fields are in the configuration.
- Job ID: (Text) the render job id assigned by Rush
- Total Render Time: (Number) the total (wall clock) time in seconds the render took to complete.
- Avg Frame Time: (Number) the average time each frame took to render in seconds.
You can configure different statuses to be set during the job progression. Since by default the Version is created when you submit the job, this allows you to see the state of your jobs right from Shotgun. Version statuses can be set at the following points:
- Job submitted
- Job started
- Job finished
- Job failed
- Job aborted (dumped)