Macromedia RoboHelp Server - 8.0 Instruction Manual

Using

ADOBE® ROBOHELP SERVER 8

If this guide is distributed with software that includes an end-user agreement, this guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an enduser license agreement.

The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide.

Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law. The unauthorized incorporation of such material into your new work could be a violation of the rights of the copyright owner. Please be sure to obtain any permission required from the copyright owner.

Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual organization.

Adobe, the Adobe logo, FlashHelp, and RoboHelp are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.

Microsoft is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries. All other trademarks are the property of their respective owners.

This work is licensed under the Creative Commons Attribution Non-Commercial 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/3.0/us/

Portions of this product utilize technology created by Gilles Vollant.

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/).

This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).

This product includes software developed by The Independent JPEG Group.

This product contains either BSAFE and/or TIPEM software by RSA Data Security, Inc.

Portions utilize RSA Data Security, Inc. MD5 Message-Digest Algorithm.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.

Notice to U.S. government end users. The software and documentation are ”Commercial Items,” as that term is defined at 48 C.F.R. §2.101, consisting of ”Commercial Computer Software” and ”Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. Unpublished rights reserved under the copyright laws of the United States. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.

Chapter 1: Getting started

Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Help and support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Deploying Adobe RoboHelp Server on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

About RoboHelp Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Top new features of Adobe RoboHelp Server 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 2: Managing the server

About the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Configuration Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Web Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Index ................................................................................................................ 22

iii

Chapter 1: Getting started

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.

Activation

To review complete system requirements and recommendations for your Adobe® RoboHelp® Server 8 software, see the ReadMe file on the installation disc.

Help with installation

For help with installation issues, see the Installation Support Center at www.adobe.com/support/robohelp/.

Register

Note: Register only once for RoboHelp Server 8.

❖ To register, follow the onscreen instructions in the Registration dialog box, which appears after you install the

software.

ReadMe

A ReadMe file for your software is available online and on the installation disc. Open the file to read important information about topics such as the following:

• System requirements

• Installation (including removing the software)

• Activation and registration

• Font installation

• Troubleshooting

• Customer support

• Legal notices

USING ROBOHELP SERVER 8

Getting started

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

www.adobe.com/go/learn_community_help_en.

Other resources

Online Help also includes a link to the complete, updated PDF version of Help.

Visit the Adobe Support website at www.adobe.com/support to learn about free and paid technical support options.

Installation

Pre-requisites for installing RoboHelp Server 8

• Java™ Runtime Environment (JRE) 1.5 or later

• Tomcat 6.0.14 or later

RoboHelp Server 8 needs a Java Servlet container (Tomcat) and a Web server to run. Tomcat is a Servlet container and can work as a Web server too—you can use RoboHelp Server with Tomcat alone. However, RoboHelp Server 8 supports the following two combinations of Web servers:

• Apache 2.2 or later and Tomcat

• Microsoft® IIS 6.0 or 7.0 and Tomcat

Installation requirements

To review complete system requirements and recommendations for your Adobe® RoboHelp® Server software, see the ReadMe file on the installation disc.

Supported browsers

• For Microsoft® Windows® operating systems, the supported browsers are Microsoft Internet Explorer 6.0 and 7.0,

and Firefox 3.0.

• For Macintosh® operating systems, the supported browsers are Firefox 3.0 and Safari 3.0.

• For Linux® or UNIX® operating systems, the supported browser is Firefox 3.0.

USING ROBOHELP SERVER 8

Getting started

Install the software

1 Close any other Adobe applications open on your computer.

2 Insert the installation disc into your hard drive, and follow the onscreen instructions.

Note: For more information, see the ReadMe file on the installation disc.

Deploying Adobe RoboHelp Server on Windows

Deploying RoboHelp Server on the Microsoft Windows operating system involves steps such as configuring Tomcat and RoboHelp Server 8. You have the option of configuring RoboHelp Server with an Apache and Tomcat combination.

Configure Tomcat and RoboHelp Server 8

1 Install JRE (1.5 or later).

2 Install and configure Tomcat 6.0.14 or later. For more information on Tomcat installation, see “Install Tomcat” on

page 4.

3 Do one of the following:

• Double-click the Apache Tomcat icon from the status bar and click Start in the Apache Tomcat Properties

dialog box. The Tomcat service starts running.

• At the Run prompt, enter services.msc. From the Windows services dialog box, you can start, stop, or restart

the Tomcat 6.0 service.

• Open the <tomcat-install-dir>/bin folder and double-click tomcat6w.exe to start Tomcat. You can start, stop,

or restart from the Tomcat Configuration dialog box.

4 To verify that the Tomcat server is running, open the Tomcat home page in the browser window. Enter

http://<server-name>:<port-num> in the address bar of the browser window.

Note: By default, Tomcat installs on port 8080.

If you see the Tomcat home page, Tomcat is running. To resolve any issues, you can view the Tomcat logs at <tomcat-install-dir>/logs.

5 Configure the database using the Configuration Manager, or select the option to use the built-in database. See

“Configuring databases” on page 4.

6 Verify that RoboHelp 8 Server is running by opening the admin link in the browser window. Log in to the server at

http://<servername:port>/robohelp/admin using the default user ID and password.

7 Using the default user ID admin and the default password admin, publish projects to RoboHelp Server from

RoboHelp.

Note: To change the default user ID and password, change the DefAdminUid and DefAdminPwd properties in the robohelp_server.properties file in <server-install-folder>/WEB-INF and restart the Apache Tomcat server. As an administrator, you can create users and assign them various rights (Publishing, Report viewing, and Admin rights) for the server.

8 To view projects, open the browser and type in the address bar:

http://<machine-name>:<portname>/robohelp/server?prj=<projectname>

USING ROBOHELP SERVER 8

Getting started

Install Tomcat

1 Download the Windows service installer apache-tomcat-6.0.14.exe from http://tomcat.apache.org/download-

60.cgi.

2 Run the Windows service installer.

3 In <tomcat-install-folder>\conf\server.xml, change the port number to a suitable port number.

Note: By default, Tomcat installs on port 8080.

4 Change the minimum heap space allotted to Java Virtual Machine (JVM) for Tomcat. Run the <tomcat-install-

dir>/bin/tomcat6w.exe file. Specify value = 256 in the Initial Memory Pool and Maximum Memory Pool boxes in the Java tab of the Tomcat properties dialog box.

Configuring databases

In the Configuration Manager, select a database to store the reports and authentication information. RoboHelp Server supports the following databases:

• Oracle 9i, 10 g, 11 g

• SQL Server 2005 Express Edition

• SQL Server 2005 and 2008

• Microsoft Access 2007 and 2003

To use Oracle 9i or a SQL database, create a system DSN:

1 Click ODBC Admin.

2 Create a system DSN.

3 Specify a user name and password to connect to the DSN.

Note: To use integrated Windows to connect to the DSN, you do not specify the user name and password.

4 Click Test Connection.

5 Click Save.

Publish from RoboHelp HTML 7

1 Run the latest version of RoboHelp HTML 7. If you do not have this version, apply earlier patches for RoboHelp

HTML 7. For more information on patches for RoboHelp HTML 7, see

http://www.adobe.com/go/learn_rhs_RoboHelp_7_patch.

2 Go to the server tab of the properties dialog box of the WebHelpPro or FlashHelp® Pro layout.

3 Create a server and specify the server name as <machine-url:port>/robohelp/server.

4 Enter the default user name and password (admin, admin).

5 Click OK to save the settings and generate the layout to publish to the server.

RoboHelp HTML 7 projects are published to the default area of RoboHelp Server 8.

Publish from RoboHelp HTML 8

1 Do one of the following:

• Double-click the WebHelp Pro or FlashHelp Pro layout in the Single Source Layouts pod.

USING ROBOHELP SERVER 8

Getting started

• Right-click the WebHelp Pro or FlashHelp Pro layout in the Single Source Layouts pod and select Properties.

2 In the WebHelp Pro Publish dialog box, click Next to go to the server selection screen. Click New to create a

RoboHelp server destination to publish projects.

3 To publish to the default context, enter the server name in the machine-url:port format. RoboHelp HTML appends

/robohelp/server to it.

4 To publish to a context other than robohelp, specify a complete URL in the format <server-name>:port/<context-

name>/server. For more information on creating contexts, see

5 Click the Refresh button to refresh the list of areas from the server. If you do not select an area, the project is

published at the default area. For more information on areas, see

“Creating contexts or multiple websites” on page 12.

“Managing areas” on page 17.

Install and configure Apache and Tomcat

Install Apache

1 Download the Windows binary distribution (.msi file) from http://www.devlib.org/apache/httpd/binaries/win32/.

2 Run the MSI file downloaded.

3 (Only if some other server is using port 80) In <apache httpd install>\conf\httpd.conf file, change the port on which

Apache listens for requests. Search for the directive this directive to

<new-port-num>.

Listen in the conf file and change the port number by changing

Download sample workers.properties

Download sample workers.properties from http://cwiki.apache.org/GMOxDOC12/configure-apache-httpd-with-

jakarta-tomcat-connector-modjk.data/workers.properties, place it in the folder <apache httpd install>\conf, and

modify it for the Apache HTTPD and Tomcat on that machine. Modify the following variables:

• workers.tomcat_home: Set to the Tomcat installation directory.

• workers.java_home: Set to the JRE path.

Download the mod_jk module

1 Download the mod_jk module for Apache from http://tomcat.apache.org/download-connectors.cgi. This module

exists as mod_jk-apache-2.2.4.so.

2 Place the module in the folder <apache httpd install>\module\.

Modify the <apache httpd install>\conf\httpd.conf file

Modify the <apache httpd install>\conf\httpd.conf file to add the mod_jk module as follows:

LoadModule jk_module modules/mod_jk-apache-2.2.4.so

Enable Apache auto-configure

1 In the server.xml for Tomcat (<tomcat install>\conf\server.xml), enable Apache auto-configure. Tomcat

automatically generates the files required for using mod_jk with an Apache HTTPS Web server.

+ 18 hidden pages

Macromedia RoboHelp Server - 8.0 Instruction Manual

Contents

Chapter 1: Getting started

Resources

Activation

Help with installation

Register

ReadMe

Help and support

Community Help

Other resources

Installation

Deploying Adobe RoboHelp Server on Windows

Configure Tomcat and RoboHelp Server 8

Install Tomcat

Configuring databases

Publish from RoboHelp HTML 7

Publish from RoboHelp HTML 8

Install and configure Apache and Tomcat