User Guide Cancel

Publish to Adobe Experience Manager

  1. RoboHelp User Guide
  2. Introduction
    1. Get to know RoboHelp workspace
    2. What's new in RoboHelp 2022 release
      1. What's new in Update 5
      2. What's new in Update 4
      3. What's new in Update 3
      4. What's new in Update 2
      5. What's new in Update 1
    3. Fixed Issues in RoboHelp
    4. RoboHelp System Requirements
    5. Download RoboHelp on Windows and macOS
    6. Download and install Adobe app
    7. RoboHelp FAQs
    8. What's new in RoboHelp 2020 release
      1. What's new in Update 8
      2. What's new in Update 7
      3. What's new in Update 6
      4. What's new in Update 5
      5. What's new in Update 4
      6. What's new in Update 3
      7. What's new in Update 2
      8. What's new in Update 1
  3. Projects
    1. Plan your RoboHelp project
    2. Create a project
    3. Manage projects
    4. Work with topics and folders
    5. Generate reports
    6. Work with context-sensitive help
    7. Manage References
    8. Set preferences in RoboHelp
  4. Collaborate with authors
    1. Collaborate using Git
    2. Collaborate using SharePoint Online
    3. Collaborate using Azure DevOps (Team Foundation Server)
  5. PDF Layout
    1. PDF templates
    2. Design a page layout
    3. Publish PDF output
    4. Work with the common content styles
    5. Components of a PDF template
    6. Support for language variables
    7. Customize PDFs
  6. Editing and formatting
    1. Format your content
    2. Create and manage cross-references
    3. Create and manage links
    4. Single-source with snippets
    5. Work with images and multimedia
    6. Create and use variables for easy updates
    7. Work with Variable Sets
    8. Use Find and Replace
    9. Auto save your content
    10. Side-by-side editing in Split View
    11. Use the Spell Check feature
    12. Create and Edit Bookmarks
    13. Insert and update fields
    14. Switch between multiple views
    15. Autonumbering in CSS
  7. Import and linking
    1. Import Markdown files into a project
    2. Import Word documents into a project
    3. Import FrameMaker documents into a project
  8. TOCs, indexes, glossaries, and citations
    1. Create and manage a Table of Contents
    2. Create and manage an index
    3. Create and manage a glossary
    4. Create and manage citations
    5. Create and manage browse sequences
    6. Work with See Also and Related Topics
  9. Conditional content
    1. What is conditional content
    2. Create and apply condition tags
    3. Configure output presets for conditional content
    4. Optimize and manage conditional content
  10. Microcontent
    1. Microcontent
  11. Review and Collaboration
    1. Review and Collaboration
  12. Translation
    1. Translating content to multiple languages
    2. Configure a translation framework for a service provider
  13. Generating output
    1. Generate output
    2. Generate Frameless output
    3. Generate Knowledge Base output
    4. Generate PDF output
    5. Generate Responsive HTML5 output
    6. Generate Word Document output
    7. Generate Content Only output
    8. Generate eBook output
    9. Generate Microsoft HTML Help output
    10. Generate Mobile App output
  14. Publish output
    1. Publish to a RoboHelp Server
    2. Publish to an FTP server, a Secure FTP server, or a File System
    3. Publish to SharePoint Online
    4. Publish to Zendesk Help Center
    5. Publish to Salesforce Knowledge Base
    6. Publish to ServiceNow Knowledge Base
    7. Publish to Zoho Knowledge Base
    8. Publish to Adobe Experience Manager
    9. Publish to Atlassian Confluence Knowledge Base
  15. Appendix
    1. Adobe RoboHelp Scripting Reference
    2. RoboHelp keyboard shortcuts

Learn how to publish your content directly to Adobe Experience Manager.

Master pages used in the PDF or Word output template have been renamed as Page Layout.

Master pages used for topic templates or for online outputs have been renamed as Topic Layouts.

For more information, see Templates in Adobe RoboHelp.

Introduction

Adobe RoboHelp extends the capabilities of its publishing feature, giving you the option to publish Knowledge Base output, directly to Adobe Experience Manager (AEM). Adobe Experience Manager is a comprehensive content management solution for building websites, mobile apps and forms. And it makes it easy to manage your marketing content and assets.

Leverage AEM’s content management capabilities to publish RoboHelp content, so that your users can consume your content at scale.

With Adobe Experience Manager integration, Adobe RoboHelp has extended its publishing capabilities to publish as Knowledge Base, directly to Adobe Experience Manager as articles.

Pre-requisites

  • You must create a site in Adobe Experience Manager first. For more information, see the AEM docs.
  • For using the publishing feature through AEM, you must have XML Documentation for Adobe Experience Manager (UUID version) deployed on your AEM instance, as it functions as an intermediary publish API. You can either purchase it from the product page or contact us at techcomm@adobe.com. To learn more about the product, you can Request for a demo

Set up the workflow

The following are the steps to configure Adobe Experience Manager before publishing your output.

Create an output preset

To create an output preset in RoboHelp, do the following:

  1. In an open project, perform one of the following:

    • Click the Output tab at the left of the Standard toolbar.
    • Click Quick Generate in the upper-right corner of the Standard toolbar and click the Edit Settings icon.

    The Output view opens.

  2. In the Output panel, click Output Presets. The Output Presets panel opens.

  3. In the Output Presets panel, click +.

  4. In the New Preset dialog box, specify the following:

    • Type: Use the drop-down list to select Knowledge Base
    • Name: Specify a name for the output preset.
  5. Click Done.

    You can access the output preset from the Output Presets panel in the Output toolbar. Alternatively, you can access the output preset in the Quick Generate dialog box of the authoring window.

Configure Adobe Experience Manager output preset

You can use the following settings to configure the output preset:

General

Title: Specify the title for the generated output.

Output Path: Specify a location for the output.

Ensure that the output path is NOT located inside the project folder. If the output path is inside the project folder, the output generation fails. Also the folder you select should NOT have any content that you need. RoboHelp deletes the contents of the folder before generating the output.

Save output path as relative to project: If enabled and you browse to the output path., the path to the output will now be a relative instead of absolute.

Language: Use the drop-down list to select the language for the output.

Encoding: From the drop-down list, select the encoding to be used for the output. Specify the type of character encoding format to be used for your content.

Post Generation Script: To run your custom script after output generation, select the script file from the drop-down list.

Content

Use the following options to specify content-related output settings, such as the settings for Table of Contents, condition expression, and variable set.

Table Of Contents: Selecting TOC shows the topics from it in the Articles tab. What ypu select in the Articles tab get generated or published. 

The set of files and their references present in the selected Table of Contents appear in the generated output.

Condition Expression: Use the drop-down list to specify the condition expression for your output. This setting allows you to easily include or exclude content depending on the desired type of output or user base. Click to edit the selected condition expression. You can also select None in the drop-down list to not specify any condition expression.

Variable Set: Use the drop-down list to specify the variable set to use in this output. In the drop-down list, you can select <Default Variable Set> to use the project's default variable set. Variable sets allow you to implement output-specific use of variables. For example, you can have different variable sets for generating output for customers and internal users.

Include Expanding Text content: Select this option to include expanding Text in your Content Only output; otherwise, only the Expanding Title goes into the output. However, the Expanding Text will be shown in the expanded form in the output.

Include Drop-down Text content: Select this option to include drop-down Text in your Content Only output; otherwise, only the Drop-down Title goes into the output. However, the Drop-down text will be displayed in the output.

Layout

Use the option to configure the appearance of your output.

AEM

Publish Profile: Use the drop-down to select among your AEM connection profile. To learn how to create a publish profile, see Configure a publish profile.

Site: From the drop-down list, select the site in your AEM instance that you want to use for publishing. If the site does not exist, you must create it first on AEM.

Category: The area in the site where you’d publish your content to.

Section Template: The template for the help article that comes from the AEM site.

Article Template: The template for the help article that comes from the AEM site.

Asset Upload Path: Browse to the location on the AEM where the assets, like images, used in the topics to be published.

Post Publishing Workflow: Choose the AEM workflow that must be used for the topics published. AEM workflows allows you to automate a series of steps that are performed on (one or more) pages and/or assets. In other words, you can perform some post-processing works on the output generated. For example, you may want to set certain properties in the output, or send an email to reviewers once the output is generated. The workflows are specific to business processes in your organization.

Remove topic heading from the article body: Enable this option if you do not want the topic header to appear in the pages that are published in AEM. Topic title is used on the published page and heading may appear as the duplicate title.

Upload images: Select this option if you want any images in topics to be included in the published output.

Upload linked documents: Select this option if you want documents like PPT, PPTX, DOC, DOCX, and PDF linked in topics to be included in the published output.

Republish all assets: Enable this option to publish all documents, images, videos, etc. again.

Articles

On the Articles tab, you can see a list of all topics that are part of the TOC that you want to publish. Select the topics that you want to publish. Expand a TOC node and choose the topics that you want to publish.

  • In Sync: Displays the count of topics that have been uploaded in AEM and are currently being synchronized.

  • Modified: Displays the count of topics that you’ve modified after uploading the topics in AEM.

  • New: Displays the count of new topics that are part of the TOC but not published in AEM.

  • Deleted: Displays the count of topics that are deleted from the TOC but are still present in AEM. Select such topics and publish them to remove from AEM.

Configure a publish profile

You must create and configure a publish profile before publishing your output to Adobe Experience Manager. To create and configure a profile:

  1. On the toolbar, click Edit > Publish Profiles.

  2. In the Server Type drop-down list field, select Adobe Experience Manager.

  3. Populate the following fields:

    • Name: This field displays the default profile name. Change the name accordingly.
    • Cloud Service: Choose this option if you are using Adobe Experience Manager as a Cloud Service and your credentials will be in a JSON file. If you do not have the credentials JSON, you can explicitly specify the credentials in the User ID and Password fields.
  4. Click Save.

    RoboHelp saves the profile and displays the profile name in the Profiles column.

    Edit a profile

    To edit a profile, click the profile name, and edit its fields.

    Delete a profile

    To delete a profile, click  near the profile.

Publish to Adobe Experience Manager

You can configure the output preset to link to Adobe Experience Manager, and then publish your content. 

  1. In the toolbar, click the Output tab. You will see a list of pre-defined output presets.

  2. In the Output Presets panel, to edit a preset, double-click an output preset. 

  3. After you've configured the preset, you can publish to Adobe Experience Manager. Click the ellipsis icon (...) near the preset and click Publish.

    You can also edit the server information after clicking Edit.

  4. Select the presets to which you want to publish the content.

  5. Click the Generate Preset icon  in the Output Presets panel. 

    You can then view a progress bar next to the selected output preset in the Output Presets panel. Once the output generation is complete, a Success dialog box is visible at the lower-right corner of the screen. 

    After the output generation is complete, click  in the Output Presets panel to view the output.

  6. To publish to the selected profiles (servers), click the output preset, and then click  in the standard toolbar. Or, right-click the output preset and click Publish.

  7. RoboHelp pushes the content to Adobe Experience Manager. After the publishing is completed, Robohelp displays a report of the published content.

  8. To view the published output, click the Articles tab. Hover on a published article, click the ellipsis icon, and then preview the article. You can also preview the article from within AEM.

Get help faster and easier

New user?