Installation and Upgrade Guide SDL WorldServer 10.4
Documentation Notice This documentation and the data contained herein are the property of SDL Language Technologies and its licensors. Any use, disclosure, reproduction, modification, display or transfer of the data and/or documentation is prohibited, except by the express written authorization of SDL. This document contains proprietary SDL Language Technologies information and is licensed for use pursuant to the SDL standard software license agreement. IfyouareanentityoftheU.S.government,youagreethattheprogram(s)anddatareferredtointhisdocumentareCommercial ComputerSoftware,asdefinedintheF.A.R.,andtheDoDF.A.R.Suppl.,andaredeliveredwithonlythoserightssetforthinthe SDL standard software license agreement. The program(s) referred to in this document are not specifically developed, or licensed, for use in any nuclear, aviation, mass transit, or medical application or in any other inherently dangerous applications, and any such use shall be construed as a misuse oftheprogram(s).sdlshallnotbeliableforanyclaimsordamagesarisingfromsuchuseoftheprogram(s)foranysuch applications. THE INFORMATION IN THIS DOCUMENT IS SUBJECT TO CHANGE WITHOUT NOTICE. SDL MAKES NO WARRANTY OF ANY KIND REGARDING THIS MATERIAL, AND ASSUMES NO RESPONSIBILITY FOR ANY ERRORS THAT MAY APPEAR IN THIS DOCUMENT. Copyright 1998-2013 by SDL plc. All rights reserved. IDIOM is a registered trademark, and WORLDSERVER is a trademark, of SDL plc. Trados and MultiTerm are registered trademarks of SDL plc. All other company product or service names referenced herein are properties of their respective owners. This product includes software developed by the Apache Software Foundation(http://www.apache.org/). This product also includes software developed by: the W3C consortium(http://www.w3c.org) the SAX project(http://www.saxproject.org) Jaspersoft JasperReports is distributed under license from Jaspersoft, Inc. Publication date: October 2013 II Installation and Upgrade Guide
Contents 1 AbouttheSDLWorldServerInstallandUpgradeGuide... 1 SDLWorldServerDocumentationandResources... 1 2 WorldServerInstallation... 5 WorldServerInstallationProcess... 5 SettingupaSQLServerDatabase... 7 SettingUpanOracleDatabase... 13 InstallingWorldServeronWindows... 18 InstallingWorldServeronSolarisorLinux... 22 WorldServerDeploymentsforApacheTomcat... 25 DeployingonWindows... 25 DeployingonUNIX... 27 WorldServerDeploymentsforIBMWebSphere... 29 DeployingonWindows... 29 DeployingonUNIX... 31 3 PropertiesFiles... 33 ConfiguringMandatorygeneral... 33 ConfiguringOthergeneral.propertiesSettings... 37 ConfiguringClusteredModeProperties... 39 OtherPropertiesFiles... 42 4 ReportCenter... 45 JasperReportsServerInstallationOverview... 45 JRSInstallationPrerequisites... 47 PlatformNotes... 47 ApplicationServerNotes... 49 EnablingSingleSign-onforJRS... 50 ReportsRepository... 51 SetDataSource... 52 ConfiguringReportingoverHTTPS... 53 Logfile... 53 UserPermissions... 53 5 SecureSettingsandConnections... 55 SettingUpaSecureConnectionforExternalUsers... 55 EnablingURLPageSecurity... 57 Installation and Upgrade Guide III
ExposeURLSecuritytoCustomServlets... 58 6 SDKSampleObjects... 59 UploadingtheWorldServerSDKSamples... 60 ImportingSampleObjects... 61 7 FileTypeSupportServerInstallation... 63 InstallingtheFTSServer... 64 WorldServerWindowsConfigurationforFTS... 66 WorldServerSolarisandLinuxConfigurationforFTS... 69 SharingFilesystemsforFTSandWorldServer... 70 FTSConnectionsforSolarisorLinuxUsingSamba... 72 LinuxFilesystemMountsUsingSamba... 75 ConfiguringNFSAISMountsforLinuxandFTS... 75 FTSServerUpgradefromInstaller... 78 AddingLanguageResourceTemplates... 79 RunningtheFTSServer... 80 8 FullUpgradeProcedures... 81 BasicWorldServerUpgradeSteps... 81 ClusterUpgradeSteps... 83 BackingupInstallationandConfigurationFiles... 84 DatabaseSchemaUpgrades... 86 UpgradingtheOracleDatabasefrom9.4... 87 UpgradingtheOracleDatabasefrom10.0... 89 UpgradingtheOracleDatabasefrom10.1... 90 UpgradingtheOracleDatabasefrom10.2... 91 UpgradingtheOracleDatabasefrom10.2.1... 92 UpgradingtheOracleDatabasefrom10.3... 93 UpgradingtheSQLServerDatabasefrom9.4... 93 UpgradingtheSQLServerDatabasefrom10.0... 95 UpgradingtheSQLServerDatabasefrom10.1... 96 UpgradingtheSQLServerDatabasefrom10.2... 98 UpgradingtheSQLServerDatabasefrom10.2.1... 99 UpgradingtheSQLServerfrom10.3... 100 UpgradingWorldServerSoftware... 100 ValidatingYourUpgrade... 103 StartingWorldServerandVerifyingtheUpgrade... 105 9 ApplicationUpdates... 107 InstallinganUpdate... 107 RedeployingontoApacheTomcat... 108 RedeployingontoIBMWebSphere... 111 WebSphere7Update... 111 IV Installation and Upgrade Guide
Chapter 1 About the SDL WorldServer Install and Upgrade Guide Scope Welcome to SDL Language Technologies and WorldServer. SDL WorldServer is a translation management system that provides advanced linguistic technology, process automation, content repository integration and management services. Completely aligned with SDL Studio, WorldServer provides consistent analysis and reporting of translation projects for localization managers, project managers, translators and reviewers. The SDL WorldServer Install and Upgrade Guide provides step-by-step instructions for IT administrators participating in installing and upgrading WorldServer. SDL WorldServer Documentation and Resources The SDL WorldServer documentation set includes 14 separate deliverables. Some of these documents are installed with WorldServer. The following publications are available from the SDL Knowledgebase, in the Product Documentation/SDL_WorldServer folder. Installation and Upgrade Guide 1
About the SDL WorldServer Install and Upgrade Guide Administrator Guide Information on setting up and administering WorldServer in your environment. Administrator Tutorial- Configuring SDL WorldServer The process of performing an initial configuration of WorldServer. Basic Operations Guide Basic system administration and troubleshooting information for installed WorldServer systems. Browser Workbench User Guide Information on embedded translation tool for brief reviews or edits. Installation and Upgrade Guide Instructions for installing or upgrading WorldServer and its components in your environment. Planning and Prerequisites Guide Conceptual information for planning a WorldServer installation or upgrade, including environment requirements and options for the WorldServer platform, infrastructure, and supported components. SDK Web Services Developer Guide Reference guide for programmers who need to add Web Services to WorldServer. Software Development Kit(SDK) User Guide Reference guide for programmers to understand the APIs that extend WorldServer functionality and integrate WorldServer with other custom or third-party applications. Translation Memory Mode Concepts Guide Information for project managers that need to understand the Studio-aligned translation memory mode. User Guide Information for general WorldServer users: project managers, translators, and reviewers. WorldServer and Studio Integration Guide Information for translators, reviewers, and project managers that use SDL Studio with WorldServer. The following WorldServer documentation resources are also available: 2 Installation and Upgrade Guide
About the SDL WorldServer Install and Upgrade Guide WorldServer Release Notes Where: The Knowledgebase SDL WorldServer/Release Notes folder. Also available from the WorldServer FTP site: Walthamftp.sdl.com/ dist/ product/ worldserver/<releasenumber>/ Information on enhancements and changes in the most recent release. Also contains late-breaking information about known issues and issues fixed in this release. SDL Glossary Where: http://producthelp.sdl.com/glossary/en/glossary.htm An alphabetical list of terms related to WorldServer and other SDL products. Transport Online Help Context-sensitive help is available for most pages in TransPort from the More Info... link.afullwebhelpsystemisavailablefromthehelplinkatthetopofeachpage. All Language Technologies online help documentation is also available from the following web page: http://www.sdl.com/ en/ language-technology/ support/online-product-help/ WorldServer Online Help Context-sensitive help is available for most pages in WorldServer from the More Info...link.AfullwebhelpsystemisavailablefromtheHelplinkatthetopofeach page. Installation and Upgrade Guide 3
About the SDL WorldServer Install and Upgrade Guide 4 Installation and Upgrade Guide
Chapter 2 WorldServer Installation This chapter describes how to install and configure WorldServer on a new system. Note: SDL recommends that you become familiar with all the information in the Installation and Configuration Guide before you begin the installation process. See the following documentation for more information on WorldServer: The latest version of the WorldServer Release Notes. The Planning and Prerequisites Guide for WorldServer system requirements. The Basic Operations Guide for basic system administration and troubleshooting. WorldServer Installation Process Before you begin The WorldServer installation process consists of the following general steps. Details are provided in other topics. Important: To create one or more dedicated WorldServer application machines in a clustered mode, first install WorldServer on each of the machines using the standard WorldServer installation instructions, but do not create a separate WorldServer database for each installation. Clustered systems use a shared database. See the Planning and Prerequisites Guide for clustered mode concepts and environment information. Note that WorldServer uses application servers to implement clusters. See the Configuring Clustered Mode Properties topic for details on specifying the number of engines, clone names, file locations, and other information. Procedure 1. Create the WorldServer database instance and populate the schema. If you are installing WorldServer on Windows with SQL Server, this process is incorporated into the WorldServer installation process. Manual procedures for setting up SQL Server and Oracle databases for Microsoft Windows or UNIX platforms are described separately. Installation and Upgrade Guide 5
WorldServer Installation Restriction: The name of the WorldServer database must be specified in ASCII characters only. Do not, for example, specify a database name in Kanji or Katakana. 2. Install the WorldServer software on the WorldServer application server machine. Separate topics describe this process on Microsoft Windows or UNIX platforms. Important: If you intend to use WorldServer reporting, you should use an application server machine whose hostname does not contain _ (underscore). Due to a known issue, Microsoft Internet Explorer will not work with a WorldServer Report Center served by a machine with underscore in the hostname. You can, however, use Firefox in this case. Also, the directory name into which you install WorldServer must be specified in ASCII characters only. Do not, for example, install WorldServer into a directory that uses Kanji or Katakana. Note: For WorldServer version 10.1, you cannot use the Windows installer for WebSphere. 3. Deploy the WorldServer Web application into the application server. If you are installing WorldServer on Windows with Apache Tomcat, this process is incorporated into the WorldServer installation process. Manual procedures for setting up Tomcat and IBM WebSphere are described separately. 4. Configure the WorldServer properties files to finish setting up your application server deployment. Whattodonext To begin using WorldServer, perform the following basic operations. For more information on these topics, see the SDL WorldServer Basic Operations Guide. 1. Start up the WorldServer instance. 2. Log on to WorldServer. 3. Install your WorldServer licenses. At this point you can begin configuring your WorldServer environment to meet your business needs. 6 Installation and Upgrade Guide
WorldServer Installation Setting up a SQL Server Database WorldServer can store all of its internal information(workflow definitions, terminology database,andsoon)inasqlserverdatabase. Setting up WorldServer to use SQL Server is divided into two phases: Creating the SQL Server database to hold the WorldServer data. Populating the schema with WorldServer content. Each of these steps requires a different set of database permissions and is outlined separately. The WorldServer installation process on Windows can create and populate a SQL Server databaseforyou.however,theremaybecaseswhereyouneedtomanuallycreateand populate the SQL Server database outside of the installation process. For example: If you are installing WorldServer on Solaris or Linux, you will need to manually create the SQL Server database. If your SQL Server database administrator(dba) does not allow other users permission to create a new database. For these situations, follow these instructions before installing WorldServer. Otherwise, skip to Installing WorldServer on Windows on page 18. Prerequisites This process assumes that you already have an existing Microsoft SQL Server 2005 instance up and running. Restriction: The name of the WorldServer database must be specified in ASCII characters only. Do not, for example, specify a database name in Kanji or Katakana characters.donotincludeahypheninyourdatabasenameasthismayresultinissues during the database population process. It also assumes that you have adequate permissions to access this instance and perform various operations; each section below will list the necessary permissions. Installation and Upgrade Guide 7
WorldServer Installation Note: With SQL Server 2005, a situation can develop in which WorldServer installs with no errors and creates its database. However, WorldServer fails with an error 500 (database instance nonexistent or not active) when invoked from a browser. This issue is related to the SQL Server Browser component that is installed with SQL Server 2005. If this component's service is not enabled and running, WorldServer cannot connect through the TCP/IP protocol and fails. To avoid this problem, when you install SQL Server 2005, ensure that the SQL Server Browser is configured to start automatically as a service on server boot. This configuration prevents communications issues between WorldServer and the SQL Server. Tuning an SQL Server Database This section contains some general guidelines for configuring and maintaining WorldServer SQL Server 2005 databases to enhance performance. SQL Server, in most cases, knows how to configure itself dynamically for optimum performance,andgenerallydoesagoodjobofit.insomecases,changingsqlserver configuration settings may cause more problems than they fix and is not recommended. When the SQL Server service is first started, SQL Server begins with its default configuration settings. But as activity begins in the databases and as queries are run, SQL Server will fine-tune itself and performance will improve with time. TheeasiestwaytoviewyourSQLServer'sconfigurationsettingsistorunthe sp_configure command in Query Analyzer. See your SQL Server Books Online for more information about this command. Memory Requirements ForbestSQLServerperformance,itisrecommendedthatSQLServerrunona dedicated machine with plenty of physical memory. Your production SQL Server should not be sharing resources with any other major application. It should be the only application running on the server and it should usually be configured with its default memory options to dynamically manage the memory on that server. Inmostcases,theSQLServersettingsforthe maximum server memoryandthe minimum server memory should be left to their default values. This is because the default values allow SQL Server to dynamically allocate memory on the server for the best overall optimum performance. The maximum server memory setting, when set to the default value of 2147483647(inMB),tellsSQLServertomanagetheuseofmemory dynamically,andifitneedsit,touseasmuchramasisavailable(while leaving some memory for the operating system). The minimum server memory setting, when set to the default value of 0(inMB),tellsSQLServertomanagetheuseofmemorydynamically. This means that SQL Server will start allocating memory as is needed, and theminimumamountoframusedcanvaryassqlserver'sneedsvary. 8 Installation and Upgrade Guide
WorldServer Installation Note: Normally, the SQL Server 2005 Enterprise Edition and SQL Server 2005 DeveloperEditioncanonlyuseupto 2GBofphysicalmemory,nomatterhow muchmemoryyouhaveontheserver.withtheuseofthemicrosoftwindows 2003 Address Windowing Extensions(AWE) enable option, SQL Server can use upto4gbofphysicalmemory. Parallelism The max degree of parallelism option allows you to specify if parallelism isturnedonoroff,oronlyturnedonforsomecpusonyourserver.parallelism referstotheabilityofthequeryoptimizertousemorethanasinglecputo executeasinglequery.bydefault,parallelismisturnedonandcanuseasmany CPUsastherearerunningonyourserver.Thisdefaultsettingisthebestgeneral setting and works for most cases. Optimistic Concurrency There are significant advantages in using the new Optimistic Concurrency feature in SQL Server 2005, including: Faster project segmentation Several improvements in blocking issue seen in SQL Server 2000/2005 To enable Optimistic Concurrency, turn on the READ_COMMITTED_SNAPSHOT option on the SQL Server 2005 database. I/O Subsystem For information about the I/O subsystem, see: http://www.microsoft.com/technet/ prodtechnol/sql/2005/iobasics.mspx. SQL Server Connection Pool WorldServer uses a connection pool of JDBC connections. Connections are initialized at WorldServer startup and are shared by all threads within one WorldServer instance. Each connection consumes one SQL Server connection process. The size of the connection pool is controlled by the general.properties setting: database_connection_pool_size. By default, SQL Server allocates only as many user connections as it needs. This allowsthosewhoneedittoconnect,whileatthesametimeminimizingtheamount ofmemoryused.whentheuserconnectionssettingissettoitsdefaultvalue of 0, user connections are dynamically set. In nearly all cases, this default setting is the ideal setting, and should not be changed. Installation and Upgrade Guide 9
WorldServer Installation Updating Statistics Keeping statistics up to date is crucial for optimal performance of a WorldServer SQL Server database. Bad statistics lead to bad execution plans. By default, SQL Server automatically creates and maintains the statistics without any user intervention. The majority of SQL Server users will achieve optimal performance without any changes to this default. This helps to ensure that the optimizer statistics are valid, and that queries are properly optimized when they are run. WhenaSQLServerdatabaseisunderveryheavyload,sometimestheAuto Update Statistics feature can update the statistics at inappropriate times, such as thebusiesttimeoftheday.butasaruleofthumb,ifyourserverisnotundermaximum load, then leaving this option on is the best decision. To check whether Auto Update Statistics is turned on for your WorldServer database, run this: sp_dboption databasename To check whether Auto Update Statistics is turned on for a particular table, run this: sp_autostats tablename To turn on the automatic updates for all statistics in WorldServer database, if not already on, execute the following statement: USE master EXEC sp_dboption MyWorldServerDatabase, auto update statistics, true However,beawarethatthisoptionisnotafullsolution: It is possible that the statistics created by the auto-update may not be accurate enoughbecauseofthesamplerowsused.ifthetableinquestionisgreaterthan8 MB, when SQL Server automatically creates statistics for the table, it does not examine everyrow.instead,ittakesasampleoftheavailablerows.thissamplemayormaynotbe good enough to produce accurate enough statistics. One way to get better statistics is to manually update the statistics for the table using the UPDATE STATISTICS command, and using either the FULLSCAN or SAMPLE command options. If your SQL Server maintenance window allows for it, you should manually update statistics for all tables in your WorldServer database on a schedule that is suitable for you. This is because the auto-update option is less than perfect, and accurate and up-to-date statistics is so important to overall performance of SQL Server. Automating Reindexing WorldServer SQL Server indexes will become fragmented over time. Nearly all UPDATE, INSERT, or DELETE activity will cause indexes to become less well organizedthantheywerewhentheywerefirstcreated.therewillbemorepage splits,therewillbeagreaternumberofpageswithlessdataonthem,and consequently, there will be more I/O required to satisfy each SELECT. The more fragmented your data and indexes become, the slower your WorldServer applicationwillbe,andthemorespaceyourdatawilltakeup.soyouwillneedto reindex your WorldServer database on a regular basis. Basically, you can use the Database Maintenance Wizard to perform reindexing, 10 Installation and Upgrade Guide
WorldServer Installation and create Maintenance Plans to do the job. But there are some limitations. First, the reindexing done by the Maintenance Wizard will reindex everything, regardless ofwhetheritneedsitornot.ifyouhavealargeworldserverdatabasewithlarge tables and lots of indexes, indiscriminately reindexing the entire database will take longer than your available maintenance window. WorldServer can make available a maintenance script, rebuild_indexes. ms.sql, for figuring out which indexes need to be rebuilt above a requested scan density threshold and rebuilding only those ones. This script can also be added as a scheduled task, either as a standalone task or included as a step in existing maintenance jobs. Contact SDL Technical Support for assistance. This WorldServer script uses the following SQL Server 2005 commands. DBCC SHOWCONTIG command checks how fragmented an index is. For example: DBCC SHOWCONTIG ( dbo.tasks ) WITH FAST, TABLERESUL TS, ALL_INDEXES, NO_INFOMSGS DBCC DBREINDEX command rebuilds indexes for tables. For example: DBCC DBREINDEX ( dbo.tasks, taskpk) WITH NO_INFOMSGS Creating the SQL Server Database ThefirststepistocreatethephysicalSQLServerdatabase.ThisprocessrequiresaSQL Server user in the Database Creator role and should generally be performed by a DBA. 1. Start SQL Server Enterprise manager and connect to your SQL Server instance as a user in the Database Creator Role. 2. CreateanewdatabaseundertheSQLServerinstance.Donotincludeahyphenin your database name as this may result in issues during the database population process. You can optionally control the location of the default data file and transaction log for this database. For the best performance, these two files should be on different physical disks(for example, D: and E:) connected to different I/O controllers. 3. CreateanewuserthatwillbeusedbyWorldServer. Make sure that you assign this user the db_owner role for the WorldServer database. 4. Exit SQL Server Enterprise Manager. Installation and Upgrade Guide 11
WorldServer Installation Populating the Database Schema When the SQL Server database has been created, the database schema can be populated by following these instructions: 1. Copy the following scripts from the sql directory of your WorldServer distribution into a working directory(for example, C:\ws_install) on your SQL Server client machine: create.ms.sql setup.ms.sql create_sp.ms.sql create_tr.ms.sql 2. Start the SQL Server Query Analyzer and log on using the WorldServer database user. 3. Use the pull-down to change to the WorldServer database. 4. Load and execute create.ms.sql.. Youcandisregardany"MAXrowsizeexceeded"warningsyouseeintheoutputas they are expected. 5. Load and execute setup.ms.sql. 6. Load and execute create_sp.ms.sql. 7. Load and execute create_tr.ms.sql. 8. Exit SQL Server Query Analyzer. At this point, your database schema has been populated and can be used by WorldServer. Note: You should back up and maintain your database regularly. See the SDL WorldServer Basic Operations Guide for more information. You can now install WorldServer. Depending on your operating system, proceed to Installing WorldServer on Windows on page 18 or Installing WorldServer on Solaris orlinux onpage22. 12 Installation and Upgrade Guide
WorldServer Installation Setting Up an Oracle Database WorldServer can store all of its internal information(workflow definitions, terminology database, and so on) in an Oracle database. Setting up WorldServer to use Oracle is divided into two phases: Creating the Oracle instance and schema to hold the WorldServer data. Populating the schema with WorldServer content. These steps must be completed before installing WorldServer on the application server machine. Note:YoucannotcreateanORACLE11databasefromtheWSinstaller.Youwillbe notified in this respect by an error message. Each of these steps requires a different set of database permissions and is outlined separately. Prerequisites You must have an existing Oracle 10g or higher installation. You must have adequate permissions to access your Oracle instance and perform various operations. The section Creating the Oracle Instance and Schema lists the necessary permissions. Important: For Oracle to work with WorldServer, make sure that your LD_LI- BRARY_PATH variable contains the location of the Oracle RDBMS software libraries. Tuning the I/O Subsystem Disk I/O performance is the most important factor for good Oracle performance. Oracle is an intense user of I/O services and requires high performance disks to operate efficiently. Oracle recommends a highly distributed disk layout, as described in the chapter"optimal Flexible Architecture" in the Oracle Administration manual. SDL generally does not require as complicated a setup as Oracle describes. We have found that a single RAID0+1 array striped across 5 SCSI disks gives adequate performance for the Oracle database. However,ifyouhaveahigh-endinstallation forexample,youhaveveryhighload, many users, or many gigabytes of data you should consider splitting your data across disks. Oracle provides a large amount of documentation on how to set up an ideal deployment. Testing by SDL confirms that following these guidelines can yield performance improvements. For example, it is possible to increase the performance by distributing the UNDO and working tablespaces across different disks. Withatwodisksetup,forexample,youcouldhaveonediskcontainingtheworking tablespace and the other containing the UNDO tablespace. With a three disk setup, you could Installation and Upgrade Guide 13
WorldServer Installation havetheundotablespacestoredononediskandtheworkingtablespaceissplitintofiles residing on the other two disks. ThedecisionastowhetheryousplitthesecontentsbydiskorwhetheryouuseRAIDto distributethecontentforyouisuptoyouandwillvaryfrominstallationtoinstallation.the important point is that you want to spread the load across multiple disks. Tuning Memory Requirements Oracle requires a large amount of memory to run efficiently. Oracle recommends configuring the Shared Global Area(sga_max_size) to use 80% of the RAM available on the server. In our experience, you can achieve good performance for WorldServer if you makeatleast2gboframavailabletothecomputerthatservesastheoracleserver. Larger organizations should consider 4-8 GB of RAM. We also make the following recommendations: Retain the default settings for the Large Pool Size(large_pool_size) and the Java Pool Size(java_pool_size). Set the Shared Pool Size(shared_pool_size) to 30% of the remaining SGA size. SettheBufferCachesize(db_cache_size)totherestoftheSGAsize. Set the PGA(pga_aggregate_target) to 100 MB. Oracle will automatically managethesortareasizebasedonthis. Note: Oracle 10g has an automatic memory management option that allows Oracle to adjust the SGA parameters automatically based on the load. Enable the Automatic Shared Memory Management option and Oracle will manage things correctly. Search for Oracle Automatic Shared Memory Management to find several helpful whitepapers from Oracle and Oracle Certified Professionals. Oracle Connection Pool WorldServer uses a connection pool of JDBC connections. Connections are initialized at WorldServer startup and are shared by all threads within one WorldServer instance. Each connection consumes one Oracle connection process. The size of the connection pool is controlled by the general.properties setting: database_connection_ pool_size. Ensure that the Oracle processes parameter is set high enough to accommodate all running WorldServer instances connected to the database. For most small installations, the default number of processes should be sufficient. However, in a clustered environment, use this formula to determine the minimum value for the processes parameter: processes = (nodes in cluster x database_connection_pool_size )+ 10 14 Installation and Upgrade Guide
WorldServer Installation Adjusting these settings will eliminate nearly all Oracle performance problems. In the rare case that you need to perform additional tuning, contact SDL support. When the connection pool is exhausted, WorldServer threads will just block for a free connection, however long it takes for another WorldServer thread to finish what it is doing andreturntheconnectiontothepool.youmightseealotofblocking(whenthreadsare waiting for connections to become available) at times of heavy load, if the connection pool is configured too low, or if you already have the maximum connections to the connection pool. There is a sql.connectionpool logging category that can be turned on to show information about how WorldServer is using connections. This logging category shows whenconnectionsaretaken,whentheyarereturnedtothepool,howmanyfree connections there are at any point, when connections are exhausted, and which threads are holding connections when the pool is exhausted. YoucanturntheloggingcategoryonandoffusingaURLlikethefollowing: http://host:8080/ws/ws_gate?&token=<token>&action=log&level=de bug&category=sql.connectionpool http://host:8080/ws/ws_gate?&token=<token>&action=log&level=wa rn&category=sql.connectionpool Number of Cursors The recommended number of cursors should be: 10 * database_statement_cache_size database_statement_cache_size is configured in WorldServer general.properties. If, for example, database_statement_cache_size is 50 by default, we would recommend a maximum cursors setting for Oracle of 500. Under heavy load, when all connections are being used heavily, you might need to increase open_cursors; however, the recommended setting above should be sufficient in most cases. Note: WorldServer result sets are automatically closed after the result set is processed. Installation and Upgrade Guide 15
WorldServer Installation Creating the Oracle Instance and Schema The WorldServer installation process requires that an Oracle instance and schema has already been setup. This process requires full database permissions and should generally beperformedbyadba. Restriction: The name of the WorldServer database must be specified in ASCII characters only. Do not, for example, specify a database name in Kanji or Katakana. 1. Create an Oracle database instance using the Oracle Database Configuration Assistant. The Database Character Set must be a Unicode-based character set. Set the Database Character Set to AL32UTF8. TheNationalCharacterSetcanbesettoeitherUTF8orAL16UTF16basedonthe characteristics of the data you will be storing. See the Oracle documentation for recommendations on which encoding to use. 2. Startsqlplus,andlogonasaDBAuser(forexample,systemorsys)tocreatethe Oracle instance in which the WorldServer schema will reside. 3. (Recommended) Create a tablespace and a temporary tablespace to hold the WorldServer schema data. The data files for these two tablespaces should be on different hard disk spindles, ideally hooked up to different I/O controllers, for the best performance. 4. Enter the following to create a user(and the schema associated with that user): CREATE USER <username> IDENTIFIED BY <password>; If you created the tablespace and temporary tablespace above, use the following syntax: CREATE USER <username> IDENTIFIED BY <password> DEFAULT TABLESPACE <tablespace_name> TEMPORARY TABLESPACE <temporay_tablespace_name>; 5. Assign the following roles for the database user: connect resource 6. Grant the database user the following privileges: Create synonym Create view For Oracle 10g, you would commit a grant statement that includes the following: grant connect, create view, create synonym, resource to <username; 7. Exitsqlplus. 16 Installation and Upgrade Guide
WorldServer Installation Populating the Database Schema You must set up an Oracle instance and schema before beginning the WorldServer installation process. To populate the schema, follow these instructions: 1. Copy the following scripts from the sql directory of your WorldServer distribution into a working directory(for example, C:\ws_install or /tmp/ws_install): create.ora.sql setup.ora.sql create_sp.ora.sql create_tr.ora.sql 2. Log on via sqlplus to the WorldServer database using the WorldServer database user. 3. Run each of the scripts as follows: @ create.ora.sql @ setup.ora.sql @ create_sp.ora.sql @ create_tr.ora.sql commit; 4. Exitsqlplus. At this point, your database schema has been populated and can be used by WorldServer. Note: You should back up and maintain your database regularly. See the SDL WorldServer Basic Operations Guide for more information. You can now install WorldServer. Depending on your operating system, proceed to Installing WorldServer on Windows on page 18 or Installing WorldServer on Solaris orlinux onpage22 Installation and Upgrade Guide 17
WorldServer Installation Installing WorldServer on Windows The following steps describe installing WorldServer on Microsoft Windows. This section is primarily targeted at new installations on a clean machine configuration. Users who want to upgrade an existing installation of WorldServer should go to Upgrading WorldServer later in this document for upgrade instructions. Before you begin Before you begin: Ensure that the machine you are installing on meets the system requirements outlined in the Planning and Prerequisites Guide. If you intend to let WorldServer create the database, be aware that the WorldServer installer will only handle letters, numbers, and underscores in the password string. Do not use a password that contains other characters than these. If you are installing against a SQL Server database note the following: If you want to separate the database creation from the installation, you must have already created and populated the WorldServer database as described in Setting up a SQL Server Database. You must have a SQL Server client installed on the WorldServer machine. If you are installing against an Oracle database, you must have already created a populated WorldServer database as described in Setting Up an Oracle Database. If you are installing against an Oracle database, you must set the NLS_LANG system environment variable to American_America. UTF8 in the System Proper ties Environment tab. If you are using IBM WebSphere on Windows, do not install the WorldServer binaries into the default c:\program Files\Idiom\WorldServer directory or any other directory with spaces in the path. Instead, install them into something like c:\ws90.(there is a problem with the way WebSphere handles spaces.) Refer to Deploying WorldServer into IBM WebSphere. Note:ThenameoftheWorldServerdatabaseandthenameofthedirectoryintowhich you install WorldServer must be specified in ASCII characters only. Do not, for example, specify a database name or directory name in Kanji or Katakana. 18 Installation and Upgrade Guide
WorldServer Installation Procedure 1. If you are installing from a downloaded distribution: a. Unzip the distribution into a temporary directory. b. Use Windows Explorer to navigate to the WorldServer directory that was created. c. Double-click on the setup.exe file. 2. IfyouareinstallingfromaCD: a. InserttheCDintoyourCD-ROMdrive. b. Use Windows Explorer to navigate to the WorldServer directory on your CD-ROM drive. c. Double-click on the setup.exe file. 3. If you have a previous installation of WorldServer(for example, if you are upgrading toanewversion),youwillbepromptedtouninstallthatversion. Youwillalsobeaskedifyouwanttodeletethe WorldServerDB andthe RCS Files. Note:Uninstallingthedatabaseforapreviousversionwillcauseyoutoloseallof the data for that version including your users, workflows, translation memory, and translationdatabase.youshouldonlydothisifyouaredoinganewinstallandwantto remove any old work. 4. When the Welcome screen appears, click Next. 5. Click Yes to accept the License Agreement. 6. TypeyourusernameandcompanynameandclickNext. 7. Choose a location to install the WorldServer program files and click Next. Note:IfyouareaWebSphereapplicationserveruser,besurethatthepathinto whichyouinstallworldserverhasnospacesinit.donotacceptthedefaultpathof c:\program Files. Instead create a directory named something like c:\ws10 and browse to it in the SDL WorldServer Program Files Location dialog. 8. Choose an installation type. ThecustomoptionallowsyoutochoosealocationfortheWorldServerlogfiles,the RCS root, and the WorldServer temp directory. For performance reasons, SDL recommends that you put the log files and temporary directory on a different physical disk drive than the application server or database files. This will reduce I/O contention as WorldServer is running. Click Next. 9. Choose an application server and click Next. If you choose Tomcat, the installer silently installs Tomcat during the installation process and sets up WorldServer to work with this deployment. The WorldServer installer deploys the WorldServer Web application into <WS_HOME>\ tomcat\ webapps\ ws(where <WS_HOME> is the WorldServer home directory, by default C:\Program Files\Idiom\WorldServer). The installer creates a service Installation and Upgrade Guide 19
WorldServer Installation calledidiomprocessmonitorwhichyoucanusetostartandstoptomcat. IfyouchooseOther,theinstallerasksyoutobrowsetothedirectorywhereyouwant ittoplacetheworldserverwar(webarchivefile),whichyoucanthendeploy under your application server. Choose Other if: You want to deploy Tomcat manually(following the instructions in Deploying WorldServer into Apache Tomcat) Your application server is WebSphere(following the instructions in Deploying WorldServer into IBM WebSphere) 10. If you chose Tomcat, letting the installer deploy Tomcat, specify the port that the TomcatshouldlistenonandclickNext.Bydefault,theportis8080.SkiptoStep12. If you have multiple Tomcat installations on a single machine, the port number specified here is used by Tomcat for WorldServer. 11. If you are installing with WebSphere, or want to perform the Tomcat deployment manually, have WorldServer place ws.war in the <WS_HOME> directory. Later, to deploy ws.war, you will select this ws.war file and the application server will create adirectorynamedwsforthedeployment.thiswswillbethenameyouuseto connect in the browser URL(for example, http://<server>:8080/ ws/ login). Note:YoudonothavetohavetheWorldServerinstallerplacews.warin <WS_HOME>. You may install it wherever you like. However, you must know the path,becauseyouwillpointtoitwhenyouextractitscontents. 12. Choose a database platform, either SQL Server 2008 or Oracle, and specify the following: For SQL Server 2008: a. ProvidethenameofanexistingSQLServerdatabaseserverandaninstance to connect to. b. If you want the installation to create a physical database and populate the schema,selectthecreatedboptionandspecifythenameofthedatabase server and database to create. This is the normal option for a new installation. c. If you already have a physical database and schema populated, specify the nameofthedatabaseserveranddatabasethatyouwanttouseandde-select the Create DB option. Note: If you are doing an upgrade from a previous installation, de-select Create DB. Selecting Create DB with an existing database will cause the installation to fail. d. Specify the username and password that you want WorldServer to use when connecting to the database. 20 Installation and Upgrade Guide
WorldServer Installation Note: The WorldServer installer will only handle letters, numbers, and underscores in the password string. Do not specify a password that contains other characters than these. IfyouchosetheCreateDBoptioninthepreviousstep,thenyoumust specifyauserthatisinthe DatabaseCreator SQLServerrole. IfyoudidnotchoosetheCreateDBoptioninthepreviousstep,then youmustspecifyauserthatisinthe db_owner roleforthe specified database. e. Click Next. For Oracle: a. The installation requires that you have already created the physical database and that you have created an Oracle user with the appropriate permissions. For more information on what you need to do, see Creating the Oracle Instance and Schema. b. To populate the schema, specify the TNSNAME of the database. The TNSNAME can be found in tnsnames.ora in <ORACLE_HOME>\ network\ admin. Note: For a WorldServer installation, do not use the Create DB option for either a new or an upgrade Oracle installation. c. Specify the username and password that you want WorldServer to use when connecting to the database. This user must have runtime access to the database. Note: The WorldServer installer will only handle letters, numbers, and underscores in the password string. Do not specify a password that contains other characters than these. d. ClickNext. Note:Ifatthispoint,yougetafailuremessagethatthesystemaccountdoes not have sufficient privileges to create the database, the problem is not about thesystemaccount'sprivileges itismorelikelytobethatyoudidnot create the Oracle database user. You should follow the steps described in Creating the Oracle Instance and Schema, being sure to create the Oracle database user, and start the WorldServer installation again. 13. Select the Program Group that you would like the WorldServer shortcuts to go into and click Next. 14. Review your install choices and click Next. 15. When the files have been copied, click Finish. 16. Complete the deployment process for your environment, using the instructions in one of the following topics: Installation and Upgrade Guide 21
WorldServer Installation Important:IfyouchosetolettheinstallerdeployTomcatforyouinStep9,you have already finished the deployment process. Skip to Configuring WorldServer. Deploying WorldServer into Apache Tomcat. Deploying WorldServer into IBM WebSphere. 17. Choose to restart your computer now or later. You must restart before using WorldServer. Note: If you want to configure the application server that WorldServer is using to use SSL, consult the SSL setup instructions for the application server that they are using. Installing WorldServer on Solaris or Linux This section explains the steps necessary to install WorldServer on a Solaris or Linux server. Before you begin Ensure that the machine you are installing on meets the system requirements outlined in the SDL WorldServer Planning and Prerequisites Guide. Confirm that the Java 1.7 SDK is installed. Note:Tomcatrequiresjavacandjdbtorun.Therefore,youmusthavethefull Java SDK installed, not just the JRE. OnSolarisonly,ifyouwanttousetheRCSsoftwareforrevisioncontrolofassets in a file system mount, download and install GNU diff, available from http://www.gnu.org. You must install the GNU diff executable in the /bin/diff directory. Confirm the $JAVA_HOME environment variable is set and points to the Java SDK installation root. IfyouareinstallingagainstaSQLServerdatabasebutwanttoseparatethe database creation from the installation, you must have already created and populated the WorldServer database as described in Setting up a SQL Server Database. 22 Installation and Upgrade Guide
WorldServer Installation If you are installing against an Oracle database, you must have already created and populated the WorldServer database as described in Setting up an Oracle Database. Depending on your installation, you may need root access. Specifically: Ifyouwanttheapplicationservertolistenonaportlowerthan1024,the applicationserverwillneedtoberunasroot. If you want to install into a standard location(for example,/usr/local), you will need permissions to create the directory WerecommendcreatingaseparateUNIXlogintoownandmanagethe WorldServer processes. Creating this user may require root permissions. If you want to configure WorldServer to start automatically on reboot, you will require root access to install the necessary startup scripts. Restriction: The name of the WorldServer database and the name of the directory into which you install WorldServer must be specified in ASCII characters only. Do not, for example, specify a database name or directory name in Kanji or Katakana. Procedure 1. Logontothetargetmachineasroot.(Ifyoursystemissetuptoallowsudo,youmay be able to accomplish all of these instructions by prepending sudo to each command.) 2. Create a directory for the WorldServer installation, referred to throughout these installation instructions as <WS_HOME>: > mkdir /usr/local/idiom/worldserver 3. Createausertoowntheinstallation,andsettheuser shomedirectorytothisnew directory.thisisaconvenientwaytocollectalloftheworldserverassetsinasingle place and manage them. Dependingonhowyouhaveyournetworksetup,youmayeitherwanttocreatea localuseroryoumaywanttocreateanisuser.tocreatealocaluserrunthefollowing command as root: > useradd d /usr/local/idiom/worldserver wrldsrvr 4. Set the permissions on the directory such that the new user owns the directory. > chown R worldserver /usr/local/idiom/worldserver 5. Logoutasrootandlogonasthewrldsrvruser. 6. If you are installing from a CD, use the following instructions to copy the distribution offofthecd: Installation and Upgrade Guide 23
WorldServer Installation > cd /mnt/cdrom> cd distribution> cp ws10.1.x.*_unix.tar.gz /usr/local/idiom/worldserver Note:Theasteriskisusedherebecausethereisabuildnumberatthislocationin thefilename.youcanreplacetheasteriskwiththebuildnumberorusethecommand asis. 7. IfyouareinstallingfromtheFTPsite,downloadthefollowingfileandcopyitinto your installation directory: ws10.1.x.<build number>_unix.tar.gz Note:Donotdownloadthews.warfileatthetopleveloftheFTPsite.Acopyis included in the.zip distribution file. 8. Extract the contents of the WorldServer distribution: > cd /usr/local/idiom/worldserver> gunzip ws10.1.x.*_unix.tar.gz> tar xvf ws10.1.x.*_unix.tar 9. To enable the rcs(revision control system) application that WorldServer utilizes and various executables(for example, wstool and diff), perform the following from the solaris/bin directory: > chmod a+x * 10.Toensurethatyourenvironmentissetcorrectlyeverytimeyoulogon,SDLprovides asamplesetofloginscripts. Ifyourdefaultshellisintheshfamily,copythe.profilefilefromtheunix directory as follows: > cd /usr/local/idiom/worldserver> cp unix/.profile /usr/local/idiom/worldserver Ifyourdefaultshellisinthecshfamily,copythe.loginfilefromtheunixdirect ory as follows: > cd /usr/local/idiom/worldserver> cp unix/.login /usr/local/idiom/worldserver 24 Installation and Upgrade Guide
WorldServer Installation Youcanthenuseatexteditortomodifythecontentsofthisfileandprovidethecorr ect values for the WS_HOME, JAVA_HOME, and, if applicable, the ORACLE_HOME, XH IVE_HOME, and TZ environment variables. These scripts also define the path to the WorldServer binaries. 11.Youcantestthatthesenewscriptsareworkingasfollows: a. Logoutofthewrldsrvraccount. b. Log back in to the wrldsrvr account. c. Run the following command: > echo $WS_HOME If the scripts worked, the WorldServer installation directory should be displayed. 12. Complete the deployment process for your environment, using the instructions in one of the following topics: Deploying WorldServer into Apache Tomcat. Deploying WorldServer into IBM WebSphere. Note: If you want to configure the application server that WorldServer is using to use SSL, consult the SSL setup instructions for the application server that they are using. Also, see the Setting Up a Secure WorldServer Connection for External Users topic. WorldServer Deployments for Apache Tomcat WorldServer supports deployment under Apache Tomcat. WorldServer runs under Tomcat version 7, which SDL provides in the 3rdparty directory of the WorldServer distribution. Ensure that the machine you are installing on meets the system requirements outlined in the Planning and Prerequisites Guide. Deploying on Windows Before you begin The WorldServer installer on Windows will install Tomcat and deploy the WorldServer application for you. However, there may be situations that require a manual deployment (for example, in your testing environment). Installation and Upgrade Guide 25
WorldServer Installation Procedure 1. If you are installing from a CD, use the following instructions to copy the distribution offofthecd(assuming,here,thatthed:driveisyourcddriveandyouare installing in C:\Program Files\Idiom\WorldServer): > D:> cd distribution> cd 3rdparty> cd win32> copy apache-tomcat-7.0.42.zip c:\program Files\Idiom\WorldSe rver Now extract theapache-tomcat-7. 0.42.zip file into this WorldServer home directory. 2. If you are installing from the network, download apache-tomcat-7. 0.42.zip and extract its contents into your <WS_HOME> directory(where <WS_HOME> is the WorldServer home directory, by default C:\Program Files\Idiom\ WorldServer). 3. Set the CATALINA_HOME environment variable > set CATALINA_HOME=<WS_HOME>\tomcat 4. Copy the WorldServer WAR file from the WorldServer installation directory into the Tomcat webapps directory: > copy c:\program Files\Idiom\WorldServer\ws.war c:\program Files\Idiom\WorldServer\apache-tomcat-7.0.42\webapps 5. Navigate to apache-tomcat-7.0.42/ bin, and start Tomcat to extract the contents of ws.war. > cd c:\program Files\Idiom\WorldServer\apache-tomcat-7.0.42\b in> startup.bat Note: The startup.bat command requires that you have JAVA_HOME set to pointtotherequiredjavasdk(thatis,1.7).tosetittothejresuppliedbythesdl installer, use the following command: > set JAVA_HOME=%WS_HOME%\jre 26 Installation and Upgrade Guide
WorldServer Installation 6. When it starts up, Tomcat automatically unpacks the contents of the.war file. The Tomcat console displays a transcript like the following when the deployment is complete: Oct 12, 2013 9:34:30 AM org.apache.coyote.http11.http11base Protocol init INFO: Initializing Coyote HTTP/1.1 on port 8080... INFO: Starting service Catalina... INFO: Starting Servlet Engine: Apache Tomcat/7.0.42... INFO: Deploying web application archive ws.war... Oct 12, 2013 9:34:37 AM org.apache.catalina.startup.catal ina start INFO: Server startup in 21310 ms 7. When the unpacking is complete, shut down Tomcat so you can continue with the WorldServer configuration: > shutdown.bat Whattodonext At this point, the application has been deployed onto the application server and is ready to be configured. To configure WorldServer, see Configuring WorldServer. Deploying on UNIX Before you begin A UNIX deployment of WorldServer onto Tomcat is always a manual process, as follows. Procedure 1. If you are installing from a CD, use the following instructions to copy the distribution fromthecd: > cd /mnt/cdrom> cd distribution> cd 3rdparty> cp apache-tomcat-7.0.42.tar.gz $WS_HOME 2. If you are installing from the network, download the following file and copy it into your $WS_HOME directory: Installation and Upgrade Guide 27
WorldServer Installation apache-tomcat-7.0.42.tar.gz 3. Extract the contents of apache-tomcat-7. 0.42.tar.gz into the $WS_HOME directory: > cd $WS_HOME> gunzip apache-tomcat-7.0.42.tar.gz> tar -xvf apache-tomcat-7.0.42.tar 4. Copy the WorldServer WAR file into Tomcat: > cp ${WS_HOME}/ws.war ${WS_HOME}/apache-tomcat-7.0.42/weba pps Note:Thews.warfilewasplacedinthe$WS_HOMEdirectoryinStep8ofthe topic Installing WorldServer on Solaris or Linux. 5. Ensure that your environment is set correctly every time you log on by modifying your login scripts. Ifyourdefaultshellisintheshfamily,addthefollowinglinestothe/usr/ local/idiom/worldserver/.profilefile: CATALINA_HOME=${WS_HOME}/apache-tomcat-7.0.42 PATH=${CATALINA_HOME}/bin:${PATH} Iftheyourdefaultshellisinthecshfamily,addthefollowinglinestothe /usr/local/idiom/worldserver/.loginfile: > setenv CATALINA_HOME ${WS_HOME}/apache-tomcat-7.0.42> setenv PATH ${CATALINA_HOME}/bin:${PATH} Logoutandtheninforthesettingtotakeeffect. 6. Navigate to apache-tomcat-7.0.42/ bin, and start Tomcat to extract the contents of ws.war. Onthefirstrunyoumayneedtosetexecutepermissionsonthe.shfiles. > cd $CATALINA_HOME/bin> chmod 777 *.sh>./startup.sh 7. Tomcat automatically unpacks the contents of the.war file. When it is complete, shut down Tomcat to continue: 28 Installation and Upgrade Guide
WorldServer Installation >./shutdown.sh Whattodonext At this point, the application has been deployed onto the application server and is ready to be configured. To configure WorldServer, see Configuring WorldServer. WorldServer Deployments for IBM WebSphere WorldServer supports deployments onto IBM WebSphere for both Windows and UNIX operating systems. Note: This section supports IBM WebSphere 7.0. Prerequisites You have installed the WebSphere 7.0 application server as documented in the WebSphere Application Server V7 Administration and Configuration Guide. You have applied the latest WebSphere patches from the IBM WebSphere Application Server Support site. You have started the WebSphere application server. The WebSphere installation folder will be referred to as <WAS_HOME> throughout this guide. For Windows installations, <WAS_HOME> is a path like C:\ws10\ WebSphere\AppServer. Deploying on Windows If you are deploying WorldServer in a WebSphere application server on Windows, you will use two base folders: WS_HOME The folder into which you install the WorldServer binaries(for example, c:\worldserver) WAS_HOME Your WebSphere application home directory(for example, c:\ws10\websphere\appserver) You perform several preliminary steps before deploying on WebSphere 7. Create the WorldServer File Structure Create a folder for the WorldServer installation and build the following structure under it: C:\worldserver- Root folder for this instance, referred as <WS_HOME> \ws WorldServer WAR will be unpacked(deployed) here Installation and Upgrade Guide 29
WorldServer Installation \bin WorldServer binaries \logs WorldServer logs are stored here \rcs WorldServer RCS repository \temp WorldServer temporary folder Make the WorldServer Binaries Available to the WebSphere Installation IfyouarerunningWebSphereonWindows,youneedtoensurethatanumberofbinaries are available to the application server. Locate the binary files on the win32\bin folder of the distribution and copy them under <WS_HOME>\bin. Make these binaries available to the WebSphere installation by adding <WS_HOME>\bin directory to the PATH environment variable for the user that the application server will be running as. WebSphere 7 Before you begin After you have performed the preliminary WebSphere Windows procedures, use the instructions for deploying WorldServer into WebSphere 7 or later. Procedure 1. Log on to the WebSphere Admin Console. 2. Inthepanelontheleftside,expandtheApplicationstreeandclickontheInstall New Application link. 3. On the main screen click the Browse button to locate the WorldServer build. Pick the ws.war file that can be found under <WS_BUILD>\ folder. 4. IntheContextRoottextfield,enter/wsandclickNext. 5. On the Select installation options screen, on Step 1: Select installation options provide the Application Name(for example, WorldServer), leave the other fields without changes, and click Next. Note:Ifyouwanttoinstalltheapplicationintoaspecificfolderenterthepathinto the"directory to install application" field. By default the application will be installed into: <WebSphere_installation_folder>\AppServer\profiles\AppSrv01 \installedapps\ <Host_Name>Node01Cell\WorldServer.ear\ws.war\ 6. Onthe Mapmodulestoservers screen,onstep2:mapmodulestoservers,check the box next to Idiom WorldServer and click Next. 30 Installation and Upgrade Guide
WorldServer Installation 7. Onthe MapvirtualhostsforWebmodules screen,onstep3:mapvirtualhosts forwebmodules,checktheboxnexttoidiomworldserverandclicknext. 8. Onthe Summary screen,onstep4:summary,clickfinishandwaituntilyousee the Application WorldServer has installed successfully message. 9. Click the Save link and wait until the save operation finishes. 10. To ensure that email notifications work: a. StillintheWebSphereAdminConsole,ontheleftsidepanel,expandthe Applications tree and click the Enterprise Applications link. b. Click the link for the WorldServer application. c. Click the Class loading and update detection link. d. Set Class loader order to"class loaded with application class loader first." e. Set WAR class loader policy to"single class loader for application. f. Set Polling interval for updated files to 600 seconds. g. ClickOK. h. Save directly to the master configuration. 11. At the file system level, copy the jasper.jar and tomcat-juli. jar files from the root of the WorldServer deployment location to the WEB-INF/lib directory. Whattodonext Restart WebSphere. You are now done with the WebSphere Admin Console part of the deployment. Deploying on UNIX If you are deploying WorldServer in a WebSphere application server on Unix, you must first prepare the location where WebSphere is going to unpack the WorldServer WAR file. For example: > cd $WS_HOME> mkdir ws WebSphere 7 Before you begin After you have performed the preliminary WebSphere UNIX procedures, use these instructions for deploying WorldServer into WebSphere 7. Installation and Upgrade Guide 31
WorldServer Installation Procedure 1. Log on to the WebSphere Admin Console. 2. In the Preparing for the application installation screen, on the left side panel, expand the Applications tree and click on the Install New Application link. 3. On the main screen click the Browse button to locate the WorldServer build. Pick the ws.war file that can be found under <WS_BUILD>/folder. 4. IntheContextRoottextfield,enter/wsandclickNext. 5. On the Select installation options screen, on Step 1: Select installation options provide the Application Name(for example, WorldServer), leave the other fields without changes, and click Next. Note:Ifyouwanttoinstalltheapplicationintoaspecificfolderenterthepathinto the Directory to install application field. By default the application will be install into: <WebSphere_installation_folder>/AppServer/profiles/AppSrv01 /installedapps/ <Host_Name>Node01Cell/WorldServer.ear/ws.war/ 6. Onthe Mapmodulestoservers screen,onstep2:mapmodulestoservers,check the box next to Idiom WorldServer and click Next. 7. Onthe MapvirtualhostsforWebmodules screen,onstep3:mapvirtualhosts forwebmodules,checktheboxnexttoidiomworldserverandclicknext. 8. Onthe Summary screen,onstep4:summary,clickfinishandwaituntilyousee the Application WorldServer has installed successfully message. 9. Click the Save link and wait until the save operation finishes. 10. To ensure that email notifications work: a. StillintheWebSphereAdminConsole,ontheleftsidepanel,expandthe Applications tree and click the Enterprise Applications link. b. Click the link for the WorldServer application. c. Click the Class loading and update detection link. d. Set Class loader order to"class loaded with application class loader first." e. Set WAR class loader policy to"single class loader for application. f. Set Polling interval for updated files to 600 seconds. g. ClickOK. h. Save directly to the master configuration. 11. At the file system level, copy the jasper.jar and tomcat-juli. jar files from the root of the WorldServer deployment location to the WEB-INF/lib directory. Whattodonext Restart WebSphere. You are now done with the WebSphere Admin Console part of the deployment. 32 Installation and Upgrade Guide
Chapter 3 Properties Files WorldServer reads many system settings from configuration(.properties) files that are installed inside the WorldServer application server. For WorldServer to function properly, these settings must be configured correctly before starting the application server. Note: If you are upgrading or updating WorldServer, you merge any customizations you have made in your pre-upgrade files into the new properties files before you re-start the application server. Configuring Mandatory general Before you begin The general.properties file contains values you must change to configure WorldServer properly. Note: When installing WorldServer using the Windows installer in a Tomcat environment, all configurations specified during the WorldServer installation process are written to the registry(in HKEY_LOCAL_MACHINE/ SOFTWARE/ Idiom/ WorldServer/ Config). Therefore, if you installed WorldServer with the Windows installer, you do not have to make these mandatory edits in general.properties. However, general.properties contains other settings you might want to configure. See the Other Settings in general.properties topic. Configurations in the registry take precedence over any configurations in the general.properties file. If you want to use the general.properties file instead of the registry entries, you will need to clear out these registry settings first. Procedure 1. On the WorldServer machine, navigate to the WEB-INF/ classes/ config directory of the exploded Web application to find the general.properties file. Below are some possible locations of this file: If WorldServer is running on Windows under Tomcat, the general.properties file is typically located in: Installation and Upgrade Guide 33
Properties Files c:\program Files\Idiom\WorldServer\tomcat\webapps\ws\W EB-INF\classes\config If WorldServer is running on UNIX under Tomcat, the general.properties file is typically located in: /usr/local/idiom/worldserver/tomcat/webapps/ws/web-inf /classes/config If WorldServer is running on Windows under WebSphere, the general.properties file is typically located in: <WAS_HOME>\WebSphere\Appserver\installedApps\ <ComputerName>\WorldServer.ear\ws.war\WEB-INF\classes\ config If WorldServer is running on UNIX under WebSphere, the general.properties file is typically located in: <WS_HOME>/ws/WorldServer.ear/ws.war/WEB-INF/classes/co nfig 2. In UNIX environments, WorldServer looks for the general.properties in the following directories(listed in preferential order): a. ~user/etc(the home directory of the user that the application server is running as). b. /usr/local/idiom c. /etc/idiom d. <TOMCAT_HOME>/webapps/ws/WEB-INF/classes/config SDL strongly recommends that you copy the general.properties file from its original location under the application server into one of these other locations. In particular,eachtimeyoudeployanewversionofthewarfile,thecontentsofthe application server directory will be overwritten and you will lose any changes to your general.properties file. 3. Open general.properties with a text editor. 4. If WorldServer is connecting to a Microsoft SQL Server database, change the following entries in the general.properties file: # JDBC driver configuration # MS SQL Server #database_driver=com.idiominc.jdbc.sqlserver.sqlserverdri ver #database=jdbc:idiom:sqlserver://host:1433;databasename=dat abase a. Removethecommentfromthelasttwolinesbyremovingthe#before database. 34 Installation and Upgrade Guide
Properties Files b. In the last line, insert the appropriate URL connection string. The generic URL connection string for a SQL server database instance is: jdbc:idiom:sqlserver://<dbservername>\\<instance if any>:<port if any>;databasename=<dbname> Note: The double-backslash is required in the general.properties file,butnotintheregistry. Forexample,iftheSQLServerdatabaseservernameiswsdataandthe database name is worldserver, then the entire section would read: # JDBC driver configuration # MS SQL Server database_driver=com.idiominc.jdbc.sqlserver.sqlserverd river database=jdbc:idiom:sqlserver://wsdata:1433;databasena me=worldserver 5. If WorldServer is connecting to an Oracle database, change the following entries in the general.properties file: # Oracle #database_driver=com.idiominc.jdbc.oracle.oracledriver #database=jdbc:idiom:oracle://host:1521;sid=database a. Uncomment the last two lines, by removing the# before database. b. In the last line, insert the appropriate URL connection string. The generic URL connection string for an Oracle database instance is: jdbc:idiom:oracle://<dbservername>:<port if any>;sid=< dbname> For example, if the Oracle database server name is wsdata and the database name is worldserver, then the entire section would read: # JDBC driver configuration # Oracle database_driver=com.idiominc.jdbc.oracle.oracledriver database=jdbc:idiom:oracle://wsdata:1521;sid=worldser ver 6. EnterthenameofthedatabaseuserthatWorldServershouldusetoconnecttothe database in the database_user line. For example: database_username=worldserver Installation and Upgrade Guide 35
Properties Files 7. Enter the password for this user in the database_password line. The password portion of the general.properties configuration requires an encrypted string. To create this string execute the following to command from the WorldServer installation directory: java -jar PasswordTool.jar <plaintext password> This will return an encrypted password. For example, a password of transl8 results in the string 4YmA6aCE4aS47buB67qc67uB4YiM. Copy this string into the general.properties file. For example: database_password=4yma6ace4as47bub67qc67ub4yim 8. Change temp_file_path entry to specify the appropriate path for the WorldServer temporary directory. This should be on a separate physical drive from the rest of the WorldServer installation, for I/O performance. For example: or # Temp directory temp_file_path=c:/temp # Temp directory temp_file_path=/tmp Note:Whenspecifyingthepath,aforwardslash(/)mustbeused,evenina Windows environment. Make sure you have not accidentally added a tab symbol at the end of the parameter. This symbol is invisible in editor but may cause WorldServer toreadtheparameterincorrectly.thisnoteappliestosteps10and11aswell. 9. In addition to the temp_file_path entry, search for other entries related to storage and shared folders to make sure you have adequate space to operate WorldServer. These entries include file_attribute_storage, background_file_storage, and ftsserver_shared_directory. Unless you specify a different location for these entries, they default to a sub-folder of temp_file_path. Note:IfyouareusingtheFTSserver,beespeciallyawareoftheftsserver_ shared_directory entry. Typically the FTS server copies the source assets of Studio file types to this working directory for processing. It therefore needs the same amount of disk space as the original source assets. 10.IfyouareusingRCSVersionControl,changethefollowingentrytospecifythe appropriate path for the root RCS directory: # RCS root. Repository used for version control information rcs_root=c:/rcs 36 Installation and Upgrade Guide
Properties Files or # RCS root. Repository used for version control information rcs_root=/rcs 11. Change the following entry to specify the appropriate path for the WorldServer log file: or # Log file for WorldServer log log4j.appender.logfile.file=c:/program Files/Idiom/WorldServ er/idiomlogs/wslog.txt # Log file for WorldServer log log4j.appender.logfile.file=/usr/local/idiom/worldserver/lo gs/ws.log Configuring Other general.properties Settings Before you begin In addition to the settings you must make in general.properties, there are other settings that will improve your WorldServer experience, whether you installed WorldServer with the Windows installer, or you installed it manually. Procedure 1. Locate the line with url_of_origin and change the placeholder to include the URL to the root of the WorldServer application under the application server. For example, this could look like: url_of_origin=http://worldserver.company.com:8080/ws This URL is used in various places in WorldServer, such as within email notifications andintranslationkits.thehostnameintheurlshouldbeahostthatisresolvable and accessible by any translators who will have online access to WorldServer. You sho uldnotuselocalhostoranipaddressasthehostname.ifyoudonotsetthis,yourtransl atorswillhavetomanuallysetthisintheirclienteverytimetheywanttouploadaprojectback to the server. 2. WorldServer encodes file names in the zip archive using UTF-8 encoding. Some localized versions of Windows use different encodings to read the zip archive. If the encodings donotmatch,theextractedfilenamesmaybecorrupt.toavoidtheissueconfigure WorldServer to use the same encoding used by your localized system. Search for zip_encoding, and change from the default(utf-8) to the encoding of your local system. For example, for Kanji or Katakana use MS932. The default Windows Zip compression does not supportutf-8andsoshouldnotbeused. Installation and Upgrade Guide 37
Properties Files 3. By default, attachment attributes are stored under the WorldServer temp directory. You can configure WorldServer to store these wherever you want.(you might not want them stored in the temp directory because that directory gets cleaned up periodically.) To configure WorldServer to store these attachments elsewhere, find the commented out line for file_attribute_storage in general.properties, and specify a suitable location. If you are using WorldServer in a clustered environment, all machines in the cluster must have access to this location. The line to uncomment(and modify) is: # file_attribute_storage=c:/shared/attributes 4. The property session_client_check, called at login, enforces that a session can only be used by the client who created the session. When the check is enabled, WorldServer tracks theclientbrowserandtiesittotheworldserversessionthebrowserhascreated.ifthesame URLisusedfromanotherbrowserthesessionisconsideredinvalidandtheuserisforcedto login. The client check requires the browser to accept cookies. 5. The property calculate_segment_length_in_bytes controls whether WorldServer measures segment length in bytes or characters. By default the length is measured in characters. Set this property to true to enable byte length calculation. The property is only applicable to maximum segment length limit functionality. That is, it works in combination with the property setting for maximum_target_length_penalty, which you set in tm.properties. For information on maximum_target_length_penalty, see the WorldServer Translation Memory Administration Guide. The line to uncomment(and modify) is: #calculate_segment_length_in_bytes=false 6. The property adhoc_asset_timeout schedules the removal of obsolete data from your database when you create translation jobs from WorldServer Explorer. By default this setting is disabled(set at zero days). 7. The property enable_live_translation_memory lets WorldServer operate in live TMmode,whichaddsandtracksentriestotheTMduringthetranslationprocess.SDL recommends enabling live TM mode, which is disabled by default. See the Translation Memory Administration Guide for more information. Whattodonext In addition to these properties, general.properties contains properties for doing things like the following: Configuring links in the WorldServer Home page. Configuring the way WorldServer is used in a cluster, with some machines serving as workflow engines and others as background processing engines. See the SDL WorldServer Planning and Prerequisites Guide for more information. Configuring the URL of the reporting engine. Configuring recurrence and notification engines. SDL recommends that you read the comments in the general.properties file to see the range of properties available. 38 Installation and Upgrade Guide
Properties Files Configuring Clustered Mode Properties Clustered WorldServer application machines share a database. Settings in the general.properties file on each system tell WorldServer how to handle clustered activities. Indicating How Many Engines to Create The key to determining whether a particular server is seen as a workflow engine machine, a background processing machine, or both, is found in the general.properties file, in the following settings: workflow_daemon background_daemon The values of these settings determine the level of concurrency for either engine: Avalueof0meansthattheengineisdisabledonthismachine. For example, the following settings: workflow_daemon=1 background_daemon=0 means that the background_daemon is disabled on this machine, and there is one workflow engine on this machine. Avalueof1(thedefault)meansthatthereisasingleengineofthattyperunning onthismachine.eachenginecanhandleonetaskoronejobatatime. Avalueof2meansthattherearetwoenginesofthattyperunningonthismachine andthattwotasksorjobscanberuninparallel. Fastest performance is achieved by assigning approximately the same number of engines as the number of CPUs. In dual-cpu application servers, set the number of enginesto2or3. To create one or more dedicated WorldServer application machines, first install WorldServer on each of the machines using the standard WorldServer installation instructions, but do not create a new WorldServer database for each installation. Make sure that each server points to the same WorldServer database. Then, set the workflow_daemon and background_daemon settings in general.properties to 0 on each of these machines. This will disable the workflow engine and background engineonthesemachinesandensurethatthemachinescanbededicatedtothe WorldServer application. Whether you have multiple engines on a single machine or multiple engines on separate machines,thescalingworksthesameway.eachenginelooksforataskorjobthatitcan execute.ifitfindsone,itclaimsit,executesit,andthenmovesontothenextone.atany giveninstanteachengineiscapableofhandlingonlyasingletaskorjob,andasingle taskorjobcannotbesharedacrossmultipleengines.iftherewasoneverylargetaskor job,youwouldseeasingleengineprocessingitandallotherengineswouldbeidle.onthe otherhand,foralargenumberoftasksorjobsandmultipleengines,youwouldseeeach oftheenginesclaimingtaskstoprocessoneatatime. Installation and Upgrade Guide 39
Properties Files Providing a Clone Name WorldServer provides several dialog boxes that display information about the tasks and background jobs that are executing or that are waiting to execute. On these dialog boxes, an Assigned To column identifies the specific workflow or background engine on which a taskorjobisrunning,inthefollowingformat: host-name:[clone-name:]engine-number where: host-nameisthenameoftheserver clone-name indicates the instance of WorldServer if you are running in a cluster, that is, cluster_environment= true. Otherwise, clone-name is not displayed. Theinstancescanberunningonasingleserverormultipleservers.Ifyoudonot provide a clone name, WorldServer displays a unique hash-code to identify the clone. engine-number is a number assigned to each running workflow engine in each WorldServer instance. To provide a human-readable name for a clone-name, change these properties in the general.properties file: Set cluster_environment to true Set the clone_name property. For example, for a two-machine cluster, you might set one s name as follows: clone_name=juliet Then,ontheothermachine,you dsetthenameasfollows: clone_name=romeo The Assigned To column will now display the names you ve assigned instead of the internally-generated codes. 40 Installation and Upgrade Guide
Properties Files Specifying a Location for Files Related to Background Processing For each job, WorldServer stores files related to background processing, specifically the logfileandanytemporarydatafilesrelatedtothejob.sevendaysaftercompletingor canceling the job, the WorldServer garbage collection feature deletes the files. Bydefault,thefilesarestoredinthetempdirectoryofthesystem,in temp_file_path/background/ BackgroundProcess_<process ID>. You can change the storage location by changing the value of the background_file_storage property in general.properties. For example, background_file_storage = c:\worldserver\background-jobs resets the storage area to the directory: c:\worldserver\ background-jobs. Note: WorldServer must be stopped before the background_file_storage property setting is changed, and all the contents of the previously configured folder must be manually copied over to the newly configured folder before WorldServer is restarted. Otherwise,WorldServerwillnotbeabletolocatethedatafilesorlogfilesofalready existing background processes(and will attempt to recreate log files for them). You can configure date formats used for background process logging. Change the background.process.log.datetimeformat in WEB-INF/ classes/ config/ strings.properties. The default configuration is as follows: # This determines how dates are formatted in background process log files. background.process.log.datetimeformat=yyyy-mm-dd hh:mm:ss,sss Sharing Files in a Clustered Environment If you are working in a clustered environment, the background_file_storage property must point to one directory that is shared across the cluster by all WorldServer instances. If WorldServer is running on multiple servers, make sure that this directory is shared by, and accessible to, all the WorldServer servers in the cluster. For a clustered environment, configure a common accessible fileshare location for each node in the cluster. On Windows systems, which are running WorldServer as a system service, use Universal Naming Convention(UNC) paths to specify the background fileshare for clustered environments, for example: background_file_storage=//hosting_machine/background_share Note: The forward slashes in UNC paths are extremely important. Using UNC pathnames is a requirement if you are running Microsoft Windows XP or Installation and Upgrade Guide 41
Properties Files Windows Server 2003. OnWindowsNTandWindows2000,thisrequirementisrelaxedandyoucanusemapped network drive letters instead of UNC paths. Drive letters on different nodes in the cluster donothavetomatch,buttheymustallpointtothesamefilesharelocation. Alocalfilepathmaybeusedonlyforthemachinehostingthebackgroundfilestorage,if the machine is a member node in the cluster. Also, ensure that necessary read/write permissions are granted so that all background processes on each node in the cluster can read and write both from and to the background file storage location. Working With Other Daemons The following settings in general.properties control startup of the Recurrence and Notification daemons: recurrence_engine=on notification_engine=on These daemons are required by workflows for time scheduled processing and automatic notifications. The Recurrence and Notification engines can be switched off by setting the corresponding property to off. Note that switching the Recurrence engine off also disables the garbage collection process. Unlike the WorldServer application or the workflow engine, the Recurrence and Notification engines do not process requests in parallel; there is only one active Recurrence Engine or Notification Engine at any given time. If you have multiple installations with these engines enabled, the engines simply share the work among the different instances in aserialmanner.hence,thereisnobenefittohavingalargeclusterofmachinesinwhich these are turned on. However, you can enable these engines on multiple machines to get automatic failover: if one of the machines needs to be brought down, the other machine willtakeoverthetasks.thus,itisagoodideatohaveatleasttwomachineswiththese engines enabled. Other Properties Files During your configuration of WorldServer, you are likely to modify the following files, in addition to those already described. After modifying these files, you should back them up,soyoucanrestorethemifyouneedtolater,forinstance,ifyouupgradetoafuture release. tm.properties see the WorldServer Translation Memory Administration Guide. The property scoping_mode lets customers who have upgraded from a pre-10.0 version of WorldServer, specify whether legacy WorldServer 9.x or Studio-aligned scoping mode and leverage implementation is used for translation projects or ad-hoc translation jobs. Permitted values are wor ldserver9x or studio. 42 Installation and Upgrade Guide
Properties Files Note: For version 10.0.0 or later installations, the legacy worldserve r9x option will not be available. Translation memory(tm) mode mechanisms let you specify date and time replacements, and number and measurement replacement options. To find the settings that apply to the Studio-aligned TM mode introduced in version 10.0.0, search for entries that start with STUDIO_. The enable_preserve_tm_entry_identifiers property should be set to True to preserve the translation memory(tm) entry identifiers whe neverthetmentryisupdated.bydefaulttmentryidentifiersaremuta ble; they change whenever the TM Entry is updated. SentenceBreaker. properties and WordBreaker. properties see WorldServer Translation Memory Administration Guide. exchange.properties A Java properties file that allows you to configure behaviors of the WorldServer Import and Export functions. See the File Properties appendix in the WorldServer Administrator Guide. Installation and Upgrade Guide 43
Properties Files 44 Installation and Upgrade Guide
Chapter 4 Report Center The WorldServer Report Center(Tools > Report Center) includes a reporting engine called JasperReports Server Enterprise. The same is used for the four reports available to youintheworldserverdashboard,whichyoucanseerightafteryoulogontothe application, on the Home page. This chapter describes the requirements, set up, and installation procedures for the JasperReports Server(JRS) as well as uploading the reports repository. You must upload and deploy the separate reports repository to use this reporting option. For information on Report Center, see the WorldServer Reporting chapter of the WorldServer User Guide. For information on JasperReports, see the documents in the...\integrations\jaspersoft_5.2.0\ jasperreports-server-5.2.0-bin\ docs folder, which is available when you unzip the jasperreports-server-5. 2.0-bin.zip file in the WorldServer distribution. This chapter refers to information in the JasperReports Server Installation Guide available in that folder. Licensing The JasperReports Server Enterprise license included in WorldServer may ONLY be used with WorldServer. Any other use of JasperReports is in violation of the Terms and Conditions of your WorldServer license agreement with SDL plc. JasperReports Server Installation Overview The WorldServer installation procedure for the JasperReports Server modifies the Jaspersoft instructions somewhat, to support WorldServer features. When you install the JasperReports Server(JRS), note the following points about a WorldServer-specific installation: Installation and Upgrade Guide 45
Report Center The installation procedure does not bundle all steps into a single bundled installer. You must follow the steps in the JasperReports Server Installation Guide, followed by the WorldServer installation steps, to complete the integration with WorldServer. WorldServer has been tested against a JRS installation which resides on the same application server as WorldServer, and which uses the same database server as WorldServer. Note: WorldServer does not use a bundled MySQL(or PostgreSQL) server to store the JRS repository. JRS is licensed software. A license is included with the installation. Installation Summary Complete these general steps(detailed in separate topics) in order to install JRS, including any changes to the WorldServer general.properties file. Otherwise JRS may throw an exception when you navigate to Tools > Report Center. Install the JasperReports Server. Use the WAR deployment method described in Chapter 5 of the JasperReports Server Installation Guide. Note: JRS should be installed to run against the same database as WorldServer. Note: Use the instructions for a minimal installation, to avoid installing unnecessary sample databases. Import the JRS repository. Connect WorldServer to JRS for setting up the single sign-on feature. Connect JRS to WorldServer by setting the data source. Log in to WorldServer as an Administrator. Test and verify the installation. 46 Installation and Upgrade Guide
Report Center JRS Installation Prerequisites Before you begin the JRS installation, you need to prepare for the process. Know where your application server(tomcat/websphere) is installed, how to configure it, and how to deploy new web applications. You need write permissions for various folders/locations in your application server deployment. Make sure you have write permissions for WorldServer's configuration files. Know the location and login credentials for the WorldServer database server. Note: The JRS data resides in a separate database instance on the same database server as WorldServer. Go to the integrations\ JasperSoft_5. 2 folder, which is included in the WorldServer ZIP file(for Windows) and TAR file(for Linux/Solaris). Locate the following two ZIP files in that folder. The JRS files enabling JasperReports, jasperreports-server-5. 2.0-bin.zip The reports repository, jrs_repository. zip Platform Notes For the WorldServer installation there are various differences in the procedures described in the JRS documentation. In all cases, note the following: Follow the instructions in Chapter 5 of the JasperReports Server Installation Guide through Section 5.2 In all cases, when you run the js-install.bat or js-install.sh script, only install the minimal configuration. This avoids installing sample data that does not apply to WorldServer. For example, on Windows the command would be jsinstall.bat minimal Backup the current JasperServer database and then move <tomcat_path>/ webapps/ jasperserver-pro to a backup location. Unpack jasperreports-server-5. 2-bin.zip to the <js-install> path, and then copy <js-install>/buildiomatic/sample-conf/sqlserver_ master. properties to <js-install>/ buildiomatic and rename to default_master. properties and set the properties in default_master. properties according to your configuration Stop Tomcat 7 and run <js-install>/buildiomatic / js-upgrade-newdb.bat input-zip c:/js-421-export.zip. ThefirsttimeyouopenJasperReportswilltakelongerasitwillupgradethe repository Start Tomcat 7 and open JasperReports in the browser: http://localhost:8080/ jasperserver-pro/ login.html. Use Installation and Upgrade Guide 47
Report Center the superuser/superuser credentials to log on to the application, and then open general.properties and set the report_center_url accordingly Whenfinished,restartTomcat7,gotoView>Repositoryandthenbrowseto <root> Organizations > Worldserver > DataSources. Then, edit the Worldserver database and configure the proper SQL credentials to see the reports from WorldServer Tools > Report Center The Jaspersoft documentation refers to changing JVM parameters to run JRS (section 6.2.1 in the JRS install guide). Though the install guide states this is required, existing Tomcat deployments may already have specific settings that should not be changed. In general the WorldServer development team does NOT adjust the JVM parameters; use your own judgement about applying these settings. Note: The superuser account has higher rights than the administrator, enabling you to access all Jasper features and functionalities. The following sections provide more information for different platforms. Linux/Solaris Permissions On Linux and Solaris installations, after you unzip the jasperreports-server-5. 2.0-bin.zip file, be sure files in the following directories are executable: buildomatic If necessary, run chmod u+x <js-install>/buildomatic/*. buildomatic/bin If necessary, run chmod u+x <js-install>/buildomatic/bin/*. apache-ant/bin If necessary, run chmod u+x <js-install>/apache-ant/bin/*. Windows7withaWindows2008Server When you install JasperReports on Win7/Win2008 Server, start a cmd shell as administrator so you can perform the installation. If you edit configuration files in C:\Program Files (x86) or C:\Program Files, your editor also must run as administrator. Otherwise anychangesyoumakewon'tshowupintheactualfile,andyouwon'tgetan error message warning you of the problem. 48 Installation and Upgrade Guide
Report Center Microsoft SQL Server Oracle The database user you choose for installing the JRS repository must have permission to create databases(dbcreator may suffice, we used sysadmin). You may want to revoke sysadmin permissions after installation. YoucannotputtheJRSdataintothesamedatabaseWorldServerisusing.They canliveonthesameserver,butcan'tshareaschema. Note the following about the Chapter 5 of the JasperReports Server Installation Guide instructions for Oracle. ThereisnomentionoftheOracle SID parameterinthejrsinstallguide,but the property sid does appear in the oracle_master. properties file. If you are using a non-default SID on your target Oracle database(default is orcl), adj ust the sid property as required. Inpracticewehavefoundthatyoudonothavetodefinethe sysusername and syspassword properties in the default_master. properties file for Oracle. They can be removed completely from the file. As described in the JasperReports Server Installation Guide, you can separate the creation of the Oracle database schema from the rest of the server installation. This eliminates anyneedtoenterthesysdbausernameandpasswordintothe default_master. properties file. The JRS installation creates a jasperserver schema instance by default, with the password password. Application Server Notes For WorldServer environments, you can install the JasperReports Server on two application servers: Tomcat and WebSphere. Installation and Upgrade Guide 49
Report Center JRS Install on Tomcat Refer to Chapter 5 of the JasperReports Server Installation Guide to install JasperReports on Tomcat. Obtain the file jasperreports-server-5. 2.0-bin.zip(located in the WorldServer ZIP or TAR file). FollowthestepsinChapter5toinstallusingtheWARfiledistribution,withthe minimal qualification. You ll need to know information such as your Tomcat location and your database information. JRS Install on WebSphere Refer to Chapter 5 of the JasperReports Server Installation Guide to install JasperReports on WebSphere. Use the binary installer js-install.bat(with the minimal qualification). WebSphere must be running when running the installation script. Note: After you run the js-install.bat script, copy the WEB-INF/ classes/ themes/ default.properties file to WEB-INF/ classes/ theme.properties in order to display reports. Enabling Single Sign-on for JRS About this task To avoid having to pass through the JasperReports login screen to access the reports, you must use your WorldServer authentication by enabling single sign-on capability. Procedure 1. Ensure that the application server is not running. 2. Locate the%catalina_home%/ webapps/ jasperserver-pro/ WEB-INF/ applicationcontext-worldserver. xml file. 3. Edit the WSSingleSignOnFilter bean in this file to use the WorldServer properties that matches your WorldServer installation. These properties are: The WorldServer URL The hostname The port The WorldServer context root 50 Installation and Upgrade Guide
Report Center 4. Edit the report_center_url entry provided in the general.properties file to point to your JasperServer location. Substitute your actual hostname for the worldserverhost variable. Substitute your actual port number for the port variable. 5. Proceed to installing the reports repository. Reports Repository WorldServer s reports are kept in a repository, distributed as a.zip file, which needs to be uploaded to your system before you can access the reports. Follow these steps to upload and deploy the JRS repository. Note:DonotgotoTools>ReportCenteruntilyouhaveuploadedtherepository. 1. Locate the repository file jrs_repository. zip in the integrations/ Jaspersoft_5. 2 directory in the WorldServer ZIP or TAR distribution files. 2. Copy this file to the machine where JRS is installed. 3. Open a command prompt with admin rights. 4. Navigate to the buildomatic sub-directory in the JRS installation, for example: cmd> cd C:\Program Files\jasperreports-server-5.2.0-bin\buildom atic 5. Import the ZIP file using the following command: cmd> js-import.bat --update --input-zip c:\jrs_repository.zip 6. Restart the application server. 7. Log into WorldServer and go to Tools > Report Center. 8. Verify that JRS comes up as expected. Note: The repository import step fails if the path to thejrs_repository. zip file hasspacesinit.eithercopythefiletoapathwithnospaces,orenclosethepathinquotes, for example path to zipfile. Installation and Upgrade Guide 51
Report Center Set Data Source About this task JRSmustlinktoyourWorldServerdatabaseinordertoaccessdata.Yousetupthe WorldServer data source in the JRS repository to point to your data:/worldserver/ DataSources/ WorldServerDB. Required edits include the database server and driver information, as described in the following steps. Procedure 1. Log in to WorldServer as an administrator. 2. GotoTools>ReportCenter. 3. Go to View > Repository. 4. In the left panel, navigate to WorldServer > DataSources. 5. Select WorldServerDB in the right panel and click Edit. 6. In the Driver field, specify the following: a. For SQL Server: com.microsoft.sqlserver.jdbc.sqlserverdriver b. For Oracle: oracle.jdbc.oracledriver 7. In the URL field, specify the following: a. For SQL Server: jdbc:sqlserver://<host name>:<port>;databasen ame=<databasename> Replace <host name>, <port>(default 1433), and <databasename> with val ues that match your WorldServer database configuration. b. For Oracle: jdbc:oracle:thin:@<host name>:<port>:<sid> Replace <host name>, <port>(default 1521), and <SID> with values that ma tch your WorldServer database configuration. 8. Enter appropriate values in the User Name and Password fields. 9. Click Test Connection. 10. If the connection passes, click Submit to save. 11. If the connection fails, review your settings and make any necessary changes. 52 Installation and Upgrade Guide
Report Center Configuring Reporting over HTTPS About this task To run reporting over an HTTPS URL connection, set the following configuration options: Procedure 1. Make sure your application server is configured for HTTPS access. See the Secure Settings and Connections chapter of the WorldServer Installation and Upgrade Guide. 2. Edit the WSSingleSignOnFilter Java bean in the applicationcontext-worldserver. xml file to use HTTPS URLs. See the Enabling Single Sign-on for JRS topic for information on editing this bean. 3. Set the report_center_url entry in the WorldServer general.properties file touseanhttpsurl. Log file Enable single sign-on debug logging with an entry in the following file: <tomcat>/ webapps/ jasperserver-pro/ WEB-INF/ log4j.properties. For example you might have the following entry: log4j.logger.com.idiominc.ws.integration. reporting.jaspersoft.wssinglesignonfilter=debug. Output for the server will appear in the file: <tomcat>/ webapps/ jasperserver-pro/ WEB-INF/ logs/ jasperserver. log and thetomcat console window. User Permissions WorldServer users and user types are automatically added to the JRS user database the first time they go to the Report Center. The predefined JRS ROLE_Administrator corresponds to the Administrator user type in WorldServer. Note the following information about JRS and user permissions: JRS automatically prefixes WorldServer user types with ROLE_. JRS automatically replaces blanks in WorldServer names with underscores. For example, the WorldServer user type Project Manager will become ROLE_Project_Manager in JRS. Administrators can assign permissions to individual reports. To set permissions for reports follow these steps. 1. Log in as Administrator. 2. GotoTools>ReportCenter. Installation and Upgrade Guide 53
Report Center 3. Right-click on a report and select Permissions. 4. Set the permissions as desired. Permissions are additive. For example, even if an individual user's permission to a reportissetto NoAccess,theymaystillbeabletoviewthereportiftheir role's permission is set to Read-Only. Note: See the JasperReports Administrator Guide, included in the distribution, for details. Administrators can use the JRS Manage > Users page to assign permissions to users and roles, or delete roles and users. The predefined ROLE_Administrator and admin users in the WorldServer organization should not be altered. System users and roles (outside the WorldServer organization) should not be altered either. Roles and users which are added automatically from WorldServer are marked User/Role is externally defined. These objects can be deleted, buttheywillberecreatedautomaticallythenexttimetheusergoesto Report Center. Users and roles are not deleted automatically from the JRS user repository if they are deleted or changed in WorldServer. Delete them manually, if necessary. Externally defined users have no passwords, so no password management is usually required. WorldServer does not communicate passwords to JRS. Note: JasperReports admin users may see reports or other objects in the Public folder of the repository, or in the search results view. These automatically-generated folders have no relevance for WorldServer and may be ignored or deleted. 54 Installation and Upgrade Guide
Chapter 5 Secure Settings and Connections WorldServer addresses security concerns in several ways: Default internal structures to isolate projects from each other.(this built-in behavior is not documented here.) Configuration options so that internal WorldServer users access the system through a non-secured connection(http), while external users use a secure connection (HTTPS). Configuration settings let you enable secure page URLs, such that WorldServer pagescanonlybeaccessedbyuserswithpermissionstousethatpage. Software Developer Kit options that let you implement URL security in your custom servlets. Setting Up a Secure Connection for External Users Before you begin The following strategy combines two techniques: one for separating your users into those who connect over HTTP and those who connect over HTTPS, and another for securing the HTTPS connection behind a firewall. First, set up your application server(tomcat or WebSphere) to listen on one IP address andport,usinghttp;thensetupanotherwebservertolistenonadifferentipaddressor port,usinghttps.then,setupthatsecond(frontend)servertoactasareverseproxy, andfeedanyrequestsitgetsontothefirstinstanceabove.enforcesecurityontheproxy server with a firewall. The sequence for setting up these two measures might be as follows: Procedure 1. Make machine1:8080 is your normal Tomcat instance. For all of your internal WorldServer users, tell them to go to http://machine1:8080/ws/login. This is the typical set up described in the WorldServer Installation topic. Installation and Upgrade Guide 55
Secure Settings and Connections Note: For instructions on setting up Tomcat for SSL, see <WS_Home>\ tomcat\ conf\ server.xml.orig. You will be instructed there to Uncomment the SSL HTTP/1.1 Connector entry in $CATALINA_HOME/conf/server.xml and tweak as necessary. Because WorldServer 10.0 ships with a streamlined version of server.xml(which doesn't include the HTTPS Connect entry), you should rename server.xml(to something like server.xml.ws) and then rename server.xml.orig, located in the same directory, to server.xml. Then find and uncomment the following: <Connector port="8443" maxthreads="150" minsparethreads="25" maxsparethread s="75" enablelookups="false" disableuploadtimeout="true" acceptcount="100" debug="0" scheme="https" secure="tr ue" clientauth="false" sslprotocol="tls" /> For instructions on setting up WebSphere for SSL, see their product documentation. 2. Next,setupafrontendWebserverlisteningonadifferentIPaddressorport,for example machine2:443 could be this second instance. Configure this machine as a proxy server, forwarding requests to machine1. Note: Apache Tomcat has out-of-the-box features that allow Web servers to be set up this way. For instructions on setting up WebSphere proxies, see their product documentation. 3. Whenyouhavesetupyourinfrastructurelikethis,youthensetupyourfirewallto only allow access to machine2 via SSL and block any external access to machine1. This allows you to force any external user to go through the secure connection to WorldServer. Results The following figure illustrates this setup. 56 Installation and Upgrade Guide
Secure Settings and Connections Figure 1: Secure WorldServer Connection Setup Enabling URL Page Security YoucanspecifythattheURLsforWorldServerpagesmustcheckthatvalidusersare accessinganewpagefromasecurepage,andnotfromanunsecurelocation.toenable URL security you must modify a setting in the general.properties file. Procedure 1. Navigate to the WEB-INF/ classes/ config directory of the installed Web application to find the general.properties file. 2. Openthefileinatexteditor. 3. Change the use_secure_urls setting to true. 4. Save the file. 5. Restart WorldServer.(All properties changes take effect after a restart.) Whattodonext We also suggest that you enable the session_client_check setting to ensure that a sessioncanonlybeusedbythesamebrowserthatcreatedit.seetheembedded documentation in the general.properties file. Installation and Upgrade Guide 57
Secure Settings and Connections Note: Properties changes take effect after you restart WorldServer. WesuggestmakingthischangewhenWorldServerisnotinactiveuse.Userswhoare loggedinwhenyouenablethissettingwillreceiveaccessdeniedwhentheyclickon links.theywillneedtoclosetheirbrowsersessionandloginagain.userswhologinafter the setting is enabled will experience no changes in WorldServer operation. Expose URL Security to Custom Servlets The WorldServer Software Developers Kit(SDK) supports the implementation of URL security, so users can include the concept in their own custom servlets. See the following components: The SDK servlet com.idiominc.wssdk.component.servlet.wshttpservlet shows exposed methods supporting secure URLs. The SDK sample custom Human Action servlet Human Action Scope Analyzer has been updated to illustrate how URL security can be used in custom servlets. The key APIs for URL security are requiresecureurl(the default is false) and getsecureurl. Application Server Environments Tomcat and WebSphere are supported with enhanced URL security starting in WorldServer version 10.1. 58 Installation and Upgrade Guide
Chapter 6 SDK Sample Objects SDL provides several sample objects that you can upload into WorldServer. These samples include: Attribute Validators Automatic Actions Connectors Content Filters FrameMaker File Format Converters Linguistic Tools(for example, stemmers and wordbreakers) Machine Translation Adapters Microsoft Office File Format Converters Notification Content Password Authenticators Rules Servlets Translation Memory Repair Translation Memory Services Triggers For a full list and description of the available samples, see the SDL WorldServer Software Development Kit(SDK) User Guide. All of the samples are included in the wssdk_<version.build>.zip file in your WorldServer distribution(for example, in WorldServer 9, the package was named wssdk_9.0.0.276.zip where 9.0.0 is the release version and 276 is the build). Installation and Upgrade Guide 59
SDK Sample Objects Uploading the WorldServer SDK Samples Procedure 1. Extract the contents of wssdk_<version.build>.zip. 2. In Management > Administration > Customization, select the component type for the SDK samples(for example, Automatic Actions from the"custom components type" list) and click Add. 3. BrowsetotheSDKsampleyouwanttoupload(forexample,<path you unzipped to>\ samples\ dist\ autoaction_samples. zip) and click OK. Results YouwillnowseetheSDKsamplesyouuploadedbothinthelistonthe Management > Administration > Customization page and in the respective page for that type of object. Forexample,ifyouuploadedtheSDKsampleautomaticactions,youwillseetheminthelistofavailable actions in the workflow editor when you add an automatic action. All components defined in the uploaded archivewillbeaddedtoworldservereveniftheyarenotofthetypeyouselectedfromthedropdownlist.for example,ifyourcomponentarchivefilehasautoactionsandtriggers,andyouloaditfromtheautoaction view,currentlyboththeautoactionsandthetriggerswillbeloaded.youwillonlyseetheautoactionslisted becauseyouareontheautoactionpage.ifyougotothetriggerspage,thenyouwouldseeanycomponentsthat werealsoaddedinthatarea. In the uploaded components list, those that have been uploaded as samples have a check boxnexttothemsoyoucandeletethem.thosethatarecoreout-of-the-boxobjectsdonot have check boxes. Note:InadditiontotheseSDKsamplesthatyoucanuploadtoWorldServer,SDL provides sample objects that are installed with WorldServer which you can import into WorldServer using the Management > Administration > Import Objects feature. Some of the sample objects that you can import have dependencies on certain SDK sample objects having already been uploaded. For example, the Advanced Quote Approval Process Workflow depends on the SDK sample Set Quote Status automatic action having already been uploaded. If you try to import the Advanced Quote Approval Process Workflow object before you upload the Set Quote Status automatic action SDK sample, the import will fail, and will tell you which object is required. For information about importing sample objects, see Importing Sample Objects on page 61. 60 Installation and Upgrade Guide
SDK Sample Objects Importing Sample Objects About this task SDL provides a number of sample objects that you can import into your WorldServer instance. Among these samples are: Workflows for quote approval processing, term validation, and asset translation. Filter configurations. User types for typical term browsing operations. To import these samples, do the following: Procedure 1. GotoManagement>Administration>ImportObjects-Step1of2,browseto thexmlfileofthesampleyouwant,andclickuploadfile. The samples are located in the samples\ deployment directory of your WorldServer installation. For example, if your installation is in C:\Program Files and you want to import the Quote Approval Process workflows, you would browse to C:\Program Files\Idiom\WorldServer\samples\deployment and then to\ workflows\ quote_processing_workflows. xml. 2. TheimporterliststhePrimaryObjectsFound,andyoucanchecktheonesthatyou want to import. After selecting the ones you want, click Next. 3. The importer lists the Objects to Be Imported for your confirmation. Click Import to import them. Results A confirmation page displays the objects imported, and they appear in the appropriate list for them in WorldServer. For example, if you imported the term browser user types, they will appear now in the Management>UserSetup>UserTypespageandyoucanusethem. Note: Some of the sample objects that you can import have dependencies on certain SDK sample objects having already been uploaded. For example, the"advanced Quote Approval Process Workflow" depends on the"set Quote Status" automatic action sample having already been uploaded. If you try to import the"advanced Quote Approval Process Workflow" object before you upload the"set Quote Status" automatic action sample,theimportwillfail,andwilltellyouwhichobjectneedstobeinplacealready. For instructions on uploading SDK samples, see Uploading the WorldServer SDK Samples. Installation and Upgrade Guide 61
SDK Sample Objects 62 Installation and Upgrade Guide
Chapter 7 File Type Support Server Installation The File Type Support(FTS) Server lets WorldServer use SDL Studio file types to handle assets. This separate Windows-only server can be run either as a Windows Service process(recommended) or through a Windows console. WorldServer identifies translatable text based upon the document file type. Because the exact makeup of translatable text versus other content varies greatly across different file formats, this process is very file-format specific with some common features across multiple file types. Note: Starting with WorldServer 2011(WorldServer version 10.0), WorldServer only supports Studio file types for new installations, which require the FTS server. If you are upgrading your WorldServer installation to version 10.0 and upwards, you can use both the Studio file types and WorldServer legacy filters. This chapter provides information on the following: Determining system requirements and supported environments Installing the FTS server files on a Windows computer Configuring the FTS properties for a WorldServer Windows installation Configuring the FTS properties for a WorldServer Solaris or Linux installation Running the FTS Server See the following documentation for more information on WorldServer: The Planning and Prerequisites Guide for WorldServer and FTS system requirements. The Basic Operations Guide for basic system administration and troubleshooting. Installation and Upgrade Guide 63
File Type Support Server Installation Installing the FTS Server These procedures describe installing a WorldServer file type support(fts) server on a Windows computer, which can be connected to a WorldServer installation on Windows, Linux, or Solaris operating systems. YouinstalltheFTSServerinthesesteps: 1. Download the FileTypeSupportServer. msi file from the WorldServer FTP sitetoaknownlocationonthewindowscomputerthatyouhavedesignatedforthat purpose. 2. Install the.net Framework 4.0 software on that computer, if necessary. 3. Run the MSI installer, to install the application in an appropriate location, such as the C:\Program Files directory. Important: The FTS Server requires that you use the database username and password used by WorldServer. Both fields should be entered in plain text. The Installer wizard encrypts the password, matching the encrypted password used by WorldServer. If you do not know the WorldServer username and password for your database, and cannot obtain it, contact WorldServer technical support. Note:FTSServerisa32-bitapplicationandrunsin32-bitmodewhenrunningona 64-bit machine. Install.NET version 4.0 If the designated FTS computer does not have the.net Framework version 4.0, you must install it. SDL provides a download of this framework on the WorldServer FTP site, for your convenience. Note: If you need more information on this version, refer to the Microsoft Download Center. 1. Download the.net Framework 4.0 redistributable file (dotnetfx40_full_setup. exe) from the FTP site. 2. Run the file to install.net version 4.0. 3. Accept the Microsoft license. 64 Installation and Upgrade Guide
File Type Support Server Installation Install the FTS application Windows permissions are extremely important for the smooth operation of the FTS and the WorldServer application servers. Both installations must be owned by user names with identical domain permissions.(file, share, and database permissions will be described later.) Note: We recommend using the same userid that currently owns the WorldServer instance to install the FTS server. Install the FTS files using the following procedure: 1. Makesureyouareloggedonwithauseridthathasdomainpermissionsthatinclude both the FTS and WorldServer instances. 2. Double-click the FileTypeSupportServer. msi file to install the files. The installer uses the following default location, which can be changed: C:\Program Files\SDL\FileTypeSupportServer 3. Step through the SDL WorldServer File Type Support Server Setup wizard that appears. Thesharedfolderyouentermustmatchtheentryinthe general.properties file. The number of processes you specify ideally should match the processors on the FTS Server computer. The database connection page will ask for the server(host) name, the database or SID name, the database user name or schema, and the database password. These must match your WorldServer installation exactly. 4. The SDL File Type Support Server service is started automatically after a successful installation. Note: All warnings and fatal errors are written to the Windows Application Event Viewer. FTS server properties are managed by the Sdl.WorldServer. FileTypeSupport. Server.HostProcess. exe.config file, which is created by the previous installation process. The Sdl.WorldServer. FileTypeSupport. Server.Launcher.exe.config file immediately starts the designated number of processes. These must be owned by the WorldServer user. To change users from the local SYSTEM account to the WorldServer user(if necessary) follow these steps. 1. On the FTS Server machine, run services.msc. 2. Right-click the SDL File Type Support service and select Properties. 3. ChoosetheLogOntab. Installation and Upgrade Guide 65
File Type Support Server Installation 4. Select This account and enter the username and password information for the WorldServer user. 5. ClickOK. 6. Right-click the SDL File Type Support service again and select Restart. Office file type requirements Two Microsoft Office file types have special installation requirements on the FTS Server: Rich Text Format(RTF) Studio File Type Microsoft Excel 2000-2003 File Type Toprocessthesefiletypes,youmustinstallExcel2007andWord2007(orthe2003 versions with the Office 2007 compatibility pack) on the machine that runs the FTS server. Both are covered if you simply install Office 2007. Goontoconfiguretheserver You must now configure the separate WorldServer installation to communicate with the FTSserver.Seeoneoftwotopics: WorldServer Windows Configuration for FTS WorldServer Solaris and Linux Configuration for FTS on page 69 WorldServer Windows Configuration for FTS AfteryouinstallaFileTypeSupport(FTS)Server,youmustsetupyourWorldServer Windows configuration to communicate with it. For WorldServer instances running on Windows, you need to configure the following areastoworkwiththeftsserver: Ensure that the WorldServer Service(IdiomRun) is running under a Windows domain account. Ensure that the FTS Server Service(ftsserver) is running under a Windows domain account. Check the Windows domains account permissions for the Directory Paths in UNC format to AIS filesystem mounts. Specify the' ftsserver_shared_directory' setting in each WorldServer general.properties file. Configure the Studio File Type Support filters in WorldServer. When deploying WorldServer and FTS in a mixed Unix/Windows environment and using NFS, Windows Active Directory must be configured with Identity Management for Unix. This enables you to map Windows usernames to Unix usernames. 66 Installation and Upgrade Guide
File Type Support Server Installation All WorldServer and FTS Server Service'run-as' users must have read/write access to: The directory paths in UNC format for AIS file system mounts in WorldServer. The UNC path defined in general.properties to' ftsserver_shared_directory' (Example://servername/pathname) Note: The UNC paths for NFS-mounted directories are not accessible from Windows Explorer on Windows 2008 R2(this is a limitation in Windows); they are only accessible via Explorer using the mounted drive letter for the directory(for example"n:"). The UNC path defined in general.properties to WorldServer's' temp_file_path' (Example://servername/ pathname) Domain Account for WorldServer TousetheFTSserver,theWorldServerservicemustberunningunderausernamethat has a Windows domain account, with the same domain permissions as the user account that is running FTS. You can change the WorldServer user in Windows fairly simply with the Run As procedure. Consult your IT department if you need further information. User Name Permissions The user names that run both WorldServer and the FTS Server must have identical domain permissions. This includes full control permissions on sharing and security for the following: FTS Shared directory, Temp file path and AIS mounts. FTS shared directory 1. From Windows Explorer, navigate to the same UNC\\ servername\ pathname directory you specified in the FTS configuration. 2. Right-click on the folder and select Sharing and Security... The[Foldername] Properties dialog appears. 3. Select the Sharing tab. 4. Select the Share this folder radio button. 5. ClickPermissions. The Permissions for[foldername] dialog appears. 6. ClickAdd. 7. In the Select Users, Computers, or Groups dialog, add the user names for both the WorldServer and FTS Server. 8. Click OK twice. 9. On the[foldername] Properties dialog, select the Security tab. 10. Click Add. Installation and Upgrade Guide 67
File Type Support Server Installation 11.IntheSelectUsers,Computers,orGroupsdialog,addtheusernamesfor both the WorldServer and FTS Server. 12. Click OK until you return to your Windows Explorer window. Temp file path In the WorldServer general.properties file, the temp_file_path needs to besettoasharedlocationwhentheftsserverisinstalledonaseparatecomputer from WorldServer(recommended installation). 1. From Windows Explorer, navigate to the folder specified as the WorldServer temp_file_path. 2. FollowthesamestepsasabovefortheSharingandSecuritytabsforthe folder. The same user names must have permissions for all WorldServer and FTS resources. AIS mounts 1. From Windows Explorer, navigate to the folder that serves as the AIS mount for both servers. Ifyoudon'tknowthelocationoftheAISmountforyourWorldServer installation, follow these steps. a. Open your WorldServer application. b. Go to Management > Asset Interface System > AIS Mounts. c. Double-clickontheAISmountyouwillbeusingwiththeFTSserver. d. Note the directory path in the File System Connector Configuration area.usethatpathtocompletethisstep. AISmountsusedwiththeFTSservermustuseUNCpathnames within WorldServer. 2. FollowthesamestepsasabovefortheSharingandSecuritytabsforthe folder. The same user names must have permissions for all WorldServer and FTS resources. TheFTSServercanusemorethanoneAISmount.Maketheabovechangesfor each mount in your environment. 68 Installation and Upgrade Guide
File Type Support Server Installation WorldServer Properties File WorldServer uses a configuration entry in the general.properties file to specify the shared FTS Server directory. 1. Open the WorldServer general.properties file. 2. Search for the ftsserver_shared_directory entry. 3. Add the same UNC pathname used for the shared folder entry in the FTS installation. This path can also be found in the FTS Server's Sdl.WorldServer. FileTypeSupport. Server.HostProcess. exe.configfile. Note:BothFTSandWorldServerwillusethelogfilenamedengine.loginthe shared folder. Do not change the file name. Studio File Type Setup PerformthefollowingtasksforthespecificStudiofiletypesyouplantousewithyour FTS Server. Set up filter groups for implementing FTS file types We recommend that WorldServer administrators consider using filter groups for FTSfiletypes.YoucansetupafiltergroupofFTSfiletypes,andapplythatgroup toaspecificsetofassetsthatusethesamemimetype.seethefiltergroups topic in the online help or the SDL WorldServer Administrator Guide for more information. Set up file type configuration settings Information on individual file types settings are available through the Filter Types topic in the online help. WorldServer Solaris and Linux Configuration for FTS Afteryouinstallafiletypesupport(FTS)serveryoumustsetupupyourWorldServer Solaris or Linux configuration to communicate with it. The FTS server can inter-operate with a WorldServer system running on Solaris and Linux systems. This section describes the configuration considerations needed to make that happen, with specific information on accessing AIS filesystem mounts hosted on Solaris and Linux. The different configurations require an understanding of Samba and/or NFS. The Samba interoperability suite(www.samba.org) can be used on Solaris and Linux to export filesystems to Windows clients, in this case to the FTS server. With the use of a Windows-based NFS client such as Microsoft's Services for UNIX(alsoknowsasServicesforNFS),NFScanalsobeusedtoexport filesystems to the FTS server. Installation and Upgrade Guide 69
File Type Support Server Installation When deploying WorldServer and FTS in a mixed Unix/Windows environment and using NFS, Windows Active Directory must be configured with Identity Management for Unix. This enables you to map Windows usernames to Unix usernames. Sharing Filesystems for FTS and WorldServer The FTS Filesystem Options figure provides a reference for the host names, Samba and Windowssharenames,AISmountnames,anduseraccountnamesusedinthe FTS/WorldServer configuration descriptions. AllexportedfilesystemsmustappeartotheFTSserverasaWindowsshare.Itisimportant to remember the following points. The WorldServer user and FTS connection user should be the same, to ensure that the same permissions apply in both cases. In the documentation examples, WorldServer and FTS are running as the user worldserver. Inorderforthenon-WindowsfilesystemtoworkasaWindowsmount,the filesystem name must match the machine name. 70 Installation and Upgrade Guide
File Type Support Server Installation AIS Mount Definitions For each mount in WorldServer used with FTS, the following must be configured TheAISMountname(asusual) TheDirectoryPathmustbeintheformofaWindowssharename,suchas: //solarishost/mount1 Note: The share name MUST be defined using forward slashes or the Solaris/Linux operating system will not recognize the pathname and the creation of the AIS mount will fail. Installation and Upgrade Guide 71
File Type Support Server Installation FTS Connections for Solaris or Linux Using Samba FTS can run with Solaris- or Linux-hosted filesystems that are local or NFS-mounted. Additionally, FTS can run with Windows-hosted filesystems that are mounted on Linux hosts. Note: Remote Windows-based filesystems are not natively supported by Solaris so are not described here. General Samba Configuration The basic Samba configurations required to support the target deployment environments are given here. Customers may desire or require more sophisticated configurations for reasons of security or other local policies. Such configurations are not covered in this document. In general, Samba must be configured to: Allow filesystem sharing. MaptheWindowsuseraccountunderwhichtheFTSServreerisrunningtoa local Solaris/Linux account, such that FTS can read and write files under the Samba share(s). Allow guest access to the Samba share(s). See the Samba configuration file that supports the previous description in the following locations: Solaris:/etc/ sfw/ smb.conf Linux:/etc/ samba/ smb.conf The[global] section of those files contains the following variables: security = share username map = </path/to/smb/users/file> guest ok = yes guest account = worldserver Note: For example, the username map could be/etc/ samba/ smbusers Samba Examples The Samba user-mapping file map = </path/to/smb/users/file> maps incoming Windows usernames to local Solaris or Linux user accounts. To allow FTS access to the filesinthesambashares,theftsconnectionmustusethesameusernameastheaccount that WorldServer is running under. 72 Installation and Upgrade Guide
File Type Support Server Installation # Unix_name = SMB_name1 SMB_name2... root = administrator admin worldserver = * Windows users administrator and admin are mapped to the local Solaris/Linux root user. Every other Windows user is mapped to the local Solaris/Linux worldserver user. Note:Inthisscenario,theFTSWindowsuseraccount fts ismappedtothesolaris/ Linux user worldserver, allowing the same access to the filesystem that the WorldServer application instances have. The Samba Share Definition holds the required definition for each directory on the hostsolarisorlinuxsystemthatistobeaccessedbyfts.thisexampleshowsthe individual[sharename] section(s): [mount1] path = /mnt/ftsaisassetdir public = yes browseable = yes guest ok = yes guest only = yes writable = yes [mount1] path browseable = yes Identifies the Samba share that will be visible from a Windows system The actual(local) filesystem directory that contains the assets to be processed Allowsthesharetobeseeninalistofavailableshares guest ok = yes Allows the share to be connected to with no password guest account = nobody guest only = yes Specifies the username used for access to the share Allows only guest connections to the share(restricts privileges to the defined guest account) writable = yes Allows creation of files and directories under the share Installation and Upgrade Guide 73
File Type Support Server Installation Local Filesystem Configuration For each Samba share defined on a given host, the following must be configured: The assets directory associated with the Samba share must exist, for example: /mnt/ftsaisassetdir Atop-leveldirectorywiththesamenameasthelocalhostnamemustbecreated, for example: mkdir /solarishost Asoft-linktoeachSambashareexportedbythehostmustbecreatedwithinthis top-level host-named directory that points to the physical assets directory, for example: ln -s /mnt/ftsaisassetdir /solarishost/mount1 NFS-Mounted Filesystem Configuration If WorldServer is running on one host(e.g. linuxhost) which has mounted files on another host(e.g. solarishost), FTS can process those files with the following configuration. Note: The basic NFS configuration required to support the target deployment environments are given here. Customers may desire or require more sophisticated configurations for reasons of security or other local policies. Such configurations are not covered in this document. The NFS server machine(solarishost in this example) must export the filesystem (assets directory) to be mounted by remote clients: share o rw /export/ftsassets See your operating system documentation for persisting NFS file system exports. The NFS client machine(linuxhost in this example) must mount the remote filesystem on the NFS server machine to a local directory, for example: mount solarishost:/export/ftsassets /mnt/ftsassets Again, see your operating system documentation for persisting NFS file system exports. With this configuration, the remote filesystem appears to the local host as a local filesystem. The local filesystem configuration discussion applies, as above, with the following exceptions: Atop-leveldirectorywiththesamenameastheremotehostnamemustbecreated, such as: mkdir /solarishost Asoft-linktoeachSambashareexportedbytheremotehostmustbecreated within this top-level directory that maps that Samba share to the local NFS mount corresponding to that share, such as: ln -s /mnt/ftsassets /solarishost/mount2 74 Installation and Upgrade Guide
File Type Support Server Installation Linux Filesystem Mounts Using Samba In addition to the setup described in the topic FTS Configurations for Solaris and UNIX, Linux-based systems can use part of the Samba suite to mount a Windows-based filesystem to appear as a local filesystem. This configuration requires support for server message block file system(smbfs) or its newer replacement common internet file system(cifs). Note: A basic CIFS configuration required to support the target deployment environments is described here. Customers may desire or require more sophisticated configurations for reasons of security or other local policies. The following configuration is required to mount a remote Windows filesystem on a Linux host. AdirectorymustbecreatedtobeusedasthemountpointfortheremoteWindows share, such as: mkdir /path/to/winshare The remote Windows share must be mounted to this directory, such as: mount t cifs o username=<winuser>,password=<winpassword> // winhostfiles/mount3 /path/to/winshare See your operating system documentation for persisting NFS file system exports. A top-level directory must be created with the same name as the remote Windows machine, such as: mkdir /winhostfiles AsoftlinktoeachWindowsshareexportedbytheWindowshostmustbecreated within this top-level host-named directory that points to the CIFS-mounted assets directory, such as: ln -s /path/to/winshare /winhostfiles/mount3 Configuring NFS AIS Mounts for Linux and FTS YoumaywanttoaccessanNFSAISmountforFTSwhenyourWorldServerapplication is running on Linux. These procedures provide examples of how to do that with Windows tools. About this task Installed NFS environments are often highly customized, and you may simply want to use the following steps as guidelines for your installation. For example, you can use the server names in this configuration example, or use names of your own. Installation and Upgrade Guide 75
File Type Support Server Installation Note: The relationships between the servers must be maintained as shown in the example and in the figure FTS Filesystem Options. The example generally uses the configuration steps for the Services for Unix(SFU) utility on Windows Server 2003. Windows Server 2008 R2 calls this utility Services for NFS, and the configuration is quite different. When deploying WorldServer and FTS in a mixed Unix/Windows environment and using NFS, Windows Active Directory must be configured with Identity Management for Unix. This enables you to map Windows usernames to Unix usernames. Procedure 1. Configure the NFS Server(linux-nfs-server1). a. Create a directory to share: mkdir /export/nfsmnt This example uses a sub-folder under nfsmnt called NFSTesting for WorldServer/FTS resource files. That subfolder also has an AISmount folder that contains the file system AIS assets. b. ChangeownershipofdirectorytothatoftheuserIDwithwhichtheNFS client will run: chown wasadmin:wasadmin /export/nfsmnt chmod 755 /export/nfsmnt c. Check for NFS server installation: yum list nfs-utils d. Install NFS Server, if necessary: yum install nfs-utils portmap e. Edit/etc/exports file. Add the line:/export/nfsmnt*(rw,sync,no_ root_squash) f. Start NFS Server process: /etc/init.d/nfs start g. Check the NFS Server process status: /etc/init.d/nfs status ## or se rvice nfs status h. Configure NFS Server Services to start at boot-time: chkconfig nfs on chkconfig portmap on 2. Install and configure Windows tools for supporting NFS. In this case, we use Services forunix,forwindowsserver2003,ontheftsservermachine( windows-fts-server2). a. Install Windows Services for UNIX on your server.(download this application from the Microsoft web site if necessary.) b. Configure user name mapping as appropriate for your environment. c. ValidatethattheFTSServermachinecannowseethefoldersinWindows Explorer by navigating to\\ linux-nfs-server1.global.sdl.corp\export\nfsmnt. TheFTSServermachinecannowseethefoldersusingaUNC-stylesyntax. 76 Installation and Upgrade Guide
File Type Support Server Installation d. With Windows Explorer opened to\\ linux-nfs-server1.global.sdl.corp\export\nfsmnt, validatethatyoucancreatefilesandfoldersonthenfssharefromthe Windows OS and that the correct file permissions are applied. e. InstalltheSDLFileTypeSupportServerusing\\ linux-nfs-server1.global.sdl.corp\export\nfsmnt\ ftsshared as the FTS Shared folder. f. Configure the FTSserver service to depend on Windows Services for Unix service: a. Open a command prompt. b. Run the appropriate service for your Windows Services for UNIX installation, such as: sc config ftsserver depend= zzinte rix 3. Configure NFS mount on WorldServer machine( linux-worldserver-server3) a. CreateadirectoryontheWorldServermachinethatistheFQDNoftheNFS Server: mkdir /mnt/linux-nfs-server1.global.sdl.corp b. Configure a temporary NFS mount: mount -t nfs linux-nfs-serve r1: /export/nfsmnt /mnt/linux-nfs-server1.global.sdl.corp -o sync c. Configure the NFS mount to be established at machine boot: a. Edit/etc/fstab b. Add the following line: linux-nfs-server1:linux-nfs-server 1:/export/nfsmnt /mnt/linux-nfs-server1.global.sdl. corp nfs defaults 0 0 c. Save and exit/etc/fstab d. Configure a symbolic link from the NFS Server's shared folder that you mounted. You have to mirror the local folder structure that you're going to create to mimic a UNC-style path. a. mkdir /linux-nfs-server1.global.sdl.corp b. mkdir/linux-nfs-server1.global.sdl.corp/export c. mkdir /linux-nfs-server1.global.sdl.corp/export/nfs mnt d. cd /linux-nfs-server1.global.sdl.corp/export/nfsmnt e. ln -s /linux-nfs-server1.global.sdl.corp/nfstesting e. Validate that your WorldServer machine can see the folders using a UNC-style: ls /linux-nfs-server1.global.sdl.corp WorldServer machine can now see the folders using a UNC-style syntax. 4. Install and configure WorldServer(linux-worldserver-server3) a. Deploy the WS.WAR file. b. Edit the standard variables in general.properties(database_username, database_password, etc). Installation and Upgrade Guide 77
File Type Support Server Installation c. In general.properties, also configure: temp_file_path=//linux-nfs-server1.global.sdl.corp/ export/nfsmnt/nfstesting/wstemp rcs_root=//linux-nfs-server1.global.sdl.corp/ export/nfsmnt/nfstesting/wsrcsroot ftsserver_shared_directory=//linux-nfs-server1.global.sdl.corp/ export/nfsmnt/nfstesting/ftsshared log4j.appender.logfile.file=//linux-nfs-server1.global.sdl.corp/ export/nfsmnt/nfstesting/ws.log d. Restart WorldServer to use the updated variables in general.properties. 5. Configure your file system AIS mount in WorldServer. a. Log into WorldServer as admin b. Navigate to Management > Asset Interface System > AIS Mounts > Add... c. Add the mount using the*directory path: *//linux-nfs-server1.global.sdl.corp/export/nfsmnt/ NFStesting/AISMount d. Save FTS Server Upgrade from Installer The installation procedure for the File Type Support(FTS) server also automatically handles version upgrades. When you perform an upgrade, the installer goes through the following steps: 1. On an installed system, the WorldServer installer prompts you to confirm the upgrade or exit. 2. After confirmation, the installer proceeds as usual, showing the dialogs for user options. These options are populated with the existing configured values. During installation, fields to enter the Windows(Run-as) Service Account username andpasswordareprovided.iftheuserleavesthemblank,thenalocalsystemuseris assigned(the standard user). If the user enters a username and password, the existence oftheusernameisverifiedbutthepasswordisnotverified.iftheusernameiscorrect andthepasswordisnotcorrect,theservicewillfailtostart.anyservicestartup failure message will be reported in the Windows Event Viewer. 3. The installer removes the existing FTS server before installing the new one. This happens behind the scenes, without user intervention. Note: You must backup the server configuration(.properties) files before the upgrade so they can be restored afterwards. 4. If for any reason the installation fails during the upgrade, the previous installation will be restored. 78 Installation and Upgrade Guide
File Type Support Server Installation Note: Upgrades can be performed on FTS server version 10.0.0 and newer. FTS servers installed under the early evaluation plan(worldserver 9.4.0) must be uninstalled manually from the Windows Add or Remove Programs dialog before running the installer. Adding Language Resource Templates You can add Language Resource Templates generated from SDL Trados Studio to the File Type Support Server. This customizes segmentation behavior for WorldServer file types. About this task A Language Resource Template defines segmentation rules for any number of source languages. Deploying a Language Resource Template may affect segmentation of all current non-segmented projects, and impacts TM leverage against existing TM resources. Note:See HowtouseLanguageResourceTemplates inthestudioonlinehelpifyou need more information. Procedure 1. Create a Language Resource Template in Studio, with whatever special changes you need to the abbreviation list, ordinal follower list, or segmentation rules. Use a single Language Resource Template for all source languages for which you need to modify segmentation. The FTS server can use one template at most. 2. Stop the FTS server. 3. Copy the Language Resource Template file you created from Studio to c:/program Files/SDL/FileTypeSupportServer, or another directory to which you have access. 4. Edit the <appsettings> section of the file Sdl.WorldServer. FileTypeSupport. Server.HostProcess. exe.config to uncomment the following line. <add key="languageresourcetemplate" value="<language Resource file path>"/> Substitutetheexactfilepathandnameyouusedinthepreviousstep. 5. Restart the FTS server. Whattodonext Check that the changed segmentation behavior meets your expectations. Installation and Upgrade Guide 79
File Type Support Server Installation TheseproceduresapplytothefirsttimeyouaddaLanguageResourceTemplatetothe FTS server. If you overwrite a defined Language Resource Template file with a modified version,theftsserverwillpickupthenewversionwithoutneedingarestart.the modifiedfilemusthavethesamenameandbecopiedtothesamelocationastheoriginal file. Note: You should back up the previous version of the file before overwriting it. Running the FTS Server When you install the FTS server, it automatically launches the SDL File Type Support Server service. This service restarts the server when the Windows computer restarts, and requires no special attention. Note:Inatestenvironment,theFTSservercanalsoberuninthesystemconsolefrom the Sdl.WorldServer. FileTypeSupport. Server.Launcher.exe file. This is not recommended for production environments. To uninstall the service, use the standard Windows Add/Remove Programs option. Monitoring FTS processing The Assignments > Filter Engine Queue page in WorldServer allows you to monitor the status of jobs assigned to the File Type Support(FTS) Server across the WorldServer environment. You can choose to see all active jobs, or all completed and canceled jobs. The More info... link on that page provides online help on monitoring FTS processing. A separate table on the Management > Administration > System Logs page provides a recordofftsserveractivity.logsdefaulttoamaximumof10mb,atwhichpoint theyrollovertoanewlogfile. 80 Installation and Upgrade Guide
Chapter 8 Full Upgrade Procedures A full upgrade of WorldServer involves changing the underlying database schema. These procedures differ slightly depending on which type of database you use in your installation. Tasks include backing up your current installation, implementing the database schema changes, upgrading the WorldServer software for new features, upgrading and validating database objects, and restarting and verifying the full upgrade. Note: You must clear your browser cache memory before running WorldServer 10.4 for the first time. Basic WorldServer Upgrade Steps About this task SDL recommends that you first perform the upgrade operation on a staging system and then use this system to test the new functionality before upgrading your production system. BeforeyouupgradetoanewversionofWorldServer,youneedtoplanforatimewhen userswillnothaveaccesstoworldserver.werecommendgivingatleastafewdays notice, and if possible, a few weeks notice. Procedure 1. Install the supported version of the Java JDK. See the WorldServer Planning and Prerequisites Guide for information about the supported JDK version. 2. If you are using the WebSphere application server, ensure that you are running the supported version. See the WorldServer Planning and Prerequisites Guide for information about supported application servers. Tomcat is included in the WorldServer installer. 3. Download the current WorldServer software from the WorldServer distribution site. 4. StopWorldServer. You stop and start WorldServer via the application server into which it is deployed. See the SDL WorldServer Basic Operations Guide for more information. Installation and Upgrade Guide 81
Full Upgrade Procedures 5. Back up the WorldServer installation and data, including all configuration files that you have modified, such as general.properties. You will merge these modified configuration files back after upgrading the WorldServer software, as described separately. 6. Set the appropriate environment variables, including JAVA_HOME, WS_HOME, and application server-specific variables. 7. Test the current database schema and then upgrade the database, as described separately. 8. Unless you are using the WorldServer installer to install Apache Tomcat and the Java Runtime Environment, make sure you have the supported Tomcat, WebSphere, and Java Runtime Environment versions installed. 9. Upgrade the WorldServer software to the new version, as described separately. Perform this step once only, regardless of the version you are starting from. 10. Locate the old versions of the configuration files you customized(the files you saved in Step 2). Open the new versions and reapply your customizations, if still appropriate. See the separate topic Backing up Installation and Configuration Files. Note:(Oracle users) The configuration properties changed for Oracle in the WorldServer 10.0.0 general.properties file. When you merge back your general.properties file, you must be sure to use the JDBC property syntax. Note that the tm.properties file defaults changed between 9.x and 10.0.0. 11.IfyouareupgradingtoWS10.2,ignorethisstep:Otherwiseforupgradetoother previous releases, upgrade the WorldServer objects by running wsupgrade.sh(for UNIX) or wsupgrade.bat(for Windows). Iftheupgradefails,youcancorrecttheerrors,andthenrerunthescriptuntilit succeeds. 12. Test the validity of the schema with the appropriate testschema script. Results You can now start WorldServer. You stop and start WorldServer via the application server into which it is deployed. See the SDL WorldServer Basic Operations Guide for more information. 82 Installation and Upgrade Guide
Full Upgrade Procedures Cluster Upgrade Steps About this task When upgrading a WorldServer cluster, some steps needs to be performed on each node, while other steps need only be performed once. TheschemaupgradeSQLscriptneedstoberunonlyonce,fromoneofthenodes. The wsupgrade script(which upgrades WorldServer objects) also needs to be runonlyonce.notethatthisisnotrelevantfor10.2. Modified.properties files must be upgraded separately and all changes must be merged into the new property files. For details on performing these basic upgrade steps see other topics on backing up files, upgrading database schemas, upgrading the WorldServer software, and upgrading database objects. Procedure 1. Download the new version distribution on a central WorldServer node. 2. Backup general.properties from each server separately. 3. Backup all shared configuration files(tm.properties, exchange.propeties, andsoon)fromeachserver. Thesefilesare"shared"inthesensethattheyshouldbethesameoneachserver.You couldchoosetobackthemuponjustoneserver,then,whenyou'vemergedthe changes back in after upgrade, propagate each file to the other servers in the cluster. This might save time and avoid the chances of introducing mistaken merges; however, youmightwanttohaveabackupcopyofthepre-upgradeversionsoneachserver. 4. Run testschema.sh(solaris/linux) or testschema.bat(windows). 5. Upgrade the database from the first server. This is the only schema upgrade you need todo. 6. On the first server application, install the new WorldServer software and, if WorldServer requires a new version, install new Java and Apache Tomcat or WebSphere versions. 7. If relevant, run wsupgrade.sh(solaris/linux) or wsupgrade.bat(windows) from the first server to complete Java based upgrades of WorldServer objects. This doesnotapplyto10.2. 8. Run the testschema.sh(solaris/linux) or testschema.bat(windows) testing script to verify the database schema upgrade. 9. Re-apply any general.properties customizations on the first server. 10. Re-apply any customizations from the other backed up configuration files (tm.properties, exchange.properties, and so on). 11. Start WorldServer on the first application server and test its operation. 12. On each subsequent machine, install the new WorldServer software and, if WorldServer requires a new version, install new Java and Apache Tomcat or Installation and Upgrade Guide 83
Full Upgrade Procedures WebSphere version, and merge back the general.properties customizations from the old general.properties. 13. Either restore your prior customizations by merging the backed up configuration files into the new configuration files(tm.properties, exchange.propeties, andsoon)or,ifyouprefer,overwritethesewiththemergedversionsfromthefirst server. 14. Start all instances and test the newly upgraded installation. Backing up Installation and Configuration Files Before you begin Before upgrading your WorldServer software and database, you should make a backup copy of both the entire directory tree of your installation(that is, <WS_HOME>) and your WorldServer database. Back up all filesystem mounts to which WorldServer connects. This way you can recover if necessary. In addition to the complete backup, you should back up, to another area, the modified files listed in the procedure. You can then merge them back with the upgraded software files after the software upgrade. WorldServer contains configuration files that control how WorldServer functions and how it integrates with your existing infrastructure. From release to release, SDL may choose to add new configuration options in these files, or deprecate old options, in order to support new functionality or provide customers with additional flexibility. When you extractthecontentsofthewarfileforanewrelease,itwillcomewithanewsetof configuration files, including any new options that are available. These new configuration files will not contain the configuration settings from your existing installation. After the software upgrade you will need to merge together your existing configuration file and the new file as follows: 1. Back up your existing configuration file(s). 2. Apply changes from the existing configuration files to the new configuration files. When you have completed this process, the new configuration files will contain all of your configuration settings along with all of the default values for the new configuration options. If you are interested in changing the settings for any of the new configuration options,youcandothisatthistimeaswell. Note: You application server will extract new configuration files after the WAR file is deployed. The following steps provide guidance on saving configuration files you may have modified. 84 Installation and Upgrade Guide
Full Upgrade Procedures Procedure 1. Save to a temporary directory all the.properties files that you have customized. Save only those properties that you have changed; do not save the default WorldServer properties files. Note: In the locations given below, <WS_HOME> is the top-level directory where WorldServer is installed. By default, this is: Windows: c:\program Files\Idiom\WorldServer UNIX: /usr/local/idiom/worldserver In a Tomcat environment, these files are by default stored in: Windows: <WS_HOME>\tomcat\webapps\ws\WEB-INF\classes\config UNIX: <WS_HOME>/tomcat/webapps/ws/WEB-INF/classes/config In a WebSphere environment, these files are by default stored in: Windows: <WS_HOME>\ws\WorldServer.ear\ws.war\WEB-INF\classes\co nfig UNIX: <WS_HOME>/ws/WorldServer.ear/ws.war/WEB-INF/classes/co nfig 2. Also, save any.properties files that you have modified, such as tm.properties SentenceBreaker.properties WordBreaker.properties exchange.properties xep.xml Note: If you are using Apache Tomcat on Solaris/Linux and have an existing Output and Artwork framework, also back up: Installation and Upgrade Guide 85
Full Upgrade Procedures $TOMCAT_HOME/conf/server.xml 3. Save any reports you have created. Database Schema Upgrades This section describes upgrading the WorldServer database schema. After you finish upgrading your schema you must upgrade your WorldServer software and database objects. Note: This section includes instructions for upgrading from WorldServer 9.4.0 onwards. If you are on an earlier version of WorldServer, contact SDL Technical Support. After you upgrade your database, you must still validate your database objects. See the full set of upgrade instructions in the Basic WorldServer Upgrade Steps topic. In most cases, the database schema upgrade will be performed by your database administrator. You should inform this DBA that the files required for the schema upgrade are in the upgrade folder of the WorldServer distribution. The following steps provide general, high-level guidelines for upgrading a WorldServer database. If your company does not have its own database strategy, consider using this one. 1. Inform all users prior to upgrading that the WorldServer application and database instance will be down(how long and time period). 2. Disable all access to the production WorldServer database at the planned down time. 3. Back up your WorldServer system both the files and database(s). 4. Carefully follow all documented steps to upgrade the WorldServer database, keeping these notes in mind: Itmaytakeawhileforthemainupgradescripttofinishrunning;thetime dependsonthesizeandtuningofthedatabase,andtheconfigurationofthe database server. Read all log files carefully before proceeding to the next step, and be patient! Ifyourunintoproblems,sendthelogfilestoSDLTechnicalSupport. 5. Run the correct upgrade scripts for your Oracle or SQL Server database, and then verify that the upgrade script successfully completed. The upgrade scripts are in the upgrade folder of the distribution. The upgrade\ 1000 folder contains scripts to test your database before upgrading. The upgrade\1010 folder contains the scripts for performing and then testing the upgrade: testschema.sh(solaris/linux) or testschema.bat(windows). Note: See the appropriate release notes for any additional upgrade information. Cumulative updates and hotfixes may also require database upgrades. 86 Installation and Upgrade Guide
Full Upgrade Procedures Upgrading the Oracle Database from 9.4 About this task These steps provide instructions for upgrading an Oracle database on the database server machine. Separate instructions tell you how to upgrade the WorldServer application server software. Afterrunningeachscript,saveandcheckthelogfilebyusingthespoolcommand. Procedure 1. Start with a WorldServer Version 9.4 database. If you re upgrading to a new instance of an Oracle database(rather than upgrading in place), when you create the database, set the default character encoding for the Oracle database server to: AL16UTF16 NCHAR 2. Set the WS_HOME environment variable. For a Tomcat installation: Windows: set WS_HOME=<TOMCAT_HOME>\webapps\ws UNIX: export WS_HOME=<TOMCAT_HOME>/webapps/ws For a WebSphere installation: Windows: set WS_HOME=<WEBSPHERE_HOME>\ws\ws.ear\ws.war UNIX: export WS_HOME=<WEBSPHERE_HOME>/ws/ws.ear/ws.war 3. Use SQLPlus to run the following query: select value from configuration where propertyid=20 and name = internal/current_schema_version ; This command verifies the database version. Confirm that the return value is 9.4.0. 4. Testthe9.4versionschemabeforetheupgradetocleanupanyerrorsbeforethe upgrade.ataminimum,youmaywanttorunthefollowingscriptforthisrelease: Windows: Installation and Upgrade Guide 87
Full Upgrade Procedures upgrade\940\testschema.bat UNIX: chmod a+x upgrade/940/*.sh upgrade/940/testschema.sh The testschema script verifies that the entire schema complies with the 9.4 version of Wor ldserver. Note: If you deleted the TM called default, testschema may report warnings that you can ignore. These warnings will look like the following: INFO: System Data has changed; TMDATABASES [TMDATABASEID, NAME, DESCRIPTION, SHINGLINGFLAG] EXPECTED: [[1, Default, Default TM database, null]] FOUND: [] 5. Connect to the WorldServer database with SQLPlus. 6. Upgrade the database using the upgrade scripts found in the distribution kit: Windows: upgrade\ws-upgrade-9.4.0-to-10.0.0.ora.sql UNIX: upgrade/ws-upgrade-9.4.0-to-10.0.0.ora.sql 7. Verify the database version by running the following script in SQLPlus: select value from configuration where propertyid=20 and name = internal/current_schema_version ; Confirm that the return value is 10.0.0. Whattodonext Continue to the procedure for updating your 10.0 database to 10.1. 88 Installation and Upgrade Guide
Full Upgrade Procedures Upgrading the Oracle Database from 10.0 About this task These instructions refer to a database that has already been upgraded to the 10.0 schema. You cannot upgrade from any earlier version of WorldServer directly to 10.1. Note:Ifyouareupgradingto10.1immediatelyafteryouupgradedfrom9.4to10.0,skip directly to step 5. Procedure 1. Start with a WorldServer version 10.0 database. If you re upgrading to a new instance of an Oracle database(rather than upgrading in place), when you create the database, set the default character encoding for the Oracle database server to: AL16UTF16 NCHAR 2. Set the WS_HOME environment variable if necessary, as described in the 9.4 upgrade instructions. 3. Use the SQLPlus query from the 9.4 upgrade instructions to verify the database version. 4. Testthe10.0versionschemabeforetheupgradetocleanupanyerrorsbeforethe upgrade.(scripts are in the upgrade/1000 folder of the distribution.) 5. For WebSphere environments, copy the jasper.jar and tomcat-juli. jar files from the root of the WorldServer deployment location(such as <WS_HOME>/ws) to the WEB-INF/lib directory. 6. If necessary, connect to the WorldServer database with SQLPlus. 7. Upgrade the database using the upgrade scripts found in the distribution kit: Windows: upgrade\ws-upgrade-10.0.0-to-10.1.0.ora.sql UNIX: upgrade/ws-upgrade-10.0.0-to-10.1.0.ora.sql 8. Add stored procedures and triggers using these scripts, found in the distribution kit: Windows: upgrade\create_sp.ora.sql create_tr.ora.sql UNIX: Installation and Upgrade Guide 89
Full Upgrade Procedures upgrade/create_sp.ora.sql create_tr.ora.sql Whattodonext You have completed updating your database to WorldServer 2011 version 10.1.0. Continue with the upgrade procedure, as outlined in the Basic WorldServer Upgrade Steps topic. Upgrading the Oracle Database from 10.1 About this task These instructions refer to an Oracle database that has already been upgraded to the 10.1 schema. You cannot upgrade from any earlier version of WorldServer directly to 10.2. Note:Ifyouareupgradingto10.2immediatelyafteryouupgradedfrom9.4to10.1, skipdirectlytostep5. Procedure 1. Start with a WorldServer version 10.1 database. If you re upgrading to a new instance of an Oracle database(rather than upgrading in place), when you create the database, set the default character encoding for the Oracle database server to: AL16UTF16 NCHAR 2. Set the WS_HOME environment variable if necessary, as described in the 9.4 upgrade instructions. 3. Use the SQLPlus query from the 9.4 upgrade instructions to verify the database version. 4. Testthe10.1versionschemabeforetheupgradetocleanupanyerrorsbeforethe upgrade.(scripts are in the upgrade/1010 folder of the distribution.) 5. For WebSphere environments, copy the jasper.jar and tomcat-juli. jar files from the root of the WorldServer deployment location(such as <WS_HOME>/ws) to the WEB-INF/lib directory. 6. If necessary, connect to the WorldServer database with SQLPlus. 7. Upgrade the database using the upgrade scripts found in the distribution kit: Windows: upgrade\ws-upgrade-10.1.0-to-10.2.0.ora.sql UNIX: upgrade/ws-upgrade-10.1.0-to-10.2.0.ora.sql 90 Installation and Upgrade Guide
Full Upgrade Procedures 8. Add stored procedures and triggers using these scripts, found in the distribution kit: Windows: upgrade\create_sp.ora.sql create_tr.ora.sql UNIX: upgrade/create_sp.ora.sql create_tr.ora.sql Upgrading the Oracle Database from 10.2 This topic explains how you upgrade from 10.2.0 to 10.2.1. Procedure 1. Merge the settings from the existing*.properties files into the newer versions of these files in your WorldServer 10.2.1 installation. These files are located in the WEB-INF\ classes\config directory of the WorldServer application in your application server. Note: Merging the files ensures that you preserve customized settings while taking advantage of new WorldServer capabilities. Without this step your users may experience unexpected behavior. 2. Run the appropriate WorldServer database upgrade scripts as listed previously to get to10.1.2. 3. From 10.1, you will then need to run the WS-Upgrade-10.1.0-to-10.2.0.xxx.sql script in the same folder as preceding upgrade scripts. xxx corresponds to ora for Oracle environments. 4. From 10.2, you will then need to run the WS-Upgrade-10.2.0-to-10.2.1.ora.sql script in the same folder as preceding upgrade scripts. 5. Finally, to confirm successful installation of WorldServer 2011 10.2.1, continue with Finishing Your Upgrade in the release notes. 6. After you have run all of the appropriate database upgrade scripts, you must validate the upgraded WorldServer 10.2.1 objects and database schema. 7. See the Validating Your Upgrade section for a full description of the environment variables you must set, and the testschema verification script. 8. Note: Finish running all applicable upgrade database scripts before you verify your upgrade with the testschema script. 9. Following the successful completion of the above, your upgrade is complete and services should be started to allow users to login and utilize the newly upgraded system. Installation and Upgrade Guide 91
Full Upgrade Procedures Upgrading the Oracle Database from 10.2.1 This topic describes how to upgrade from 10.2.1 to 10.3. Procedure 1. Merge the settings from the existing*.properties files into the newer versions of these files in your WorldServer 10.3 installation. These files are located in the WEB-INF\ classes\config directory of the WorldServer application in your application server. Note: Merging the files ensures that you preserve customized settings while taking advantage of new WorldServer capabilities. Without this step your users may experience unexpected behavior. 2. Run the appropriate WorldServer database upgrade scripts as listed previously to get to10.2.1. 3. From 10.1, you will then need to run the WS-Upgrade-10.1.0-to-10.2.0.xxx.sql script in the same folder as preceding upgrade scripts. xxx corresponds to ora for Oracle environments. 4. From 10.2.0, you will then need to run the WS-Upgrade-10.2.0-to-10.2.1.ora.sql script in the same folder as preceding upgrade scripts. 5. From 10.2.1, you will then need to run the WS-Upgrade-10.2.1-to-10.3.ora.sql script in the same folder as preceding upgrade scripts. 6. Finally, to confirm successful installation of WorldServer 2011 10.3, continue with Finishing Your Upgrade in the release notes. 7. After you have run all of the appropriate database upgrade scripts, you must validate the upgraded WorldServer 10.2.2 objects and database schema. 8. See the Validating Your Upgrade section for a full description of the environment variables you must set, and the testschema verification script. 9. Note: Finish running all applicable upgrade database scripts before you verify your upgrade with the testschema script. 10. Following the successful completion of the above, your upgrade is complete and services should be started to allow users to login and utilize the newly upgraded system. 92 Installation and Upgrade Guide
Full Upgrade Procedures Upgrading the Oracle Database from 10.3 Thistopicdescribeshowtoupgradefrom10.3to10.4. Procedure 1. Merge the settings from the existing*.properties files into the newer versions of these files in your WorldServer 10.3 installation. These files are located in the WEB-INF\ classes\config directory of the WorldServer application in your application server. Note: Merging the files ensures that you preserve customized settings while taking advantage of new WorldServer capabilities. Without this step your users may experience unexpected behavior. 2. Run the appropriate WorldServer database upgrade scripts as listed previously to get to 10.3. 3. From 10.3, you will then need to run the WS-Upgrade-10.3-to-10.4.ora.sql script in the same folder as preceding upgrade scripts. 4. Finally, to confirm successful installation of WorldServer 2011 10.34 continue with Finishing Your Upgrade in the release notes. 5. After you have run all of the appropriate database upgrade scripts, you must validate the upgraded WorldServer 10.4 objects and database schema. See the Validating Your Upgrade section for a full description of the environment variables you must set, and the testschema verification script. 6. Note: Finish running all applicable upgrade database scripts before you verify your upgrade with the testschema script. 7. Following the successful completion of the above, your upgrade is complete and services should be started to allow users to login and utilize the newly upgraded system. Upgrading the SQL Server Database from 9.4 About this task These steps provide instructions for upgrading an SQL Server database on the database server machine. Separate instructions tell you how to upgrade the WorldServer application server software. Afteryouruneveryscript,saveandchecktheloginformationbyusingtheMessages PaneatthebottomoftheQueryAnalyzerwindowtocopyandpastethelogintoafile. IfyouarefamiliarwithSQLCMD,youcanrunthefollowingcommandandredirectthe results to a file instead: sqlcmd -E -d <dbname> -S <dbserver> -i WS-Upgrade-9.4.0-to-10. 0.0.ms.sql > upgrade.log Installation and Upgrade Guide 93
Full Upgrade Procedures Note: These instructions are for upgrading from WorldServer 9.4.0. If you are on an earlier version, contact SDL Technical Support for guidance on getting to 9.4.0. Procedure 1. Start with a WorldServer Version 9.4.0 database. 2. Set the WS_HOME environment variable, if necessary: For a Tomcat installation: Windows: set WS_HOME=<TOMCAT_HOME>\webapps\ws UNIX: export WS_HOME=<TOMCAT_HOME>/webapps/ws For a WebSphere installation: Windows: set WS_HOME=<WEBSPHERE_HOME>\ws\ws.ear\ws.war UNIX: export WS_HOME=<WEBSPHERE_HOME>/ws/ws.ear/ws.war 3. Use the Query Analyzer to run the following query: select value from configuration where propertyid=20 and name = internal/current_schema_version ; Confirm that the return value is 9.4.0. 4. Testthe9.4.0versionschemabeforetheupgradetocleanupanyerrorsbeforethe upgrade.ataminimum,youmaywanttorunthefollowingscriptforthisrelease: Windows: upgrade\940\testschema.bat UNIX: chmod a+x upgrade/940/*.sh upgrade/940/testschema.sh The testschema script verifies that the entire schema complies with the 9.4.0 version of Wo rldserver. 5. Upgrade the database using the upgrade script, in the distribution kit: Windows: 94 Installation and Upgrade Guide
Full Upgrade Procedures upgrade\ws-upgrade-9.4.0-to-10.0.0.ms.sql UNIX: upgrade/ws-upgrade-9.4.0-to-10.0.0.ms.sql Note: The upgrade script displays warnings, many of which say that the total row sizeinthetableexceedsthelimits.thesewarningsareharmlessanditissafetoignore them. Upgrading the SQL Server Database from 10.0 About this task These instructions refer to a database that has already been upgraded to the 10.0 schema. You cannot upgrade from any earlier version of WorldServer directly to 10.1. Afteryouruneveryscript,saveandchecktheloginformationbyusingtheMessages PaneatthebottomoftheQueryAnalyzerwindowtocopyandpastethelogintoafile. IfyouarefamiliarwithSQLCMD,youcanrunthefollowingcommandandredirectthe results to a file instead: sqlcmd -E -d <dbname> -S <dbserver> -i WS-Upgrade-10.0.0-to-1 0.1.0.ms.sql > upgrade.log Procedure 1. Start with a WorldServer Version 10.0.0 database. 2. Set the WS_HOME environment variable, if necessary. Note: See Step 2 of the 9.4 upgrade instructions for more information. 3. For WebSphere environments, copy the jasper.jar and tomcat-juli. jar files from the root of the WorldServer deployment location(such as <WS_HOME>/ws) to the WEB-INF/lib directory. 4. Use the Query Analyzer to run the following query: select value from configuration where propertyid=20 and name = internal/current_schema_version ; Confirm that the return value is 10.0.0. Installation and Upgrade Guide 95
Full Upgrade Procedures 5. Test the 10.0.0 version schema before the upgrade to clean up any errors before the upgrade.ataminimum,youmaywanttorunthefollowingscriptforthisrelease: Windows: upgrade\1000\testschema.bat UNIX: chmod a+x upgrade/1000/*.sh upgrade/1000/testschema.sh The testschema script verifies that the entire schema complies with the 10.0.0 version of Wo rldserver. 6. Upgrade the database using the upgrade script, in the distribution kit: Windows: upgrade\ws-upgrade-10.0.0-to-10.1.0.ms.sql UNIX: upgrade/ws-upgrade-10.0.0-to-10.1.0.ms.sql Note: The upgrade script displays warnings, many of which say that the total row sizeinthetableexceedsthelimits.thesewarningsareharmlessanditissafetoignore them. 7. Add stored procedures and triggers using these scripts, found in the distribution kit: Windows: upgrade\create_sp.ms.sql upgrade\create_tr.ms.sql UNIX: upgrade/create_sp.ms.sql upgrade/create_tr.ms.sql Upgrading the SQL Server Database from 10.1 About this task These instructions refer to a Microsoft SQL server database that has already been upgraded to the 10.1 schema. You cannot upgrade from any earlier version of WorldServer directly to 10.2. Afteryouruneveryscript,saveandchecktheloginformationbyusingtheMessages PaneatthebottomoftheQueryAnalyzerwindowtocopyandpastethelogintoafile. 96 Installation and Upgrade Guide
Full Upgrade Procedures IfyouarefamiliarwithSQLCMD,youcanrunthefollowingcommandandredirectthe results to a file instead: sqlcmd -E -d <dbname> -S <dbserver> -I WS-Upgrade-10.1.0-to-1 0.2.0.ms.sql > upgrade.log Note: The following procedure is written for Windows installations only. Procedure 1. Start with a WorldServer version 10.1.0 Microsoft SQL server database. 2. Set the WS_HOME environment variable, if necessary. Note: See Step 2 of the 9.4 upgrade instructions for more information. 3. For WebSphere environments, copy the jasper.jar and tomcat-juli. jar files from the root of the WorldServer deployment location(such as <WS_HOME>/ws) to the WEB-INF/lib directory. 4. Use the Query Analyzer to run the following query: select value from configuration where propertyid=20 and name = internal/current_schema_version ; Confirm that the return value is 10.1.0. 5. Test the 10.1.0 version schema before the upgrade to clean up any errors before the upgrade.ataminimum,youmaywanttorunthefollowingscriptforthisrelease: upgrade\1010\testschema.bat The testschema script verifies that the entire schema complies with the 10.1.0 version of Wo rldserver. 6. Upgrade the database using the upgrade script, in the distribution kit: upgrade\ws-upgrade-10.1.0-to-10.2.0.ms.sql Note: The upgrade script displays warnings, many of which say that the total row sizeinthetableexceedsthelimits.thesewarningsareharmlessanditissafetoignore them. 7. Add stored procedures and triggers using these scripts, found in the distribution kit: Installation and Upgrade Guide 97
Full Upgrade Procedures upgrade\create_sp.ms.sql upgrade\create_tr.ms.sql Upgrading the SQL Server Database from 10.2 This topic explains how you upgrade from 10.2 to 10.2.1. Procedure 1. Merge the settings from the existing*.properties files into the newer versions of these files in your WorldServer 10.2.1 installation. These files are located in the WEB-INF\ classes\config directory of the WorldServer application in your application server. Note: Merging the files ensures that you preserve customized settings while taking advantage of new WorldServer capabilities. Without this step your users may experience unexpected behavior. 2. Run the appropriate WorldServer database upgrade scripts as listed previously to get to10.1.0. 3. From 10.1.0, you will then need to run the WS-Upgrade-10.1.0-to-10.2.0.xxx.sql script in the same folder as preceding upgrade scripts. xxx corresponds to ms for Microsoft SQL Server environments 4. From 10.2.0, you will then need to run the WS-Upgrade-10.2.0-to-10.2.1.ms.sql script in the same folder as preceding upgrade scripts. 5. Finally, to confirm successful installation of WorldServer 2011 10.2.1, continue with Finishing Your Upgrade in the release notes. 6. After you have run all of the appropriate database upgrade scripts, you must validate the upgraded WorldServer 10.2.1 objects and database schema. 7. See the Validating Your Upgrade section for a full description of the environment variables you must set, and the testschema verification script. 8. Note: Finish running all applicable upgrade database scripts before you verify your upgrade with the testschema script. 9. Following the successful completion of the above, your upgrade is complete and services should be started to allow users to login and utilize the newly upgraded system. 98 Installation and Upgrade Guide
Full Upgrade Procedures Upgrading the SQL Server Database from 10.2.1 This topic describes how to upgrade from 10.2.1 to 10.3. Procedure 1. Merge the settings from the existing*.properties files into the newer versions of these files in your WorldServer 10.3 installation. These files are located in the WEB-INF\ classes\config directory of the WorldServer application in your application server. Note: Merging the files ensures that you preserve customized settings while taking advantage of new WorldServer capabilities. Without this step your users may experience unexpected behavior. 2. Run the appropriate WorldServer database upgrade scripts as listed previously to get to 10.2.1. 3. From 10.1.0, you will then need to run the WS-Upgrade-10.1.0-to-10.2.0.xxx.sql script in the same folder as preceding upgrade scripts. xxx corresponds to ms for Microsoft SQL Server environments. 4. From 10.2.0, you will then need to run the WS-Upgrade-10.2.0-to-10.2.1.ms.sql script in the same folder as preceding upgrade scripts. 5. From 10.2.1, you will then need to run the WS-Upgrade-10.2.1-to-10.3.ms.sql script in the same folder as preceding upgrade scripts. 6. Finally, to confirm successful installation of WorldServer 2011 10.3, continue with Finishing Your Upgrade in the release notes. 7. After you have run all of the appropriate database upgrade scripts, you must validate the upgraded WorldServer 10.3 objects and database schema. 8. See the Validating Your Upgrade section for a full description of the environment variables you must set, and the testschema verification script. 9. Note: Finish running all applicable upgrade database scripts before you verify your upgrade with the testschema script. 10. Following the successful completion of the above, your upgrade is complete and services should be started to allow users to login and utilize the newly upgraded system. Installation and Upgrade Guide 99
Full Upgrade Procedures Upgrading the SQL Server from 10.3 Thistopicdescribeshowtoupgradefrom10.3to10.4. Procedure 1. Merge the settings from the existing*.properties files into the newer versions of these files in your WorldServer 10.4 installation. These files are located in the WEB-INF\ classes\config directory of the WorldServer application in your application server. Note: Merging the files ensures that you preserve customized settings while taking advantage of new WorldServer capabilities. Without this step your users may experience unexpected behavior. 2. Run the appropriate WorldServer database upgrade scripts as listed previously to get to 10.3. 3. From 10.3, you will then need to run the WS-Upgrade-10.3-to-10.4.ms.sql script in the same folder as preceding upgrade scripts. 4. Finally, to confirm successful installation of WorldServer 2014 10.4, continue with Finishing Your Upgrade in the release notes. 5. After you have run all of the appropriate database upgrade scripts, you must validate the upgraded WorldServer 10.4 objects and database schema. 6. See the Validating Your Upgrade section for a full description of the environment variables you must set, and the testschema verification script. 7. Note: Finish running all applicable upgrade database scripts before you verify your upgrade with the testschema script. 8. Following the successful completion of the above, your upgrade is complete and services should be started to allow users to login and utilize the newly upgraded system. Upgrading WorldServer Software About this task After you finish upgrading your database, follow these steps to upgrade the WorldServer installation on your application server. Note: You must clear your browser cache memory before running WorldServer 10.4 for the first time. 100 Installation and Upgrade Guide
Full Upgrade Procedures Procedure 1. Uninstall your previous WorldServer instance(for Windows, use Add or Remove Programs to select SDL WorldServer). This is particularly important if you are going from a WorldServer 10.0 32-bit installation to a WorldServer 10.1 64-bit installation. 2. In Windows environments only, run setup.exe for 32-bit systems, or setup_x64. exe for 64-bit systems. 3. For Windows, install the new WorldServer software by expanding the WS10<build number>_win.zip distribution file. The installer first uninstalls and removes the old WorldServer and Tomcat instances. It then installs the new WorldServer, Tomcat and Java developers kit. You do not need todownloadorinstallthews.warfile.itisincludedintheoperatingsystem distribution files. The installer first uninstalls and removes the old WorldServer and Tomcat instances. It then installs the new WorldServer, Tomcat and Java Runtime Environment. Note: For WorldServer version 10.1, you cannot use the Windows installer for WebSphere. 4. For Solaris/Linux, expand the WS10<build number>_unix.tar.gz distribution file. 5. If WorldServer was started, stop WorldServer before proceeding. You stop and start WorldServer via the application server into which it is deployed. See the SDL WorldServer Basic Operations Guide for more information. 6. Deploy your WorldServer upgrade as described in the appropriate deployment topics in the WorldServer Installation chapter of this guide. Your procedure will differ depending on whether you use the Tomcat or WebSphere application server. 7. Re-apply all custom configurations: a. Apply your changes from your existing configuration file to the new configuration files. See the separate topics describing WorldServer properties files. Donotjustreplacethenewpropertiesfileswiththeoldversions,oryouwill lose the improvements in the new files. You must bring your customizations from the old files into the new files, if the customizations are still appropriate. Note:SomepropertiescanbestoredineithertheWindowsRegistryorina properties file. If you are using Windows, any WorldServer properties stored in the Windows Registry override properties stored in a properties file. Copy the database configuration from the general.properties file you saved to the new general.properties file, along with the other updates required for general.properties. Installation and Upgrade Guide 101
Full Upgrade Procedures Note:(Oracle users) The configuration properties changed for Oracle in the WorldServer 10.0 general.properties file. When you merge back your general.properties file, you must be sure to use the JDBC property syntax in the WorldServer 10.0 general.properties file, not thesyntaxfromyour9.4file.changethefollowingentriesinthe general.properties file: # Oracle #database_driver=com.idiominc.jdbc.oracle.oracledriver #database=jdbc:idiom:oracle://host:1521;sid=database Removethecommentfromthelasttwolinesbyremovingthe# before database. In the last line, insert the appropriate URL connection string. jdbc:idiom:oracle://<dbservername>:<port if any>;sid=<dbname> Forexample,iftheOracledatabaseservernameiswsdataandtheda tabase name is worldserver, then the entire section would read: # JDBC driver configuration # Oracle database_driver=com.idiominc.jdbc.oracle.oracled river database=jdbc:idiom:oracle://wsdata:1521;sid=wor ldserver By default, the new versions of the properties files are in the following locati ons: In a Tomcat environment, these files are by default stored in: Windows: <WS_HOME>\tomcat\webapps\ws\WEB-INF\classes\con fig UNIX: <WS_HOME>/tomcat/webapps/ws/WEB-INF/classes/con fig In a WebSphere environment, these files are by default stored in: Windows: <WS_HOME>\ws\WorldServer.ear\ws.war\WEB-INF\clas ses\config 102 Installation and Upgrade Guide
Full Upgrade Procedures UNIX: <WS_HOME>/ws/WorldServer.ear/ws.war/WEB-INF/clas ses/config b. Apply any other customizations you may have made in previous configuration files to the new configuration files. 8. If desired, install the JasperReports server following the directions in the Report Center chapter of this Installation and Upgrade Guide. 9. If you implemented additional custom code in an earlier version of WorldServer, recompile the code against the new version of WorldServer and upload again. If you need help with this upgrade, please contact SDL Professional Services. Validating Your Upgrade About this task Check your environment variable and verify the database upgrade. Procedure 1. Make sure that the environment variable WS_HOME points at your WorldServer installation. Note:IfyousetWS_HOMEtoalocationthathasspacesinthename,youcannotuse quotesaroundyourpathwhenyoudefineit.useapathlikethis: WS_HOME=c:\program files\idiom\worldserver\tomcat\webapps\ws Ifyousurroundthepathinquotes,thebatchfileswillfailwiththeerrorbelow. Exception in thread "main" java.lang.noclassdeffounderror: files\idiom\worldserver\tomcat\webapps\ws \WEB-INF\classes; c:\program For a Tomcat installation: MakesureyourBeforerunningtheupgradeandtestscripts,alsobesurethatyour TOMCAT_HOME and CATALINA_HOME environment variables are set. Windows: set WS_HOME=<TOMCAT_HOME>\webapps\ws set CATALINA_HOME=<TOMCAT_HOME> UNIX: export WS_HOME=<TOMCAT_HOME>/webapps/ws export WS_CATALINA=<TOMCAT_HOME> For a WebSphere installation: Installation and Upgrade Guide 103
Full Upgrade Procedures Make sure WEBSPHERE_HOME is correctly defined: Windows: set WS_HOME=<WEBSPHERE_HOME>\ws\ws.ear\ws.war UNIX: export WS_HOME=<WEBSPHERE_HOME>/ws/ws.ear/ws.war 2. Set execute permissions on the wsupgrade scripts, if applicable. These do not apply to 10.2: > cd <upgrade directory> > chmod 777 3. Run the following scripts to upgrade the WorldServer objects(for example, your translation memory and AIS mounts) and collect an upgrade log to review for errors. a. Onlyifyouareupgradingfrom9.4,runthisscriptfirst. Windows: upgrade\1000\wsupgrade.bat > wsupgrade.log UNIX: upgrade/1000/wsupgrade.sh > wsupgrade.log b. Upgrade from 10.0 with this script(not applicable for 10.2): Windows: upgrade\1010\wsupgrade.bat > wsupgrade.log UNIX: upgrade/1010/wsupgrade.sh > wsupgrade.log 4. Use the testschema script to validate the new version of WorldServer with the upgraded da tabase.ataminimum,youmaywanttorunthefollowingscriptforthisrelease,whichredire ctstheoutputtoalogfilesoyoucanchecktoseethattheschematestsucceeded. Windows: upgrade\1010\testschema.bat > testschema.log Solaris/Linux: upgrade/1010/testschema.sh > testschema.log The testschema script verifies all the steps of the incremental upgrade process and that the en tire schema complies with the latest version of WorldServer. 104 Installation and Upgrade Guide
Full Upgrade Procedures Starting WorldServer and Verifying the Upgrade About this task You have now completed the WorldServer upgrade. Do the following to resume your WorldServer operation: Procedure 1. StartWorldServer. You stop and start WorldServer via the application server into which it is deployed. See the SDL WorldServer Basic Operations Guide for more information. 2. Verify that all WorldServer functionality works as expected. 3. Notify users that WorldServer is back online. Installation and Upgrade Guide 105
Full Upgrade Procedures 106 Installation and Upgrade Guide
Chapter 9 Application Updates SDL sometimes releases application updates to WorldServer. In this type of installation, you simply replace your existing ws.war file and expand it by restarting the application server. You do not have to upgrade the WorldServer binaries or database schema. Note: This type of update is sometimes used for hotfixes or cumulative updates. It does not apply to major updates such as SDL WorldServer 2011, version 10.1 or version 10.2. Note: In addition to redeploying ws.war, there are likely to be new and updated files, outside of the expanded ws.war file, that you should manually place into your WorldServer installation. See the WorldServer Release Notes for information about other files you might need to replace. Installing an Update Procedure 1. Back up your WorldServer installation and configuration files. Youneedtopreserveanycustomconfigurationsyoumayhavemadetoyour.properties files. 2. Obtain the ws.war file for the Service Pack from SDL Technical Support. 3. Stop the application server(tomcat or WebSphere). You stop and start WorldServer via the application server into which it is deployed. See the SDL WorldServer Basic Operations Guide for more information. 4. MoveyourwsdirectorytoaplacefromwhichyoucanrecoveritiftheServicePack install fails. 5. Putthenewws.warfileinthedirectorywheretheoldonewas.Seethedeployment steps for your specific application server. 6. Restart the application server(tomcat or WebSphere) to unpack the WAR file. 7. Stop the application server again. Installation and Upgrade Guide 107
Application Updates 8. MergebacktheconfigurationfilesyousavedinStep1.Donotjustreplacethe propertiesfileswiththeoldversions,oryouwilllosetheimprovementsinthenew files. Note: Some properties can be stored in either the Windows registry or in a properties file. If you are using Windows, any WorldServer properties stored in the Windows registry override properties stored in a properties file. 9. Run the testschema.sh(unix) or testschema.bat(windows) test script to verify the database schema upgrade. 10. Start the application server again. 11. Contact SDL Technical Support for any changes to files residing outside the WorldServer WAR file. Documentation, for example, may change from release to release. The SDL WorldServer Documentation and Resources section in the Preface of this document includes information on locating documentation files in the product and the distribution. Redeploying onto Apache Tomcat Before you begin Todeploythenewws.warfile,justplaceitinthelocationwherethepreviousWARfilewasandrestart Tomcat. Be sure that you have backed up your WorldServer configuration files before you execute these instructions. You merge back any modified files after you have redeployed the WAR file. These instructions assume you have obtained the new WAR file from SDL Technical Support. Procedure 1. Rename the old ws.war file and ws directory.this backs up your customized files so youcanmergethembackafteryoudeploythenewwarfile. a. For Windows rename <TOMCAT_HOME>\ webapps\ ws.war and the <TOMCAT_HOME>\ webapps\ wsdirectory. The <TOMCAT_HOME> directory is the location of the installed version in <WS_HOME>\ Idiom\ WorldServer\ tomcat. By default, this directory expands to C:\Program Files\Idiom\WorldServer\tomcat. b. For UNIX, rename ${WS_HOME}/ apache-tomcat-7.0.42/ webapps/ ws.war and the ${WS_HOME}/ apache-tomcat-7.0.42/ webapps/ ws directory. 108 Installation and Upgrade Guide
Application Updates Note:Whenyourenamews.war,youcankeepitinthesamelocationifyoumodify the end of the filename. For example, you can name it ws.war.may19.2012. However,ifyourenameitbutleavetheextensionas.war(forexample, ws.may.19.2012.war), because Tomcat expands any.war file it finds in that directory,itwillexpandthis backup filewhenyoustarttomcatandyouwillhavea conflict. To avoid this conflict, either use a different file extension or move the file to another directory. 2. Copy the new ws.war file to <TOMCAT_HOME>\ webapps(for Windows) or ${WS_HOME}/ apache-tomcat-7.0.42/ webapps(for UNIX). 3. Restart Tomcat and wait for the ws.war file to completely expand. When it has finished, the.complete file appears in the <TOMCAT_HOME>\ webapps\ ws directory for Windows or the ${WS_HOME}/ apache-tomcat-7.0.42/ webapps/ ws directory for UNIX: a. On Windows, start the Tomcat service(called the Idiom Process Monitor). Note: If you deployed WorldServer into Tomcat manually, instead of letting the WorldServer installer deploy it, there will not be an Idiom Process Monitor and you must use a startup script instead. b. On Solaris, run the following command as root: > /etc/init.d/worldserver start c. OnLinux,runthefollowingcommandasroot: 4. StopTomcat. > /sbin/service worldserver start 5. Merge the.properties files that you modified in your WorldServer 9.0 environment from the original directory into the new directory. Among the files you probably modified is general.properties. You might also have modified exchange.properties, tm.properties, and other properties files. For Windows, merge the properties files from: <original ws directory now renamed>\web-inf\classes\config into the equivalent.properties files in the following directory: <newly created ws directory>\web-inf\classes\config For UNIX, merge the properties files from: Installation and Upgrade Guide 109
Application Updates <original ws directory now renamed>/web-inf/classes/config into the equivalent.properties files in the following directory: <newly created ws directory>/web-inf/classes/config Ifyoumadeanyotherfilemodifications,savethosealso.Forexample,ifyouadded any fonts and updated the <TOMCAT_HOME>\ webapps\ ws\ gep\ xep\ xep.xml file(for Windows) or ${WS_HOME}/ apache-tomcat-7.0.42/ ws/ gep/ xep/ xep.xml(for UNIX), back up xep.xml as well as the gep/xep/fonts direct ory where you placed the fonts. Donotjustreplacethepropertiesfileswiththeoldversions.Besuretocopythedatab ase configuration from the general.properties file you saved to the new gen eral.properties file. SomepropertiescanbestoredineithertheWindowsregistryorinapropertiesfile.If you are using Windows, any WorldServer properties stored in the Windows registry override properties stored in a properties file. Other files you might have modified, and need to restore, include: tm.properties SentenceBreaker.properties WordBreaker.properties Note:Note:IfyouareausingApacheTomcatonUNIX,andhaveanexistingOutput and Artwork framework, also merge back: <TOMCAT_HOME>/conf/server.xml 6. RestartTomcat. Results The update is now in place. The WorldServer login screen now indicates an update version number after the build number. Whattodonext Shouldyouneedtorollback,stopTomcat,backupthenewwsdirectory(renamingthe directory), rename the original ws directory back to its original name, and restart Tomcat. 110 Installation and Upgrade Guide
Application Updates Redeploying onto IBM WebSphere In these instructions for redeploying the WorldServer WAR file, we call the location of the installation directory for your WorldServer application server <WS_HOME>. Do not confuse this with the directory where you installed your WebSphere Web application. Be sureyouhavenotedthelocationintowhichyoudownloadedthe ws.warfile.youwill need to point the WebSphere Administrative Console to this location later. Be sure that you have backed up your WorldServer configuration files before you execute these instructions. You merge back any modified files after you have redeployed the WAR file. These instructions assume you have obtained the new WAR file from SDL Technical Support. Note: These instructions follow the Windows convention of backslashes in paths. For UNIX, use slashes instead. WebSphere 7 Update Procedure 1. If you haven't done so already, save your configuration files, including the general.properties file, in a directory outside the application area. You will need to restore it into the application area later. 2. Log on to the WebSphere Admin Console. 3. Inthepanelontheleftside,expandtheApplicationstreeandclickontheEnterprise Applications link. 4. Select your WorldServer application and click the Stop button. 5. When the WorldServer application is stopped, keep it selected and click Update. 6. On the"preparing for the application installation" screen, Replace the entire application should be selected. 7. Click the Browse button to locate the WorldServer WAR file(ws.war) that you downloaded earlier. 8. In the Context Root text field, enter/ws(or whatever you used in the original install). 9. Click Next and wait while WebSphere collects information for the deployment. 10. In the Select installation options screen, on Step 1: Select installation options, accept the settings and click Next. 11.Inthe Mapmodulestoservers screen,onstep2:mapmodulestoservers,check the box next to Idiom WorldServer and click Next. 12.Inthe MapvirtualhostsforWebmodules screen,onstep3:mapvirtualhostsfor Web modules, check the box next to Idiom WorldServer and click Next. 13.Inthe Summary screen,onstep4:summary,clickfinishandwaituntilyousee the Application WorldServer has installed successfully message. Installation and Upgrade Guide 111
Application Updates 14.ClicktheSavelinktosavethechangestothemasterconfiguration,andwaituntilthe save operation finishes. 15. To ensure that email notifications work: a. StillintheWebSphereAdminConsole,ontheleftsidepanel,expandthe Applications tree and click the Enterprise Applications link. b. Click the link for the WorldServer application. c. Click the Class loading and update detection link. d. Set Class loader order to"class loaded with application class loader first." e. Set WAR class loader policy to"single class loader for application. f. Set Polling interval for updated files to 600 seconds. g. ClickOK. h. Save directly to the master configuration and restart WebSphere. 16. Merge any appropriate changes in your original general.properties file to the new versions of those files you just deployed. Note: Do not simply overwrite the new configuration(.properties) files with the original files. It is important to preserve your database configuration settings, for example. 17. Close the WebSphere Admin Console and restart the WebSphere service. Results The update is now in place. The WorldServer login screen now indicates an update version number after the build number. Whattodonext Shouldyouneedtorollback,stopWebSphere,backupthenewwsdirectory(renaming the directory), rename the original ws directory back to its original name, and restart WebSphere. 112 Installation and Upgrade Guide