Flow (ShotGrid) Addon Settings

Last updated 8 months ago

Main Settings

Settings Locations:

  • ayon+settings://shotgrid/shotgrid_server

  • ayon+settings://shotgrid/shotgrid_project_code_field

  • ayon+settings://shotgrid/enable_shotgrid_local_storage

  • ayon+settings://shotgrid/shotgrid_local_storage_key

  • ayon+settings://shotgrid/anatomy_preset

  • ShotGrid URL: The URL to the ShotGrid Server we want to interact with.
    example: https://my-site.shotgrid.autodesk.com/

  • ShotGrid Project Code filed name: In order to create AYON projects, we need a Project Code, you can specify here which field in the ShotGrid Project entity represents it.

  • Enable ShotGrid Local Storage.: Whether to try make use of local storage defined in ShotGrid ('Site Preferences -> File Management -> Local Storage') or not.

  • Shotgrid Local Storage entery name: Name of the 'code' to select which one of the multiple possible local storages entries to use.

  • Anatomy Preset: This anatomy preset will be used when ShotGrid create new projects on

    synchronization.

Shot Grid <-> AYON compatibility Settings

Setting Location: ayon+settings://shotgrid/compatibility_settings

Settings to define relationships between ShotGrid and AYON.

  • Default Task Type: Default Task Type for SG tasks with missing pipeline step.

  • ShotGrid Enabled Entities: The Entities that are enabled in ShotGrid, disable any that you do not use.

  • Folder Attributes Map: AYON attributes <> ShotGrid Mapping. Empty ones will be ignored.
    Each attribute map includes

    • AYON: AYON attribute.

    • Field Type: Attribute Type.

    • SG: Flow(ShotGrid) attribute without sg_ prefix!

    • Scope: List of Flow(ShotGrid) entities that the mapping applies to.

  • Folder re-parenting: Parent folders for AYON folders matching to SG types.

Folder re-parenting

Setting Location: ayon+settings://shotgrid/compatibility_settings/folder_parenting

When enabled, AYON will re-parent folders based on the type you are using.
Each Mode has a list of presets for re-parenting.
leave blank for default behavior.
The order of the parents from top to bottom is important. Within 'Root relocation' type the first parent will be the root folder.

Find examples about using this setting here: Reparenting the hierarchy in AYON

  • Each preset includes:

    • Filter by ShotGrid Entity Type

    • Parents: Each Parent includes

      • Parent AYON Folder Type

      • Parent AYON Folder Name

Service settings

Setting Location: ayon+settings://shotgrid/service_settings

Specific settings for the ShotGrid Services: Processor, Leecher and Transmitter.

  • How often (in seconds) to process ShotGrid to process ShotGrid related events: control how long to wait between each event is processed.

  • ShotGrid’s Script api key: Select AYON Secret related to ShotGrid's Script api key.
    For more info, check Adding Script Users and AYON Server Secrets.

  • ShotGrid’s Script Name: The Script Name of your ShotGrid script.
    For more info, check Adding Script Users.