Q100214: How to include the Clip Version or Project Version in NukeStudio/Hiero exports with tokens

Chris Wetherly

Updated : August 03, 2023 22:10

Created : November 07, 2016 15:50

SUMMARY

This article explains how to include the clip version and project version tokens for exported filenames.

MORE INFORMATION

NukeStudio and Hiero offer the ability for exported filenames to include the current version of the clip you are exporting, or the current project version you are working with. This is very useful for organizing project directories and exports, but can cause confusion if the token differences are not understood correctly. 

The key tokens to use are {version} and {clip}

{version}

The {version} token can be used when exporting using the "Process as Sequence" or "Process as Shots" options. This token adds the letter "v" followed by the value in the "Version token number" section of the export dialog, such as "v01".

The "Version token number" can be defined in the bottom left hand corner of the export tab, and can be used to give a custom version number to an export that is purely defined by the user, as shown below:
​​
This is commonly where users mistake the {version} token to relate to the version number of clips on the Timeline. This is not the purpose of the {version} token, and instead we would recommend using the {clip} token for Timeline clip versions.

{clip}

The {clip} token can only be used when exporting using "Process as Shots" and is used to export a filename which includes the name of the clip used in the shot being processed.

Because it utilizes the name of the clip used in the shot, if you are exporting a clip with multiple versions, such as a comp container, the exported filename will include the current version number that is active on the Timeline.

Here is an example workflow:

1. Import clip to the Timeline named "exampleClip"
2. Create a comp container for this clip using Effects > Create Comp
3. Add changes to comp, i.e. grade/color correct/etc, and render comp to the Timeline
4. Save new version using File > Save New Comp Version
5. Render new version to the Timeline
6. Repeat steps 4-5 as needed
7. Select comp container on the Timeline, "exampleClip (example_clip_comp > 02)"
8. Export > Process as Shot, and include the {clip} token in the export path

Result: Depending on how you have set up your export path, so long as the token {clip} has been included, then the active version number of the clip you are exporting will be included in the directory name/file name:

FURTHER READING

For more information on versioning please visit our Nuke Online Help.

A complete list of tokens can be found in the Using Local and Project Presets page.