Asset Validation

The "Asset Validation" plugin allows to validate assets and marks them if they do not pass the validation.

Properties

To be configured in {home}/appserver/conf/custom.properties

assetValidation.license

type: String, required: yes, default: -

License key (delivered by brix IT Solutions)

assetValidation.validators

type: List of String (comma-separated), required: yes, default: -

This property takes a list of all validators that are enabled.

Validators

Every validator has its own properties. For every validator, the following properties are the same. Replace validatorName with the name of the validator specified in the section for the validator further down.

assetValidation.validatorName.nodeIdValid

type: long, required: no, default: -

If this property is set, the valid assets are collected in the configured node. This can help to find the valid assets and get an overview. Initially, all the assets can be validated and added to the node by running the "Revalidate Assets"-Task in "General"-Tab in System Tasks.

assetValidation.validatorName.nodeIdInvalid

type: long, required: no, default: -

If this property is set, the invalid assets are collected in the configured node. This can help to find the valid assets and get an overview. Initially, all the assets can be validated and added to the node by running the "Revalidate Assets"-Task in "General"-Tab in System Tasks.

assetValidation.validatorName.imagePath

type: String, required: no, default: -

This property takes a 16x16 px image which is shown on invalid assets. NOTE: to show the bullet, the validatorName needs to be added to the list of bullets in the property "guiPlugin.bullets.asset=". This property is global and may be also used by other plugins. If not, the celum bullets need to be added to the list, e.g. guiPlugin.bullets.asset=noAssetType,invalidInformationFields,unlinked,unreleased,availability,locked,duplicate,conversionStatus,fileTypeWhitelistValdiator

File Type Whitelist

This validator takes a list of allowed file extensions.

• validatorName: fileTypeWhiteList
• bulletName: fileTypeWhiteListValidator

assetValidation.fileTypeWhiteList.whitelist

type: List of String (comma-separated), required: yes, default: -

All file extensions set in this property are allowed. Assets with one of these extensions are valid.

assetValidation.fileTypeWhiteList.checkboxId

type: InformationFieldId, required: no, default: -

Sets the checkbox to true if the validation is true.

File Type Blacklist

This validator takes a list of forbidden file extensions.

• validatorName: fileTypeBlacklist
• bulletName: fileTypeBlacklistValidator

assetValidation.fileTypeBlacklist.blacklist

type: List of String (comma-separated), required: yes, default: -

All file extensions set in this property are prohibited. Assets with one of these extensions are invalid.

assetValidation.fileTypeBlacklist.checkboxId

type: InformationFieldId, required: no, default: -

Sets the checkbox to true if the validation is true.

Densitiy

This validator takes a minimum density for assets to be valid.

• validatorName: density
• bulletName: densityValidator

assetValidation.density.noDensityValid

type: Boolean, required: yes, default: false

If this property is set to true, the asset has a valid density if there is no density given on the asset.

assetValidation.density.minDensity

type: Long, required: yes, default: -

This property takes the minimum required density for an asset to be valid.

assetValidation.density.checkboxId

type: InformationFieldId, required: no, default: -

Sets the checkbox to true if the validation is true.

Image Resolution Validator

This valdiator takes a minWidth and / or minHeight in pixels an image must have.

• validatorName: imageResolution
• bulletName: imageResolutionValidator

assetValidation.imageResolution.mode

type: String, required: no, default: OR

This property can be set to 'OR' or 'AND'. 'OR': The image needs to have either minWidht or minHeight to be valid. 'AND': An image needs to have minWidth and minHeight to be valid.

assetValidation.imageResolution.minWidth

type: long, required: no, default: 0

This property takes the minWidth an image must have. Note: If the imageResolution.mode is set to OR a valid image may not have the set minWidth since the minHeigt may be reached.

assetValidation.imageResolution.minHeight

type: long, required: no, default: 0

This property takes the minHeight an image must have. Note: If the imageResolution.mode is set to OR a valid image may not have the set minHeight since the minWidth may be reached.

assetValidation.imageResolution.checkboxId

type: InformationFieldId, required: no, default: -

Sets the checkbox to true if the validation is true.

Asset Name Validator

This Validator takes a list of forbidden strings that are not allowed in the asset name.

• validatorName: assetNameValidator
• bulletName: assetNameValidator

assetValidation.assetNameValidator.notAllowed

type: List of String (comma-separated), required: yes, default: -

This property takes a list of strings that are not allowed in the asset name.

assetValidation.assetNameValidator.checkboxId

type: InformationFieldId, required: no, default: -

Sets the checkbox to true if the validation is true.

assetValidation.{duplicateValidator}.bulletTitle

type: string, required: yes, default: -

This property sets the mouseover-title on the bullet. For multilanguage-support, add your messages to appserver/lang/customMessages_xy.properties and use the key here.

Example

Using two validators, one for density and one for resolution:

guiPlugin.bullets.asset=noAssetType,invalidInformationFields,validMetadata,unlinked,unreleased,availability,locked,duplicate,conversionStatus,densityValidator,imageResolutionValidator

assetValidation.license=***
assetValidation.validators=densityValidator,imageResolutionValidator

assetValidation.density.bulletId=densityValidator
assetValidation.density.bulletTitle=assetValidation.invalidDensity
assetValidation.density.noDensityValid=false
assetValidation.density.nodeIdInvalid=26530
assetValidation.density.minDensity=300
assetValidation.density.forFileTypes=png,jpg

assetValidation.imageResolution.bulletId=imageResolutionValidator
assetValidation.imageResolution.bulletTitle=assetValidation.invalidResolution
assetValidation.imageResolution.nodeIdInvalid=26531
assetValidation.imageResolution.minWidth=1000
assetValidation.imageResolution.minHeight=1000
assetValidation.imageResolution.mode=AND
assetValidation.imageResolution.forFileTypes=png,jpg

Compatibility Matrix

Release Notes

1.0

Released 2018-06-15

Initial Version

1.1

Released 2018-06-20

Added Blacklist Filetype Validator

1.2

Released 2021-01-20

• Additional asset validators: Bit depth validator, video Codec validator, Color space validator
• Possibility to apply validators only for specific filetypes