Sequence and shot folder grouping

server/settings/main.py

@@ -113,6 +113,14 @@ class AttributesMappingModel(BaseSettingsModel):
     )
 
 
+class FolderLocationsModel(BaseSettingsModel):
+    """AYON folders to store separate of SG types"""
+    asset_folder: str = SettingsField(title="Assets", default="assets")
+    sequence_folder: str = SettingsField(title="Sequences",
+                                         default="sequences")
+    shot_folder: str = SettingsField(title="Shots", default="shots")
+
+
 class ShotgridCompatibilitySettings(BaseSettingsModel):
     """ Settings to define relationships between ShotGrid and AYON.
     """
@@ -136,6 +144,15 @@ class ShotgridCompatibilitySettings(BaseSettingsModel):
         ),
     )
 
+    folder_locations: FolderLocationsModel = SettingsField(
+        title="Folder locations",
+        default_factory=FolderLocationsModel,
+        description=(
+            "Locations of AYON folders matching to SG types."
+            "Eg. where SG assets will be stored, where SG shots and sequences."
+        ),
+    )
+
 
 class ClientLoginDetailsModel(BaseSettingsModel):
     _layout = "expanded"
@@ -218,13 +235,13 @@ class ShotgridSettings(BaseSettingsModel):
     shotgrid_project_code_field: str = SettingsField(
         default="code",
         title="ShotGrid Project Code field name",
+        disabled=True,
         description=(
             "In order to create AYON projects, we need a Project Code, you "
             "can specify here which field in the ShotGrid Project "
             "entity represents it."
         ),
-        example="sg_code",
-        scope=["studio"],
+        example="sg_code"
     )
     enable_shotgrid_local_storage: bool = SettingsField(
         default=True,

services/shotgrid_common/ayon_shotgrid_hub/__init__.py

@@ -280,7 +280,8 @@ def synchronize_projects(self, source="ayon"):
                     self._sg,
                     self.sg_enabled_entities,
                     self.sg_project_code_field,
-                    self.custom_attribs_map
+                    self.custom_attribs_map,
+                    self.settings
                 )
 
             case _:
@@ -321,6 +322,7 @@ def react_to_shotgrid_event(self, sg_event_meta):
                     self.sg_enabled_entities,
                     self.sg_project_code_field,
                     self.custom_attribs_map,
+                    self.settings
                 )
 
             case "attribute_change":

services/shotgrid_common/ayon_shotgrid_hub/match_ayon_hierarchy_in_shotgrid.py

@@ -123,7 +123,6 @@ def match_ayon_hierarchy_in_shotgrid(
             )
             continue
         elif sg_entity_id:
-            # convert sg_entity_id to int if exists
             sg_entity_id = int(sg_entity_id)
 
         if sg_entity_type == "AssetCategory":

services/shotgrid_common/ayon_shotgrid_hub/match_shotgrid_hierarchy_in_ayon.py

@@ -21,6 +21,8 @@
 from utils import (
     get_sg_entities,
     get_asset_category,
+    get_sequence_category,
+    get_shot_category,
     update_ay_entity_custom_attributes,
 )
 
@@ -36,7 +38,8 @@ def match_shotgrid_hierarchy_in_ayon(
     sg_session: shotgun_api3.Shotgun,
     sg_enabled_entities: List[str],
     project_code_field: str,
-    custom_attribs_map: Dict[str, str]
+    custom_attribs_map: Dict[str, str],
+    addon_settings: Dict[str, str]
 ):
     """Replicate a Shotgrid project into AYON.
 
@@ -107,11 +110,31 @@ def match_shotgrid_hierarchy_in_ayon(
 
         # If we couldn't find it we create it.
         if ay_entity is None:
-            if sg_ay_dict["attribs"].get(SHOTGRID_TYPE_ATTRIB) == "AssetCategory":  # noqa
+            parent_is_project = isinstance(ay_parent_entity, ProjectEntity)
+
+            shotgrid_type = sg_ay_dict["attribs"].get(SHOTGRID_TYPE_ATTRIB)
+            if shotgrid_type == "AssetCategory":
                 ay_entity = get_asset_category(
                     entity_hub,
                     ay_parent_entity,
-                    sg_ay_dict
+                    sg_ay_dict,
+                    addon_settings
+                )
+
+            if shotgrid_type == "Sequence" and parent_is_project:
+                ay_parent_entity = get_sequence_category(
+                    entity_hub,
+                    ay_parent_entity,
+                    sg_ay_dict,
+                    addon_settings
+                )
+
+            if shotgrid_type == "Shot" and parent_is_project:
+                ay_parent_entity = get_shot_category(
+                    entity_hub,
+                    ay_parent_entity,
+                    sg_ay_dict,
+                    addon_settings
                 )
 
             if not ay_entity:

services/shotgrid_common/ayon_shotgrid_hub/update_from_ayon.py

@@ -325,16 +325,19 @@ def _create_sg_entity(
     sg_field_name = "code"
     sg_step = None
 
-    # parent AssetCategory should not be created in Shotgrid
-    # it is only used for grouping Asset types
+    special_folder_types =["AssetCategory", "ShotCategory", "SequenceCategory"]
+    # parent special folder like AssetCategory should not be created in
+    # Shotgrid it is only used for grouping Asset types
+    is_parent_project_entity = isinstance(ay_entity.parent, ProjectEntity)
     if (
-        isinstance(ay_entity.parent, ProjectEntity)
-        and ay_entity.folder_type == "AssetCategory"
+        is_parent_project_entity
+        and ay_entity.folder_type in special_folder_types
     ):
         return
-    elif ay_entity.parent.folder_type == "AssetCategory":
+    elif (not is_parent_project_entity and
+          ay_entity.parent.folder_type in special_folder_types):
         sg_parent_id = None
-        sg_parent_type = "AssetCategory"
+        sg_parent_type = ay_entity.parent.folder_type
     else:
         sg_parent_id = ay_entity.parent.attribs.get(SHOTGRID_ID_ATTRIB)
         sg_parent_type = ay_entity.parent.attribs.get(SHOTGRID_TYPE_ATTRIB)
@@ -413,13 +416,14 @@ def _create_sg_entity(
     else:
         data = {
             "project": sg_project,
-            parent_field: {
-                "type": sg_parent_type,
-                "id": int(sg_parent_id)
-            },
             sg_field_name: ay_entity.name,
             CUST_FIELD_CODE_ID: ay_entity.id,
         }
+        if isinstance(sg_parent_id, int):
+            data[parent_field] = {
+                "type": sg_parent_type,
+                "id": int(sg_parent_id)
+            }
 
     # Fill up data with any extra attributes from Ayon we want to sync to SG
     data.update(get_sg_custom_attributes_data(

services/shotgrid_common/ayon_shotgrid_hub/update_from_shotgrid.py

@@ -29,6 +29,8 @@
 
 from utils import (
     get_asset_category,
+    get_shot_category,
+    get_sequence_category,
     get_sg_entity_as_ay_dict,
     get_sg_entity_parent_field,
     update_ay_entity_custom_attributes,
@@ -54,7 +56,8 @@ def create_ay_entity_from_sg_event(
     ayon_entity_hub: ayon_api.entity_hub.EntityHub,
     sg_enabled_entities: List[str],
     project_code_field: str,
-    custom_attribs_map: Optional[Dict[str, str]] = None
+    custom_attribs_map: Optional[Dict[str, str]] = None,
+    addon_settings: Optional[Dict[str, str]] = None
 ):
     """Create an AYON entity from a ShotGrid Event.
 
@@ -67,6 +70,7 @@ def create_ay_entity_from_sg_event(
         project_code_field (str): The Shotgrid project code field.
         custom_attribs_map (Optional[dict]): A dictionary that maps ShotGrid
             attributes to Ayon attributes.
+        addon_settings (Optional[dict]): A dictionary of Settings
 
     Returns:
         ay_entity (ayon_api.entity_hub.EntityHub.Entity): The newly
@@ -84,6 +88,9 @@ def create_ay_entity_from_sg_event(
         extra_fields.append("sg_asset_type")
         sg_parent_field = "sg_asset_type"
 
+    if sg_event["entity_type"] == "Shot":
+        sg_parent_field = "sg_sequence"
+
     sg_ay_dict = get_sg_entity_as_ay_dict(
         sg_session,
         sg_event["entity_type"],
@@ -131,29 +138,52 @@ def create_ay_entity_from_sg_event(
 
             return ay_entity
 
-    # INFO: Parent entity might not be added in SG so this needs to be handled
-    #       with optional way.
-    if sg_ay_dict["data"].get(sg_parent_field) is None:
-        # Parent is the project
-        log.debug(f"ShotGrid Parent is the Project: {sg_project}")
-        ay_parent_entity = ayon_entity_hub.project_entity
-    elif (
-        sg_ay_dict["attribs"][SHOTGRID_TYPE_ATTRIB] == "Asset"
+    shotgrid_type = sg_ay_dict["attribs"][SHOTGRID_TYPE_ATTRIB]
+    sg_parent = sg_ay_dict["data"].get(sg_parent_field)
+
+    if (
+        shotgrid_type == "Asset"
         and sg_ay_dict["data"].get("sg_asset_type")
     ):
         log.debug("ShotGrid Parent is an Asset category.")
         ay_parent_entity = get_asset_category(
             ayon_entity_hub,
             ayon_entity_hub.project_entity,
             sg_ay_dict,
+            addon_settings
         )
 
+    elif(shotgrid_type == "Sequence"):
+        log.info("ShotGrid Parent is an Sequence category.")
+        ay_parent_entity = get_sequence_category(
+            ayon_entity_hub,
+            ayon_entity_hub.project_entity,
+            sg_ay_dict,
+            addon_settings
+        )
+
+    elif(shotgrid_type == "Shot") and not sg_parent:
+        log.info("ShotGrid Parent is an Shot category.")
+        ay_parent_entity = get_shot_category(
+            ayon_entity_hub,
+            ayon_entity_hub.project_entity,
+            sg_ay_dict,
+            addon_settings
+        )
+
+    # INFO: Parent entity might not be added in SG so this needs to be handled
+    #       with optional way.
+    elif sg_parent is None:
+        # Parent is the project
+        log.debug(f"ShotGrid Parent is the Project: {sg_project}")
+        ay_parent_entity = ayon_entity_hub.project_entity
+
     else:
         # Find parent entity ID
         sg_parent_entity_dict = get_sg_entity_as_ay_dict(
             sg_session,
-            sg_ay_dict["data"][sg_parent_field]["type"],
-            sg_ay_dict["data"][sg_parent_field]["id"],
+            sg_parent["type"],
+            sg_parent["id"],
             project_code_field,
         )