Skip to content

creator_plugins

BatchMovieCreatorPlugin

Bases: BaseSettingsModel

Allows to publish multiple video files in one go.
Name of matching asset is parsed from file names ('asset.mov', 'asset_v001.mov', 'my_asset_to_publish.mov')

Source code in server/settings/creator_plugins.py
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class BatchMovieCreatorPlugin(BaseSettingsModel):
    """Allows to publish multiple video files in one go. <br />Name of matching
     asset is parsed from file names ('asset.mov', 'asset_v001.mov',
     'my_asset_to_publish.mov')"""

    default_variants: list[str] = SettingsField(
        title="Default variants",
        default_factory=list
    )
    default_tasks: list[str] = SettingsField(
        title="Default tasks",
        default_factory=list
    )
    extensions: list[str] = SettingsField(
        title="Extensions",
        default_factory=list
    )
    product_types: list[str] = SettingsField(
        title="Product types",
        default_factory=list
    )

ColumnConfigModel

Bases: BaseSettingsModel

Column configuration model

Source code in server/settings/creator_plugins.py
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
class ColumnConfigModel(BaseSettingsModel):
    """Column configuration model"""

    csv_delimiter: str = SettingsField(
        title="CSV delimiter",
        default=","
    )

    columns: list[ColumnItemModel] = SettingsField(
        title="Columns",
        default_factory=list
    )

    @validator("columns")
    def validate_unique_outputs(cls, value):
        ensure_unique_names(value)
        return value

ColumnItemModel

Bases: BaseSettingsModel

Allows to publish multiple video files in one go.
Name of matching asset is parsed from file names ('asset.mov', 'asset_v001.mov', 'my_asset_to_publish.mov')

Source code in server/settings/creator_plugins.py
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
class ColumnItemModel(BaseSettingsModel):
    """Allows to publish multiple video files in one go. <br />Name of matching
     asset is parsed from file names ('asset.mov', 'asset_v001.mov',
     'my_asset_to_publish.mov')"""

    _layout = "expanded"
    name: str = SettingsField(
        title="Name",
        default=""
    )

    type: str = SettingsField(
        title="Type",
        default=""
    )

    default: str = SettingsField(
        title="Default",
        default=""
    )

    required_column: bool = SettingsField(
        title="Required Column",
        default=False
    )

    validation_pattern: str = SettingsField(
        title="Validation Regex Pattern",
        default="^(.*)$"
    )

FolderCreationConfigModel

Bases: BaseSettingsModel

Allow to create folder hierarchy when non-existing.

Source code in server/settings/creator_plugins.py
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
class FolderCreationConfigModel(BaseSettingsModel):
    """Allow to create folder hierarchy when non-existing."""

    enabled: bool = SettingsField(
        title="Enabled folder creation",
        default=False,
    )
    folder_create_type: str = SettingsField(
        "Folder",
        title="Default Folder Type",
        enum_resolver=folder_types_enum,
        description=(
            "Default folder type for new folder(s) creation."),
        section="Folder Settings"
    )
    folder_type_regexes: list[FolderTypeRegexItem] = SettingsField(
        default_factory=list,
        description=(
            "Using Regex expressions to create missing folders. \nThose can be used"
            " to define which folder types are used for new folder creation"
            " depending on their names."
        )
    )
    task_create_type: str = SettingsField(
        "",
        title="Default Task Type",
        enum_resolver=task_types_enum,
        description=(
            "Default task type for new task(s) creation."),
        section="Task Settings"
    )
    task_type_regexes: list[TaskTypeRegexItem] = SettingsField(
        default_factory=list,
        description=(
            "Using Regex expressions to create missing tasks. \nThose can be used"
            " to define which task types are used for new folder+task creation"
            " depending on their names."
        )
    )

IngestCSVPluginModel

Bases: BaseSettingsModel

CSV ingest plugin.

Source code in server/settings/creator_plugins.py
260
261
262
263
264
265
266
267
268
269
270
271
class IngestCSVPluginModel(BaseSettingsModel):
    """CSV ingest plugin."""

    enabled: bool = SettingsField(
        title="Enabled",
        default=False
    )

    presets: list[IngestCSVPresetModel] = SettingsField(
        title="Presets",
        default_factory=list
    )

IngestCSVPresetModel

Bases: BaseSettingsModel

Model for CSV ingest preset.

Source code in server/settings/creator_plugins.py
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
class IngestCSVPresetModel(BaseSettingsModel):
    """Model for CSV ingest preset."""
    name: str = SettingsField(
        "Default",
        title="Name",
    )
    columns_config: ColumnConfigModel = SettingsField(
        title="Columns config",
        default_factory=ColumnConfigModel
    )

    representations_config: RepresentationConfigModel = SettingsField(
        title="Representations config",
        default_factory=RepresentationConfigModel
    )

    folder_creation_config: FolderCreationConfigModel = SettingsField(
        title="Folder creation config",
        default_factory=FolderCreationConfigModel
    )

PSDWorkfileCreatorPluginModel

Bases: BaseSettingsModel

Creates the workfile and image publish instances together.

For .psd which could be both workfile and image product base type.

Source code in server/settings/creator_plugins.py
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
class PSDWorkfileCreatorPluginModel(BaseSettingsModel):
    """Creates the workfile and image publish instances together.

    For .psd which could be both workfile and image product base type.
    """
    enabled: bool = SettingsField(
        title="Enabled",
        default=True,
    )
    default_variants: list[str] = SettingsField(
        title="Default variants",
        default_factory=list,
    )
    workfile_product_types: list[str] = SettingsField(
        title="Workfile product types",
        default_factory=list,
    )
    image_product_types: list[str] = SettingsField(
        title="Image  product types",
        default_factory=list,
    )

RepresentationConfigModel

Bases: BaseSettingsModel

Representation configuration model

Source code in server/settings/creator_plugins.py
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class RepresentationConfigModel(BaseSettingsModel):
    """Representation configuration model"""

    tags_delimiter: str = SettingsField(
        title="Tags delimiter",
        default=";"
    )

    default_tags: list[str] = SettingsField(
        title="Default tags",
        default_factory=list
    )

    representations: list[RepresentationItemModel] = SettingsField(
        title="Representations",
        default_factory=list
    )

    @validator("representations")
    def validate_unique_outputs(cls, value):
        ensure_unique_names(value)
        return value

RepresentationItemModel

Bases: BaseSettingsModel

Allows to publish multiple video files in one go.

Name of matching asset is parsed from file names ('asset.mov', 'asset_v001.mov', 'my_asset_to_publish.mov')

Source code in server/settings/creator_plugins.py
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
class RepresentationItemModel(BaseSettingsModel):
    """Allows to publish multiple video files in one go.

    Name of matching asset is parsed from file names
    ('asset.mov', 'asset_v001.mov', 'my_asset_to_publish.mov')
    """

    _layout = "expanded"
    name: str = SettingsField(
        title="Name",
        default=""
    )

    extensions: list[str] = SettingsField(
        title="Extensions",
        default_factory=list
    )

    @validator("extensions")
    def validate_extension(cls, value):
        for ext in value:
            if not ext.startswith("."):
                raise BadRequestException(f"Extension must start with '.': {ext}")
        return value

TextureCreatorPluginModel

Bases: BaseSettingsModel

Texture files or UDIM sequences creator

Source code in server/settings/creator_plugins.py
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
class TextureCreatorPluginModel(BaseSettingsModel):
    """Texture files or UDIM sequences creator"""
    enabled: bool = SettingsField(
        title="Enabled",
        default=True,
    )
    default_variants: list[str] = SettingsField(
        title="Default variants",
        default_factory=list
    )
    extensions: list[str] = SettingsField(
        title="Extensions",
        default_factory=list,
        description=(
            "List of file extensions that are allowed as textures."
        )
    )
    product_type_items: list[ProductTypeItemModel] = SettingsField(
        default_factory=list,
        title="Product type items",
        description=(
            "Optional list of product types that this plugin can create."
        )
    )