Getting-started.book Page i Thursday, January 11, 2007 9:57 PM
ADOBE ROBOHELP SERVER 6 速
G E T T I N G S TA R T E D G U I D E
速
Getting-started.book Page ii 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 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 end-user 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, RoboHelp, Acrobat, RoboEngine, FlashHelp, are either registered trademarks or trademarks of Adobe Systems Incorporated 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 registered trademarks of Oracle Corporation and/or its affiliates. Windows, Windows XP, Access, and Internet Explorer are either a registered trademark 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 owners. Portions of Adobe Acrobat include technology used under license from Autonomy, and are copyrighted.
Getting-started.book Page iii 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, 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. Unpublishedrights reserved under the copyright laws of the United States. Adobe Systems 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 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.
Getting-started.book Page iv Thursday, January 11, 2007 9:57 PM
Getting-started.book Page v Thursday, January 11, 2007 9:57 PM
ADOBE ROBOHELP SERVER 6 v Getting Started Guide
Contents Getting started Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 What’s new
................................2
Uninstalling RoboEngine 4 System requirements Install RoboHelp Server Technical support
.................2
......................3 ....................7
. . . . . . . . . . . . . . . . . . . . . . . . .12
Getting-started.book Page vi Thursday, January 11, 2007 9:57 PM
vi Contents
Getting-started.book Page 1 Thursday, January 11, 2007 9:57 PM
1
Getting started Introduction This 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 structured 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 2 Thursday, January 11, 2007 9:57 PM
2 Getting 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 new FlashHelp 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 significantly 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 4 It’s recommended that you remove server from Microsoft IIS 5.0/6.0 before uninstalling RoboEngine®.
Remove server from IIS Manager 1 Click the icon for Configuration Manager on your desktop. Configuration Manager opens. 2 Choose File > Delete Engine.
Getting-started.book Page 3 Thursday, January 11, 2007 9:57 PM
ADOBE ROBOHELP SERVER 6 3 Getting Started Guide
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 RoboEngine 1 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 requirements Make 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
Getting-started.book Page 4 Thursday, January 11, 2007 9:57 PM
4 Getting 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.0 Note: 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 Server 1 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 website 1 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.
Getting-started.book Page 5 Thursday, January 11, 2007 9:57 PM
ADOBE ROBOHELP SERVER 6 5 Getting Started Guide
7 Assign access permissions. By default, permissions are read only. 8 Click Next, and then click Finish.
Preinstall configuration RoboHelp 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 group 1 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 permissions Before installing RoboHelp Server, set the file system permissions, as described in the following table: Path/Files
Permissions
Install Root:
Administrators – Full Control
C:\
Reason
The RoboHelp Server search System – Full Control engine needs to resolve paths to files RoboRuntime – List Folder Con- being indexed. tents
Getting-started.book Page 6 Thursday, January 11, 2007 9:57 PM
6 Getting started
Path/Files
Permissions
WINDOWS Folder: * If your data source is SQL Server or Oracle: RoboRuntime C:\WINDOWS – Read & Execute ** If your data source is Microsoft Access RoboRuntime – Modify ODBC Registry RoboRuntime – Full Control Key HKEY_LOCAL_MA CHINE:
Reason * RoboHelp Server needs access to Microsoft Runtime Libraries ** Microsoft Access uses this folder tree for TEMP files. RoboHelp Server needs to create and read ODBC data sources.
Software\ODBC\odbc .ini
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.
Getting-started.book Page 7 Thursday, January 11, 2007 9:57 PM
ADOBE ROBOHELP SERVER 6 7 Getting Started Guide
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 Server 1 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 Server For 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.
Getting-started.book Page 8 Thursday, January 11, 2007 9:57 PM
8 Getting started
Post-installation tasks Create a publishing group To 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 group To 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 permissions After 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:
Reports group - Modify
C:\
*Apply to this folder only
The PHP Script engine uses this folder for temporary files.
Getting-started.book Page 9 Thursday, January 11, 2007 9:57 PM
ADOBE ROBOHELP SERVER 6 9 Getting Started Guide
Folder/Files
Permissions
Reason
WINDOWS Folder:
Reports group – Modify
C:\WINDOWS
*Apply only if your data source is using Microsoft Access
Microsoft Access uses this folder tree for TEMP files. Since anonymous access is disabled, database operations are authenticated with the reports group (not IUSR and IWAM).
WINDOWS Folder:
Publishing group – Read & Execute
C:\WINDOWS
Publishing and Reports require use of Microsoft RuntReports group - Read & Execute ime Libraries RoboRuntime - Read & Execute
RoboHelp Server needs access to its ASP files (default.asp, roboapi.asp)
Install Folder
RoboRuntime - Read & Execute
C:\Program Files\Adobe\RoboHelp Server 6.0
Publishing group - Read & Execute
All groups need access to RoboHelp Server modules and data.
Web Root Folder: C:\Inetpub\wwwroot
Reports group – Read & Execute Content Tree [install folder]\Servers
RoboRuntime – Modify
C:\Program Files\Adobe\RoboHelp Server 6.0\Servers
Publishing group – Modify
All content served from RoboHelp Server is stored in this folder tree.
Getting-started.book Page 10 Thursday, January 11, 2007 9:57 PM
10 Getting started
Folder/Files
Permissions
Reason
Reserved Folder: [install folder]\Reserved
RoboRuntime – Modify
RoboHelp Server uses folder tree for it’s temporary files and folders.
Publishing group – Modify
C:\Program Files\Adobe\RoboHelp Server 6.0\Reserved Database Folder: [install folder]\Database
RoboRuntime – Modify *Apply only if your data source is using Microsoft Access
By default, Access database files are created in this folder.
C:\Program Files\Adobe\RoboHelp Server 6.0\Database Registry key:
RoboRuntime – Full Control
HKEY_LOCAL_MACHI NE\SOFTWARE\Adobe\RoboHelp Server\6.00\InstalledHelpSystems\
Publishing Group – Full Control
RoboHelp Server needs to create and enumerate its project list.
IIS permissions After 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 Configuration Wizard.
Getting-started.book Page 11 Thursday, January 11, 2007 9:57 PM
ADOBE ROBOHELP SERVER 6 11 Getting Started Guide
Virtual Folder and Path
Permissions
Reason
IRobo [install folder]\Servers\[website ID]
Local Path – Read
C:\Program Files\Adobe\RoboHelp Server 6.0\Servers\1
Directory Security – 1. Anonymous Access enabled 2. Integrated Windows Authentication enabled
* Anonymous access is disabled on the Reports folder. Users must authenticate with the server system to view reports.
Execute permissions – Scripts Only
•\Documents •\Projects •\Reports* •\Resource Robo\Bin [install folder]\Bin C:\Program Files\Adobe\RoboHelp Server 6.0\Bin
Local Path – Read Execute permissions – Scripts and Executable files*
* Robo.dll and WPSHost.dll need to execute on the server system
Directory Security – 1.Anony** If you don’t want mous Access enabled ** 2.Integrated Windows Authenti- anonymous users to access projects, disable cation enabled anonymous access. Then, only users that can authenticate with the server system will be able to view your content
Test RoboHelp Server 1 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.
Getting-started.book Page 12 Thursday, January 11, 2007 9:57 PM
12 Getting 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 support If you need further assistance using your software, visit the Support area of the Adobe website, where youâ&#x20AC;&#x2122;ll find troubleshooting and contact information.