Skip to main content

Install and configure the Typefi Connector for Adobe Experience Manager

Toni Gonzales
  • Updated

This documentation is intended for the following audiences:

  • Administrators who would install and manage the Typefi Connector for Adobe Experience Manager.
  • Content authors and editors who use Adobe Experience Manager Guides* (formerly XML Documentation for Adobe Experience Manager) and want to create InDesign layouts and PDF or other print outputs using Adobe InDesign Server.

You should also have experience working with Typefi workflows in Typefi Server.

  • Adobe Experience Manager Guides was formerly branded as XML Documentation for Adobe Experience Manager. A name change occurred on 11 May 2022. Please note certain references within the documentation may still refer to prior branding but are still applicable to the current offering.

About Adobe Experience Manager Guides

Typefi Connector for Adobe Experience Manager Guides enables you to easily integrate Adobe InDesign Server into your omnichannel publishing workflows. With Typefi’s Connector for Adobe Experience Manager Guides, go beyond the out-of-the-box PDF generation capabilities of DITA Open Toolkit, FrameMaker Publishing Server, or even the new native PDF publishing.

  • Leverage the design, layout, and typographical capabilities of Adobe InDesign for both technical and marketing communications.
  • Build sophisticated and flexible templates with InDesign that don’t compromise design consistency, support for translation services, or rapid time to market.
  • Elevate your web-to-print capabilities to improve efficiency while protecting brand integrity.

In this guide

This documentation provides instructions to download, install, and configure the Typefi and Adobe Experience Manager connector.

The information in this guide is organised as follows:

Download and install

You will need to download and install Adobe Experience Manager (on-premise or through Adobe Managed Services), Adobe Experience Manager Guides, and the Typefi and Adobe Experience Manager connector.  

Compatibility with Adobe Experience Cloud service will be evaluated for future updates.

First:

  1. Download and install Adobe Experience Manager. Follow the instructions in Adobe’s Installation and Configuration Guide (Chapter 2: Install Adobe Experience Manager).
  2. Download and install Adobe Experience Manager Guides. Follow the instructions in Adobe's Installation and Configuration Guide (Chapter 2: Download and install XML Documentation solution for the first time).
  3. Sign in to the Typefi FTP and download the Typefi Connector for Adobe Experience Manager.

Next, uninstall and delete any previous versions of the Typefi Connector (recommended):

To update the Typefi Connector, we recommend first uninstalling and deleting earlier versions. The content stored in Typefi Server and Adobe Experience Manager (AEM) won't be affected by removing earlier versions of the Typefi Connector.  * To proceed with a fresh installation, please follow the installation steps provided.

  1. Sign in to your Adobe Experience Manager instance as an administrator.
  2. Go to the CRX Package Manager. The Package Manager manages the packages on your local AEM installation. See How to Work With Packages in Adobe’s documentation for more information about working with the Package Manager.
    1. Click Adobe Experience Manager to open the Navigation page.
    2. Click the hammer icon along the left of the page to open the Tools page.
    3. Click Deployment.
    4. Click Packages to open the CRX Package Manager.
    5. Click the Package icon in the CRX Package Manager interface (the middle one along the top).
  3. Click on aem-dita.ui.content-1.1.x-SNAPSHOT.zip package details.
  4. Click More, then select Uninstall and confirm your selection. (This action does not delete the package from the Package Manager).
  5. With the package still selected, select Delete in the More drop-down menu and confirm your selection.
  6. Click on aem-dita-ui.apps-1.1.x-SNAPSHOT.zip package details and repeat steps 4-5 above.

Then, install the Typefi Connector for Adobe Experience Manager:

  1. Sign in to your Adobe Experience Manager instance as an administrator.
  2. Go to the CRX Package Manager. The Package Manager manages the packages on your local AEM installation. See How to Work With Packages in Adobe’s documentation for more information about working with the Package Manager.
  3. Install the Typefi and Adobe Experience Manager connector:
    1. Click Adobe Experience Manager to open the Navigation page.
    2. Click the hammer icon along the left of the page to open the Tools page.
    3. Click Deployment.
    4. Click Packages to open the CRX Package Manager.
    5. In the CRX Package Manager interface, click the Package icon (the middle one along the top).
    6. Click Upload Package.
    7. Upload the installer packages you downloaded from the Typefi FTP. For example, aem-dita.ui.content-2.0-SNAPSHOT.zip and aem-dita.ui.apps-2.0-SNAPSHOT.zip.
    8. After uploading the installer packages, click Install.

Configure the Typefi Connector for Adobe Experience Manager

Go to the Configuration page in your Adobe Experience Manager instance

  1. If you’re not already, sign in to your Adobe Experience Manager instance as an administrator.
  2. Click Adobe Experience Manager. The Navigation page opens.
  3. Click the hammer icon along the left of the page. The Tools page opens.
  4. Click Operations.
  5. Click Configuration. In the top left corner, click on AEM_Adobe Marketing Cloud page_button
    This will take you to the Adobe Marketing Cloud page.
  6. Then, on the bottom right side of the WCM page, click on Web Console. This will take you to the Adobe Experience Manager Web Console Configuration page.

Complete the configuration

  1. Scroll to the bottom and click Typefi Configuration. (Configurations are listed in alphabetical order).
    AEM_Typefi Configuration
  2. Complete the configuration according to the configuration table:
    Property Type Value Required
    Enable config Boolean Select to enable Yes
    Protocol Drop-down menu http / https Yes
    Server Field

    <URL hostname of Typefi Server>

    Example: aem-pub.typefi.net

    Do not include <http://> or <https://> protocol

    		 Yes
    Endpoint Field /api/v3/workflows Yes
    Username Field <Typefi worker account> Yes
    Password Field <Typefi worker password> Yes
  3. Click Save.

Apply the permissions for Adobe Experience Manager

These steps will help you set up the necessary permissions for users and groups in AEM to view and manage Typefi workflow jobs in the path: /content/typefi_jobs. Refer to the Principal View for Permissions Management page for more details about permission management.

  1. If you’re not already, sign in to your Adobe Experience Manager instance as an administrator.
  2. Click the hammer icon along the left of the page. The Tools page opens.
  3. Click on Security and open the Permissions card.
  4. Use the filter to find the users and groups you want to add or edit permissions. Clicking the name displays assigned permissions.
  5. Add Access Control Entries (ACE) by clicking the Add ACE button.

    Add Access Entries_permissions management.jpg

  1. Type /content/typefi_jobs in the Path box.
  2. Add the following privileges for /content/typefi_jobs:
    • jcr:write
    • jcr:readAccessControl
    • jcr:lockManagement
    • jcr:versionManagement
    • jcr:nodeTypeManagement
    • jcr:retentionManagement
    • jcr:lifecycleManagement
  3. Select Allow permission type.
  4. Click Add.

Verify permissions and privileges

  1. Return to Permissions.
  2. Select users or groups that need privileges to the path: /content/typefi_jobs.
  3. Verify that permissions are set to allow, and that all privileges were entered correctly. If needed, adjust by clicking the editing tool.

AEM_Access_Control_Entries_List.jpg

If you are using Adobe Experience Manager Guides, confirm that jcr:read privileges are set for paths: /,/var/dxml, and var/dxml/profiles.

Set up your Typefi workflow

  1. Sign in to your Typefi Server as an administrator.
  2. Install the Ant plug-in. See Install workflow plug-ins and actions for instructions.
  3. Create a new Typefi workflow.
  4. Add the Run Ant Buildfile action. This action must be the first action in the workflow.
  5. Leave the Input field blank (recommended). Alternatively, click the variables icon Typefi_variable_icon.pngand select the ${ask} variable. (Your input file will automatically be retrieved when you select a .dita or .ditamap file.)
    Run-ant-buildfile-for-TypefiConnector.png
  6. Set the Resources (required) to ZIP or XZIP file with DITA to CXML transformation. You must specify at least one resource in this input.
  7. Set the Parameters (required) to pass the .ditamap file path and to select the XSL transformation file from Resources. Parameters are a collection of key=value pairs separated by semicolons. These are passed to the Apache Ant buildfile: job.dir=${job-folder};entry.xsl.filename=<transform>.xsl
    Parameter Description
    job.dir=${job-folder} Sets the destination to the Typefi job folder.
    entry.xsl.filename=<transform>.xsl Sets the entry point for the XSL transform (DITA to CXML); a resources file may contain multiple transforms for different document types. This allows you to target a specific document type.
  8. Add the Create InDesign document or Create InDesign book action and the Input to ${job-folder}/content.cxml.
  9. Add other workflow actions as needed.
  10. Save your workflow.

Run a Typefi job

  1. If you're not already, sign back into your Adobe Experience Manager instance.
  2. Click Adobe Experience Manager to open the Navigation page.
  3. Click Assets.
  4. Click Files.
  5. Select a .ditamap file.
  6. Click Typefi.
    ditamap_AEM.png
  7. In the Run Typefi Job panel:
    1. Choose PDF only (default) or All files. PDF only returns only the PDF output from Typefi. Choosing All files returns three file types: the PDF, the composed InDesign document/book, and the most recent CXML used to create the INDD document.
    2. Click the Attach button next to Typefi Workflow and select a Typefi workflow to attach. Click the paperclip icon to attach a Typefi workflow

      When you attach your .ditamap file in the Run Typefi Job panel, the Typefi Connector saves your output and workflow selections by adding <othermeta> elements— as a child to the <bookmeta> elements— in the selected .ditamap file. This means that when you select a previously worked-on .ditamap file, the Typefi Connector will automatically preselect the output and workflow using the stored <othermeta> elements. Therefore, you won't need to input any additional details in the Run Typefi Job panel.

    3. Click Run. After you click Run, you will be redirected to the Jobs panel. You can view the job status while the job is running and download and view the output files once the job is complete.
  8. Click Download to save the output files to your computer, or click View to see a list of returned files.

Review the Adobe Experience Manager Web Console Log files

  1. Click the hammer icon along the left of the page to open the Tools page.
  2. Click Operations.
  3. Click Web Console.
  4. In the top navigation bar, choose Status → Log Files.

See also

Related articles

Comments

0 comments

Please sign in to leave a comment.