Published data

Here's an overview of published data and how they are intended to be used. It also states which are used by Avalon core.

Avalon Publish data

Subset data

Name	Description
subsetGroup	The group name for this subset. Used in Avalon core loader to group multiple subsets with getavalon/core/#391

Version data

Name	Description
families	List of family names this publish belongs to. Also visualized in Avalon core loader and used by api.load. Note: Loader still visually only shows the first family in the list
startFrame	The start frame of the sequence. Also visualized in Avalon core loader.
endFrame	The end frame of the sequence. Also visualized in Avalon core loader.
handles	Start/end frame handles (e.g. 1 means an extra frame in front and after). Also visualized in Avalon core loader.
step	The step size between startFrame and endFrame. Also visualized in Avalon core loader.
source	The source work file. Also visualized in Avalon core loader.
fps	The frames per seconds of the content.
machine	The machine name that generated the output.
author	The user who generated this publish, e.g. Roy. Also visualized in Avalon core loader.
comment	An artist defined comment for this publish. Also visualized in Avalon core loader, right-hand side.
time	A timestamp of the creation date time, e.g 20190724T182854Z Also visualized in Avalon core loader as a human readable date format.

Note the required attributes for version data in the Version Schema in avalon core. It is up to the config to validate against the schema before you write the data into the database.

Representation data

Name	Description
inputs	The input dependencies that were used to create this publish for Input/Output Tracking. This should be a list of avalon.io.ObjectId (pymongo database object id) referring to Representation ids. This is stored on the representation to allow quick traversals upstream/downstream as it also refers to representations.

To be implemented

The following entries we are not storing yet but have spoken about that we might implement in the future.

Version data

Name	Description
frames	An explicit list of integer frames [1, 2, 5, 8, 10] to allow support for incomplete sequences with holes in the range.
batchId	A unique identifier generated at the start of the publish that will help to allow identifying which publishes were generated in one go together, as such which would potentially "belong together". See Avalon Gitter discussion.