Skip to content

service_handlers

CreateDailyListsModel

Bases: BaseSettingsModel

Create list with AssetVersions by filter criteria.

Source code in server/settings/service_handlers.py
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
class CreateDailyListsModel(BaseSettingsModel):
    """Create list with AssetVersions by filter criteria."""

    _isGroup = True
    enabled: bool = True
    cycle_hour_start: str = SettingsField(
        "00:00:00",
        title="Create daily lists at",
        description="This may take affect on next day",
        widget="time",
        regex=r"(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)",
        section="Automated execution",
        scope=["studio"],
    )
    cycle_days: list[str] = SettingsField(
        title="Days of week",
        default_factory=default_week_days,
        enum_resolver=week_days,
        scope=["studio"],
    )
    lists: list[DailyListItemModel] = SettingsField(
        title="Lists",
        default_factory=list,
    )
    role_list: list[str] = SettingsField(
        section="---",
        title=ROLES_TITLE,
        default_factory=list,
    )

DailyListItemModel

Bases: BaseSettingsModel

Create list with AssetVersions by filter criteria.

Source code in server/settings/service_handlers.py
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
class DailyListItemModel(BaseSettingsModel):
    """Create list with AssetVersions by filter criteria."""

    _layout = "expanded"
    name_template: str = SettingsField("{yy}{mm}{dd}", title="Name template")
    category: str = SettingsField(
        "Dailies",
        title="List category",
        enum_resolver=lambda: ["Default", "Clients", "Dailies"],
    )
    cycle_enabled: bool = SettingsField(
        False,
        title="Run automatically",
    )
    filters: list[DailyListFilterModel] = SettingsField(
        title="Asset version filters",
        default_factory=list,
    )

FtrackServiceHandlers

Bases: BaseSettingsModel

Settings for event handlers running in ftrack service.

Source code in server/settings/service_handlers.py
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
class FtrackServiceHandlers(BaseSettingsModel):
    """Settings for event handlers running in ftrack service."""

    prepare_project: SimpleServiceAction = SettingsField(
        title="Prepare Project",
        default_factory=SimpleServiceAction,
    )
    sync_from_ftrack: SyncFromFtrackModel = SettingsField(
        title="Sync to AYON",
        default_factory=SyncFromFtrackModel,
    )
    sync_users_from_ftrack: SimpleServiceAction = SettingsField(
        title="Sync Users to AYON",
        default_factory=SimpleServiceAction,
    )
    sync_hier_entity_attributes: SyncHierarchicalAttributes = SettingsField(
        title="Sync Hierarchical and Entity Attributes",
        default_factory=SyncHierarchicalAttributes,
    )
    clone_review_session: CloneReviewAction = SettingsField(
        title="Clone Review Session",
        default_factory=CloneReviewAction,
    )
    delete_ayon_entities: SimpleServiceAction = SettingsField(
        title="Delete Folders/Products",
        default_factory=SimpleServiceAction,
    )
    thumbnail_updates: ThumbnailHierarchyUpdates = SettingsField(
        title="Update Hierarchy thumbnails",
        default_factory=ThumbnailHierarchyUpdates,
    )
    status_task_to_parent: SyncStatusTaskToParent = SettingsField(
        title="Sync status from Task to Parent",
        default_factory=SyncStatusTaskToParent,
    )
    status_task_to_version: SyncStatusTaskToVersion = SettingsField(
        title="Sync status from Task to Version",
        default_factory=SyncStatusTaskToVersion,
    )
    status_version_to_task: SyncStatusVersionToTask = SettingsField(
        title="Sync status from Version to Task",
        default_factory=SyncStatusVersionToTask,
    )
    next_task_update: NextTaskUpdate = SettingsField(
        title="Update status on next task",
        default_factory=NextTaskUpdate,
    )
    transfer_values_of_hierarchical_attributes: TransferHierNonHierAttrsAction = SettingsField(
        title="Action to transfer hierarchical attribute values",
        default_factory=TransferHierNonHierAttrsAction,
    )
    # create_daily_review_session: CreateDailyReviewSession = SettingsField(
    #     title="Create daily review session",
    #     default_factory=CreateDailyReviewSession,
    # )
    create_daily_lists: CreateDailyListsModel = SettingsField(
        title="Create daily lists",
        default_factory=CreateDailyListsModel,
    )
    project_components_sizes: ComponentsSizeCalcModel = SettingsField(
        title="Calculate project component sizes",
        default_factory=ComponentsSizeCalcModel,
    )

NextTaskUpdate

Bases: BaseSettingsModel

Source code in server/settings/service_handlers.py
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
class NextTaskUpdate(BaseSettingsModel):
    _isGroup = True
    enabled: bool = True
    mapping: list[NextTaskStatusMapping] = SettingsField(
        title="Status Mappings",
        default_factory=list,
    )
    ignored_statuses: list[str] = SettingsField(
        title="Ignored statuses",
        default_factory=list,
    )
    name_sorting: bool = True

    @validator("mapping")
    def ensure_unique_names(cls, value):
        """Ensure name fields within the lists have unique names."""

        ensure_unique_names(value)
        return value

ensure_unique_names(value)

Ensure name fields within the lists have unique names.

Source code in server/settings/service_handlers.py
216
217
218
219
220
221
@validator("mapping")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""

    ensure_unique_names(value)
    return value

SyncStatusTaskToVersion

Bases: BaseSettingsModel

Source code in server/settings/service_handlers.py
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
class SyncStatusTaskToVersion(BaseSettingsModel):
    _isGroup = True
    enabled: bool = True
    mapping: list[DictWithStrList] = SettingsField(
        title="Status mapping",
        default_factory=list,
    )
    asset_types_filter_type: str = SettingsField(
        title="Asset types Allow/Deny",
        default="allow_list",
        enum_resolver=_allow_deny_enum,
    )
    asset_types: list[str] = SettingsField(
        title="Asset types (short)",
        default_factory=list,
    )

    @validator("mapping")
    def ensure_unique_names(cls, value):
        """Ensure name fields within the lists have unique names."""

        ensure_unique_names(value)
        return value

ensure_unique_names(value)

Ensure name fields within the lists have unique names.

Source code in server/settings/service_handlers.py
164
165
166
167
168
169
@validator("mapping")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""

    ensure_unique_names(value)
    return value

SyncStatusVersionToTask

Bases: BaseSettingsModel

Source code in server/settings/service_handlers.py
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
class SyncStatusVersionToTask(BaseSettingsModel):
    _isGroup = True
    enabled: bool = True
    mapping: list[DictWithStrList] = SettingsField(
        title="Status mapping",
        default_factory=list,
    )
    asset_types_filter_type: str = SettingsField(
        title="Asset types Allow/Deny",
        default="deny_list",
        enum_resolver=_allow_deny_enum,
    )
    asset_types: list[str] = SettingsField(
        title="Asset types (short)",
        default_factory=list,
    )

    @validator("mapping")
    def ensure_unique_names(cls, value):
        """Ensure name fields within the lists have unique names."""

        ensure_unique_names(value)
        return value

ensure_unique_names(value)

Ensure name fields within the lists have unique names.

Source code in server/settings/service_handlers.py
189
190
191
192
193
194
@validator("mapping")
def ensure_unique_names(cls, value):
    """Ensure name fields within the lists have unique names."""

    ensure_unique_names(value)
    return value

ThumbnailHierarchyUpdates

Bases: BaseSettingsModel

Push thumbnail from version, up through multiple hierarchy levels.

Source code in server/settings/service_handlers.py
104
105
106
107
108
class ThumbnailHierarchyUpdates(BaseSettingsModel):
    """Push thumbnail from version, up through multiple hierarchy levels."""

    enabled: bool = True
    levels: int = SettingsField(1, title="Levels", ge=0)