Asset Configuration

Configure image processing settings for product assets in Omnium.

Product asset configuration is managed through tenant settings. This page covers image processing and asset organization settings.


Storage

Asset files are stored in Azure Blob Storage with optional CDN delivery. Storage configuration is managed by Omnium and does not require manual setup.

Blob storage and CDN settings are configured by Omnium as part of tenant provisioning. Contact Omnium support if you need changes to your storage configuration.


Image Settings

Configure image processing in TenantSettings.ProductSettings.

Properties

PropertyTypeDescription
ImageAspectRatiosList<AspectRatio>Preview image sizes to generate
ImageFileTypesList<FileTypeOptions>Allowed image file types with compression
IsImagesAutoResizedOnUploadboolEnable automatic preview generation
ImageMaxSizeAspectRatioMaximum image dimensions
AssetPurposeKeysList<string>Valid values for asset Purpose property

Configuration Example

{
  "ProductSettings": {
    "IsImagesAutoResizedOnUpload": true,
    "ImageMaxSize": {
      "name": "max",
      "width": 2000,
      "height": 2000
    },
    "ImageAspectRatios": [
      {
        "name": "thumbnail",
        "translateKey": "Products.ImageSize.Thumbnail",
        "width": 150,
        "height": 150,
        "isDefault": false
      },
      {
        "name": "medium",
        "translateKey": "Products.ImageSize.Medium",
        "width": 600,
        "height": 600,
        "isDefault": true
      },
      {
        "name": "large",
        "translateKey": "Products.ImageSize.Large",
        "width": 1200,
        "height": 1200,
        "isDefault": false
      }
    ],
    "ImageFileTypes": [
      {
        "fileType": "jpg",
        "isDefault": true,
        "compressionOptions": {
          "quality": 85
        }
      },
      {
        "fileType": "png",
        "isDefault": false,
        "compressionOptions": {
          "quality": 90
        }
      },
      {
        "fileType": "webp",
        "isDefault": false,
        "compressionOptions": {
          "quality": 80
        }
      }
    ],
    "AssetPurposeKeys": [
      "hero",
      "thumbnail",
      "gallery",
      "documentation",
      "lifestyle"
    ]
  }
}

AspectRatio Reference

The AspectRatio class defines image dimensions for preview generation.

PropertyTypeDescription
NamestringIdentifier for the size (used in file naming)
TranslateKeystringUI translation key
IsDefaultboolMark as default size
WidthintWidth in pixels
HeightintHeight in pixels

How Previews Are Named

When preview images are generated, they follow this naming pattern:

{original-filename}_{aspect-ratio-name}.{extension}

Example:

  • Original: product-image.jpg
  • Thumbnail: product-image_thumbnail.jpg
  • Medium: product-image_medium.jpg
  • Large: product-image_large.jpg

FileTypeOptions Reference

The FileTypeOptions class defines allowed image formats and compression.

PropertyTypeDescription
FileTypestringFile extension (e.g., jpg, png, webp)
IsDefaultboolDefault format for conversions
CompressionOptionsCompressionOptionsCompression settings

CompressionOptions

PropertyTypeDescription
QualityintCompression quality (1-100)

Storage Containers

Assets are automatically organized into containers based on their context:

ContainerUsage
productsProduct images and documents
customerCustomer attachments
projectsProject-related assets

Container assignment is handled automatically by Omnium based on the upload context.


Best Practices

Image Settings

  • Configure ImageMaxSize to prevent excessively large uploads
  • Use IsImagesAutoResizedOnUpload to ensure consistent image sizes
  • Define aspect ratios that match your frontend design requirements

Asset Purpose Keys

  • Define consistent purpose values across your catalog
  • Use purpose keys for filtering and organizing assets in the UI
  • Common values: hero, thumbnail, gallery, detail, lifestyle, documentation

Changing ImageAspectRatios after assets have been uploaded will not regenerate existing preview images. You'll need to re-upload assets or run a migration to regenerate previews.

On this page