Skip to content

publish_plugins

CollectColorCodedInstancesPlugin

Bases: BaseSettingsModel

Set color for publishable layers, set its resulting product base type and template for product name. Can create flatten image from published instances. (Applicable only for remote publishing!)

Source code in server/settings/publish_plugins.py
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
class CollectColorCodedInstancesPlugin(BaseSettingsModel):
    """Set color for publishable layers, set its resulting product base type
    and template for product name. \n Can create flatten image from published
    instances.
    (Applicable only for remote publishing!)"""

    enabled: bool = SettingsField(True, title="Enabled")
    create_flatten_image: str = SettingsField(
        "",
        title="Create flatten image",
        enum_resolver=lambda: create_flatten_image_enum,
    )

    flatten_product_name_template: str = SettingsField(
        "",
        title="Product name template for flatten image"
    )

    color_code_mapping: list[ColorCodeMappings] = SettingsField(
        title="Color code mappings",
        default_factory=ColorCodeMappings,
    )

CollectReviewPlugin

Bases: BaseSettingsModel

Should review product be created

Source code in server/settings/publish_plugins.py
106
107
108
class CollectReviewPlugin(BaseSettingsModel):
    """Should review product be created"""
    enabled: bool = SettingsField(True, title="Enabled")

CollectVersionPlugin

Bases: BaseSettingsModel

Synchronize version for image and review instances by workfile version

Source code in server/settings/publish_plugins.py
111
112
113
class CollectVersionPlugin(BaseSettingsModel):
    """Synchronize version for image and review instances by workfile version"""  # noqa
    enabled: bool = SettingsField(True, title="Enabled")

ExtractImagePlugin

Bases: BaseSettingsModel

Extracts image products and representations per published instance

Source code in server/settings/publish_plugins.py
129
130
131
132
133
134
135
136
137
138
class ExtractImagePlugin(BaseSettingsModel):
    """Extracts image products and representations per published instance"""
    enabled: bool = SettingsField(True, title="Enabled")
    optional: bool = SettingsField(False, title="Optional")
    active: bool = SettingsField(True, title="Active")
    formats: list[str] = SettingsField(
        title="Extract Formats",
        default_factory=list,
        enum_resolver=lambda: extract_image_ext_enum,
    )

ExtractLayersPlugin

Bases: BaseSettingsModel

Export layers within the instance layerset to a PSD file.

Source code in server/settings/publish_plugins.py
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class ExtractLayersPlugin(BaseSettingsModel):
    """Export layers within the instance layerset to a PSD file."""
    enabled: bool = SettingsField(False, title="Enabled")
    optional: bool = SettingsField(False, title="Optional")
    active: bool = SettingsField(True, title="Active")
    merge_layersets: bool = SettingsField(
        False,
        title="Merge Layersets",
        description="Merge all layersets within the instance set.",
    )
    extension: str = SettingsField(
        "psd",
        title="Export extension",
        enum_resolver=lambda: extract_layer_ext_enum,
    )

ValidateDocumentSettingsPlugin

Bases: BaseSettingsModel

Validate document resolution, color mode and bit depth.

Source code in server/settings/publish_plugins.py
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
class ValidateDocumentSettingsPlugin(BaseSettingsModel):
    """Validate document resolution, color mode and bit depth."""
    enabled: bool = SettingsField(True, title="Enabled")
    optional: bool = SettingsField(True, title="Optional")
    active: bool = SettingsField(True, title="Active")
    expected_dpi: int = SettingsField(72, title="Expected DPI")
    expected_mode: str = SettingsField(
        "RGB",
        title="Expected Color Mode",
        enum_resolver=lambda: color_mode_enum,
    )
    expected_bits: str = SettingsField(
        "8",
        title="Expected Bit Depth",
        enum_resolver=lambda: bit_depth_enum,
    )

ValidateNamingPlugin

Bases: BaseSettingsModel

Validate naming of products and layers

Source code in server/settings/publish_plugins.py
116
117
118
119
120
121
122
123
124
125
126
class ValidateNamingPlugin(BaseSettingsModel):
    """Validate naming of products and layers"""  # noqa
    invalid_chars: str = SettingsField(
        '',
        title="Regex pattern of invalid characters"
    )

    replace_char: str = SettingsField(
        '',
        title="Replacement character"
    )

ValidateSmartObjectLinksPlugin

Bases: BaseSettingsModel

Validate that no Smart Object layers have broken or missing links.

Source code in server/settings/publish_plugins.py
165
166
167
168
169
class ValidateSmartObjectLinksPlugin(BaseSettingsModel):
    """Validate that no Smart Object layers have broken or missing links."""
    enabled: bool = SettingsField(True, title="Enabled")
    optional: bool = SettingsField(True, title="Optional")
    active: bool = SettingsField(True, title="Active")