In this guide you’ll learn how to:
- Install ftrack Connect
- Use ftrack Connect
- Customize ftrack Connect
Installing ftrack Connect
Standard (Out of the Box) installation
- Visit the ftrack Connect download page at ftrack.com/downloads.
- Select your app's operating system to download. Links are found at the right side of the page.
- Launch the installation file and follow the onscreen instructions.
- Continue onto ‘Launching the app’ below.
Having trouble? Here is what to try first:
- Make sure you are using the latest version of the app: ftrack.com/downloads.
Using ftrack Connect
Launching the app
- macOS users: double-click the ftrack-connect executable in the Applications folder.
- Windows users: double-click the shortcut on the desktop or find it in the start menu.
- Linux users: double-click the ftrack-connect executable in the folder where the installation .tar file was extracted.
Signing in to the app
Before you can start using Connect, you will need to sign in with your ftrack user account.
Once signed in, you will not have to sign in again even if you close and reopen the app.
Signing in automatically
- Enter the site name or https://sitename.ftrackapp.com account URL on the sign in screen.
- Upon clicking ‘Sign in’, your web browser will open and let you login to your ftrack user account. If you’re already logged in to your ftrack user account, you will be authenticated and prompted to close the browser window.
- You are now signed in to ftrack Connect and ready to use the app.
Signing in by using an API key
Users can also sign into ftrack Connect without a web browser using their API key.
- Click ‘Sign in with username and API key’ at the bottom of the sign in screen.
- Enter the site name or https://sitename.ftrackapp.com account URL.
- Enter your ftrack account user name.
- Find your personal API key on the My account page (click your profile picture in the web interface and select My account). Copy and paste the key into the ftrack Connect app and click ‘Sign in’.
- You’re now signed in to ftrack Connect and ready to use the app.
Launching a desktop application or Action
The Actions tab displays shortcuts of available Actions and supported desktop applications.
For example, if you have Adobe Photoshop installed on your computer, a shortcut to the app will display in this tab and let you launch it together with the ftrack integration.
Learn more about Actions and how you can add your own.
The Connect app provides two types of software integrations:
- Those that can be launched from a task context only.
- Those that can be launched from any context (project, task, folder, etc.).
If you have trouble finding an application on the Actions tab, please see the FAQ below.
A desktop application can be launched by simply clicking its icon. If multiple versions of an application exist on your computer, a menu with each version will appear.
Each bundled integration has its own documentation. You can find them all here.
An Action can be triggered by simply clicking its icon. Any Action displayed in this tab are the same as those available in the web interface of ftrack.
The Publish tab enables you to create new assets or version up an existing asset on a project without launching an application.
You can read about publishing in ftrack here.
An asset version can hold several components. Each component usually represents a file on a disk. You can drag and drop files from your computer into the dashed line area to create a component for each file, or alternatively, browse to the file(s) by clicking the Browse button.
Each component’s name will be based on the filename of the file. You can manually edit the name if desired by clicking the name of the component and typing a new name.
A component can be removed by clicking the trash can icon next to each entry.
Note: Sequences of files will automatically be detected and added as one entry.
Selecting a linked entity
Each asset version needs to be linked to an entity on a project. We recommend linking asset versions to tasks, but you can also choose other entity types.
You can select an entity in two ways:
1. By clicking the Browse button next to the ‘Linked to’ field in the ftrack Connect app and selecting an entity from the project tree dialog.
2. Or by clicking the ‘Publish files with Connect’ button in the top of the sidebar in the web interface.
If you choose the first way: you can navigate through the project tree by double clicking items in the list. The navigation bar at the top will show you where you are and you can also click an item in the navigation bar to jump back up the hierarchy. Alternatively, use the neighbouring Navigate up button to move up a level at a time.
Note: If an item you expect to see in the list is not appearing, try clicking the reload button to refresh the list from the server.
Creating a new asset or versioning up an existing asset
You can choose to publish a new version of a previously published asset or publish the first version of a new asset.
To create a new asset, select Create new and an asset type, and give it a name.
To publish a new version of an existing asset, select Version up existing and then the name of an existing asset in the list.
Note: The list of asset types can be managed from System settings in ftrack.
Note: The asset name and type must be unique when creating new assets.
Other optional properties
Selecting the ‘web playable’ option encodes the file to be playable directly in the web browser. This will also update the thumbnail.
If not selecting the ‘web playable’ option, you can upload a thumbnail for this asset version by dragging and dropping an image file here.
You can enter a brief description of the published asset or the changes made since the last published version. Adding context to the asset can be especially helpful for your teammates.
Customizing ftrack Connect
ftrack Connect is an incredibly powerful app that can be deeply integrated into your pipeline with custom plugins and processes.
Examples of added functionality include your own custom Actions, event processing scripts or listeners, Location plugins, and many other possibilities.
Custom functionality can be picked up by the ftrack Connect app by placing it in a special plugin directory that the app is watching.
Plugin directories vary by operating systems. You can find it easily on your computer by clicking the menu bar icon and selecting Open plugin directory.
- macOS users: ~/Library/Application Support/ftrack-connect-plugins
- Windows users: C:\Documents and Settings\<User>\Application Data\Local Settings\ftrack\ftrack-connect-plugins
- Linux users: ~/.local/share/ftrack-connect-plugins
You can read more about developing for ftrack connect here.
Troubleshooting: Frequently Asked Questions
My application is not shown in the Actions tab, how can I fix this?
If you can’t find an application in the Actions tab and have installed it in the default location, first browse to and select a task as the action context at the top of the tab, then wait a second for the tab to reload and the application you are looking for should be displayed. If you know the application is installed in a non-default location on your computer or network, you will need to modify the application Action hook file (requires Python knowledge and is only recommended for advanced users).
How do I know what version of Connect I’m using?
Details on the ftrack Connect version you have installed can be found in the About dialog.
Select About in the context menu that will be displayed when you click the ftrack icon in the menu bar/taskbar. Here you will also find information about bundled integrations, user signed in, ftrack server currently connected, etc.
Where can I find the ftrack Connect log files?
The log files can be found in a separate directory from the ftrack Connect installation. You can open the directory from the About dialog by selecting About in the context menu that will be displayed when you click the ftrack icon in the menu bar/taskbar, and then clicking Open log directory.