DocumentationAEM 6.5User Guide

Integrate Adobe Experience Manager Assets with Adobe InDesign Server integrating-aem-assets-with-indesign-server

Last update: Wed Nov 08 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin

Adobe Experience Manager Assets uses:

  • A proxy to distribute the load of certain processing tasks. A proxy is an Experience Manager instance that communicates with a proxy worker to fulfil a specific task, and other Experience Manager instances to deliver the results.
  • A proxy worker to define and manage a specific task.
    These can cover a wide variety of tasks; for example, using an InDesign Server to process files.

To fully upload files to Experience Manager Assets that you have created with Adobe InDesign a proxy is used. This uses a proxy worker to communicate with the Adobe InDesign Server, where scripts are run to extract metadata and generate various renditions for Experience Manager Assets. The proxy worker enables the two-way communication between the InDesign Server and the Experience Manager instances in a cloud configuration.

NOTE
Adobe InDesign is offered as two separate offerings. Adobe InDesign desktop app that is used to design page layouts for print and digital distribution. Adobe InDesign Server enables you to programmatically create automated documents based on what you have created with InDesign. It operates as a service offering an interface to its ExtendScript engine.The scripts are written in ExtendScript, which is similar to JavaScript. For information about InDesign scripts see https://www.adobe.com/devnet/indesign/documentation.html#idscripting.

How the extraction works how-the-extraction-works

The Adobe InDesign Server can be integrated with Experience Manager Assets so that INDD files created with InDesign can be uploaded, renditions generated, all media extracted (for example, video) and stored as assets:

NOTE
Previous versions of Experience Manager were able to extract XMP and the thumbnail, now all media can be extracted.

  1. Upload your INDD file to Experience Manager Assets.

  2. A framework sends command script(s) to the InDesign Server via SOAP (Simple Object Access Protocol).
    This command script will:

    • Retrieve the INDD file.

    • Execute InDesign Server commands:

      • The structure, text and any media files are extracted.
      • PDF and JPG renditions are generated.
      • HTML and IDML renditions are generated.

    • Post the resulting files back to Experience Manager Assets.

    note note
    NOTE
    IDML is an XML-based format that renders all contents of the InDesign file. It is stored as an compressed package using ZIP compression. For more information, see InDesign Interchange Formats INX and IDML.
    note caution
    CAUTION
    If the InDesign Server is not installed or not configured, then you can still upload an INDD file into Experience Manager. However the renditions generated are limited to PNG and JPEG. You will not be able to generate HTML, .idml, or the page renditions.

  3. After the extraction and rendition generation:

    • The structure is replicated to a cq:Page (type of rendition).
    • The extracted text and files are stored in Experience Manager Assets.
    • All renditions are stored in Experience Manager Assets, in the asset itself.

Integrate the InDesign Server with Experience Manager integrating-the-indesign-server-with-aem

To integrate the InDesign Server for use with Experience Manager Assets and after configuring your proxy, you need to:

  1. Install the InDesign Server.
  2. If necessary, configure the Experience Manager Assets Workflow.
    This is only necessary if the default values are not appropriate for your instance.
  3. Configure a proxy worker for the InDesign Server.

Install the InDesign Server installing-the-indesign-server

To install and start the InDesign Server for use with Experience Manager:

  1. Download and install the InDesign Server.

  2. If necessary, you can customize the configuration of your InDesign Server instance.

  3. From the command line, start the server:

    <*ids-installation-dir*>/InDesignServer.com -port 8080

    This will start the server with the SOAP plugin listening on port 8080. All log messages and output are written directly to the command window.

    note note
    NOTE
    If you want to save the output messages to a file then use redirection; for example, under Windows:
    <ids-installation-dir>/InDesignServer.com -port 8080 > ~/temp/INDD-logfile.txt 2>&1

Configure the Experience Manager Assets workflow configuring-the-aem-assets-workflow

Experience Manager Assets has a pre-configured workflow DAM Update Asset, that has several process steps specifically for InDesign:

This workflow is setup with default values that can be adapted for your setup on the various author instances (this is a standard workflow, so further information is available under Editing a Workflow). If you are using the default values (including the SOAP port), then no configuration is needed.

After the setup, uploading InDesign files into Experience Manager Assets (by any of the usual methods) triggers the workflow to process the asset and prepare the various renditions. Test your configuration by uploading an INDD file into Experience Manager Assets to confirm that you see the different renditions created by IDS under <*your_asset*>.indd/Renditions

Media extraction media-extraction

This step controls the extraction of media from the INDD file.

To customize, you can edit Arguments tab of the Media Extraction step.

Media extraction arguments and script paths

Media extraction arguments and script paths

  • ExtendScript library: This is a simple http get/post method library, required by the other scripts.

  • Extend Scripts: You can specify different script combinations here. If you want your own scripts to be executed on the InDesign Server, save the scripts at /apps/settings/dam/indesign/scripts.

CAUTION
Do not change the ExtendScript library. This library provides the HTTP functionality required to communicate with Sling. This setting specifies the library to be send to the InDesign Server for use there.

The ThumbnailExport.jsx script run by the Media Extraction workflow step generates a thumbnail rendition in JPG format. This rendition is used by the Process Thumbnails workflow step to generate the static renditions required by Experience Manager.

You can configure the Process Thumbnails workflow step to generate static renditions at different sizes. Ensure that you do not remove the defaults, because they are required by the Experience Manager Assets interface. Finally, the Delete Image Preview Rendition workflow step removes the JPG thumbnail rendition, as it is no longer needed.

Page extraction page-extraction

This creates an Experience Manager page from the extracted elements. An extraction handler is used to extract data from a rendition (currently HTML or IDML). This data is then used to create a page using the PageBuilder.

To customize, you can edit the Arguments tab of the Page Extraction step.

chlimage_1-96

  • Page Extraction Handler: From the popup list, select the handler that you want to use. An extraction handler operates on a specific rendition, chosen by a related RenditionPicker (see the ExtractionHandler API). In a standard Experience Manager installation the following is available:

    • IDML Export Extraction Handle: Operates on the IDML rendition generated in the MediaExtract step.

  • Page Name: Specify the name you want to have assigned to the resulting page. If left blank then the name is “page” (or a derivative if “page” already exists).

  • Page Title: Specify the title you want to have assigned to the resulting page.

  • Page Root Path: The path to the root location of the resulting page. If left blank the node holding the asset’s renditions is used.

  • Page Template: The template to use when generating the resulting page.

  • Page Design: The page design to be used when generating the resulting page.

Configure the proxy worker for InDesign Server configuring-the-proxy-worker-for-indesign-server

NOTE
The worker resides on the proxy instance.

  1. In the Tools console, expand Cloud Services Configurations in the left pane. Then expand Cloud Proxy Configuration.

  2. Double-click the IDS worker to open for configuration.

  3. Click Edit to open the configuration dialog and define the required settings:

    proxy_idsworkerconfig

    • IDS Pool
      The SOAP endpoint(s) to be used for communicating with the InDesign Server. You can add, remove and order items are required.

  4. Click OK to save.

If the InDesign Server and Experience Manager are on different hosts or one or both of these applications are not working on default ports, then configure Day CQ Link Externalizer to set the host name, port, and content path for the InDesign Server.

  1. Access the Web Console at https://[aem_server]:[port]/system/console/configMgr.

  2. Locate the configuration Day CQ Link Externalizer. Click Edit to open.

  3. Link Externalizer settings help create absolute URLs for the Experience Manager deployment and for the InDesign Server. Use Domains field to specify the host name for the Adobe InDesign Server. Click Save.

    In absolute URLs, use localhost as the host name for your local (author) instance, and host name or IP address for the publish instance as shown in the following illustration.

    Link externalizer setting

Enable parallel job processing for InDesign Server enabling-parallel-job-processing-for-indesign-server

You can now enable parallel job processing for IDS. Determine the maximum number of parallel jobs (x) an InDesign Server can process:

  • On a single multiprocessor machine, the maximum number of parallel jobs (x) that an InDesign Server can process is one less than the number of processors running IDS.
  • When you are running IDS on multiple machines you need to count the total number of processors available (ie on all machines) then subtract the total number of machines.

To configure the number of parallel IDS jobs:

  1. Open the Configurations tab of the Felix Console; for example: https://[aem_server]:[port]/system/console/configMgr.

  2. Select the IDS processing queue under Apache Sling Job Queue Configuration.

  3. Set:

    • Type - Parallel
    • Maximum Parallel Jobs - <*x*> (as calculated above)

  4. Save these changes.

  5. To enable multi-session support for Adobe CS6 and later, check enable.multisession.name checkbox, under com.day.cq.dam.ids.impl.IDSJobProcessor.name configuration.

  6. Create a pool of x IDS workers by adding SOAP endpoints to the IDS Worker configuration.

    If there are multiple machines running InDesign Server, add SOAP endpoints (number of processors per machine -1) for each machine.

    note note
    NOTE
    When working with pool of workers, you can enable blocked list of IDS workers.
    To do so, enable the enable.retry.name checkbox, under the com.day.cq.dam.ids.impl.IDSJobProcessor.name configuration, which enables IDS job retrials.
    Also, under the com.day.cq.dam.ids.impl.IDSPoolImpl.name configuration, set a positive value for max.errors.to.blacklist parameter which determines number of job retrials before barring an IDS from the job handlers list.
    By default, after the configurable (retry.interval.to.whitelist.name) time in minutes the IDS worker is revalidated. If the worker is found online, it is removed from the blocked list.

Enable support for InDesign Server 10.0 or later enabling-support-for-indesign-server-or-later

For InDesign Server 10.0 or higher, perform the following steps to enable multi-session support.

  1. Open Configuration Manager from your Experience Manager Assets instance https://[aem_server]:[port]/system/console/configMgr.
  2. Edit the configuration com.day.cq.dam.ids.impl.IDSJobProcessor.name.
  3. Select the ids.cc.enable option, and click Save.
NOTE
For InDesign Server integration with Experience Manager Assets, use a multi-core processor because the session support feature necessary for the integration is not supported on single core systems.

Configure Experience Manager credentials configure-aem-credentials

You can change the default administrator credentials (user name and password) for accessing the InDesign Server from your Experience Manager deployment without breaking the integration with the InDesign Server.

  1. Go to /etc/cloudservices/proxy.html.
  2. In the dialog, specify the new user name and password.
  3. Save the credentials.
Related Articles
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2