Installation and Upgrade Guide. SDL WorldServer 10.4

(1)

(2)

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.

If you are an entity of the U.S. government, you agree that the program(s) and data referred to in this document are Commercial Computer Software, as defined in the F.A.R., and the DoD F.A.R. Suppl., and are delivered with only those rights set forth in the 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 of the program(s). SDL shall not be liable for any claims or damages arising from such use of the program(s) for any such 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

(3)

1 About the SDL WorldServer Install and Upgrade Guide ... 1

SDL WorldServer Documentation and Resources . . . 1

2 WorldServer Installation ... 5

WorldServer Installation Process . . . 5

Setting up a SQL Server Database . . . 7

Setting Up an Oracle Database . . . 13

Installing WorldServer on Windows . . . 18

Installing WorldServer on Solaris or Linux . . . 22

WorldServer Deployments for Apache Tomcat . . . 25

Deploying on Windows . . . 25

Deploying on UNIX . . . 27

WorldServer Deployments for IBM WebSphere . . . 29

Deploying on Windows . . . 29

Deploying on UNIX . . . 31

3 Properties Files ... 33

Configuring Mandatory general . . . 33

Configuring Other general.properties Settings . . . 37

Configuring Clustered Mode Properties . . . 39

Other Properties Files . . . 42

4 Report Center ... 45

JasperReports Server Installation Overview . . . 45

JRS Installation Prerequisites . . . 47

Platform Notes . . . 47

Application Server Notes . . . 49

Enabling Single Sign-on for JRS . . . 50

Reports Repository . . . 51

Set Data Source . . . 52

Configuring Reporting over HTTPS . . . 53

Log file . . . 53

User Permissions . . . 53

5 Secure Settings and Connections ... 55

Setting Up a Secure Connection for External Users . . . 55

(4)

6 SDK Sample Objects ... 59

Uploading the WorldServer SDK Samples . . . 60

Importing Sample Objects . . . 61

7 File Type Support Server Installation ... 63

Installing the FTS Server . . . 64

WorldServer Windows Configuration for FTS . . . 66

WorldServer Solaris and Linux Configuration for FTS . . . 69

Sharing Filesystems for FTS and WorldServer . . . 70

FTS Connections for Solaris or Linux Using Samba . . . 72

Linux Filesystem Mounts Using Samba . . . 75

Configuring NFS AIS Mounts for Linux and FTS . . . 75

FTS Server Upgrade from Installer . . . 78

Adding Language Resource Templates . . . 79

Running the FTS Server . . . 80

8 Full Upgrade Procedures ... 81

Basic WorldServer Upgrade Steps . . . 81

Cluster Upgrade Steps . . . 83

Backing up Installation and Configuration Files . . . 84

Database Schema Upgrades . . . 86

Upgrading the Oracle Database from 9.4 . . . 87

Upgrading the Oracle Database from 10.2.1 . . . 92

Upgrading the SQL Server Database from 9.4 . . . 93

Upgrading the SQL Server Database from 10.2.1 . . . 99

Upgrading the SQL Server from 10.3 . . . 100

Upgrading WorldServer Software . . . 100

Validating Your Upgrade . . . 103

Starting WorldServer and Verifying the Upgrade . . . 105

9 Application Updates ... 107

Installing an Update . . . 107

Redeploying onto Apache Tomcat . . . 108

Redeploying onto IBM WebSphere . . . 111

(5)

About the SDL WorldServer Install

and Upgrade Guide

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.

Scope

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.

(6)

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.

(7)

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. A full web help system is available from the Help link at the top of each page. 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. A full web help system is available from the Help link at the top of each

(8)

(9)

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.

(10)

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.

What to do next

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.

(11)

Setting up a SQL Server Database

WorldServer can store all of its internal information (workflow definitions, terminology database, and so on) in a SQL Server database.

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 database for you. However, there may be cases where you need to manually create and 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.

characters only. Do not, for example, specify a database name in Kanji or Katakana characters. Do not include a hyphen in your database name as this may result in issues 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.

(12)

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, and generally does a good job of it. In some cases, changing SQL Server 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.

The easiest way to view your SQL Server's configuration settings is to run the

sp_configurecommand in Query Analyzer. See your SQL Server Books Online for more information about this command.

■ _{Memory Requirements}

For best SQL Server performance, it is recommended that SQL Server run on a 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. In most cases, the SQL Server settings for themaximum server memoryand the minimum server memoryshould 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(in MB), tells SQL Server to manage the use of memory dynamically, and if it needs it, to use as much RAM as is available (while leaving some memory for the operating system).

■ _Theminimum server memorysetting, when set to the default value of 0(in MB), tells SQL Server to manage the use of memory dynamically. This means that SQL Server will start allocating memory as is needed, and the minimum amount of RAM used can vary as SQL Server's needs vary.

(13)

Note: Normally, the SQL Server 2005 Enterprise Edition and SQL Server 2005

Developer Edition can only use up to2GB of physical memory, no matter how much memory you have on the server. With the use of the Microsoft Windows 2003 Address Windowing Extensions (AWE) enable option, SQL Server can use up to4GB of physical memory.

■ _Parallelism

Themax degree of parallelism option allows you to specify if parallelism is turned on or off, or only turned on for some CPUs on your server. Parallelism refers to the ability of the Query Optimizer to use more than a single CPU to execute a single query. By default, parallelism is turned on and can use as many CPUs as there are running on your server. This default setting is the best general 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 theREAD_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.propertiessetting:database_connection_pool_size. By default, SQL Server allocates only as many user connections as it needs. This allows those who need it to connect, while at the same time minimizing the amount of memory used. When theuser connectionssetting is set to its default value of0, user connections are dynamically set. In nearly all cases, this default setting is the ideal setting, and should not be changed.

(14)

■ _{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. When a SQL Server database is under very heavy load, sometimes theAuto Update Statisticsfeature can update the statistics at inappropriate times, such as the busiest time of the day. But as a rule of thumb, if your server is not under maximum load, then leaving this option on is the best decision.

To check whetherAuto Update Statisticsis turned on for your WorldServer database, run this:

sp_dboption databasename

To check whetherAuto Update Statisticsis 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, be aware that this option is not a full solution:

It is possible that the statistics created by the auto-update may not be accurate enough because of the sample rows used. If the table in question is greater than8 MB, when SQL Server automatically creates statistics for the table, it does not examine every row. Instead, it takes a sample of the available rows. This sample may or may not be good enough to produce accurate enough statistics. One way to get better statistics is to manually update the statistics for the table using theUPDATE STATISTICScommand, and using either theFULLSCAN or SAMPLEcommand 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, orDELETEactivity will cause indexes to become less well organized than they were when they were first created. There will be more page splits, there will be a greater number of pages with less data on them, and consequently, there will be more I/O required to satisfy eachSELECT. The more fragmented your data and indexes become, the slower your WorldServer

application will be, and the more space your data will take up. So you will need to reindex your WorldServer database on a regular basis.

(15)

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 of whether it needs it or not. If you have a large WorldServer database with large 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

The first step is to create the physical SQL Server database. This process requires a SQL 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. Create a new database under the SQL Server instance. Do not include a hyphen in 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. Create a new user that will be used by WorldServer.

Make sure that you assign this user thedb_ownerrole for the WorldServer database. 4. Exit SQL Server Enterprise Manager.

(16)

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..

You can disregard any "MAX row size exceeded" warnings you see in the output as 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 or Linux ”on page 22.

(17)

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: You cannot create an ORACLE 11 database from the WS installer. You will be

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_PATHvariable 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, if you have a high-end installation — for example, you have very high load, 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 UNDOand working tablespaces across different disks.

With a two disk setup, for example, you could have one disk containing the working tablespace and the other containing theUNDOtablespace. With a three disk setup, you could

(18)

have theUNDOtablespace stored on one disk and the working table space is split into files residing on the other two disks.

The decision as to whether you split these contents by disk or whether you use RAID to distribute the content for you is up to you and will vary from installation to installation. 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 make at least 2 GB of RAM available to the computer that serves as the Oracle server. 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.

■ _{Set the Buffer Cache size (db_cache_size) to the rest of the SGA size.} ■ _{Set the PGA (}pga_aggregate_target) to 100 MB. Oracle will automatically

manage the Sort Area Size based on this.

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 theprocessesparameter:

processes = (nodes in cluster x database_connection_pool_size )+ 10

(19)

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 and return the connection to the pool. You might see a lot of blocking (when threads are 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 asql.ConnectionPoollogging category that can be turned on to show information about how WorldServer is using connections. This logging category shows when connections are taken, when they are returned to the pool, how many free

connections there are at any point, when connections are exhausted, and which threads are holding connections when the pool is exhausted.

You can turn the logging category on and off using a URL like the following:

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_sizeis configured in WorldServer general.properties.

If, for example,database_statement_cache_sizeis 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.

(20)

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 be performed by a DBA.

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 toAL32UTF8.

The National Character Set can be set to eitherUTF8orAL16UTF16based on the characteristics of the data you will be storing. See the Oracle documentation for recommendations on which encoding to use.

2. Startsqlplus, and log on as a DBA user (for example,systemorsys) to create the 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;

(21)

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_in-stall):

create.ora.sql setup.ora.sql create_sp.ora.sql create_tr.ora.sql

2. Log on viasqlplusto 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 or Linux ”on page 22

(22)

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:

■ _{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 toAmerican_America. UTF8in 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: 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.

(23)

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 thesetup.exefile. 2. If you are installing from a CD:

a. Insert the CD into your CD-ROM drive.

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 to a new version), you will be prompted to uninstall that version.

You will also be asked if you want to delete the “WorldServer DB” and the “RCS

Files”.

Note: Uninstalling the database for a previous version will cause you to lose all of

the data for that version including your users, workflows, translation memory, and translation database. You should only do this if you are doing a new install and want to remove any old work.

4. When the Welcome screen appears, click Next. 5. Click Yes to accept the License Agreement.

6. Type your user name and company name and click Next.

7. Choose a location to install the WorldServer program files and click Next.

Note: If you are a WebSphere application server user, be sure that the path into

which you install WorldServer has no spaces in it. Do not accept the default path of 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.

The custom option allows you to choose a location for the WorldServer log files, 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

(24)

called Idiom Process Monitor which you can use to start and stop Tomcat.

If you choose Other, the installer asks you to browse to the directory where you want it to place the WorldServer WAR (Web archive file), which you can then deploy 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 Tomcat should listen on and click Next. By default, the port is 8080. Skip to Step 12. 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 a directory named ws for the deployment. This ws will be the name you use to connect in the browser URL (for example, http://<server>:8080/ ws/ login).

Note: You do not have to have the WorldServer installer place ws.war in

<WS_HOME>. You may install it wherever you like. However, you must know the path, because you will point to it when you extract its contents.

12. Choose a database platform, either SQL Server 2008 or Oracle, and specify the following:

For SQL Server 2008:

a. Provide the name of an existing SQL Server database server and an instance to connect to.

b. If you want the installation to create a physical database and populate the schema, select the Create DB option and specify the name of the database 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

name of the database server and database that you want to use and de-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.

(25)

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.

■ _{If you chose the Create DB option in the previous step, then you must} specify a user that is in the “Database Creator” SQL Server role. ■ _{If you did not choose the Create DB option in the previous step, then}

you must specify a user that is in the “db_owner” role for the 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 theTNSNAMEof the database. TheTNSNAME can be found intnsnames.orain <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. Click Next.

Note: If at this point, you get a failure message that the system account does

not have sufficient privileges to create the database, the problem is not about the system account's privileges—it is more likely to be that you did not 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:

(26)

Important: If you chose to let the installer deploy Tomcat for you in Step 9, 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.

■ _{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: Tomcat requiresjavacandjdbto run. Therefore, you must have the full Java SDK installed, not just the JRE.

■ _{On Solaris only, if you want to use the RCS software for revision control of assets} in a file system mount, download and install GNUdiff, available from

“http://www.gnu.org”. You must install the GNUdiffexecutable in the /bin/diffdirectory.

■ _{Confirm the $JAVA_HOME environment variable is set and points to the Java} SDK installation root.

■ _{If you are installing against a SQL Server database but 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

(27)

■ _{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}rootaccess. Specifically: ■ _{If you want the application server to listen on a port lower than 1024, the}

application server will need to be run asroot.

■ _{If you want to install into a standard location (for example,} /usr/lo-cal), you will need permissions to create the directory

■ _{We recommend creating a separate UNIX login to own and manage the} WorldServer processes. Creating this user may requirerootpermissions. ■ _{If you want to configure WorldServer to start automatically on reboot, you}

will requirerootaccess 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. Log on to the target machine asroot. (If your system is set up to allowsudo, you may be able to accomplish all of these instructions by prependingsudoto 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. Create a user to own the installation, and set the user’s home directory to this new directory. This is a convenient way to collect all of the WorldServer assets in a single place and manage them.

Depending on how you have your network set up, you may either want to create a local user or you may want to create a NIS user. To create a local user run the following command asroot:

>

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. Log out asrootand log on as thewrldsrvruser.

6. If you are installing from a CD, use the following instructions to copy the distribution off of the CD:

(28)

>

cd /mnt/cdrom> cd distribution>

cp ws10.1.x.*_unix.tar.gz /usr/local/idiom/worldserver

Note: The asterisk is used here because there is a build number at this location in

the filename. You can replace the asterisk with the build number or use the command as is.

7. If you are installing from the FTP site, download the following file and copy it into your installation directory:

ws10.1.x.<build number>_unix.tar.gz

Note: Do not download the ws.war file at the top level of the FTP site. A copy is

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 thercs(revision control system) application that WorldServer utilizes and various executables (for example,wstoolanddiff), perform the following from the

solaris/bindirectory:

>

chmod a+x *

10. To ensure that your environment is set correctly every time you log on, SDL provides a sample set of login scripts.

If your default shell is in theshfamily, copy the .profile file from the unix directory as follows:

>

cd /usr/local/idiom/worldserver>

cp unix/.profile /usr/local/idiom/worldserver

If your default shell is in thecshfamily, copy the .login file from the unix direct ory as follows:

>

cd /usr/local/idiom/worldserver>

(29)

You can then use a text editor to modify the contents of this file and provide the corr 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. You can test that these new scripts are working as follows: a. Log out of thewrldsrvraccount.

b. Log back in to thewrldsrvraccount. 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

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).

(30)

Procedure

1. If you are installing from a CD, use the following instructions to copy the distribution off of the CD (assuming, here, that the D: drive is your CD drive and you are 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

point to the required Java SDK (that is, 1.7). To set it to the JRE supplied by the SDL installer, use the following command:

>

(31)

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

What to do next

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

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 from the CD: > 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:

(32)

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: The ws.war file was placed in the $WS_HOME directory in Step 8 of the

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.

■ _{If your default shell is in the}_sh_{family, add the following lines to the /usr/} local/idiom/worldserver/.profilefile:

CATALINA_HOME=${WS_HOME}/apache-tomcat-7.0.42 PATH=${CATALINA_HOME}/bin:${PATH}

■ _{If the your default shell is in the csh family, add the following lines to the} /usr/local/idiom/worldserver/.loginfile:

>

setenv CATALINA_HOME ${WS_HOME}/apache-tomcat-7.0.42> setenv PATH ${CATALINA_HOME}/bin:${PATH}

Log out and then in for the setting to take effect.

6. Navigate to apache-tomcat-7.0.42/ bin, and start Tomcat to extract the contents of ws.war.

On the first run you may need to set execute permissions on the .sh files.

>

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:

(33)

>

./shutdown.sh

What to do next

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>

(34)

\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

If you are running WebSphere on Windows, you need to ensure that a number of binaries 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 thePATHenvironment variable for the user that the application server will be running as.

WebSphere 7

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. In the panel on the left side, 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.warfile that can be found under <WS_BUILD>\ folder.

4. In theContext Roottext field, enter/wsand click Next.

5. On the “Select installation options” screen, on Step 1: Select installation options provide theApplication Name(for example, WorldServer), leave the other fields without changes, and click Next.

Note: If you want to install the application into a specific folder enter the path into

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.w-ar\

6. On the “Map modules to servers” screen, on Step 2: Map modules to servers, check the box next to Idiom WorldServer and click Next.

(35)

7. On the “Map virtual hosts for Web modules” screen, on Step 3: Map virtual hosts

for Web modules, check the box next to Idiom WorldServer and click Next.

8. On the “Summary” screen, on Step 4: Summary, click Finish and wait until you see 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. Still in the WebSphere Admin Console, on the left side panel, expand the

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. Click OK.

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.

What to do next

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

After you have performed the preliminary WebSphere UNIX procedures, use these instructions for deploying WorldServer into WebSphere 7.

(36)

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.warfile that can be found under <WS_BUILD>/folder.

4. In theContext Roottext field, enter/wsand click Next.

5. On the “Select installation options” screen, on Step 1: Select installation options provide theApplication Name(for example, WorldServer), leave the other fields without changes, and click Next.

Note: If you want to install the application into a specific folder enter the path into

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.w-ar/