Skip to main content

Introduction

Integrating your studio pipeline with ftrack is a powerful way to streamline your production process, this section will help you get started.

Overview​

To facilitate pipeline integrations, ftrack provides a desktop application named Connect and a Python Framework enabling integration into DCC:s and your pipeline, leveraging the ftrack Python API.

The capabilities of Connect are extended by downloading plugins, such as DCC integrations or other tools. By developing your own plugins, or customising the DCC integrations, you can start integrating your pipeline with ftrack in an easy and intuitive way.

Download Connect​

Your very first step would be to download Connect, you will find the official release here with previous versions and source code available on the ftrack Integrations Github repository.

Install your first plugin​

The next step would be to install your first plugin, that is done through the Plugin tab in Connect, find more information about the process here.

Develop your first plugin​

We provide a base example here on how to develop a plugin that will show up as widget inside Connect.

Another example is provided here on how you can create a custom location overrides the default behaviour of how Connect and the integrations interact with your storage - dictate where files get saved and what names they will be given.

Customise the DCC integrations​

The DCC integrations are built on top of the Framework and can be customised to fit your pipeline, go to the guides section to get started and find working examples in the recipes section, for example on how to change the path were a DCC is installed.

Create your own integration​

If you want to create your own integration, go to the guides section to get started.

note

We would love to hear from you before embarking on your new integration journey, to coordinate your effort and make sure you get the best possible support.

Develop the framework​

All our code is open source and available on Github for you to explore and contribute to.

In general, it should be sufficient to leverage the Framework extensions to achieve your goals, but if you need to go deeper, forking the repository and developing/building your own version of the Framework and Connect is always an option.

note

Don't hesitate to reach out to us, communicating what parts of the framework that you could need to augment, for us to better understand your needs and be able to answer any questions you might have.

Header over to the advanced section were your will find all information you need to get started with developing.