ftrack Connect Pipeline Framework

Welcome to ftrack-connect-pipeline’s documentation!

Important

This is the new DCC Framework for Connect 2 written in Python. If you are migrating from the old ftrack Connectors integrations then please read the dedicated migration guide.

This document is intended to bring a deeper understanding of how the new Framework works under the hood, enabling developers to customise it to their particular needs.

For a general introduction on how to install and use ftrack Connect 2 out of the box, please head over here: https://www.ftrack.com/en/portfolio/connect

The documentation is divided into two main parts, the first part is where we describe the new Framework and the second part is where we customise it to fit our needs.

Contents:

• Introduction
  • Overview
    • Prerequisites
    • Key design elements and tradeoffs
    • Architecture
  • Connect
    • Application launcher
    • Connect Package
  • Framework
    • Core Pipeline layer
    • Definition layer
    • UI layer
    • DCC integration layer
  • How it works
    • DCC launch
    • Asset loading
    • Asset management
    • Asset publish
  • History
• Installing
• Developing
  • Coding environment setup
    • IDE
    • Source Code Management
  • Download
  • Customise
    • ftrack-connect-pipeline
    • ftrack-connect-pipeline-definition
    • ftrack-connect-pipeline-qt
    • ftrack-connect-pipeline-host_type
  • Build
    • Create a virtual environment
    • Building the Framework
    • Building the documentation
    • Building the Framework
    • Building the documentation
  • Deploy
    • Deploying the Framework locally
    • Building and deploying Connect centrally
    • Deploying Framework centrally
• Tutorial
  • Introduction
    • Checkout documentation code
    • The tools we are about to build
  • Setup
    • Prerequisites
    • Git repositories
    • Branching
    • Testing
    • Pipeline deploy
  • Custom file structure
    • Structure
    • Location
  • Maya open latest scene
    • Prerequisites
    • Implementation
  • Load camera image plane in Maya
    • Constrain camera loader
    • Render loader
  • Post Slack message on publish
    • Save copy of thumbnail image
    • Finaliser
    • Add Slack finaliser to publishers
    • Add Slack library
  • Add a custom tool the the ftrack menu within Maya
  • Customising DCC launch
    • Changing paths to DCC executables and arguments
  • Deploy the customised pipeline within studio
    • Create and activate an virtual environment
    • Build the integrations
    • Install the integrations on another machine
    • Deploy the integrations studio wide
• Standalone
  • Python Example
  • DCC Maya Example
  • Discover Framework from Standalone DCC
• API Reference
  • ftrack_connect_pipeline
    • ftrack_connect_pipeline.asset
    • ftrack_connect_pipeline.client
    • ftrack_connect_pipeline.constants
    • ftrack_connect_pipeline.definition
    • ftrack_connect_pipeline.host
    • ftrack_connect_pipeline.log
    • ftrack_connect_pipeline.plugin
    • ftrack_connect_pipeline.configure_logging
    • ftrack_connect_pipeline.event
    • ftrack_connect_pipeline.exception
    • ftrack_connect_pipeline.utils
• Release and migration notes
  • Release Notes
    • 1.3.0
    • 1.2.0
    • 1.1.0
    • 1.0.1
  • Migrating from old ftrack Connectors
    • Why a new Framework?
    • Compability
• Glossary
• Troubleshooting

Help and support

Please visit our user Slack channel to get help on integration issues, and receive tips and tricks from other users.

On our forum, you will also find useful information about Connect and Framework releases.

Indices and tables

• Index

• Module Index

• Search Page