User Guide Cancel

Publish to ServiceNow Knowledge Base

Search
Robohelp

Robohelp

Open app
  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 ServiceNow Knowledge Base.

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.

With ServiceNow integration, Adobe RoboHelp has extended its publishing capabilities to publish to Knowledge Base output, directly to ServiceNow Knowledge Base as KBs.

Pre-requisites

Before you begin to start creating knowledge bases and knowledge articles, you must set up ServiceNow Knowledge Management. For more guided set-up, follow the below steps:

  • Step-by-step instructions to configure ServiceNow Knowledge Management in your instance. For more details, see Using guided setup.
  • Create, Publish rights for ServiceNow articles (kb_knowledge table CRUD Operation rights). For more details, see Create a knowledge article.
  • To use keywords as tags, additional permissions to create and write label_entry.table and lable_entry.table_key. For more details, see Administering tags.

Set up the workflow

Following are the steps to configure ServiceNow Knowledge Base prior to publishing your output.

Create an output preset

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

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

    • Click the Output tab at the left side 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 toolbar, 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 preset type. 

    Name Specify a name for the output preset.

    Target From the target drop-down, choose ServiceNow Knowledge Base.

  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 a ServiceNow Knowledge Base output preset

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

General

Use the following options to specify basic output settings, such as title, target, output path, encoding, and more:

Title Specify the title for the generated output.

You can use variables in the title. To do so, type Ctrl+1 and select a variable from the drop-down list, and then press Enter. Note that if you have provided a variable set in the Content tab > Variable Set field, during output generation, the value of the selected variable is picked from the variable set.

Target Use the drop-down to select ServiceNow Knowledge Base to generate the chosen output.

Output Path Specify a location for the output. To select a location, click  . 

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. 

Encoding Use the drop-down list to 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 .js 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 Use the drop-down list to select a Table of Contents to be included in the output. This drop-down list displays the Tables of Contents available in your project. The first Table of Contents in this drop-down list is selected by default.

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  This option is not valid for publishing to ServiceNow Knowledge Base. 

Include Drop-down Text This option is not valid for publishing to ServiceNow Knowledge Base. 

Note:

It is important to note that ServiceNow does not permit adding JavaScript or Cascading Style Sheets (CSS) within the articles, so your publication must not use Drop-down text, Expanding text, or Thumbnail images. However if used, the text that is enclosed is preserved as plain text.

Layout

ServiceNow

Use the following options to specify ServiceNow publish settings, such as Publish Profile, RecordType, Categories, and more:

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

Knowledge Base Use this field to select the required ServiceNow Knowledge Base.

The user can configure Knowledge Bases in the ServiceNow site to store the content based on the permissions. All the articles published from this project can be published to these Knowledge Bases. 

Publish all articles in the same category Select this option to publish all the topics of the TOC to a single category and section on ServiceNow site. 

Convert all styles to inline styles Select this option to ensure that your styling used in RoboHelp is maintained when you publish your output to ServiceNow Knowledge Base.

Use search keywords from topic as article tags Use tags to filter and view tagged articles. Select this option to tag your articles with search keywords. 

ServiceNow uses article tags using your keywords. Tags can be visible to any user (global), visible only to specific groups or users (shared), or visible to a single user (private).

For example, an article about setting up the translation in multiple languages might get the following system tags applied: translation, multiple, languages, etc. When searching or browsing for an article, users may click a tag to finesse their search results.

Upload as draft Select this option to upload the topic to share it as a draft before making it available to the users.

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. 

Configure a publish profile

You must create and configure a publish profile before publishing your output to ServiceNow Knowledge Base. To create and configure a profile:

  1. Choose Edit > Publish Profiles.

    The Publish Settings dialog box opens. 

  2. Click  to create a profile.

  3. In the Server Type field, select ServiceNow Knowledge Base.

  4. For the ServiceNow Knowledge Base server type, do the following:

    • Name Shows the default profile name. Modify the name if required.
    • Site URL Add a site name to complete the site URL. 
                   For example: https://devInstance.service-now.com

  5. Click Save.

    RoboHelp saves the profile and displays the profile name under the Profiles column. To edit a profile, click the profile name and edit its fields. To delete a profile, click  against it.

Configure the TOC structure for ServiceNow Knowledge Base

The last step prior to publishing is to check that your TOC is organized to publish your content into categories and sections, keeping the following guidelines in mind:

  • The top-level of the TOC is converted to categories and second-level to sections; therefore, it is recommended to create a two-level TOC.
  • Published articles that do not fall in this structure are rearranged into categories and sections.
Two-level TOC
An illustration of how the two-level TOC looks

Publish to ServiceNow Knowledge Base

You can configure Knowledge Base output preset to link to ServiceNow, and then publish your content to ServiceNow Knowledge Base. 

  1. Click the Output tab in the standard toolbar. Output Presets is the default selection in the Output toolbar. 

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

  3. In the Output Preset editor, click the Publish tab to view the profile selected in ServiceNow tab configuration.

    You can also edit server information in the Publish Profiles dialog box, which you can launch by clicking . 

  4. Select the profiles (servers) to which you want to publish 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 ServiceNow. To view the published output, click the  icon to take you to the landing page of the ServiceNow Knowledge Base, where you can browse to your article.

  8. To view the published output, click the  icon to take you to the landing page of the ServiceNow Knowledge Base, where you can browse to your article.

 Adobe

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy