-
-

ShotGrid pipeline toolkit core platform, v0.20.34

+
+

Flow Production Tracking core platform, v0.21.0

-
  • Uploading a configuration to ShotGrid
    • +
  • Uploading a configuration to Flow Production Tracking
  • Managing distributed configurations
    • @@ -243,7 +243,7 @@

    The Toolkit startup_images/launch.png

    This design is repeated everywhere and is a pattern which can be easily extended. -Users typically launch Toolkit by launching the ShotGrid Desktop. The ShotGrid Desktop +Users typically launch Toolkit by launching the Flow Production Tracking. The Flow Production Tracking contains a Toolkit plugin which runs the Bootstrap API in order to load in a full Toolkit environment.

    @@ -254,10 +254,10 @@

    The Toolkit startuptk-config-basic configuration in the ShotGrid App Store.

    +If not, the default plugins running in Flow Production Tracking will fall back on looking for the +latest release of the tk-config-basic configuration in the Flow Production Tracking App Store.

    The bootstrap API will make the necessary preparations and then launch a Toolkit Engine, as well as the apps defined in the configuration.

    _images/launch2.png @@ -277,11 +277,11 @@

    The Toolkit startupRez, general utilities, etc.

    -

    There are two fundamentally different ways to set up a Toolkit Project in ShotGrid, +

    There are two fundamentally different ways to set up a Toolkit Project in Flow Production Tracking, both briefly outlined below:

    Distributed configurations

    -

    Distributed configurations are defined as Pipeline Configurations inside ShotGrid. +

    Distributed configurations are defined as Pipeline Configurations inside Flow Production Tracking. At startup, these are detected by the Bootstrap API which will automatically manage your local configuration and resources on disk, ensuring that you have all the right apps, engines and other dependencies needed to run the configuration. @@ -290,8 +290,8 @@

    The Toolkit startup_images/distributed_config.png

    Note

    -

    To create a distributed configuration, manually go into ShotGrid and create -a ShotGrid Pipeline Configuration entity for your project. For more information, +

    To create a distributed configuration, manually go into Flow Production Tracking and create +a Flow Production Tracking Pipeline Configuration entity for your project. For more information, see Managing distributed configurations.

    @@ -301,16 +301,16 @@

    The Toolkit startup_images/shared_config.png -

    These configurations are created using Toolkit’s project setup system (either the ShotGrid Desktop project +

    These configurations are created using Toolkit’s project setup system (either the Flow Production Tracking project setup wizard or the tank setup_project command). After project setup, the configuration is manually managed, typically via the tank command.

    -
    -

    Uploading a configuration to ShotGrid

    +
    +

    Uploading a configuration to Flow Production Tracking

    The simplest way to distribute a Toolkit configuration to a group of users, whether these are distributed in different locations or all working in the same building, is to upload it -to ShotGrid. At startup, the Toolkit Bootstrap will automatically look for uploaded configurations +to Flow Production Tracking. At startup, the Toolkit Bootstrap will automatically look for uploaded configurations and if detected, download the configuration locally and then launch. Toolkit will take care of distribution and setup.

    To use this workflow, simply zip up your configuration and upload it as an attachment:

    @@ -319,24 +319,24 @@

    The Toolkit startupNote

    For backwards compatibility, configurations uploaded to the custom sg_uploaded_config field are also supported.

    -

    Older versions of ShotGrid may not have an Uploaded Config field enabled by +

    Older versions of Flow Production Tracking may not have an Uploaded Config field enabled by default, and in this case it may be necessary to create a custom field. Naming it Uploaded Config will generate a field with the API name sg_uploaded_config and thus will be recognized by Toolkit.

    Once a configuration is uploaded, it will be detected and used at bootstrap. -If a new configuration is uploaded to ShotGrid, users will pick it up the +If a new configuration is uploaded to Flow Production Tracking, users will pick it up the next time they start up.

    Note

    As an example, you can download one of the default configurations from -github as a zip and upload it as an attachment from ShotGrid: +github as a zip and upload it as an attachment from Flow Production Tracking: https://github.com/shotgunsoftware/tk-config-basic/archive/master.zip

    Managing distributed configurations

    In order to configure an automatically managed configuration, create an -entity in ShotGrid to represent a Primary configuration:

    +entity in Flow Production Tracking to represent a Primary configuration:

    _images/pipeline_config.png

    The descriptor field contains a Descriptor URI pointing at a configuration. The bootstrap API will detect this and use it as it starts up @@ -345,7 +345,7 @@

    The Toolkit startup_images/bootstrap.png -

    First, the ShotGrid Pipeline Configuration will be determined. The bootstrap +

    First, the Flow Production Tracking Pipeline Configuration will be determined. The bootstrap will search for a configuration in the following order: