Express Web Services Installation Guide

Transcription

1 Express Web Services Installation Guide PRODUCT VERSION: 4.12 REVISION DATE: December 2012

2 Copyright Copyright 2012, Adlib Software This manual, 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. The content of this manual is furnished for informational use only, is subject to change without notice and should not be construed as a commitment by Adlib Publishing Systems Inc. Adlib Publishing Systems Inc. assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual. Except as permitted by such license, no part of this publication 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 Adlib Publishing Systems Inc. Adlib, Express, Express Server, ExpressConversion, ExpressRecognition, ExpressPublishing, Relay, Express Web Services, Insight and Publisher are either registered trademarks or trademarks of Adlib Publishing Systems Inc. Microsoft Windows and Microsoft Office are either registered trademarks or trademarks of the Microsoft Corporation in the United States and/or other countries. Corel, WordPerfect, CorelDRAW and Quattro Pro are either registered trademarks or trademarks of Corel Corporation. IBM, Lotus, SmartSuite, Word Pro and Freelance Graphics are either registered trademarks or trademarks of IBM Corporation. Adobe, Acrobat and Adobe Reader are either registered trademarks or trademarks of Adobe Systems Inc. Crystal Reports is either a registered trademark or trademark of Seagate Software. OpenOffice.Org is either a trademark or registered trademark of Oracle. Portions of this product contain code from OmniPage Capture SDK (registered trademark of Nuance Communications Inc.), Outside In (registered trademark of Oracle), Glyph & Cog, LLC (Copyright ), Pegasus Imaging Corporation (Tampa, FL), PDFNet SDK from PDFTron Systems (Copyright ) and are distributed by Adlib under license. ALL RIGHTS RESERVED.

3 Table of Contents Introduction...4 Architecture...5 System Requirements...6 Express Web Service Adaptor...6 Express Manager...6 Express Connector...7 Installation Instructions...9 Prepare for Installation...9 Uninstallation Instructions...15 Upgrade Instructions...17 Silent Installation...18 Silent Installation Configuration Settings...20 Silent Uninstallation Instructions...22 Appendix A Glossary...23 Appendix B Contact Adlib...24 Page 3 of 24

4 Introduction Express Web Services (EWS) is a suite of software applications that enable document processing requests (Jobs) to be initiated from different requestors, prioritized and distributed to one or more available Express Servers for processing. Express Web Services provides scalability to Express Server so that multiple servers can work together to provide a unified document processing resource. Express Web Services is comprised of several distinct but cooperating components: - Express Manager, which distributes and load balances the work - Express Connector, which works with Express Server itself to process a job - Express Web Service Adaptor, an interface through which jobs are added and feedback is retrieved For more detailed information on each of these components, please refer to the Express Web Services User Guide. Page 4 of 24

5 Architecture Before beginning the installation, architecture must be decided on. As Express Web Services is composed of several components, there are many different ways those components can be laid out. For instance, an Express Manager is able to interact with either one or multiple Express Connectors. Some important things to keep in mind when deciding on architecture: - An Express Connector must be installed on a machine that contains Express Server - Different Express Connectors must be on different machines - Adlib does not recommend installing Express Connector and Express Manager on the same machine If assistance is required, please contact Adlib. Page 5 of 24

6 System Requirements Express Web Service Adaptor Hardware Requirements Processor Type Minimum: Pentium 4 compatible processor Processor Speed Minimum: 1 GHz Memory (RAM) Minimum: 512 MB Recommended: 2 GB or higher Hard Disk Space Minimum: 10 MB available Software Requirements Operating System Microsoft Windows Server bit/64 Microsoft Windows Server bit* Microsoft Windows Server 2008 R2*.NET Framework IIS Note: We recommend the installation of the latest Windows Service Pack..NET Framework 2.0 (with latest Service Pack) or greater ( 8EDD-AAB15C5E04F5&displaylang=en) Windows Server bit Internet Information Services 6.0 Windows Server bit Internet Information Services 6.0 Management Compatibility Internet Information Services 7.0 (must be enabled) Windows Server 2008 R2 Internet Information Services 6.0 Management Compatibility Internet Information Services 7.5 (must be enabled) ASP.NET Service Must be installed and enabled for Windows Server 2003 WebDAV Must be allowed to process PUT commands (default is prohibited) Authoring Rule must have Allow access to option set to All content Express Manager Hardware Requirements Processor Type Minimum: Pentium 4 compatible processor Page 6 of 24

7 Recommended: Dual or Quad processors Processor Speed Minimum: 1 GHz Recommended: 2.8 GHz or higher Memory (RAM) Minimum: 512 MB Recommended: 2 GB or higher Hard Disk Space Minimum: 10 MB available Software Requirements Operating System Microsoft Windows Server bit/64 Microsoft Windows Server bit* Microsoft Windows Server 2008 R2* * See Error! Reference source not found.appendix C Windows Server 2008 Support (Process Manager) for further details..net Framework Message Queuing (MSMQ) Note: We recommend the installation of the latest Windows Service Pack..NET Framework 2.0 (with latest Service Pack) or greater ( 8EDD-AAB15C5E04F5&displaylang=en) Message Queuing (MSMQ) version 2.0 or greater Note: It is recommended that Express Manager and Express Connector(s) be installed on separate systems. Express Connector Hardware Requirements Processor Type Minimum: Pentium 4 compatible processor Recommended: Dual or Quad processors Processor Speed Minimum: 1 GHz Recommended: 2.8 GHz or higher Memory (RAM) Minimum: 512 MB Recommended: 2 GB or higher Hard Disk Space Minimum: 15 MB available Express Connector Operating System Microsoft Windows Server bit/64 Microsoft Windows Server bit* Microsoft Windows Server 2008 R2* * See Error! Reference source not found.appendix C Windows Server 2008 Support (Process Manager) for further details. Page 7 of 24

8 .NET Framework Message Queuing (MSMQ) Note: We recommend the installation of the latest Windows Service Pack..NET Framework 2.0 (with latest Service Pack) or greater ( 8EDD-AAB15C5E04F5&displaylang=en) Message Queuing (MSMQ) version 2.0 or greater Express Server Adlib Express Server 4.12 Note: These components use TCP port 9932 to communicate with each other. This port may be blocked by a firewall. Page 8 of 24

9 Installation Instructions Prepare for Installation To install Express Web Services you must be logged onto the system with an account that has Local Administrator rights and install from the local machine (do not install from Terminal Services). 1. Close all applications. 2. If you are installing Express Web Services on Windows Server 2008, Windows Authentication will need to be installed and enabled is IIS. Windows Authentication will need to be enabled for both the website that Express Web Services is installed under as well as the ExponentJobs folder within that website. To install Windows Authenication for IIS: 1. Click Start, Control Panel, Programs And Features, Click Turn Windows Features On or Off. 2. In the Server Manager, Click Roles. 3. In the Pane on the right-hand side, scroll down to the Web Server (IIS) section. 4. Click Add Role Services. 5. Under Web Server, under Security, Check Windows Authentication. 6. Click Next, review, then click Install. 3. Run the Express Web Services installation file (e.g. ExpressWebServices4111.exe) 4. Follow the instructions that appear on your screen. Page 9 of 24

10 Press Next to begin the installation. Accept the terms of the Adlib Software EULA Page 10 of 24

11 Enter User Name and Company Name and click the Next button. Choose which components to install on this machine, and press the Next button. Note: It is not recommended that all three components reside on the same machine for production systems. For improved performance, Express Manager should be installed on a separate system from the Express Connector application. Page 11 of 24

12 Choose an installation folder, and press Next. All installed components will be placed into this folder. If installing Express Connector, enter the credentials under which the service will run. Press the Next button to continue. Page 12 of 24

13 If installing Express Manager, enter the credentials under which the service will run. Press the Next button to continue. Enter the machine name of the system where Express Manager is being installed, and press the Next button to continue. Page 13 of 24

14 Review the information to confirm it is correct, and press Next to begin installing. Page 14 of 24

15 Uninstallation Instructions Go to the Control Panel and open Add or Remove Programs/Programs and Features, select Express Web Services and click on Remove/Uninstall. The following uninstall dialog box will be launched. Select Remove to start the uninstallation process. Select the Modify option to remove or install individual Express Web Services components. Page 15 of 24

16 Note: The Repair option will reinstall Express Web Services with all of the previously selected options from the last install. A final dialog box warning will appear before the uninstallation process begins. Figure 1 Final Uninstallation Acknowledgement Selecting Yes will tell the uninstallation process to proceed and Express Web Services will be removed from the system. Selecting No will abort the uninstallation process leaving Express Web Services on the system. Page 16 of 24

17 Upgrade Instructions In order to install a new version of Express Web Services onto a system that already contains a previous version of the software; the User is required to remove the previous version before proceeding. One or more of the following dialog boxes will appear when attempting to install a newer version of Express Web Services than is currently installed on the system. Figure 2 Express Web Services dialog Users should acknowledge this dialog box and proceed to uninstall the previous version of Express Web Services as detailed under Uninstallation Instructions. Note: Express Web Services was formerly known as Exponent prior to version 4.0. The Exponent installation was broken up into three separate installs: Exponent Connector, Exponent Manager and Exponent Web Service Adaptor. Each of these components will need to be uninstalled separately before upgrading to the latest version of Express Web Services. Page 17 of 24

18 Silent Installation Adlib products can be configured to install silently, which means that there are no dialogs, no message boxes and no user intervention needed. An interactive installation receives the necessary input from the user in the form of responses to dialog boxes. A silent installation for Adlib products receives user input from an Adlib Installation Configuration file (AdlibInstall.cfg). The installation configuration file contains information that an end user would ordinarily enter as responses to dialog boxes when running a normal installation. The format of AdlibInstall.cfg resembles that of an.ini file, except for the.cfg extension. The installation configuration file is a plain text file consisting of sections containing data entries. For Example: [ExpressConnector] InstallDir= C:\Program Files\Adlib\Express Web Services\Connector CreateShortcuts=Yes StartService=Yes To install an Adlib product silently, the user executes the installation with a /s command line parameter (i.e. ExpressWebServices.4120.exe /s). The file setup.iss must be placed in the same location as the installation package (ExpressWebServices.4120.exe). Please contact Adlib to obtain the file. This file is needed to silently respond to the dialogs. The installation will search for AdlibInstall.cfg in the same folder as the installation file. Optionally, the user can specify a different location for the installation configuration file by passing the path as a second parameter (i.e. ExpressWebServices.4120.exe /s C:\User\SomePath). The installation configuration file must always be named AdlibInstall.cfg. The Silent installation will read the information from the installation configuration file and install the product according to the data provided. To modify the installation configuration file simply open it in a text editor. The Silent installation will not force a reboot, however it is recommended that the user reboot after the installation has completed. Please see the next page for a sample Express Web Services silent installation script. Page 18 of 24

19 AdlibInstall.cfg [ExpressConnector] Install = Yes No InstallDir = C:\Program Files\Adlib\Express Web Services\Connector RootFolder = C:\Adlib Express Connector CreateShortcuts = Yes No ServiceAccount = user@domain.com.\administrator ServicePassword = ****** ServiceStartType = Auto Manual StartService = Yes No StartExpress = Yes No CreateExpressConfiguration = Yes No AddExpressManager = Manager Name Userguide = Yes No [ExpressManager] Install = Yes No InstallDir = C:\Program Files\Adlib\Express Web Services\Manager RootFolder = C:\Adlib Express Manager CreateShortcuts= Yes No ServiceAccount= user@domain.com.\administrator ServicePassword= password ServiceStartType= Auto Manual StartService= Yes No Userguide = Yes No [ExpressWSA] Install = Yes No InstallDir = C:\Program Files\Adlib\Express Web Services\WSA RootFolder = C:\Adlib Express WSA ServerName = ComputerName CreateShortcuts= Yes No Userguide = Yes No WebService = MTOM DIME AddExpressManager = manager name SampleApps = Yes No Userguide = Yes No Page 19 of 24

20 Silent Installation Configuration Settings AddExpressManager - Specify the name of an Express Manager which you wish to be added to the list of Managers. (Express Connector and Express Web Service Adaptor only) CreateExpressConfiguration- Specifying Yes will install a default Express configuration which is preconfigured for use with Express Connector. (Express Connector only) Note: If silently installing Express Server along with Express Connector pay special attention to this property if you are also specifying an ExpressSettingsPath. CreateShortcuts Install InstallDir InstallService RootFolder - Specify whether or not you would like the application shortcuts created in the start menu. - Specify whether or not you would like to install the product (Express Connector, Express Manager, and Express Web Service Adaptor only) - Specify the location where you would like the product installed. - Specify whether or not you would like to install the application s Windows service. - Specify the location where you would like to create the default processing folders. Note: It is not recommended to set this property if you are also setting the ExpressSettingsPath property. The configuration specified will already contain the paths to all the processing folders. ServiceAccount - Specify the account under which you would like to create the application s Windows service. Leaving this field blank or using LOCALSYSTEM will create the service under the Local System account. Note: Make sure the account specified has the following privilege, Logon as a Service. ServicePassword ServiceStartType StartService - Specify the password for the account specified in ServiceAccount for the application s Windows service. Leaving this field blank will assume no password. - Specify how you would like to start the application s Windows service. Valid options are Auto or manual. - Specify whether or not you would like to start the application s service immediately after installation. Page 20 of 24

21 Userguide - Specify whether or not you would like the complete User Guide installed to the installation folder. WebService - Specify the Web Service to install for use with Express Web Service Adaptor. Page 21 of 24

22 Silent Uninstallation Instructions In order to silently uninstall an Adlib product, a product specific.iss file is needed. Please contact Adlib to obtain the appropriate file(s). Similar to installation, the uninstall.iss file contains information that an end user would ordinarily enter as responses to dialog boxes when running a normal uninstall. After receiving the file from Adlib, simply copy it to an accessible location. Do NOT copy it to the application s program folder (e.g. C:\Program Files\Adlib\Express Web Services ). To begin the silent uninstall, the user executes the setup.exe installation located in a specific hidden folder within the default program files directory. The user executes the installation with /s and /f1 command line parameters. The /f1 switch should contain the fully qualified path to the.iss file. Below are examples of the command line parameters required to begin silent uninstallation: 32-bit Windows OS location C:\Program Files\Installshield Installation Information\{C9AD4F0B-7B4C-4DC1-A9C4-356B9DEF1B31}\setup.exe /s /f1 C:\Temp\Uninstall_setup.iss 64-bit Windows OS location C:\Program Files (x86)\installshield Installation Information\{C9AD4F0B-7B4C-4DC1-A9C4-356B9DEF1B31}\setup.exe /s /f1 C:\Temp\Uninstall_setup.iss Page 22 of 24

23 Appendix A Glossary Express XML Job Ticket see XML Job Ticket (below) XML Extensible Markup Language. XML Job Ticket An XML-formatted piece of text used by Express Server to process job instructions. EWS Express Web Services IIS Internet Information Server WSA Web Service Adaptor MSMQ Microsoft Message Queue DIME Direct Internet Message Encapsulation. A way of transferring binary data over the internet. Obsolete. MTOM Message Transmission Optimization Mechanism, a method of efficiently sending binary data over the internet. Page 23 of 24

24 Appendix B Contact Adlib Please contact Adlib if you have any questions or comments. Web: info@adlibsoftware.com for General Inquiries sales@adlibsoftware.com for Sales Support support@adlibsoftware.com for Technical Support Phone: Fax: Toll Free: Sales: Support: (North America Only) Mail: Adlib South Service Road, Burlington, Ontario. L7N 3H8 Canada Page 24 of 24