Robohelp Server 6

ADOBE® ROBOHELP® SERVER 6GE T TING STARTED GUIDE

Getting-started.book Page i Thursday, January 11, 2007 9:57 PM

© 2006 Adobe Systems Incorporated. All rights reserved.

Adobe® RoboHelp® Server 6 Getting Started Guide for Windows® XP®, Windows 2003 Server, Windows 2000/2000 Server

If this guide is distributed with software that includes an end-user agree-ment, 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 end-user license agreement.

The content of this guide is furnished for informational use only, is sub-ject to change without notice, and should not be construed as a commit-ment 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 in-clude in your project may be protected under copyright law. The unau-thorized 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 demonstra-tion purposes only and are not intended to refer to any actual organiza-tion.

Adobe, the Adobe logo, RoboHelp, Acrobat, RoboEngine, FlashHelp, are either registered trademarks or trademarks of Adobe Systems Incorporat-ed in the United States and/or other countries.. Pentium is a trademark or registered trademark of Intel Corporation or its subsidiaries in the U.S. and other countries. Oracle, JD Edwards, PeopleSoft, and Siebel are reg-istered trademarks of Oracle Corporation and/or its affiliates. Windows, Windows XP, Access, and Internet Explorer are either a registered trade-mark or a trademark of Microsoft Corporation in the United States and/or other countries. Verity and TOPIC are registered trademarks of Autonomy. All other trademarks are the property of their respective own-ers.

Portions of Adobe Acrobat include technology used under license from Autonomy, and are copyrighted.

Getting-started.book Page ii Thursday, January 11, 2007 9:57 PM

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, con-sisting of “Commercial Computer Software” and “Commercial Comput-er 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 Com-mercial Computer Software and Commercial Computer Software Docu-mentation 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 oth-er end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright laws of the United States. Adobe Sys-tems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Exec-utive 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 incor-porated by reference.

Getting-started.book Page iii Thursday, January 11, 2007 9:57 PM

Getting-started.book Page iv Thursday, January 11, 2007 9:57 PM

vADOBE ROBOHELP SERVER 6Getting Started Guide

Contents

Getting started

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

What’s new . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Uninstalling RoboEngine 4 . . . . . . . . . . . . . . . . . 2

System requirements . . . . . . . . . . . . . . . . . . . . . . 3

Install RoboHelp Server . . . . . . . . . . . . . . . . . . . . 7

Technical support . . . . . . . . . . . . . . . . . . . . . . . . .12

Getting-started.book Page v Thursday, January 11, 2007 9:57 PM

viContents

Getting-started.book Page vi Thursday, January 11, 2007 9:57 PM

1

Getting started

IntroductionThis guide describes what’s new and updated in this release and helps you install and start the latest version of Adobe® RoboHelp® Server 6.

RoboHelp Server enables you to create, deliver, and measure struc-tured information. It integrates easily with your RoboHelp projects to give them the extra power only a server can provide. RoboHelp Server gathers and logs data about what questions users ask while searching content and how users navigate through topics. This data is then displayed as reports. You can analyze and use these reports to improve your online documentation. RoboHelp Server performs the following tasks:

Gather and store usage data RoboHelp Server stores information about how your users navigate and interact with your policies and procedures information system. This data is processed into useful reports. By using this feature, you can see where users are entering the system, what questions they are asking, and most importantly, what questions are going unanswered.

Structured content Any content you create with RoboHelp 6 is hosted and displayed to your end users with RoboHelp Server 6.

Run-time project merging Traditionally, you publish multiple WebHelp Pro Projects from RoboHelp and then merge them from Server. Now you can also publish multiple FlashHelp® Pro Projects from RoboHelp 6 and then merge them with the help of RoboHelp Server. You can merge WebHelp Pro Projects with WebHelp Pro Projects and merge FlashHelp Pro Projects with FlashHelp Pro Projects.

Getting-started.book Page 1 Thursday, January 11, 2007 9:57 PM

2Getting started

Question grouping RoboHelp Server groups similar questions in reports. This feature enables authors to read and share reports that are more accurate and streamlined. Question grouping helps solve the problem of looking at a report that contains long lists of questions that are similar but phrased in slightly different ways.

What’s newFlashHelp Pro RoboHelp Server introduces server-based FlashHelp. FlashHelp Pro projects can be published to RoboHelp Server. Server features like merging Projects, and context-sensitive help are also available in FlashHelp Pro Projects.

Improved publishing of projects While publishing projects to RoboHelp Server, only the files that have been modified after the last publish operation are republished. As a result, performance is signif-icantly improved, especially for large projects.

Web administration Now you can do Remote administration of RoboHelp Server using a web interface. Administration can be done from RoboHelp itself from the RoboHelp Server tab (Tools > Options > General). A web browser can also be used for this purpose. Web administration can be used for managing projects, user accounts, and groups; viewing reports; and troubleshooting.

Improved layout The new layout makes it easier to set up and install RoboHelp Server. An improved installer resolves issues that were present in RoboHelp Engine 4.

Publishing to relational databases RoboHelp Server provides the capability to connect to an Oracle or SQL server database.

Uninstalling RoboEngine 4It’s recommended that you remove server from Microsoft IIS 5.0/6.0 before uninstalling RoboEngine®.

Remove server from IIS Manager1 Click the icon for Configuration Manager on your desktop. Config-uration Manager opens.

2 Choose File > Delete Engine.


ADOBE ROBOHELP SERVER 6Getting Started Guide

3

3 If multiple websites are set up for multiple engines, choose File > Open Engine to display the list of websites. Open each site and repeat step 2.

Uninstall RoboEngine1 From the Start menu, choose Settings > Control Panel.

2 Double-click Add/Remove Programs.

3 From the list of programs, select RoboEngine.

4 Click Change/Remove.

5 Click OK to confirm that you want to remove the RoboEngine.

6 When the uninstall program indicates that the process is complete, click OK.

7 Delete the following files from Inetpub\wwwroot:

• RoboAPI.asp • Default.asp

System requirementsMake sure that your computer meets the following software and hardware requirements before installing each program.

Operating system and web server• Windows® XP with IIS 5.0/6.0• Windows® 2003 Server with IIS 6.0• Windows® 2000/2000 Server with IIS 5.0

Hardware• Pentium® III 450 MHz or higher• 256 MB RAM• 100 MB available disk space

Database• Oracle® 9i, 10g• SQL Server 9.0


4Getting started

Software• Microsoft® Index Service (The index service is installed by default

with Microsoft Windows 2000/2003 Server)

Run-time browser compatibility• Internet Explorer® 6 and above, Firefox 2.0, and Safari 2.0Note: All published projects are stored in a subdirectory of Program Files\Adobe\RoboHelp Server 6.0 unless a different partition or drive for RoboHelp Server is specified during installation.

Installing Microsoft IIS Server and setting up a website

Install IIS Server1 From the Start menu, choose Control Panel > Add Or Remove Programs.

2 Click Add/Remove Windows Components.

3 Select Application Server, and click Details.

4 Select Internet Information Services, and click OK.

5 Click Next, and then click Finish.

Set up a website1 From the Start menu, choose Control Panel > Administrative Tools.

2 Click Internet Information Services Manager.

The IIS Manager appears. Note that default website is created in the Web Sites folder.

3 To set up more websites, right click the Web Sites folder and choose New Web Site.

4 Click Next, and enter a description for the website.

5 Click Next. Specify an IP address and a port for the website. The default port is 80.

6 Click Next. Enter a path for Web Site Home Directory. It can be a local path on your machine.



5

7 Assign access permissions. By default, permissions are read only.

8 Click Next, and then click Finish.

Preinstall configurationRoboHelp Server needs access to folders on the file system and needs user accounts provided by the server system to execute processes. Administrators who lock down web access and NFTS permissions need to perform the following steps to ensure RoboHelp Server will run properly.

Create a run-time group1 Log on to the server system. The account used for logging on to the server system should be part of the Administrators user group for the server system, defined in the Windows User Manager. This is typically the “Administrator” account.

2 Create a local user group called RoboRuntime.

3 Add the pre-defined accounts IUSR_<SERVERNAME> and IWAM_<SERVERNAME> to this group.

Note: If IUSR and IWAM are already part of a group, you don’t need to create the RoboRuntime group.

Preinstall permissionsBefore installing RoboHelp Server, set the file system permissions, as described in the following table:

Path/Files Permissions Reason

Install Root: C:\

Administrators – Full Control System – Full Control RoboRuntime – List Folder Con-tents

The RoboHelp Server search engine needs to resolve paths to files being indexed.


6Getting started

Note: Make sure that the option to propagate to existing objects is checked.

Running the IIS Lock Down tool (optional)If you run the IIS Lockdown Wizard, use the following settings for RoboHelp Server:

• Select Server Template Use Dynamic Web Server (ASP enabled). Check View template settings.

• Internet Services Select Web Service (HTTP) only.

• Additional Security Accept all settings on this page.

• URLScan Deselect Install URLScan filter on the server. If you select this option, the RoboHelp Server ISAPI DLL (robo.dll) is disabled.

Note: The lock down tool will stop the Indexing Service. RoboHelp Server requires this service to index Microsoft documents (.doc, .sly, and .ppt). You must open the Services MMC to start the Indexing service automatically.

WINDOWS Folder: C:\WINDOWS

* If your data source is SQL Server or Oracle: RoboRuntime – Read & Execute ** If your data source is Microsoft Access RoboRuntime – Modify

* RoboHelp Server needs access to Microsoft Runtime Libraries ** Microsoft Access uses this folder tree for TEMP files.

ODBC Registry Key HKEY_LOCAL_MACHINE: Soft-ware\ODBC\odbc.ini

RoboRuntime – Full Control RoboHelp Server needs to create and read ODBC data sources.

Path/Files Permissions Reason



7

Install RoboHelp Server 1 Close all programs.

2 Insert the Adobe RoboHelp Server CD into your CD-ROM drive. If Autorun is enabled on your system, the installation process starts automatically, and you can go to step 5.

3 From the Start menu, choose Run.

4 Type D:\setup (where “D” represents the CD drive on your computer).

5 Follow the on-screen instructions.

By default, RoboHelp Server is installed to Program Files\Adobe.

Configure RoboHelp Server1 In Configuration Manager, choose File > New Server, and click Next. (After the installation is complete, Configuration Manager starts automatically.)

2 Websites you set up are listed. Choose the website to which you want to associate this new server.

3 Click Next.

4 The database configuration appears. By default, Microsoft Access® database is selected. To use SQL Server or Oracle, select the second radio button. Enter the relevant information and click Next.

5 Click Next to configure the engine.

6 Click Finish.

Install on 2003 .Net ServerFor RoboHelp Server to run on 2003 .net server, complete the following steps.

1 Enable unknown ISAPI extensions. This step enables the RoboHelp Server ISAPI DLL (Robo.dll).

2 Enable unknown CGI extensions. This step enables the PHP Scripting CGI exe (Php.exe). PHP is used to display report charts and graphs.


8Getting started

Post-installation tasks

Create a publishing groupTo grant access to users that can only publish projects, create a publishing group. Then, create local user accounts, and add those accounts as members of the publishing group.

Note: A publishing group is created automatically by the installer. The name of the group is RoboPublish.

Create a reports groupTo grant access to users that may only view reports, create a reports group. Then, create local user accounts, and add those accounts as members of the reports group.

Note: A reports group is created automatically by the installer. The name of the group is RoboReports.

Post-install permissionsAfter installing RoboHelp Server and configuring a RoboHelp Server site, set file system permissions, as described in the following table:

Note: Make sure that the option to propagate to existing objects is checked. Also, after changing permissions, restart the IIS Admin Service so that the changes take effect.

Folder/Files Permissions Reason

Install Root: C:\

Reports group - Modify *Apply to this folder only

The PHP Script engine uses this folder for temporary files.



9


Reports group – Modify *Apply only if your data source is using Microsoft Access

Microsoft Access uses this folder tree for TEMP files. Since anonymous access is disabled, data-base operations are authenticated with the reports group (not IUSR and IWAM).


Publishing group – Read & Exe-cute Reports group - Read & Execute

Publishing and Reports require use of Microsoft Runt-ime Libraries

Web Root Folder: C:\Inetpub\wwwroot

RoboRuntime - Read & Execute RoboHelp Server needs access to its ASP files (default.asp, roboapi.asp)

Install Folder C:\Program Files\Adobe\Robo-Help Server 6.0

RoboRuntime - Read & Execute Publishing group - Read & Exe-cute Reports group – Read & Execute

All groups need access to RoboHelp Server modules and data.

Content Tree [install folder]\Servers

C:\Program Files\Adobe\Robo-Help Server 6.0\Serv-ers

RoboRuntime – Modify Publishing group – Modify

All content served from RoboHelp Server is stored in this folder tree.



10Getting started

IIS permissionsAfter running the RoboHelp Server Configuration Wizard, a folder structure is created under the RoboHelp Server content tree (Program Files\Adobe\RoboHelp Server 6.0\Servers\[website ID). Also, virtual folders are created in the configured website. The Configuration Wizard creates the necessary permissions on these virtual folders. Therefore, no permissions need to be modified. Listed for reference are the permissions set by the RoboHelp Server Config-uration Wizard.

Reserved Folder: [install folder]\Reserved

C:\Program Files\Adobe\Robo-Help Server 6.0\Reserved

RoboRuntime – Modify Publishing group – Modify

RoboHelp Server uses folder tree for it’s temporary files and folders.

Database Folder: [install folder]\Data-base C:\Program Files\Adobe\Robo-Help Server 6.0\Data-base

RoboRuntime – Modify *Apply only if your data source is using Microsoft Access

By default, Access database files are created in this folder.

Registry key: HKEY_LOCAL_MACHINE\SOFT-WARE\Adobe\Robo-Help Server\6.00\Installed-HelpSystems\

RoboRuntime – Full Control Publishing Group – Full Control

RoboHelp Server needs to create and enumerate its project list.




11

Test RoboHelp Server1 Create WebHelp Pro of FlashHelp Pro projects in Adobe RoboHelp.

2 From Single Source Layout, choose WebHelp Pro or FlashHelp Pro. Follow the instructions, including the server name of the RoboHelp Server you configured. Publish the project.

3 View the project from your browser by typing http://[server name]/roboapi.asp?project=[project name]. Or, from RoboHelp Server Tab in RoboHelp 6, connect to the server.

Virtual Folder and Path

Permissions Reason

IRobo [install folder]\Serv-ers\[website ID]

C:\Program Files\Adobe\Robo-Help Server 6.0\Servers\1

•\Documents •\Projects •\Reports* •\Resource

Local Path – Read

Execute permissions – Scripts Only

Directory Security – 1. Anonymous Access enabled 2. Integrated Windows Authen-tication enabled

* Anonymous access is disabled on the Reports folder. Users must authenticate with the server system to view reports.

Robo\Bin [install folder]\Bin

C:\Program Files\Adobe\Robo-Help Server 6.0\Bin

Local Path – Read

Execute permissions – Scripts and Executable files*

Directory Security – 1.Anony-mous Access enabled ** 2.Integrated Windows Authenti-cation enabled

* Robo.dll and WPSHost.dll need to execute on the server system

** If you don’t want anonymous users to access projects, disable anonymous access. Then, only users that can authenticate with the server system will be able to view your content


12Getting started

4 In the Web Administrator dialog box, choose Projects from the list of icons provided.

5 From the list of projects, choose your project and click View Project.

6 View the help output in the default browser.

Technical supportIf you need further assistance using your software, visit the Support area of the Adobe website, where you’ll find troubleshooting and contact information.
