Read time: 5 min | Article Quick Search
This document is a first-hand guide to ftrack integrations management. It takes you through the steps to discover, install, and update plugins used by ftrack Connect to integrate with third-party applications.
Please note: We are currently in the middle of a technology transition, and some integrations are not yet considered production-ready to be used with the updated Connect version.
Article Quick Search:
There are two main plugin types:
The main difference between the two is their installation location, either in Connect or in the application itself. This depends on how the application can be extended.
Downloading integration plugins
Opening your ftrack Connect for the first time, the app asks you to click on the yellow button to Install the plugin manager to get started.
Once done, to see the most recent plugin versions currently in use, select the Plugins option in the Connect tabs in the upper-left corner.
The latest available plugins for download can be found in the plugin manager within Connect.
Building integration plugins
Whenever a new version of an ftrack integration is released, it is made available via our plugin manager.
However, all the integrations are available as open-source code from our Bitbucket Git repository. They can be freely downloaded as a compressed archive or by cloning the repository and building them locally.
Using the git repository, rather than downloading from the portal, will allow you to access upcoming bug fixes and features, which still have to be integrated into the code.
We recommend having Python >= 3.7.0 installed and available on the system paths.
Most of the Python plugins can be easily built with the following command from within the plugin source folder:
>> python.exe setup.py build_plugin
This will produce a build folder under the plugin root folder, which contains a subfolder named with the plugin and version being built.
We suggest checking the readme and docs of other plugins to see what dependencies and requirements they have when building.
Tip: In case of any doubt, please contact support – And we’ll be happy to talk you through the process.
Installing or updating integration plugins
You have several options for installing / updating Connect plugins.
Whether you have downloaded the plugin from our forum or central download page or built it locally, you’ll access a compressed folder named
Please note: ftrack connect plugins can be downloaded and installed from the plugin manager widget. New and supported plugins can be found within the plugin manager itself.
Plugins will be automatically updated by the widget, the user will just have to restart connect when the new plugins have been installed.
Manual installation in connect-package
1. Locate the plugin you want to replace, and delete it from its current location.
2. Decompress the zip and copy the <plugin-name>-<version>
3. Restart Connect.
Manual installation in the local user plugin folder
1. Start Connect.
2. Select the ftrack Connect icon on the system tray.
3. Right-click and select Open plugin directory
4. Decompress the zip and copy the <plugin-name>-<version>
5. Restart Connect
Installation of the plugin in a centralized folder
This solution is most suitable for studios that wish to use one central location to store all ftrack integration plugins in use at the company.
Please note: The machine should be able to resolve the environment variable.
FTRACK_CONNECT_PLUGIN_PATH to a network path accessible from all the machines at the same address. Please check your operating system docs on how to set this up.
1. Decompress the zip and copy the <plugin-name>-<version>
2. Restart Connect.
Customizing integration plugins
Should your company require you to change or customize ftrack’s integrations, the best approach might be to use your bitbucket account and fork the project.
This way, you can always pull the latest updates from ftrack and ensure your changes will be kept. It’s up to you, however, to oversee the merges.
Once the code is in your repository, you can follow the guide on how to build and install plugins to install your custom version. In the case of extending connect capabilities, though, this can also be archived through a custom connect widget plugin.