Core Pipeline layer

The core pipeline Framework module is the backbone of the pipeline, on which all other modules rely.

It is in the core were all the interaction with the underlying host type is performed, except when it comes to bootstrap of the DCC.

The core is depending on the definition module to be present.

The module comprises four major components:

Host

To use the Framework, a host must be instantiated with an event manager.

The host:

  • Loads the supplied context(task) from the FTRACK_CONTEXTID environment variable.

  • Discovers and validates each definition against its schema.

  • Serves each Client with data, handles context change.

  • Run definitions by instantiating an Engine.

  • Manages logging by listening to client notifications.

Client

The Client is the the user facing component that communicates with host through the host connection over the ftrack event system.

Clients are categorised into the engine types, see below.

Clients reads the definition and context from the host, and then commands the host to run the augmented definition and its plugins with options collected from the user.

Engine

An Framework Engine is a module within the core that defines a function and require an associated schema. The current defined engine types are:

  • Publisher

  • Loader

  • Asset manager

  • Opener

Logs

Clients sends notifications to the host which is stored in an internal SQLite database valid during the session.