Adobe RoboHelp Server is a server-based Help solution that provides real-time end-user feedback on
your Help and knowledgebase. RoboHelp Server gathers and logs data about what questions users ask
while searching content and how users navigate through topics. Results are displayed in an easy-to-view
graphical format for quick interpretation. Your Help system resides on a server (for example, Adobe Help
Resource Center), and you can make instant updates to your Help system content.
RoboHelp Server contains the back-end processes, database functionality, and JDBC connections necessary to integrate it. RoboHelp Server works with the authoring tool, so authors can edit content, set
master project options, maintain windows, and view reports.
RoboHelp Server interaction with different components
NOTE: With RoboHelp Server, you can install your database server on a separate machine or use any of
the existing database servers.
RoboHelp Server features
Tracking and reporting
Adobe RoboHelp Server provides end users with the ability to find information when they have questions. Users can view content using any standard browser and operating system. Any number of users
can access the published documents.
NOTE: You can define the maximum number of database connections for Oracle and Microsoft SQL Server
database management systems through the maxload property in the robohelp_server.properties file.
RoboHelp Server tracks the following types of data:
1
CHAPTER 1GETTINGSTARTED
•Where users request assistance: Identifies the location where users make repeated requests for
specific information.
•How users search: Searches that users perform repeatedly. This data can be mined to move
frequently searched information to a more prominent position in the content for easier access. You
can also use this information to find information gaps and to improve heading titles for more intuitive navigation.
•How users navigate online content: Tracks how users seek information in online content and how
frequently they access particular information such as headings and articles. This information is
available at a topic level.
•RoboHelp Server tracks the entire operating system and browser details. You can use this information to improve the content quality for browsers preferred by users.
RESOURCES
Automatic project merging
Concurrently work on multiple projects and merge them into a single project at run time.
While building an online information system, authors can develop and publish their content according to
their own schedules. RoboHelp Server provides automatic project merging, so authors can work on
different parts of a project at the same time, and publish them to the same server. When end users view
the content, they see one seamless online information system. Do not worry about sharing source or
depending on a single author or project—all the separate projects are merged when users access the
content. Users can navigate across all the projects using the Index, Contents, and Search buttons.
By default, projects are added to the Table of Contents in the order they are published to the server. You
can customize this order in the Projects page of the Web Admin interface. When you merge projects,
each project file in the authoring tool remains intact, but the keywords from the indexes and glossary
terms are combined at run time, or when end users access the system from the server.
Support for languages other than English
The runtime interface (including Table of Contents, index, glossary, and search) can be automatically
localized, and authors can publish projects written in various languages to the same server. RoboHelp
Server supports localization for French, German and Japanese languages. You can change the display text
on the user interface of the online system to another language, including text on the Contents, Index,
and Search buttons.
In addition, end users can perform a full-text search of online content in their native language. This flexibility allows authors to develop content in languages other than English and take advantage of
server-based online information systems.
Resources
Before you begin working with your software, take a few moments to read an overview of activation and
the many resources available to you. You have access to instructional videos, plug-ins, templates, user
communities, seminars, tutorials, RSS feeds, and much more.
2
CHAPTER 1GETTINGSTARTED
ACTIVATION
Activation
To review complete system requirements and recommendations for your Adobe RoboHelp Server 10
software, see System requirements section in this document.
Help with installation
For help with installation issues, contact Adobe Support.
Register
Register your product to receive complimentary installation support, notifications of updates, and other
services.
NOTE: Register only once for RoboHelp Server 10.
To register, follow the on-screen instructions in the Registration dialog box, which appears after you
install the software.
Help and support
Community Help
Community Help is an integrated environment on Adobe.com that gives you access to community-generated content moderated by Adobe and industry experts. Comments from users help guide you to an
answer. Search Community Help to find the best content on the Web about Adobe products and technologies, including these resources:
•Videos, tutorials, tips and techniques, blogs, articles, and examples for designers and developers.
•Complete online Help, which is updated regularly and is more complete than the Help delivered
with your product. If you are connected to the Internet when you access Help, you automatically
see the latest online Help rather than the set delivered with your product.
•All other content on Adobe.com, including knowledgebase articles, downloads and updates, Adobe
Developer Connection, and more.
Use the Help search field in your product’s user interface to access Community Help. You can search for
content within the Adobe.com site and also in websites that have useful information about your product.
Moderators continue to identify most relevant Web content for your product. You can add comments to
online Help and view comments added by other users. For a video of Community Help, see Adobe
Community help page.
Other resources
Adobe RoboHelp Server Support page also includes a link to the complete, updated PDF version of Help.
3
HAPTER 1GETTINGSTARTED
C
WHAT’SNEWIN ADOBE ROBOHELP SERVER 10
Visit the Adobe Support website at www.adobe.com/support to learn about free and paid technical
support options.
What’s new in Adobe RoboHelp Server 10
Publishing enhancements
RoboHelp Server supports Responsive HTML5 output published from both RoboHelp (2017 release) and
FrameMaker (2017 release). Along with WebHelp Pro and FlashHelp Pro, you can also publish Responsive
HTML5 output on RoboHelp Server and perform tracking, reporting, and project merging for various projects.
NOTE: If you are using 2015 version of RoboHelp and FrameMaker, then this feature is available with
update 3 or later of RoboHelp (2015 release) and update 3.1 or later of FrameMaker (2015 release).
Enhanced database support
RoboHelp Server supports Apache Derby version 10.7.1 as its default database. You don't have to install
Apache Derby manually, as RoboHelp Server's installer installs Apache Derby on your system.
Technical enhancements
•Support for JDBC Connectivity - RoboHelp Server uses a database to store usage reports, users and
group information, and Air Help comments. Database connection architecture has been enhanced
in RoboHelp Server to support external databases using JDBC connectivity.
•LDAP sub-container lookup - RoboHelp Server supports integration with LDAP server which enables
users to login to RoboHelp Server using their LDAP credentials. To integrate RoboHelp Server with
LDAP, administrator has to provide base search node for users or groups in the LDAP tree. Till RoboHelp Server 9, only the users or groups which were directly under the specified nodes, could be
authenticated from RoboHelp Server. Starting from RoboHelp Server 10, all users or groups which
are in different sub-nodes within the base node can also be authenticated.
•Data Migration from RoboHelp Server 9 - RoboHelp Server 10 supports migration of content from
RoboHelp Server 9. Migrating an older version of Microsoft SQL or Oracle server database will
require the user to enter JDBC details for that server. In case you are migrating data from MS
Access, then you must have MS Access Runtime installed on the destination machine (where RoboHelp Server 10 is installed). For more information see Migrate context data.
Reporting enhancements
RoboHelp Server 10 delivers new and enhanced reports that will help you better optimize the value of
your Help content:
•New Dynamic filter tag usage report
4
CHAPTER 1GETTINGSTARTED
NOTE: To know more about Dynamic filters, see “Generate dynamic content output” section in the
Generating Output chapter of the RoboHelp user Guide.
•Enhanced browser report
•Enhanced operating system report
•Enhanced Topic, search, and page visit reports for HTML5
SYSTEMREQUIREMENTS
Configuration Manager enhancements
You can now perform the following additional tasks using the RoboHelp Server Configuration Manager:
•Migrate context data from RoboHelp Server 9 to RoboHelp Server 10
•Define JDBC and database settings
•Import RoboHelp Server 10 setup for any given context using the new Import Settings feature
Search-related enhancements
Enhanced server-side search indexing is provided in RoboHelp Server 10. In RoboHelp Server Web
Administrator, if the option for merging same type of projects is selected in the Projects tab, then the
search items will appear aligned as per the projects. The search is now faster and more intuitive.
System requirements
Hardware requirements
•Intel Pentium 4 or faster processor
•1 GB of RAM (2 GB is recommended)
•6 GB of available hard-disk space; additional free hard-disk space may be required during installation
NOTE: RoboHelp Server installation is not supported on flash storage devices.
Supported operating systems
Adobe RoboHelp Server 10 is supported on the following 64-bit architecture of the Microsoft Windows
operating system:
•Windows Server 2012 R2
•Windows Server 2008 R2
•Windows 10
5
CHAPTER 1GETTINGSTARTED
SYSTEMREQUIREMENTS
Prerequisites for installing RoboHelp Server 10
•JRE 7 u51 or later
•Apache Tomcat 8.0.32 (64-bit) or later
NOTE: RoboHelp Server requires Apache Tomcat to run. Tomcat is a servlet container that can also
work as a Web server.
•JDBC Drivers (for external database)
NOTE: The .jar files given below are just recommendations.
Oracle12c driver jar fileojdbc7.jar
Oracle11g R2 driver jar fileojdbc6.jar
Microsoft SQL 2008/2012/2014sqljdbc41.jar (Version 4.1)
Supported browsers
•Microsoft Internet Explorer 11 and 10
•Microsoft Edge 20 or later
•Mozilla Firefox 44 or later
•Google Chrome 48 or later
Supported Web servers
You can configure Tomcat with an external Web server. Using an external Web server offers ease and
flexibility while configuring settings, such as proxy server and filtering rules. RoboHelp Server supports
the following Web servers in combination with Tomcat:
•Apache HTTP Server 2.4 and 2.2
•Microsoft IIS 8.5 and 8.0
Supported database management systems
You can use the built-in Apache Derby database or select an external database to store reports and
authentication information for RoboHelp Server. The following external database management systems
are supported:
•Oracle 12c and 11g R2
•Microsoft SQL Server 2014 Express Edition
•Microsoft SQL Server 2014, 2012, and 2008 R2
Supported databases
RoboHelp Server connects to Apache Derby, Oracle (12c and 11g R2), Microsoft SQL Server, or Microsoft
SQL Server Express Edition database management systems.
6
CHAPTER 1GETTINGSTARTED
SYSTEMREQUIREMENTS
Apache Derby
It is an open source relational database created in Java. A full-fledged Derby system consists of a
system directory, zero or more databases, and a system-wide configuration. For RoboHelp Server,
the Derby system directory is set as <RHS-Install-Path>\database.
Microsoft SQL Server
Microsoft SQL Server is a relational database management system capable of handling large
amounts of data and many concurrent users. When a client application requests data, the server
retrieves or updates the data. Microsoft SQL Server can roll back transactions. It does not commit
a partially entered record to the database.
Oracle
The Oracle database management system provides for the definition, storage, and management of
data in a centralized area. It supports client-server environments, large databases, space management, concurrent database users, high transaction-processing performance, openness, compliance
with industry standards, manageable security, portability, compatibility, and connectivity.
Microsoft SQL Server Express Edition
Microsoft SQL Server Express Edition is a relational database management system (RDBMS)
produced by Microsoft. Its primary query languages are MS-SQL and T-SQL.
Install a database management system
To install a supported database management system, refer to the relevant documentation given below:
DBMS64-bit installation instructions
Oracle 12cOracle documentation
Oracle 11g R2Oracle documentation
Microsoft SQL Server 2014
Microsoft documentation
Express Edition
Microsoft SQL Server 2014Microsoft documentation
Microsoft SQL Server 2012Microsoft documentation
Microsoft SQL Server 2008 R2Microsoft documentation
Apache Derby 10.7.1Apache Derby documentation (built-in for RoboHelp Server
10)
7
CHAPTER 1GETTINGSTARTED
INSTALLATION
Installation
Installation overview
Installing RoboHelp Server involves the following steps:
1)Close any other Adobe application running on your computer.
2)Uninstall any previous version of RoboHelp Server installed on your computer.
You cannot install RoboHelp Server 9 and RoboHelp Server 10 together on the same system. There‐
fore, uninstall RoboHelp Server 9 before installing RoboHelp Server 10. However, if you want to mi‐
grate data from RoboHelp Server 9 to RoboHelp Server 10, ensure that you back up the following
files available in the [RHS-installation-directory]\web-inf folder before uninstalling
RoboHelp Server 9:
3)Install JRE 7 u51. For more information, see Java SE documentation.
4)Install Tomcat 8.0.32 as a Windows service. Download the 64-bit Windows Service Installer from
the ApacheTomcat page. Run the installer and follow the on-screen instructions to complete the
installation.
5)To verify that the Tomcat server is running, open the Tomcat home page in a browser window. To
do so, enter http://<server-name>:<port-number> in the address bar of the browser
window.
NOTE: By default, Tomcat installs on port 8080. On your local machine the server name will be local-
host.
If you see the Tomcat home page, it confirms successful installation of Tomcat. To resolve any in‐
stallation and configuration issues, visit Apache Tomcat website. Consider the following points to
configure Tomcat:
–If necessary, in <tomcat-install-folder>\conf\server.xml, change the port
number to a desired port number.
–Change the minimum heap space allotted to the Java Virtual Machine (JVM):
a)Run the .exe file given at
6)<tomcat-install-folder>\bin\tomcat8w.exe
a)On the Java tab in the Apache Tomcat Properties dialog, specify 256 as the value for the Initial
Memory Pool and Maximum Memory Pool.
b)Re-start Tomcat service.
7)(Optional) Install a supported database system. Apache Derby is the default database that is in-built
in the RoboHelp Server 10 package. To work with other supported databases, see Supported data‐
base management systems.
8
CHAPTER 1GETTINGSTARTED
INSTALLATION
8)Install RoboHelp Server 10. You can download the installers from Adobe RoboHelp Server 10 page.
During installation, you can either enter the license number to install the licensed version of the
product, or install the trial version for 30 days.
9)Once the installation is complete, start the RoboHelp Server Configuration Manager (Start > All
Programs > Adobe RoboHelp Server 10 > Configuration Manager). If prompted, select the
server.xml file for the Tomcat servlet container (RoboHelp Server supports Tomcat 8.0.32)
installed on your system.
Configure RoboHelp Server
1)Start Tomcat service by performing any one of the following steps:
–At the Run prompt, enter services.msc. From the Windows services dialog box, start the
Tomcat service.
–Double-click the Apache Tomcat icon from the status bar and click Start in the Apache Tomcat
Properties dialog box.
–Open the <tomcat-install-folder>\bin folder and double-click tomcat8w.exe to
start Tomcat.
2)Start the RoboHelp Server Configuration Manager (Start > All Programs > Adobe RoboHelp Server
10 > Configuration Manager). If prompted, select the server.xml file for the Tomcat servlet
container installed on your system.
3)Click File > New Context to create a new context in Configuration Manager. Once the context is
created, you see a success message, “New context has been successfully created”. For more information, see Create contexts or multiple websites.
4)Configure the database or select the option to use the built-in database. See Configure a database
for more information.
5)Configure LDAP settings if you want to use LDAP authentication. See Specify LDAP settings for more
information.
6)Verify that RoboHelp Server is running by accessing the RoboHelp Server Web Administrator link in
the browser window. Log in to the server at:
7)http://<server-name>:<port-number>/<context-name>/admin by using the
default user ID (admin) and password (admin).
8)Using the configured server details, publish projects to RoboHelp Server from RoboHelp or
FrameMaker.
NOTE: Using the Configuration Manager is the recommended way of changing the default user ID
and password. However, you can also change the default credentials by editing the
robohelp_server.properties file in the <server-install-folder>\WEB-INF folder.
To do so, change the DefAdminUid and DefAdminPwd properties in this file and restart Tomcat.
NOTE: As an administrator, you can create users and assign them various rights (Publishing, Report
viewing, and Admin rights) for the server.
9)To view projects, open the browser and type the project URL in the address bar. For Example: