Info: Performing the steps described in this article requires direct server access. Depending upon how your system is hosted and the level of access you have to that system, coordination may be required with your Partner or WoodWing Support team. For a full overview of the steps that need to be done by WoodWing and how to request them, see WoodWing Cloud - Change management.
Note: This article is aimed at Studio Server versions 10.27 and higher. For versions 10.26 and lower, see Image preview generation in Studio Server 10.26 or lower.
With the default configuration of Studio Server, ImageMagick is used for generating image previews for the following types of images:
In this article, the process of setting up Studio Server for generating image previews for the various formats is explained. It also explains how to set up image generation for additional image formats, such as HEIC and HEIF.
Studio Server is shipped with an ‘ImageMagick Preview‘ Server plug-in that can be activated after installing ImageMagick and Ghostscript. The plug-in uses the ImageMagick and Ghostscript applications to generate previews from uploaded native files.
For some image formats (such as PDF, EPS, and Adobe Illustrator) ImageMagick invokes Ghostscript to render the preview. Both ImageMagick and Ghostscript applications are required by the ImageMagick Preview plug-in (see the Installation steps below):
- ImageMagick. Free software (under the General Public License), available for all major operating systems.
- Visit the ImageMagick Web site
- Installing ImageMagick
- Ghostscript. Copyrighted and available under several licenses.
- Visit the Ghostscript Web Site
- Installing Ghostscript
When ImageMagick does not generate previews
When a client application uploads an image to Studio Server, it may provide the preview of the image as well. In such cases Studio Server will not request ImageMagick to generate the preview.
This could happen for example when creating a new image that was locally placed on an InDesign layout page.
When Studio Server is integrated with Assets Server, the image preview is generated by Assets Server. This is regardless whether the client application provides a preview while uploading an image. The uploaded preview will be ignored and the one generated by Assets will be used instead.
Requirements for HEIC and HEIF image formats
Take note of the following requirements:
- Placing images in HEIC or HEIF format on layouts or Print articles requires InDesign 2023 or higher, or InCopy 2023 or higher.
- When using InDesign on Windows, a HEIC/HEIF codec is needed. See the Adobe documentation: Work with HEIF or HEIC files on Windows.
- Placing images in HEIC or HEIF format on Digital articles requires Assets Server integration to generate a high-resolution JPEG image that can be rendered in the editor and in the published article. Without the Assets Server integration, HEIC and HEIF images are placed and published in their own format and cannot be rendered by the web browser (showing an empty image frame).
- Some ImageMagick distributions do not support HEIC and HEIF image formats out of the box. In that case the HEIC module needs to be added. The Image Magick test on the Studio Server Health Check page will show an error when this is needed. See the Configuration steps explained below. This would require recompiling and reinstalling the ImageMagick binaries.
Step 2. Set Read & Write access rights to the Temp subdirectory of the ATTACHMENTDIRECTORY for the Web Server user:
- Windows: “IUSR_<servername>”
- Linux: “nobody”
Note: The ATTACHMENTDIRECTORY is specified in the config.php file (recommended: config_overrule.php file).
Step 3. Ensure that the Web Server user has execute access for the ImageMagick and Ghostscript executables ("convert" and "gs").
Step 4. Install the ImageMagick Preview Studio Server plug-in. (See About the ImageMagick Preview Server plug-in.)
In this step, the file formats are configured for which ImageMagick needs to generate previews.
Step 1. (Optional) Apart from the pre-configured image formats, you can have ImageMagick generate previews for additional image formats by doing the following:
Step 1a. In the configserver.php file (or preferably the config_overrule.php file), locate the EXTENSIONMAP option and make sure that the file format for which you want ImageMagick to generate the preview for is listed.
Step 1b. Still in the configserver.php file (or preferably the config_overrule.php file), locate the IMAGEMAGICK_FORMATS option and add the file formats for which you want ImageMagick to generate previews. In case the option is already listed but prefixed with two slashes (//), remove those slashes to make the option active.
Step 1c. Save the file.
Step 2. On the Health Check page, run the ImageMagick test to validate the default or customized configuration.
The test will validate the image format added in the IMAGEMAGICK_FORMATS option. If any of the listed image formats are not supported by ImageMagick, the test will raise an error.
When an error is raised, do one of the following:
- Remove the reported image format from the IMAGEMAGICK_FORMATS option if you do not plan to use it for your installation. Removing this option means that previews for this image format will not be available.
- Add the reported image format module to the ImageMagick executable. This requires recompiling and reinstalling the ImageMagick binaries.
Step 3. Test the configuration by uploading an image to a Dossier in Studio. Check if the preview of the image is available by selecting the image and pressing the Spacebar.