All the information also applies to Nuke Studio, but for simplicity we only refer to hiero. The workflows are identical for both. We are supporting versions 11.0 and above.

Hiero specific tools

Create Default Tags

This tool will recreate all necessary pype tags needed for successful publishing. It is automatically ran at start of the hiero. Use this tool to manually re-create all the tags if you accidentaly delete them, or you want to reset them to default values.

Default Tags


  • Will create tags in Tags bin in case there were none
  • Will set all tags to default values if they have been altered

Publishing Shots

With Pype, you can use hiero as a starting point for creating project hierarchy in avalon and ftrack database (episodes, sequences, shots, folders etc.), publishing plates, reference quicktimes, audio and various soft effects that will be evailable later on for compositors and 3d artist to use.

There are two ways to Publish data and create shots in database from hiero. Use either context menu on right clicking selected clips or go to top menu > Pype > Publish.

Clips naming

Keep in mind that the publishing currently works on selected shots

Shot names for all the related plates that you want to publish (subsets) has to be the same to be correctly paired together (as it is shown in image). Note the layer review which contains plateMainReview. This media is just h264,1920x1080 video for tha will be used as preview of the actua plateMain subset and will be uploaded to Ftrack. We explain how to work with review tag in Reviewing.


To to successfuly publish a shot from hiero:

  1. At least one clip of your shot must be tagged with Hierarchy, subset and handleStart/End.
  2. Your source media must be pre-cut to correct length (including handles)


Pype's custom tags are used for defining shot parameters and to define which clips and how they are going to be published.

If you want to add any properties to your clips you'll need to adjust values on the given tag and then drag it onto the clip.

Tags basic

  1. double click on preferable tag and drag&drop it to selected clip(s)
  2. Basic set of tags on clip (usually subset: plateMain)
  3. Additionally select clip and edit its parameters
  4. Edit parameters here but Do not touch family

Only clips with subset will be directly processed for publishing.

Custom Tags Details

Asset related

HierarchyDefine parent hierarchy of the shot. Usually combined with one of subset tags.root, folder, sequence, episode, shotexample: {sequence} = name of hiero sequence or overwrite by any text without - or _
Frame StartSet start frame of the shot. Using "source" will keep original frame numbers.numberint number or "source"


ReviewChoose which track holds review quicktime for the given shot.track"review" or other track name
Plate MainMain plate subset identifiersubset"main" or other
Plate FGForeground plate subset identifier (comped over the main plate)subset"Fg##" or other
Plate BGBackground plate subset identifier (comped under the main plate)subset"Bg##" or other
Plate RefReference plate subset identifiersubset"Ref" or other

Subset's attributes

ResolutionUse source resolution instead of sequence settings.none
RetimingPublish retime metadata to shot if retime or time-warp found on clipmarginIn, marginOutint number frame cushioning
LensSpecify lens focal length metadata (work in progress)focalLengthMmint number


Handles StartHandles at the start of the clip/shotvaluechange to any int number
Handles EndHandles at the end of a clip/shotvaluechange to any int number


Pype requires handle information in shot metadata even if they are set to 0. For this you need to add handles tags to the main clip (Should be the one with Hierarchy tag). This way we are defining a shot property. In case you wish to have different handles on other subsets (e.g. when plateBG is longer than plateFG) you can add handle tags with different value to this longer plate.

If you wish to have different handles length (say 100) than one of the default tags, simply drag start: add 10 frames to your clip and then go to clips tags, find the tag, then replace 10 for 100 in name and also change value to 100. This is also explained following tutorial Extending premade handles tags


Even if you don't need any handles you have to add start: add 0 frames and end: add 0 frames tags to the clip with Hierarchy tag.


Pype is also able to publish retiming parameters into the database. Any clip with editorial/retime or TimeWarp soft effect has to be tagged with Retiming tag, if you want this information preserved during publishing.

Any animation on TimeWarp is also preserved and reapplied in Nuke.

You can only combine retime and with a single Timewarp.


There are two ways to publish reviewable h264 mov into Pype (and ftrack).

The first one uses the Review Tag pointing to the track that holds the reviewable quicktimes for plates.

This tag metadata has track key inside that points to review track by default. If you drop this tag onto any publishable clip on the timeline you're telling pype "you will find quicktime version of this plate on review track (clips must have the same name)"

In the image on the right we dropped it to plateMain clip. Then we renamed the layer tha hold reviewable quicktime called plateMainReview. YOu can see that the clip names are the same.


  1. - review suffix is added to publishing item label if any reviewable file is found
  2. plateMain clip is holding the Review tag
  3. layer name is review as it is used as default in Review Tag in track
  4. name of clip is the same across all subsets

LUT Workflow

It is possible to publish hiero soft effects for compositors to use later on. You can add the effect to a particular clip or to whole layer as shows on the picture. All clips below the Video 6 layer (green arrow) will be published with the lut subset which combines all the colour corrections from he soft effects. Any clips above the Video 6 layer will have no lut published with them.


Any external Lut files used in the soft effects will be copied over to resources of the published subset folder lutPlateMain (in our example).


You cannot currently publish soft effects on their own because at the moment we only support soft effects as a part of other subset publishing. Image is demonstrating successful publishing.



Basic publishing with soft effects

Extending premade handles tags