-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Chore: Use mapping of custom attributes to AYON attributes #184
Chore: Use mapping of custom attributes to AYON attributes #184
Conversation
…-ftrack-custom-attributes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copying settings only works from a some previous versions, not generally.
…-ftrack-custom-attributes
Found out it cannot be fixed in addon, it is caused by server logic which skipes settings override application if source version does not have any overrides. It should change in next release, but even without it, it should be ok for production use-cases. |
…-ftrack-custom-attributes
…-ftrack-custom-attributes
Changelog Description
Change custom attributes sync to allow custom mapping of AYON attribute to ftrack custom attributes.
Additional review information
PR is changing how ftrack custom attributes sync works. Instead of one-to-one mapping there is a option to map AYON attribute to different ftrack attribute. Because of technical difficulties it was decided that it is possible to map one AYON attribute to one hierarchical attribute, or multiple standard attributes (with different names).
There is a checkbox that does allow to use previous one-to-one mapping, but is not based on
ayon
group anymore.Mandatory custom attributes (ayon id/path, auto sync and sync failed) are automatically created automatically during sync/prepare project if don't exist yet, these are the only one which stay in
ayon
group.Create/Update custom attributes work same way as before, but does not add
ayon
group to them.Removed
library_project
,applications
andtools_env
custom attributes. Library checkbox can be change in AYON FE so it is not necessary to set it in ftrack.Conversion of settings from older ftrack addon versions will change the overrides automatically to use "old style" sync. Default settings should be set to match ftrack default custom attributes (This might still need some investigation, I didn't spend time to find out what built-in ftrack custom attributes have available).
Possible issues
When
ayon+settings://ftrack/custom_attributes/attributes_mapping/enabled
orayon+settings://ftrack/custom_attributes/attributes_mapping/mapping
changes it is necessary to trigger sync of project to "propagate" the change -> it is hard to capture that correctly. Future enhancement.Testing notes:
Custom attributes sync - Backwards compatibility
ayon+settings://ftrack/custom_attributes/attributes_mapping/enabled
is set toFalse
all should work as before.True
and map all AYON attributes inayon+settings://ftrack/custom_attributes/attributes_mapping/mapping
to hierarchical custom attribute in ftrack with same name. The custom attributes must be on ftrack server -> e.g. ifCreate/Update custom attributes
action was triggered at least once on the server.Custom attributes sync - Using mapping
ayon+settings://ftrack/custom_attributes/attributes_mapping/enabled
toTrue
.ayon+settings://ftrack/custom_attributes/attributes_mapping/mapping
. For example mapframeStart
tofstart
andframeEnd
tofend
.Creation of mandatory custom attributes
There are ftrack custom attributes that are mandatory for AYON sync (
"ayon_id"
,"ayon_path"
,"ayon_sync_failed"
and"auto_sync_enabled"
). Those are now created automatically if do not exist. That happens automatically during Prepare project or Sync to AYON action. So it is not necessary to runCreate/Update custom attributes
action at all for simple sync.ayon_id2
).ayon_id
and renameayon_id2
back toayon_id
when finished testing.Resolves #157