Building from source

Note

Unless you are doing any modifications, there should be no need to build the extension yourself.

You can also build manually from the source for more control. First obtain a copy of the source by either downloading the zipball or cloning the repository:

git clone git@bitbucket.org:ftrack/ftrack-connect-spark-adobe.git

Full documentation, including installation and setup guides, can be found at https://ftrack-connect-spark-adobe.readthedocs.io/en/latest/

Setting up node environment

You will need a recent version of node with npm installed. It is highly recommended that you also install a version manager for node, such as n (Mac OS) or nodist (windows). It enables you can use different node versions in different projects.

Mac OS

  1. Install homebrew, unless already installed.

  2. Ensure homebrew is installed correctly:

    brew doctor

  3. Install latest node and npm versions:

    brew install node

  4. Install n globally:

    npm install -g n

  5. Install latest stable version:

    n stable

Windows

  1. Install Node.js 9.11.2

  2. Download ZXPSignCMD.exe

Note

As ZXPSignCMD comes without installer, make sure it is set in your system $PATH environment variable.

Building (All platforms)

Preparations

  1. Prepare ftrack-connect-spark by checking it out.

  2. Install yarn (MacOS: brew install yarn && npm install webpack) and run:

    npm install
yarn dist
yarn link

  3. Go back to ftrack-connect-spark-adobe repository checkout folder and run:

    yarn link ftrack-connect-spark

  4. Get access to the Adobe Vault, store the certificate password in an environment variable:

    export FTRACK_ADOBE_CERTIFICATE_PASSWORD=xxxxxxx

  5. Update extension version string in package.json.

  6. Download and install ZXPSignCMD (https://github.com/Adobe-CEP/CEP-Resources/tree/master/ZXPSignCMD).

Note

(MacOS only) 7. Link executable to make it available to build:

ln -s /path/to/ZXPSignCmd-64bit /usr/local/bin/ZXPSignCmd

Building

Run:

python setup.py build_extension

The built extension will be available in build folder.

Testing

  1. Download and unzip ExManCmd (https://partners.adobe.com/exchangeprogram/creativecloud/support/exman-com-line-tool.html).

  2. Install an Adobe DCC app, for example Photoshop.

  3. Uninstall any previous ftrack extension:

    ExManCmd /list all
ExManCmd /remove com.ftrack.connect.adobe

  4. Install extension:

    ExManCmd /install ftrack_connect_adobe_1.0.3.zxp

  5. Launch a task from ftrack connect, choose Adobe DCC app (Photoshop).

  6. In Windows menu, open ftrack from “Extensions” submenu.

  7. Test publish an image to ftrack, it should succeed and turn up as a version.