The Worldserver 11.5 Planning and Prerequisites Guide

Planning and Prerequisites Guide SDL WorldServer 11.5 Legal notice

SDL Group means SDL PLC. and its subsidiaries and affiliates. All intellectual property rights contained herein are the sole and exclusive rights of SDL Group. All references to SDL or SDL Group shall mean SDL PLC. and its subsidiaries and affiliates details of which can be obtained upon written request.

All rights reserved. Unless explicitly stated otherwise, all intellectual property rights including those in copyright in the content of this website and documentation are owned by or controlled for these purposes by SDL Group. Except as otherwise expressly permitted hereunder or in accordance with copyright legislation, the content of this site, and/or the documentation may not be copied, reproduced, republished, downloaded, posted, broadcast or transmitted in any way without the express written permission of SDL.

WorldServer is a registered trademark of SDL Group. All other trademarks are the property of their respective owners. The names of other companies and products mentioned herein may be the trademarks of their respective owners. Unless stated to the contrary, no association with any other company or product is intended or should be inferred.

This product may include open source or similar third-party software.

Although SDL Group takes all reasonable measures to provide accurate and comprehensive information about the product, this information is provided as-is and all warranties, conditions or other terms concerning the documentation whether express or implied by statute, common law or otherwise (including those relating to satisfactory quality and fitness for purposes) are excluded to the extent permitted by law.

To the maximum extent permitted by law, SDL Group shall not be liable in contract, tort (including negligence or breach of statutory duty) or otherwise for any loss, injury, claim liability or damage of any kind or arising out of, or in connection with, the use or performance of the Software Documentation even if such losses and/or damages were foreseen, foreseeable or known, for: (a) loss of, damage to or corruption of data, (b) economic loss, (c) loss of actual or anticipated profits, (d) loss of business revenue, (e) loss of anticipated savings, (f) loss of business, (g) loss of opportunity, (h) loss of goodwill, or (i) any indirect, special, incidental or consequential loss or damage howsoever caused.

All Third Party Software is licensed "as is." Licensor makes no warranties, express, implied, statutory or otherwise with respect to the Third Party Software, and expressly disclaims all implied warranties of non- infringement, merchantability and fitness for a particular purpose. In no event will Licensor be liable for any damages, including loss of data, lost profits, cost of cover or other special, incidental, consequential, direct, actual, general or indirect damages arising from the use of the Third Party Software or accompanying materials, however caused and on any theory of liability. This limitation will apply even if Licensor has been advised of the possibility of such damage. The parties acknowledge that this is a reasonable allocation of risk.

Information in this documentation, including any URL and other Internet website references, is subject to change without notice. Without limiting the rights under copyright, no part of this may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of SDL Group.

ii Planning and Prerequisites Contents

1 Environment overview and recommendations ...... 1

2 Clustered mode planning ...... 5

3 System requirements ...... 9

Requirements for the application server ...... 10

Requirements for the database server ...... 11 Database size estimation ...... 12

Requirements for installing SDL Online Editor ...... 13

Prerequisites for installing the File Type Support (FTS) Server ...... 14

Supported browsers and recommendations for client machines ...... 15

4 Components supported in WorldServer ...... 17

Content repository connectors ...... 18

Third-party tools ...... 18

Translation tools and terminology providers ...... 19

Interoperability standards ...... 19

Languages for translation ...... 19

Planning and Prerequisites iii iv Planning and Prerequisites 1

Environment overview and recommendations 1 Environment overview and recommendations

WorldServer installations involve various components that you need to install on several different machines.

Run your application servers and your database server on separate machines. A typical configuration deploys the database system on a single Linux or Windows server and the WorldServer application on one or more Linux or Windows servers. Typical deployments of WorldServer also contain multiple machines that serve as clients, servers, repositories, and databases, as shown in the following diagram:

Hardware requirements depend on the amount of data and the operational load you expect on the system. WorldServer is CPU-intensive and database processing is input/output (I/O)-intensive. Thus, the application server should have adequate CPU power and the database server should have a fast disk subsystem and sufficient memory.

2 Planning and Prerequisites Environment overview and recommendations 1

Prepare for growth

Most globalization needs grow over time; therefore, you should consider installing more powerful hardware than the initial requirements indicate. This gives you extra capacity and room for scalability expansion in the future. It is much harder to upgrade to new hardware after the system is in production mode than to anticipate future growth at the outset. The most important aspect of hardware configuration is the database server. WorldServer is a highly database-intensive application; the database system can never be too powerful. The database server should place more emphasis on its I/O subsystem and memory than on the CPU power. Oracle (the recommended database management system for large deployments) uses all the memory and I/O bandwidth it can get. SDL recommends a fast RAID array. You can achieve good performance on RAID 0+1 configurations. For the application server, CPU power is more important than I/O bandwidth. A baseline system consisting of at least a 2.8-3 GHz CPU can provide good performance. The general requirements for a server configuration are as follows: • Recommended configuration: 4 x CPU Cores at 2.0 GHz each with at least 16 GB RAM, running on Windows Server 2012 R2 (64-bit) or on Windows Server 2016, to support at least 4 File Type Support (FTS) Server processes. • Database servers: 4 x 4 CPU at 2.0 GHz with 16 GB RAM, as well as sufficient high speed storage and backup allocation. On the application server, you only need disk space for keeping system files, application files, temporary files, and uploaded documents. 20-30 GB of free disk space is sufficient. If the server has enough physical memory, any modern desktop-grade disk subsystem is adequate. For workflow-intensive installations, you should allocate one or more separate business processing (workflow engine) machines. If you use sophisticated workflows containing many automatic actions, you should separate the servers that run workflow processes from those that are used for user requests. When WorldServer processes a large project through a workflow, the workflow engine uses all the CPU it can get. If the workflow engine runs on the same server as other WorldServer functions, this might impact the performance of other user requests and cause slower user interface response time. A separate workflow server helps you maintain good user interface response tine while processing large project workflows.

Dedicated vs. shared machines

You should put WorldServer on a dedicated application server machine rather than on the same application server as other web-based applications. There is no way to restrict the amount of the CPU power given to web-based applications, which means that one application can starve the others. Because WorldServer is very processor-intensive, it can degrade the performance of other applications on the same machine. Similarly, you should also put the WorldServer database under a dedicated database server installation on a dedicated machine rather than having it share a database instance with other applications.

Planning and Prerequisites 3 1 Environment overview and recommendations

4 Planning and Prerequisites 2

Clustered mode planning 2 Clustered mode planning

WorldServer was designed to run in a clustered mode with multiple application servers accessing a shared database. Clustering provides almost linear scalability on the application server side as long as the database is powerful enough.

For scalability, you should run a clustered application server configuration with each system having less CPU power, rather than a single application server on a powerful CPU system. As the demand grows, you can add server systems to accommodate possible growth in application load.

A cluster setup provides many benefits over a stand-alone configuration: • Performance – Spreading the load across multiple machines can greatly improve the responsive- ness of the system and the overall user experience. • Redundancy – A WorldServer cluster does not have any single point of failure (except for the database). If a node in the cluster goes down, the service continues uninterrupted, by switching requests to other nodes. WorldServer is a stateless application—the user state is kept either in the database or on the client—and if a node goes down, another node can continue the user session without needing to log in again and without losing data. • High availability – Because taking down a node does not interrupt the service, you can perform hardware maintenance on one node at a time without service interruption. • Specialization – The cluster can be specialized, based on your particular needs. For example, if your process involves a lot of automatic processing, you can allocate extra hardware for automatic task processing. Also, you expect considerable user interaction, use additional hardware to boost interface-serving (front-end) machines.

Clustering can include multiple WorldServer instances on a single machine (vertical clustering) or multiple instances spread across different machines (horizontal clustering). You can also have a mix of vertical and horizontal clustering.You should not put more than two WorldServer instances per CPU. For example, a dual CPU box should not run more than four WorldServer instances; otherwise, performance might decrease.

SDL does not provide any separate software to implement a cluster. You can build a cluster using a Tomcat application server by installing multiple Tomcat instances and managing them separately. You can use the Apache web server load balancer plug-in in this configuration. Commercial application servers have built-in facilities for creating and maintaining a cluster. You can stop and start nodes, upgrade them at the same time, and monitor their performance.

Clustered WorldServer deployments are designed to handle thousands of assets, translation memories of millions of words, and multiple projects going through WorldServer at the same time. They require more server and repository capacity and usually include load balancing capabilities and multiple machines, as shown in the following diagram:

6 Planning and Prerequisites Clustered mode planning 2

In a cluster, certain configuration parameters must be shared across all the nodes, while you can configure others differently to allow for node specialization. Shared parameters include: • Database – All instances must connect to the same database instance using the same credentials (user name and password). • Temporary directory – All instances must point to the same shared file system for the temporary directory (the temp_file_path property in the general.properties file). • Revision control system (RCS) directory – If you are using built-in version control, the RCS directory must also be located on a shared file system. • Any additional configuration files (.properties files that include configurations for translation memories, terminology databases, sentence breaking, and import/export) must be the same across all instances.

You can also configure certain parameters differently between the nodes: • The log file location and log level – Each node can have a separate log file. • The number of workflow engines – Each node can run zero or more workflow engines, depending on its role in the cluster. • Whether the rules engine is on or off – Each node may or may not run a rules engine thread. • The notification engine – Each node may or may not run a notification engine.

Planning and Prerequisites 7 2 Clustered mode planning

Setting up clustered workflow and background processing engines

In a generic WorldServer setup, you use a single WorldServer instance for the following purposes: • For the user interface that users interact with to create new projects, upload offline work, or modify workflows. • For the workflow engine that executes the defined workflows. • For the background processing engine for any jobs that are submitted for background processing. In a larger installation, to improve performance, you should separate these activities, assigning them to one or more machines. Specifically, you should create one or more dedicated WorldServer application machines, one or more dedicated business processing (workflow engine) machines, and one or more background processing machines. The primary benefit of this split is that you can provide adequate response times for each of the WorldServer tasks. Workflows, for example, may consume large amounts of CPU power. If the workflow engine is on the same machine as the WorldServer application, it can result in a performance decrease on the application server. Similarly, if your organization submits large jobs for background processing, response time can degrade. By separating the WorldServer application, the workflow engine, and the background processing engine, you can eliminate this sort of resource contention. In addition, by separating these activities, you can also independently scale the resources assigned to each. For example, you might start with three machines, each dedicated to one of the three main activity areas. As more background processing occurs, you might add more machines dedicated just to one area.

Controlling application access

There is no specific setting to turn off the application portion of WorldServer. In particular, you are likely to want to log in to the WorldServer instances of workflow and background processing machines to monitor jobs, configure logging settings, and so on. The best way to ensure that these machines are not used as general-purpose WorldServer application machines is to simply not give your users access to them. For example, if you have inserted a load balancer in front of the WorldServer application machines, do not include the dedicated engines in the list of machines over which you balance end-user requests.

8 Planning and Prerequisites 3

System requirements 3 System requirements

The WorldServer platform consists of the central application server, the relational database management system (RDBMS), the appropriate database clients, as well as the File Type Support (FTS) Server, which is used for processing translation assets. Requirements for the application server

The WorldServer application server is the central machine in any WorldServer deployment. This is the machine that manages all the WorldServer processes, including workflows, translation memories, and document publishing.

Supported Tomcat versions

WorldServer 11.5 supports Tomcat 9.0.22 (included).

Recommended operating systems

The following operating systems are recommended for running WorldServer 11.5: • Microsoft Windows Server 2016 (64-bit), standard and enterprise editions • Microsoft Windows Server 2012 R2 (64-bit), standard and enterprise editions • 32-bit and 64-bit Red Hat Enterprise Linux 7 • 32-bit and 64-bit Red Hat Enterprise Linux 6 • 32-bit and 64-bit CentOS 7 • 32-bit and 64-bit CentOS 6.5 Note: On 64-bit systems, a complete 64-bit infrastructure is recommended, including Tomcat and Java versions.

Supported Java version

WorldServer 11.5 supports Java 11 and includes a kit for deploying OpenJDK 11.0.3_7.

Database clients

If your database server resides on a different machine from the WorldServer application server, you need to install a database client for that database server on the WorldServer application server. Moreover, if you create the WorldServer database yourself and your database server is on a different machine than WorldServer, you also need to have a database client (Microsoft SQL Server or Oracle) on the machine on which you create the database.

10 Planning and Prerequisites System requirements 3

Recommended hardware

The general requirements for configuring the application server are as follows: • Recommended configuration: 4 x CPU Cores at 2.0 GHz each with at least 16 GB RAM, running on Windows Server 2012 R2 (64-bit) or Windows Server 2016, to support at least 4 File Type Support (FTS) Server processes. • Database servers: 4 x 4 CPU at 2.0 GHz with 16 GB RAM, as well as sufficient high speed storage and backup allocation. Also, make sure that the monitor you use for working with WorldServer has a resolution of 1024 x 768 pixels or higher. Requirements for the database server

WorldServer stores information about your installation (for example, your workflow definitions, translation memory, terminology database, and users) in a relational database management system. You can create the WorldServer database on the same machine as the WorldServer application server. However, you should install the database server on a dedicated machine and place applications and the content management system on other machines.

Recommended relational database management systems

The following relational database management systems are recommended for running WorldServer 11.5: • Microsoft SQL Server 2017, Standard and Enterprise editions • Microsoft SQL Server 2016, Standard and Enterprise editions • 32-bit and 64-bit Oracle 12c Release 1 • 32-bit and 64-bit Oracle 11g Release 1 and Release 2, Standard and Enterprise editions Note: Microsoft SQL Server is recommended only on Microsoft Windows platforms.

WorldServer does not support case-sensitive SQL Server. To use WorldServer with SQL Server, you need to configure SQL Server to be case-insensitive. The same case-sensitivity restriction applies to enterprise and standard editions, and to both 32-bit and 64-bit versions of SQL Server. On 64-bit systems, a complete 64-bit infrastructure is recommended, including Tomcat and Java versions.

Note: As of version 11.1, WorldServer supports the AlwaysOn failover feature in SQL Server, which allows you to store a database on multiple servers simultaneously. Thus, if the primary server experiences issues, one of the secondary servers becomes primary and you can continue to work without losing information.

Planning and Prerequisites 11 3 System requirements

Recommended operating systems

Use one of the following operating systems on the WorldServer 11.5 database server: • Microsoft Windows Server 2016 (English, 64-bit), standard and enterprise editions • Microsoft Windows Server 2012 R2 (English, 64-bit), standard and enterprise editions • 32-bit and 64-bit Red Hat Enterprise Linux 7 • 32-bit and 64-bit Red Hat Enterprise Linux 6 Recommended hardware

Make sure that your WorldServer database server meets the following hardware requirements: • Recommended configuration: 4 x 4 CPU at 2.0 GHz with 16 GB RAM, as well as sufficient high speed storage and backup allocation. • SCSI RAID Disk Array with a minimum of 100 GB free disk space (250 GB or higher is recommended). Database size estimation

WorldServer can handle extremely large amounts of data. However, it is essential to estimate the amount of content that a WorldServer installation might be required to handle and to provide adequate hardware, including storage capacity. The estimation of storage requirements depends on factors such as the type of data to be used, the number of target languages supported, or typical user activity patterns.

Areas in WorldServer that can require a large amount of storage space include: • Translation memories (TMs) • Terminology databases (TDs) • Segmented assets

Translation memories

You can measure translation memory size either in words or in entries, where an entry usually contains a single sentence. The average English sentence contains 15 to 20 words. An analysis of customer translation memories performed by SDL confirmed this range, with the average word count being 17 words per sentence. If you measure the size of a translation memory in the number of entries, you can use the following formula to calculate the number of words:

TM words = 17 * TM entries

To estimate the disk space required for a translation memory, you should multiply the total translation memory size in thousands of entries by a space factor that needs to be calculated experimentally and is database dependent. If you do not have any existing translation memories, you can estimate the future translation memory size from the number of words you expect to translate, using the formula presented earlier. Customers using the file types introduced in WorldServer and processed by the File Type Support (FTS) Server should expect their translation memory size to increase compared to that of TMs created with

12 Planning and Prerequisites System requirements 3

legacy WorldServer filters. This size increase should be covered by the formula change described in the CONTENT entry for the estimate guidance presented later in this topic.

Terminology databases

Terminology database (TD or termbase) size is measured in number of entries. Entries usually contain one source term and one or more target terms. In most cases, there is a one-to-one correspondence, but a terminology database entry might contain several target terms in several languages.

Segmented assets

WorldServer segments all content into textual and markup elements. Usually, segmentation is done on a sentence level; each sentence becomes a separate segment. WorldServer stores this information in its database and uses it as the representation of the internal document. Each asset (file) becomes a separate segmented document structure. The size of this structure corresponds directly to the size of the document and the amount of textual content it contains. The estimating factor in the final formula is based on markup language formats (.html, .xml, and so on). For binary data formats (.doc, .ppt) the space factor is much smaller because most of the binary data deals with formatting and does not get loaded into WorldServer.

Overhead

In addition to the three biggest storage contributors described earlier, there is also the overhead of keeping all other WorldServer information, including users, projects, workflows, and so on. This overhead is difficult to estimate because it depends on how you are using WorldServer. However, 1 GB of space is usually more than enough to cover the overhead for most WorldServer installations. Requirements for installing SDL Online Editor

A list of software and hardware requirements that you must meet to install SDL Online Editor.

The machine on which you plan to install SDL Online Editor must use Windows Server 2012 R2 or 2016 (64-bit) as its operating system.

Hardware requirements for the SDL Online Editor machine

Minimum hardware requirements: 2 CPU cores at 2.40 GHz each and 4 GB of RAM. Recommended hardware configuration: At least 4 CPU cores at 2.40 GHz each and 8 GB of RAM.

Tip: Always consider your specific use cases when planning for your deployment. When multiple users are using SDL Online Editor concurrently, each user requires at least 100 MB of RAM. For example, if 100 users will be using SDL Online Editor concurrently on your environment, your machine needs to have at least 10 GB of RAM.

Planning and Prerequisites 13 3 System requirements

Load testing results suggest that on a WorldServer machine with 10 workflow engines where 4 of the 16 GB of RAM are allocated to Apache Tomcat, you can successfully upload ten 90000-word assets at the same time. In this case, uploading refers to the Enable Online Editing step in your workflow. Prerequisites for installing the File Type Support (FTS) Server

The File Type Support (FTS) Server launcher runs as a Windows Service process and individual FTS Server instances run as Windows processes. Even though the File Type Support (FTS) Server runs only on Microsoft Windows machines, it can communicate with WorldServer installations on Windows or on Linux. The FTS Server is a 32-bit application and runs in 32-bit mode even on 64-bit machines.

System requirements for the FTS Server

A separate machine is recommended for hosting the FTS Server. You can have multiple FTS Server instances connected to your WorldServer installation. The servers can share a single Windows machine. Usually, you should install the FTS Server instances on a separate machine than WorldServer, but, in lower-demand installations, you can put a single FTS Server instance on the same Windows machine as WorldServer. In both cases, make sure that you have administrative permissions on the machine on which you are installing the FTS Server. Install or configure the following on your FTS Server machine: • Microsoft Windows Server 2012 or 2016 (standard or enterprise) as the operating system. • Microsoft .NET Framework 4.7. • The vcredist_x86. exe version of the MicrosoftVisual C++ 2013 Redistributable package, available here. • Microsoft Visual C++ Redistributable for Visual Studio 2017 (x86). Make sure that you download the 32-bit version (x86) regardless of your system configuration. You can download it from the official Microsoft website . Before you install it, you might also need to apply certain Windows updates. For more information, see the Visual Studio 2017 system requirements . • A shared directory for WorldServer and the FTS Server, supporting the shared file system connection and the FTS Server log. Configure this directory in two places: • On your WorldServer machine, in the general.properties file (you can find it in the WS_CONFIG folder), as the value of the ftsserver_shared_directory property. For example, ftsserver_shared_directory=c:/Program Files (x86)/SDL/ FileTypeSupportServer/ • On your FTS Server machine, in the Sdl.WorldServer. FileTypeSupport. Server. HostProcess. exe.config file (you can find it in the FTS Server installation folder), as the value of the ftsserver_shared_directory property. For example, When using the FTS Server in WorldServer, it is important to note that the default operating system cultures, default .NET cultures, and user-defined cultures determine which cultures are available. The version of Windows on which the FTS Server is installed also plays a role in which .NET culture codes are available. Not all versions of Windows have all .NET cultures available. For example, Windows Server does not support a number of cultures. The same is true for certain locales in WorldServer that .NET has

14 Planning and Prerequisites System requirements 3

never supported. You can map these WorldServer locales to .NET cultures in the exchange.properties file. When deploying WorldServer and the FTS Server in a mixed Linux/Windows environment and using NFS, configure Windows Active Directory with Identity Management for Linux. By doing so, you can map Windows user names to Linux user names. 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 the general.properties file as the value of the ftsserver_shared_ directory property (For example, ///). • The UNC path defined in the general.properties file as the WorldServer temp_file_path (For example, ///).

Supported databases

The FTS Server uses the WorldServer database and works with the two types of relational database management systems that WorldServer supports: Microsoft SQL Server and Oracle. You do not need database clients on the machine that runs the FTS Server.

Requirements for Microsoft Office file types

With the new versions of the Microsoft Excel 2000-2003 and Rich Text Format (RTF) file types, added in WorldServer 11.3, you no longer need to have Microsoft Office installed on the machine that runs the FTS Server. If you want to keep using the deprecated versions, however, you still need Microsoft Office 2007 or later (or Office 2003 with the 2007 compatibility pack) on your FTS Server machine. Supported browsers and recommendations for client machines

Most interactions with WorldServer take place through a web browser. WorldServer provides a browser- based interface to perform tasks such as defining workflows, managing users and permissions, or translating content.

Supported web browsers

WorldServer 11.5 supports the following web browsers: • Microsoft Internet Explorer 11 • Microsoft Edge 38 or later • Mozilla Firefox ESR (Extended Support Release) 52.1.2 or later • Safari 9 or later • Google Chrome 68 or later Note: SDL Online Editor does not support Microsoft Internet Explorer. Also, if you are planning to use SDL Online Editor on Google Chrome, you need to use a more recent version (68 or later).

Planning and Prerequisites 15 3 System requirements

More recent versions of Chrome no longer support Microsoft Silverlight and Java as part of their policy to no longer allow Netscape Plugin Application Programming Interface (NPAPI) plugins. You can run Internet Explorer inside Chrome by using a workaround for Silverlight called IE Tab. Alternatively, you can continue to work with WorldServer using other supported browsers. Also, while SDL no longer routinely tests earlier versions of Internet Explorer, they are expected to continue to work with WorldServer 11.5. The login page, however, no longer checks for supported browser versions, so you might experience some display or functionality issues when using earlier versions of Internet Explorer.

Recommended hardware for client machines

Your WorldServer client machine must meet the following requirements: • Processor: 1 GHz (minimum) • RAM: 256 MB (minimum) • High-speed network connection Also, make sure that the monitor you use for working with WorldServer has a resolution of 1024 x 768 pixels or higher.

16 Planning and Prerequisites 4

Components supported in WorldServer 4 Components supported in WorldServer

WorldServer is a robust enterprise-level application that works alongside many different components to manage translation projects and assets. WorldServer includes support for many document formats, repository connectors, third-party tools, servers, browsers, and applications. It complies with many industry standards and supports over 300 different languages.

SDL has reviewed the products listed as supported as part of each release. Check with your product (application server, database, and operating system) providers or internal IT group to see if an update would be appropriate for your deployment and environment. Content repository connectors

To get access to the content that needs to be translated, WorldServer connects to content repositories. In most cases, WorldServer connects to an existing content management system or source control system to access the content.

WorldServer has connectors for the following types of content repositories: • Microsoft SQL Server 2017 • Microsoft SQL Server 2016 • 32-bit and 64-bit Oracle 12c Release 1 • 32-bit and 64-bit Oracle 11g • Perforce Software Configuration Management (SCM) system 2009.1 - 2014 • SDL Tridion Docs 13 SP2 • SDL Tridion Sites 9 • SDL Web 8.5 • Acrolinx Server version 4.1 or later Note: As of version 10.4.4, WorldServer no longer provides support for Oracle 10. Use Oracle 12 instead.