ftrack server url

Setting Location: ayon+settings://ftrack/ftrack_server

• ftrack server url: Link to your ftrack server.

Service settings

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

• ftrack user name: Select ftrack user name from AYON secrets drop down menu.

• ftrack API Key: Select ftrack API Key from AYON secrets drop down menu.

ftrack service cares about handling ftrack event and synchronization. To be able do that work it is required to listen and process events as one of ftrack users. It is recommended to use special user for that purposes so you can see which changes happened from service.

Server Actions/Events

Settings for event handlers running in ftrack service.

Prepare Project

Setting Location: ayon+settings://ftrack/service_event_handlers/prepare_project

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Sync to AYON

Setting Location: ayon+settings://ftrack/service_event_handlers/sync_from_ftrack

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Sync Users to AYON

Setting Location: ayon+settings://ftrack/service_event_handlers/sync_users_from_ftrack

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Sync Hierarchial and Entity Attributes

Setting Location: ayon+settings://ftrack/service_event_handlers/sync_hier_entity_attributes

• Enable: The default state of the action.

• Entity types of interest

• Attributes to sync

• Enable Action

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Clone Review Session

Setting Location: ayon+settings://ftrack/service_event_handlers/clone_review_session

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Delete Folders/Products

Setting Location: ayon+settings://ftrack/service_event_handlers/delete_ayon_entities

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Update Hierarchy thumbnails

Setting Location: ayon+settings://ftrack/service_event_handlers/thumbnail_updates

Push thumbnail from version, up through multiple hierarchy levels.

• Enable: The default state of the action.

• Levels

Sync status from Task to Parent

Setting Location: ayon+settings://ftrack/service_event_handlers/status_task_to_parent

• Enable: The default state of the action.

• Object types

• Chane parent if all tasks match

  

• Change parent status if a single task matches

  

Sync status from Task to Version

Setting Location: ayon+settings://ftrack/service_event_handlers/status_task_to_version

• Enable: The default state of the action.

• Status mapping

  

• Asset types Allow/Deny

Sync status from Version to Task

Setting Location: ayon+settings://ftrack/service_event_handlers/status_version_to_task

• Enable: The default state of the action.

• Status mapping

  

• Asset types Allow/Deny

Update status on next task

Setting Location: ayon+settings://ftrack/service_event_handlers/next_task_update

• Enable: The default state of the action.

• Status mapping

  

• Ignored statuses

• Naming Sorting

Action to transfer hierarchical attribute values

Setting Location: ayon+settings://ftrack/service_event_handlers/transfer_values_of_hierarchical_attributes

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Create daily lists

Setting Location: ayon+settings://ftrack/service_event_handlers/create_daily_lists

Create list with AssetVersions by filter criteria.

• Enable: The default state of the action.

• Create daily lists at: This may take affect on next day.

• Days of week

• Lists

  

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Calculate project component sizes

Setting Location: ayon+settings://ftrack/service_event_handlers/project_components_sizes

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Status change on application launch

Setting Location: ayon+settings://ftrack/post_launch_hook

Change task status on application launch.
Change of status is based on mapping. Each item in mapping defines new status which is used based on current status(es). Special value for current statuses is __any__, in that case the new status is always used. And if new status name is __ignore__, the change of status is skipped if current status is in current statuses list. More info, See Update status on task action​.

• Mapping

  Each item includes

  

  • New status

  • From statuses

User Actions/Events

Create/Update Custom Attribute

Setting Location: ayon+settings://ftrack/user_handlers/create_update_attributes

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Prepare Project

Setting Location: ayon+settings://ftrack/user_handlers/prepare_project

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

• Create project structure

Clean hierarchical custom attributes

Setting Location: ayon+settings://ftrack/user_handlers/clean_hierarchical_attr

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Delete old versions

Setting Location: ayon+settings://ftrack/user_handlers/delete_old_versions

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Delivery action

Setting Location: ayon+settings://ftrack/user_handlers/delivery_action

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Job Killer

Setting Location: ayon+settings://ftrack/user_handlers/job_killer

• Enable: The default state of the action.

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Fill workfile Custom attribute

Setting Location: ayon+settings://ftrack/user_handlers/fill_workfile_attribute

• Enable: The default state of the action.

• Custom attribute key

• Roles for action: Defines which user roles can view and trigger the action.
  For more info about roles, see User Permissions.

Publish plugins​

Collect ftrack Family

Setting Location: ayon+settings://ftrack/publish/CollectFtrackFamily

Reviews uploads to ftrack could be configured by combination of hosts, families and task names.

• Profiles

  

  ​

  Profiles are used to select when to add ftrack family to the instance. One or multiple profiles could be configured, Families, Task names (regex available), Host names combination is needed.
  

  Eg. If I want review created and uploaded to ftrack for render published from Maya , setting is: Host names: 'maya' Families: 'render' Add ftrack Family: enabled

  • Advanced adding if additional families present

    In special cases adding 'ftrack' based on main family ('Families' set higher) is not enough. (For example upload to ftrack for 'plate' main family should only happen if 'review' is contained in instance 'families', not added in other cases. )

Collect Custom Attribute Data

Setting Location: ayon+settings://ftrack/publish/CollectFtrackCustomAttributeData

Collect custom attributes from ftrack for ftrack entities that can be used in some templates during publishing.

• Custom attribute keys

Validate ftrack Attributes

Setting Location: ayon+settings://ftrack/publish/ValidateFtrackAttributes

• Enable: The default state of the plugin.

• Custom attributes to validate

Integrate Hierarchy to ftrack

Setting Location: ayon+settings://ftrack/publish/IntegrateHierarchyToFtrack

Set task status on new task creation. ftrack's default status is used otherwise.

• Create Task Status Profiles

  • + : Add a status profile.

  • Each profile includes:

    

    • Task types

    • Task names

    • Status name

Integrate ftract Description

Setting Location: ayon+settings://ftrack/publish/IntegrateFtrackDescription

Add description to integrated AssetVersion

• Enable: The default state of the plugin.

• Optional: Allows the user to toggle this setting in the publisher UI.

• Active: The default value of the toggle in the publisher UI.

• Description template: Template may contain formatting keys intent and comment.

Integrate ftrack Component Overwrite

Setting Location: ayon+settings://ftrack/publish/IntegrateFtrackComponentOverwrite

• Enable: The default state of the action.

Integrate ftrack Instance

Setting Location: ayon+settings://ftrack/publish/IntegrateFtrackInstance

• Product type Mapping

  • + : Add a mapping

  • Each type mapping includes:

    

    • Family

    • Asset Type

• Make product name as first asset name

• AssetVersion status on publish

  • + : Add a profile

  • Each profile includes:

    

    • Host names

    • Families

    • Task types

    • Status name

• Additional metadata keys on components

Integrate ftrack Farm Status

Setting Location: ayon+settings://ftrack/publish/IntegrateFtrackFarmStatus

Change status of task when it's product is submitted to farm

• Farm status profiles

  • + : Add a profile.

  • Each profile includes:

    • Host names

    • Task types

    • Task names

    • Product names

    • Status name

ftrack Status Local Integration

Setting Location: ayon+settings://ftrack/publish/ftrack_task_status_local_publish

Change status of task when is integrated locally.

• Status profiles

  • + : Add a profile.

  • Each profile includes:

    

    • Host names

    • Task types

    • Task names

    • Product types

    • Product names

    • Status names

ftrack Status On Farm Integration

Setting Location: ayon+settings://ftrack/publish/ftrack_task_status_on_farm_publish

Change status of task when it's product is integrated on farm.

• Status profiles

  • + : Add a profile.

  • Each profile includes:

    

    • Host names

    • Task types

    • Task names

    • Product types

    • Product names

    • Status names

Integrate ftrack Task Status

Setting Location: ayon+settings://ftrack/publish/IntegrateFtrackTaskStatus

• After version integration: Apply collected task statuses. This plugin can run before or after version integration. Some status automations may conflict with status changes on versions because of wrong order.

Custom Attributes

Setting Location: ayon+settings://ftrack/custom_attributes

Mandatory custom attributes

Set read/write roles of AYON mandatory custom attributes.

• Each setting includes:

  

  • Write roles

  • Read roles

Attributes mapping

Use custom mapping of AYON attributes to ftrack custom attributes.

• Attributes mapping: Map AYON attributes to ftrack custom attributes.

  • + : Add attribute mapping

  • Each attribue mapping includes:

    

    • AYON attribute

    • Attribute type

    • ftrack attribute names