Installation and Upgrade Guide

SDL WorldServer 11.2

Legal notice
Copyright and trademark information relating to this product release.

Copyright © 1998–2017 SDL Group.

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 trade-
marks 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, details of which can be found by
clicking the Acknowledgments link in the Online documentation.

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 Web site 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 Installation and Upgrade Guide

 Contents
1 About the SDL WorldServer Installation and Upgrade Guide . . . . . . . . . . . . . . . 1

SDL WorldServer Documentation and Resources . . . . . . . . . . . . . . . . . . . . . . . 2

2 Installing and configuring WorldServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Setting up the WorldServer database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Setting up an SQL Server database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
High-level recommendations for Oracle databases . . . . . . . . . . . . . . . . . . . . 9
Setting up an Oracle database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Installing and deploying WorldServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Installing WorldServer through the installer (on Windows) . . . . . . . . . . . . . . . 14
Deploying WorldServer through Tomcat (on Windows) . . . . . . . . . . . . . . . . . 17
Installing WorldServer through Tomcat (on Linux) . . . . . . . . . . . . . . . . . . . . 18

Configuring .properties files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Configuring mandatory settings in general.properties . . . . . . . . . . . . . . . . . 22
Database connection settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Configuring optional settings in general.properties . . . . . . . . . . . . . . . . . . . 26
Configuring clustered mode settings in general.properties . . . . . . . . . . . . . . 31
Logging and terminating abandoned connections . . . . . . . . . . . . . . . . . . . 35
Configuring permissions to Web services in webservices.properties . . . . . . . . . 35
Configurable properties in the exchange.properties file . . . . . . . . . . . . . . . . 36
Making various configurations in other .properties files . . . . . . . . . . . . . . . . 42

Advanced configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Delta configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Delta localization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Configuring multiple log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Configurations for translation memory modes . . . . . . . . . . . . . . . . . . . . . . . 47

Live TM mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Differences between live TM mode and non-live mode . . . . . . . . . . . . . . . . . 48

Legacy-only configurations in WorldServer 11.x . . . . . . . . . . . . . . . . . . . . . . . 49

Configuring WorldServer 11.x to use only the legacy interface (with the
installer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuring WorldServer 11.x to use only the legacy interface (through
Tomcat) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
About machine translation adapters in WorldServer legacy . . . . . . . . . . . . . . 51

Installation and Upgrade Guide iii

 Security settings and connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Setting up a secure connection for external users . . . . . . . . . . . . . . . . . . . . 52
Enabling URL page security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Expose URL security to custom servlets . . . . . . . . . . . . . . . . . . . . . . . . . . 53

SDK sample objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Uploading SDK sample objects into WorldServer . . . . . . . . . . . . . . . . . . . . 54
Importing sample objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

3 Installing SDL Online Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Deploying SDL Online Editor through Chef Solo . . . . . . . . . . . . . . . . . . . . . . 59

Configuring WorldServer to connect to SDL Online Editor . . . . . . . . . . . . . . . . . 62

Changing the location of the SDL Online Editor log files . . . . . . . . . . . . . . . . . . 63

Granting permissions for SDL Online Editor . . . . . . . . . . . . . . . . . . . . . . . . . 64

Automatic actions required for SDL Online Editor . . . . . . . . . . . . . . . . . . . . . . 65

Useful notes about the administration of SDL Online Editor . . . . . . . . . . . . . . . . 68

4 Upgrading WorldServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Backing up installation files and other components . . . . . . . . . . . . . . . . . . . . 73

Permissions required for WorldServer database users . . . . . . . . . . . . . . . . . . . 73

Upgrading the database schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Upgrading Oracle database schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Upgrading SQL Server database schemas . . . . . . . . . . . . . . . . . . . . . . . . . 76

Upgrading the WorldServer software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Upgrading SDL Online Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Validating your upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Upgrading WorldServer in clustered mode . . . . . . . . . . . . . . . . . . . . . . . . . . 81

5 Updating WorldServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Installing an update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Redeploying onto Apache Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

6 Installing the Report Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

JasperReports Server installation overview . . . . . . . . . . . . . . . . . . . . . . . . . 88

JasperReports Server installation prerequisites . . . . . . . . . . . . . . . . . . . . . . . 88

iv Installation and Upgrade Guide

 Installing JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Upgrading JasperReports Server from version 4.2.1 to version 5.2 . . . . . . . . . . . . 93

Platform notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Configuring reporting over HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

User permissions in Jasper Reports Server . . . . . . . . . . . . . . . . . . . . . . . . . . 98

7 Installing the File Type Support Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Installing the File Type Support Server on Windows . . . . . . . . . . . . . . . . . . . . 102

FTS Server configurations for Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

FTS Server configurations for Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Filesystem sharing for FTS Server and WorldServer . . . . . . . . . . . . . . . . . . . 107
FTS Server connections using Samba . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Linux filesystem mounts using Samba . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Configuring NFS AIS mounts for FTS Server on Linux . . . . . . . . . . . . . . . . . 111

Upgrading the FTS Server from the installer . . . . . . . . . . . . . . . . . . . . . . . . 113

Mapping language resource templates to file type configurations . . . . . . . . . . . 114

Running the FTS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Installation and Upgrade Guide v

vi Installation and Upgrade Guide
 1

About the SDL WorldServer

Installation and Upgrade Guide
 1 About the SDL WorldServer Installation and Upgrade Guide

Welcome to SDL Language Technologies and WorldServer™. SDL WorldServer is a translation manage-
ment system that provides advanced linguistic technology, process automation, content repository
integration and management services. Aligned with SDL Trados Studio™, WorldServer provides consis-
tent analysis and reporting of translation projects for localization managers, project managers, translators
and reviewers.

Scope
The SDL WorldServer Installation and Upgrade Guide provides step-by-step instructions for IT administra-
tors who install and upgrade WorldServer.

SDL WorldServer Documentation and

Resources
The SDL WorldServer documentation set includes multiple separate deliverables. Some of these
documents are installed with WorldServer.
Administrator Guide
Information on setting up and administrating 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.

2 Installation and Upgrade Guide

 About the SDL WorldServer Installation and Upgrade Guide 1

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:

WorldServer Release Notes
Information on enhancements and changes in the most recent release. Also contains up-to-date
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.
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 page.

Installation and Upgrade Guide 3

 1 About the SDL WorldServer Installation and Upgrade Guide

4 Installation and Upgrade Guide

 2

Installing and configuring

WorldServer
 2 Installing and configuring WorldServer

There are multiple ways in which you can install WorldServer, depending on the environment on which
you plan to install it. After the installation, you must also make various configurations to ensure that
WorldServer is running properly.

Before you begin

• Make sure that you are familiar with the information in the "Before installing WorldServer" section
and that the environment on which you want to install WorldServer meets the requirements outlined
there.
• Set up the WorldServer database and populate the schema. You can create either a Microsoft SQL
Server database or an Oracle database.

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

Procedure
1. Install WorldServer on the WorldServer application server machine.
You can install WorldServer either on Windows or on Linux.

Note: If you also plan to use the WorldServer Report Center, make sure you install WorldServer on
an application server machine whose hostname does not contain _ (underscore). Due to a known
issue, Internet Explorer will not work in conjunction with Report Center if the machine's hostname
contains an underscore. Alternatively, you can use another browser.

Moreover, after installing WorldServer with the installer, you can find details about the status of the
installation in the wsInstallation. log file, which is available at C:\Program Files\Idiom
\WorldServer\IdiomLogs. This is particularly useful in the case of unsuccessful installations.

2. Deploy the WorldServer Web application onto the application server.

Note: If you are installing WorldServer on Windows by using the WorldServer installer, this step is
performed automatically during the installation.

3. Configure the WorldServer .properties files to finish setting up your application server
deployment.
Before using WorldServer, you must configure the following properties:
• ws.api.url (in the WS_CONFIG\ws folder, in the ui.properties file)

• ws.legacy.url (in the WS_CONFIG\ws folder, in the ui.properties file)

• navigation.panel.url (in the WS_CONFIG\ws-legacy folder, in the general.properties

file)

Important: Make sure that you configure these properties to fully qualified domain names (not to
localhost) and access WorldServer only using these domain names. For further information about
other configurations and properties, see “Configurations in WorldServer”, especially
“Delta configuration” on page 43.

4. Configure the security settings.

6 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Important: For maximum security, configure these settings so that external users always access
WorldServer via HTTPS.

5. Start WorldServer and verify the installation.

Setting up the WorldServer database

WorldServer can store all of its internal information (such as workflow definitions or terminology
databases) in an SQL Server database or in an Oracle database.

About this task

To set up such a database for WorldServer, you must perform two main actions, each of them having its
own substeps:
• Creating the database which will contain the WorldServer data
• Populating the database schema with WorldServer content
Each of these actions requires a different set of database permissions and is outlined separately. You
must complete them before installing WorldServer on the application server machine.

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.

Setting up an SQL Server database

Before installing WorldServer on your environment, you need to create an populate an SQL Server
database.

Before you begin

You must have a supported Microsoft SQL Server instance up and running. You must also have adequate
permissions to access this instance and to perform various operations.

Important: Specify the name of the WorldServer database in ASCII characters only. Do not, for example,
specify a database name in Kanji or Katakana characters. Also, do not include hyphens in the database
name, as this may cause issues during the database population process.

Installation and Upgrade Guide 7

 2 Installing and configuring WorldServer

Permissions required for database users

To create an SQL Server database, you need an SQL Server user that has database creation permissions
(such as sa). If you want to create users used only by WorldServer, make sure you assign them the
db_owner role for the WorldServer database.

If you want to use the System Monitor tool, make sure that the user also has READ rights on the following
tables:
• sys.dm_tran_locks

• sys.dm_os_waiting_tasks

• sys.partitions

• sys.dm_exec_requests

• sys.dm_exec_sessions

• sys.databases

• sys.dm_exec_connections

• sys.dm_exec_query_stats You can achieve this by running the following command:

GRANT VIEW SERVER STATE TO <username>

where <username> is the name of the database user.

Creating the SQL Server database

This process should generally be performed by a database administrator.
1. Log in to SQL Server Management Studio as a user with database creation permissions (for example,
sa).

Important: When you log in, select SQL Server Authentication from the Authentication list.

2. In Object Explorer, right-click the Database tree, and then click New Database.
3. In the New Database window, type a name for the new database and make other configurations, if
necessary.
4. Click OK. The new database has been created and added to the Databases tree.

Note: Optionally, you can 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.

Populating the database schema

After you have created the SQL Server database, you can populate the database schema. To do so:
1. Copy the following scripts from the sql folder of your WorldServer distribution kit to a working
directory on your SQL Server client machine:
• create.ms.sql

• create_sp.ms.sql

8 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

• create_tr.ms.sql

• setup.ms.sql
2. In SQL Server Management Studio, right-click the database you have just created, and then, on the
shortcut menu, click New Query.
3. Run the following queries:
• create.ms.sql

• create_sp.ms.sql

• create_tr.ms.sql

• setup.ms.sql

Note: Ignore any "MAX row size exceeded" messages that you might see in the output, because they
are expected.

At this point, your database schema has been populated and can be used by WorldServer. You can now
install WorldServer on the supported operating system of your choice.

Tip: Make sure to back up and maintain your database regularly.

High-level recommendations for Oracle databases

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 UNDO and 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 the UNDO tablespace. With a three disk setup, you could have the UNDO tablespace
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.

Installation and Upgrade Guide 9

 2 Installing and configuring WorldServer

Tuning the query optimizer

As a best practice, you should make the following query optimization configurations on Oracle databases:

optimizer_mode=FIRST_ROWS
optimizer_index_cost_adj=10
optimizer_index_caching=90

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 8 GB of RAM available to the computer
that serves as the Oracle server. Larger organizations should consider 16-32 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.

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 pro-
cesses parameter:

processes = (nodes in cluster x database_connection_pool_size)+ 10

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 a sql.ConnectionPool logging 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.

10 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

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

http://host:8080/ws-legacy/ws_gate?&token=<token>&action=log&level=debug
&category=sql.ConnectionPool
http://host:8080/ws-legacy/ws_gate?&token=<token>&action=log&level=warn
&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_cur-
sors; however, the recommended setting above should be sufficient in most cases.

Note: WorldServer result sets are automatically closed after the result set is processed.

Setting up an Oracle database

Before you begin

You must have adequate permissions to access your Oracle instance and perform various operations.

Important: For Oracle to work with WorldServer, make sure that your LD_LIBRARY_PATH variable
contains the location of the Oracle relational database management system libraries.

Creating the Oracle instance and schema through sqlplus

Before installing WorldServer, you need to set up an Oracle instance and schema. This process requires
full database permissions and should generally be performed by a database administrator (DBA).

Restriction: The name of the WorldServer database must be specified in ASCII characters only. For
example, do not 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.
• The National Character Set can be set to either UTF8 or AL16UTF16 based on the characteristics
of the data you will be storing. See the Oracle documentation for recommendations about
which encoding to use.

Installation and Upgrade Guide 11

 2 Installing and configuring WorldServer

2. Start sqlplus and log on as a DBA user (for example, system or sys) 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.

Tip: 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. To create a user and the schema associated with that user, enter the following:

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 <temporary_tablespace_name>;
QUOTA UNLIMITED ON <tablespace_name>

5. Assign the following roles to the database user:

connect
resource

6. Grant the database user the following privileges:

Create synonym
Create view
Create table

Commit a grant statement that includes the following:

GRANT CONNECT, CREATE VIEW, CREATE SYNONYM, CREATE TABLE, RESOURCE TO

<username>;

7. Optional: If you want to use the System Monitor tool, run the following commands:

GRANT SELECT ON SYS.V_$SESSION TO <username>;

GRANT SELECT ON SYS.V_$LOCKED_OBJECT TO <username>;
GRANT SELECT ON SYS.V_$SQLTEXT_WITH_NEWLINES TO <username>;
GRANT SELECT ON SYS.V_$SQL TO <username>;
GRANT SELECT ON SYS.DBA_OBJECTS TO <username>;
COMMIT;

This ensures that the user has READ rights on the following tables:
• SYS.V_$SESSION

• SYS.V_$LOCKED_OBJECT

• SYS.V_$SQLTEXT_WITH_NEWLINES

• SYS.V_$SQL

• SYS.DBA_OBJECTS
8. Exit sqlplus.

12 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

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. Exit sqlplus.
At this point, your database schema has been populated and can be used by WorldServer. You can now
install WorldServer on the supported operating system of your choice.

Tip: Make sure that you back up and maintain your database regularly.

Installing and deploying WorldServer

You can install WorldServer either with the installer (only on Windows) or through Apache Tomcat 8 (on
Windows and on Linux).
• Make sure that the machine on which you are installing WorldServer meets the system requirements.
• As of WorldServer 11.0, Microsoft SQL Server 2005 and Microsoft Windows 2003 are no longer
supported.
• The name of the WorldServer database and the name of the folder in which you install WorldServer
must be specified in ASCII characters only. Do not, for example, specify a database name or a folder
name in Kanji or Katakana characters. Also, do not include hyphens in the database name, as this may
cause issues during the database population process.

Tip: After installing WorldServer with the installer, you can find details about the status of the instal-
lation in the wsInstallation. log file, which is available at: C:\Program Files\Idiom
\WorldServer\IdiomLogs. This is particularly useful in the case of unsuccessful installations.

Installation and Upgrade Guide 13

 2 Installing and configuring WorldServer

Installing WorldServer through the installer (on

Windows)
Before you begin

• You need to create and populate the WorldServer database before installing WorldServer. At the
moment, the WorldServer installer cannot create new databases during the installation process.
• If you are installing on an SQL Server database, you must have an SQL Server client installed on the
WorldServer machine.
• If you are installing on an Oracle database, you must set the NLS_LANG environment variable to
American_America. UTF8 in the System Properties Environment tab.

Procedure
1. If you have a previous instance of WorldServer on your machine, uninstall that instance (Control
Panel > Add or Remove Programs > SDL WorldServer).

Note: You can choose whether you also want to delete the WorldServer database and the RCS
files. Deleting the database of a previous version will cause you to lose all the data for that version,
including your users, workflows, translation memories, and translation databases. You should only
delete the previous database if you are performing a new installation and want to delete all the
old work.

2. If you are installing from a downloaded distribution kit, extract the kit in a temporary folder.
3. Use Windows Explorer to navigate to the newly created WorldServer folder and double-click the
setup_64.exe file.
4. On the Welcome screen, click Next, and then click Yes to accept the License Agreement.
5. On the Setup Configuration Folder Path screen, you can change the folder where you want to store
the configuration files by clicking Change. If the folder already exits, the new files will be added
within the folder and the installer will not overwrite any existing files. The WS_CONFIG system
property is created or updated.
6. Type your user name and company name, and then click Next.
7. Choose a location to install the WorldServer program files, and then click Next.
8. Choose an installation type, and then click Next.

Note: By using the custom option, you can choose a location for the WorldServer log files, the RCS
root, and the WorldServer temp directory. For performance reasons, SDL recommends that you place
the log files and temporary directory on a different physical disk drive than the application server
or the database files. This will reduce I/O contention as WorldServer is running.

9. Choose an application server, and then click Next.

14 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Note: If you choose Tomcat, the installer installs Tomcat and sets up WorldServer to work with this
deployment. The WorldServer installer deploys the WorldServer Web application to <WS_HOME>\
tomcat\ webapps\ ws (where <WS_HOME> is the WorldServer home directory, by default
C:\Program Files\Idiom\WorldServer). The installer also creates a service called Idiom Process
Monitor which you can use to start and stop Tomcat.

If you choose Other, you have to browse to the directory where you want to place the WorldServer
WAR (Web archive) files, which you can then deploy under your application server. Choose Other
only if you want to deploy Tomcat manually.

10. Depending on your previous selection, do one of the following:

• If you chose Tomcat to have Tomcat deployed automatically, specify the port that Tomcat
should listen to, and then click Next. By default. the port is 8080. If you have multiple Tomcat
installations on a single machine, the port number specified here is the one that Tomcat uses for
WorldServer.
• If you chose Other and you want to perform the Tomcat deployment manually, have World-
Server place the WAR files in the <WS_HOME> folder. The name of the WAR file becomes the name
you will use to connect in the browser URL (for example, http://<server-IP>:8080/<war-
name>).
11. Choose a database platform (SQL Server or Oracle) and specify the following:
For SQL Server:
a. Provide the name of an existing SQL Server database server and an instance to connect to.
b. The installation requires that you have already created the physical database and that you have
created an SQL Server user with appropriate permissions.
c. Specify the name of the database server and of the database that you want to use and clear
the Create DB option.

Note: You also need to clear Create DB if you are upgrading from a previous version. Selecting
Create DB with an existing database causes the installation to fail.

d. Specify the username and password that you want WorldServer to use when connecting to the
database.

Note: The WorldServer installer only handles letters, numbers, and underscores in the pass-
word string. Do not specify a password that contains other characters.

• If you cleared the Create DB option in the previous step, you must specify a user that has
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.
b. To populate the schema, specify the TNSNAME of the database. The TNSNAME can be found in
tnsnames.ora in <ORACLE_HOME>\network\admin.

Installation and Upgrade Guide 15

 2 Installing and configuring WorldServer

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 only handles letters, numbers, and underscores in the pass-
word 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
create the Oracle database user, and then start the WorldServer installation again.

12. Select the program group where you would like the WorldServer shortcuts to be placed, and then
click Next.
13. Review your installation choices, and then click Next.
14. After the files have been copied, click Finish.
15. Deploy WorldServer on your environment.
If you chose to have Tomcat deployed automatically in step 9, you have already finished the
deployment process and you can move on to the next step.
16. Restart your machine.
17. Configure the WorldServer .properties files.

Note: If you want to configure the WorldServer application server to use SSL, consult the SSL setup
instructions for the application server that they are using.

18. Restart the Idiom Process Monitor service.

Results
You have now finished installing the components needed for WorldServer to function at a basic level.

What to do next
At this point, you can make various other configurations or you can proceed to installing the Report
Center and the File Type Support (FTS) Server.

16 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Deploying WorldServer through Tomcat (on Windows)

The WorldServer installer for Windows installs Tomcat and deploys WorldServer for you. However, there
may be situations when you have to deploy WorldServer manually (for example, in your testing
environment). You can deploy WorldServer through Apache Tomcat version 8, which is provided in the
3rdparty folder of the WorldServer distribution kit.

About this task

You can use this procedure both to deploy WorldServer on a new environment and to upgrade Tomcat
on an existing WorldServer environment. In the latter case, however, you have to uninstall your existing
Tomcat version before you start upgrading to a new one and you no longer need to configure the
.properties files at the end, because they have already been configured.

Procedure
1. Download the apache-tomcat-8. 0.36.zip file from the internet or copy it from the WorldServer
distribution kit.
2. Extract the contents of the apache-tomcat-8. 0.36.zip file to your <WS_HOME> folder (where
<WS_HOME> is the WorldServer installation folder – by default, C:\Program Files\Idiom
\WorldServer).
3. If you haven't already done so, set the CATALINA_HOME environment variable:

> set CATALINA_HOME=<WS_HOME>\tomcat

4. Copy the WorldServer WAR files from the WorldServer installation folder to the Tomcat webapps
folder:

> copy c:\Program Files\Idiom\WorldServer\ws.war

> copy c:\Program Files\Idiom\WorldServer\ws-legacy.war
> copy c:\Program Files\Idiom\WorldServer\ws-api.war
c:\Program Files\Idiom\WorldServer\apache-tomcat-8.0.36\webapps

5. Start Tomcat.

> cd c:\Program Files\Idiom\WorldServer\apache-tomcat-8.0.36\bin>

startup.bat

Note: The startup.bat command requires that you have the JAVA_HOME variable configured to
point to the required Java SDK (that is, 1.8). To set it to the JRE supplied by the SDL installer, use the
following command:

> set JAVA_HOME=%WS_HOME%\jre

The contents of the ws.war, ws-legacy.war, and ws-api.war files are extracted and the Tomcat
console displays a log such as the following:

Oct 12, 2016 9:34:30 AM org.apache.coyote.http11.Http11BaseProtocol

init
INFO: Initializing Coyote HTTP/1.1 on port 8080
...

Installation and Upgrade Guide 17

 2 Installing and configuring WorldServer

INFO: Starting service Catalina

...
INFO: Starting Servlet Engine: Apache Tomcat/8.0.36
...
INFO: Deploying web application archive ws.war
...
INFO: Deploying web application archive ws-legacy.war
...
INFO: Deploying web application archive ws-api.war
...
Oct 12, 2016 9:34:37 AM org.apache.catalina.startup.Catalina start
INFO: Server startup in 21310 ms

Results
You have now finished deploying WorldServer on Windows.

What to do next
At this point, you must configure the .properties files. After that, you can also install the Report
Center and the File Type Support (FTS) Server.

Tip: Make sure you stop Tomcat (> shutdown.bat) before you configure the .properties files and
start it again after you finish.

Installing WorldServer through Tomcat (on Linux)

Before you begin

• Make sure that you have downloaded and installed Java 8, which you can find it in the UNIX folder
of the WorldServer distribution kit. Tomcat requires javac and jdb to run. Therefore, you must have
the full Java SDK installed, not just the JRE.
• Make sure the $JAVA_HOME environment variable is set and points to the Java SDK installation root.
• If you are installing on an SQL Server database, but you want to separate the database creation
process from the installation process, you must create and populate the WorldServer database
before installing WorldServer.
• If you are installing on an Oracle database, you must create and populate the WorldServer database
before installing WorldServer.
• Depending on your installation, you may need root access. Specifically:
• If you want the application server to listen on a port lower than 1024, you have to run the
application server as root.
• If you want to install to a standard location (for example, /user/local), you need permissions
to create the folder.
• We recommend creating a separate Linux user to own and manage the WorldServer processes.
Creating this user may require root permissions.
• If you want to configure WorldServer to start automatically on reboot, you need root access to
install the necessary startup scripts.

18 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Procedure
1. Log in to the target machine as root.
If your system is set up to allow sudo, you may be able to perform these instructions by prepending
sudo to each command.
2. Create a folder for the WorldServer installation, which will be referred to as <WS_HOME>:

> mkdir /usr/local/idiom/worldserver

3. Create a user to own the installation and set the user’s home folder to the folder you created earlier.
This is a convenient way to collect all the WorldServer assets in a single place and to manage them.
Depending on how you have set up your network, you may want to create either a local user or a NIS
user. To create a local user, run the following command as root:

> useradd –d /usr/local/idiom/worldserver wrldsrvr

4. Set the permissions on the folder so that the new user is its owner.

> chown –R wrldsrvr /usr/local/idiom/worldserver

5. Log out from root and log in as the wrldsrvr user.

6. If you are installing from the FTP website, download the following file and copy it into your instal-
lation folder:

ws11.x.<build number>_unix.tar.gz

Tip: You not need to download the ws.war, ws-api.war, and ws-legacy.war files at the top
level of the FTP website, because they are included in the .zip distribution kit.

7. Extract the contents of the WorldServer distribution kit:

> cd /usr/local/idiom/worldserver> gunzip ws11.x.<build number>.*_unix.

tar.gz> tar –xvf ws11.x.<build number>.*_unix.tar

8. To enable the rcs (revision control system) application used by WorldServer, as well as various
other executables (for example, wstool and diff), perform the following from the linux/bin
folder:

> chmod a+x *

9. To ensure that your environment is set correctly every time you log in, SDL provides a sample set of
login scripts. Do one of the following:
• If your default shell is in the sh family, copy the .profile file from the unix folder.

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

worldserver

Installation and Upgrade Guide 19

 2 Installing and configuring WorldServer

• If your default shell is in the csh family, copy the .login file from the unix folder.

> cd /usr/local/idiom/worldserver> cp unix/.login /usr/local/idiom/

worldserver

You can then use a text editor to modify the contents of this file and provide the correct values for
the WS_HOME, JAVA_HOME, and, if applicable, the ORACLE_HOME, XHIVE_HOME, and TZ environ-
ment variables. These scripts also define the path to the WorldServer binaries.
10. Test that the new scripts are working:
a. Log out of the wrldsrvr account.
b. Log back in to the wrldsrvr account.
c. Run the following command:

> echo $WS_HOME

The WorldServer installation folder should be displayed. You can now start the WorldServer
deployment process.
11. If you are installing from the network, download the apache-tomcat-8. 0.36.tar.gz file and
copy it to your <WS_HOME> folder.
12. Extract the contents of the file to the <WS_HOME> folder:

> cd $WS_HOME
> gunzip apache-tomcat-8.0.36.tar.gz
> tar -xvf apache-tomcat-8.0.36.tar

13. Copy the WorldServer WAR files to Tomcat.

> cp ${WS_HOME}/ws.war ${WS_HOME}/apache-tomcat-8.0.36/webapps

> cp ${WS_HOME}/ws-legacy.war ${WS_HOME}/apache-tomcat-8.0.36/webapps

> cp ${WS_HOME}/ws-api.war ${WS_HOME}/apache-tomcat-8.0.36/webapps

The ws.war, ws-api.war, and ws-legacy.war files are placed in the <WS_HOME> folder.
14. Make sure that your environment is set correctly every time you log in by modifying your login
scripts.
• If your default shell is in the sh family, add the following lines to the /usr/ local/ idiom/
worldserver/ .profile file:

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

• If your default shell is in the csh family, add the following lines to the /usr/ local/ idiom/
worldserver/ .login file:

20 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

> setenv CATALINA_HOME ${WS_HOME}/apache-tomcat-8.0.36

> setenv PATH ${CATALINA_HOME}/bin:${PATH}

Log out, and then log back in for the setting to take effect.
15. Go to apache-tomcat-8.0.36/ bin and start Tomcat to extract the contents of the ws.war,
ws-api.war, and ws-legacy.war files. On the first run, you may need to set execute permissions
on the .sh files.

> cd $CATALINA_HOME/bin
> chmod 777 *.sh
> ./startup.sh

Tomcat automatically unpacks the contents of the ws.war, ws-api.war, and ws-legacy.war
files.
16. Stop Tomcat.

> ./shutdown.sh

At this point, WorldServer has been deployed.

17. Configure the WorldServer .properties files.

Note: If you want to configure the WorldServer application server to use SSL, consult the SSL setup
instructions for the application server that they are using.

18. Restart the WorldServer service.

Results
You have now finished installing the components needed for WorldServer to function at a basic level.

What to do next
At this point, you can make various other configurations or you can proceed to installing the Report
Center and the File Type Support (FTS) Server.

Configuring .properties files

WorldServer reads many system settings from configuration (.properties) files that are installed on
the WorldServer application server. For WorldServer to work properly, you must configure these settings
correctly before starting the application server.

Prior to WorldServer 11.0, the configuration files were loaded from classpath: config. Starting with
version 11.0, the system checks the WS_CONFIG folder first, looking for the subfolder with the application
name (ws-legacy, ws-api, or ws). In case it does not find it there, it goes to classpath: config.

Important: Make sure that you configure the ws.legacy.url and navigation.panel.url proper-
ties to the publicly available address of the application server and use the same address to access
WorldServer. For example, do not use localhost to access WorldServer if you specified an IP address as
the value for ws.legacy.url and navigation.panel.url.

Installation and Upgrade Guide 21

 2 Installing and configuring WorldServer

In the ui.properties file, located in the WS_CONFIG\ws folder, set the value of the ws.api.url
property to the publicly available address of the application server.

The following properties must have the same values across all WorldServer components:
• session_timeout

• use_secure_urls

• temp_file_path

Note: If you use registries, make sure that the value of the temp_file_path property is the same both
in the general.properties file and in the registries.

Also, if you installed WorldServer through Tomcat, you should set the session_client_check
property in the general.properties file as follows:
• to on in the %WS_CONFIG% and ws-legacy folders
• to off in the ws-api folder When you set it to on, the session_client_check property ensures
that a session can only be used by the same browser that created it. If the same URL is used from another
browser, the session is considered invalid and the user has to log in again. This applies to the legacy
and TransPort components of WorldServer. As a security measure, in WorldServer 11.x, users always have
to log in again if they copy the same valid URL into another browser. To enable the session_cli-
ent_check property, your browser must accept cookies.

Configuring mandatory settings in general.properties

The general.properties file contains settings you must configure for WorldServer to function
properly.

Before you begin

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 installedWorld-
Server with the Windows installer, you do not have to make these mandatory changes in general.
properties. However, general.properties contains other settings you might want to configure,
which are described in the "Configuring other settings in general.properties" topic.

Tip: 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 the registry settings first.

Procedure
1. On the WorldServer machine, go to the configuration folder of the 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:

%WS_CONFIG%\<application name>

22 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

c:\Program Files\Idiom\WorldServer\tomcat\webapps\<application
name>\WEB-INF\classes\config

• If WorldServer is running on Linux under Tomcat, the general.properties file is typically

located in:

$WS_CONFIG/<application name>

/usr/local/idiom/worldserver/tomcat/webapps/<application name>/WEB-
INF/classes/config

2. In Linux environments, WorldServer looks for the general.properties in the following folder
(listed in preferential order):
a. $WS_CONFIG/<application name>.
b. ~user/etc (the home folder of the user that the application server is running as).
c. /usr/local/idiom
d. /etc/idiom
e. classpath:config (for example, <TOMCAT_HOME>/webapps/ws-legacy/WEB-INF/
classes/config )

Note: 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, each time you
deploy a new version of the WAR file, the contents of the application server folder will be overwritten
and you will lose any changes to your general.properties file.

3. Open general.properties with a text editor.

4. Configure the database connection settings.
5. Enter the name of the database user that WorldServer should use to connect to the database in the
database_user line. For example:

database_username=worldserver

6. 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 folder:

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

7. Change temp_file_path entry to specify the appropriate path for the WorldServer temporary
folder. This should be on a separate physical drive from the rest of the WorldServer installation, for
I/O performance.

Installation and Upgrade Guide 23

 2 Installing and configuring WorldServer

For example:

# Temp directory
temp_file_path=c:/temp

or

# Temp directory
temp_file_path=/tmp

Note: When specifying the path, a forward slash (/) must be used, even in a Windows environment.
Make sure you have not accidentally added a tab symbol at the end of the parameter. This symbol
is invisible in the editor, but it may cause WorldServer to read the parameter incorrectly. This note
applies to steps 10 and 11 as well.

Important: The temp_file_path property should have the same value across all WorldServer
components. If you use registries, make sure that the value of the temp_file_path property is the
same both in the general.properties file and in the registries.

8. 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: If you are using the FTS server, be especially aware of the ftsserver_shared_directory
entry. Typically, FTS Server copies the source assets of file types to this working directory for
processing. Therefore, it needs the same amount of disk space as the original source assets.

9. If you are using RCS Version Control, change the following entry to specify the appropriate path for
the root RCS folder:

# RCS root. Repository used for version control information

rcs_root=c:/rcs

or

# RCS root. Repository used for version control information

rcs_root=/rcs

10. Specify a different log file path for each WorldServer component by uncommenting and modifying
the following entry in the general.properties file of each component folder (WS_CONFIG,
ws-api, ws-legacy):

# WorldServer Log File

log4j.appender.logfile.File=<log_path>

24 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Database connection settings

By configuring the database connection settings, you specify how you want WorldServer to connect to
your database and add connection parameters, if necessary. You can configure these connection settings
in the general.properties file.

Connect to a Microsoft SQL Server database

If you want WorldServer to connect 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.SQLServerDriver
database=jdbc:idiom:sqlserver://wsdata:1433;DatabaseName=worldserver

1. Uncomment the last two lines by removing the # sign before the word database.
2. In the last line, insert the appropriate URL connection string. The generic URL connection string for
an 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, but not in the registry.

For example, if the name of the SQL Server database server is wsdata and the name of the database is
worldserver, the entire section will look like this:

# JDBC driver configuration

# MS SQL Server
database_driver=com.idiominc.jdbc.sqlserver.SQLServerDriver
database=jdbc:idiom:sqlserver://wsdata:1433;DatabaseName=worldserver

Connect to an Oracle Database

If you want WorldServer to connect 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

1. Uncomment the last two lines by removing the # sign before the word database.
2. 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>

Installation and Upgrade Guide 25

 2 Installing and configuring WorldServer

For example, if the name of the Oracle database server is wsdata and the name of the database is
worldserver, the entire section will look like this:

# JDBC driver configuration

# Oracle
database_driver=com.idiominc.jdbc.oracle.OracleDriver
database=jdbc:idiom:oracle://wsdata:1521;SID=worldserver

Connection parameters
QueryTimeout
By using this parameter, you can set the default query timeout interval (in seconds) for all the
statements created by a connection.
The values you can specify for this parameter are -1, 0, or x, where x is a number of seconds.
• If you specify -1, the query timeout functionality is disabled.
• If you specify 0, the default query timeout is infinite, which means that the query is never timed
out. This is the default value.
• If you specify x, the data driver uses that value as the default timeout for any statement that is
created by the connection. The default value is 0.

You can configure the QueryTimeout parameter in the general.properties file by modifying the
database configuration value. For example:
• Oracle: database=jdbc:idiom:oracle://wsdata:1521;SID=worldserver;
QueryTimeout=300

• Microsoft SQL Server: database=jdbc:idiom:sqlserver://wsdata: 1433;DatabaseName=

worldserver;QueryTimeout=300

Configuring optional settings in general.properties

In addition to the mandatory settings 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 through Apache Tomcat 8.

26 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Property Description
url_of_origin Find this property and modify its value to include
the URL to the root of the WorldServer application
under the application server. For example:
url_of_origin=http://worldserver.company.
com:8080/ws

This URL is used in various places in WorldServer,

such as within email notifications and in
translation kits. The hostname in the URL should
be a host that can be resolved and that
WorldServer users can access.

Do not use localhost or an IP address as the

hostname.
If you do not configure this property, users will
have to manually set it in their client every time
they want to upload a project back to the server.
zip_encoding WorldServer uses UTF-8 encoding to encode file
names in ZIP archives. However, some localized
versions of Windows use different encodings to
read ZIP archives. If the encodings do not match,
the extracted file names may be corrupt. To avoid
this issue, configure WorldServer to use the same
encoding as your localized system.

Search for the zip_encoding property and

change it 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 support UTF-8, and,
therefore, you should not use it.
file_attribute_storage By default, attachment attributes are stored in the
WorldServer temp folder. You can configure
WorldServer to store these wherever you want.
You might not want them stored in the temp
folder, because that folder gets cleaned up
periodically.
To configure WorldServer to store these
attachments elsewhere, uncomment the
file_attribute_storage property and specify
a more suitable location. If you are using
WorldServer in a clustered environment, all
machines in the cluster must have access to this
location.
The line you should uncomment and modify is: #
file_attribute_storage=c:/Shared/Attributes

Installation and Upgrade Guide 27

 2 Installing and configuring WorldServer

Property Description
session_client_check When you set it to on, the session_cli-
ent_check property ensures that a session can
only be used by the same browser that created it.
If the same URL is used from another browser, the
session is considered invalid and the user has to
log in again. This applies to the classic and
TransPort components of WorldServer.
As a security measure, in WorldServer 11.x, users
always have to log in again if they copy the same
valid URL into another browser. To enable the
session_client_check property, your browser
must accept cookies.
calculate_segment_length_in_bytes This property determines whether WorldServer
measures segment length in bytes or in
characters. By default, the length is measured in
characters.
To enable length calculation in bytes, set the value
of the property to true. The property only applies
to the maximum segment length limit
functionality. That is, it works in combination with
the property setting for the maximum_target_
length_penalty property, which you can set in
tm.properties.

The line you should uncomment and modify is:

#calculate_segment_length_in_bytes=false
adhoc_asset_timeout This property schedules the removal of obsolete
data from your database when you create
translation jobs from WorldServer Explorer.
By default, this property is disabled (set at zero
days).
enable_live_translation_memory This property allows WorldServer to operate in
Live TM mode, which adds and tracks entries to
the translation memory during the translation
process.
By default, this property is enabled.
workbench_generate_target This property manages the automatic generation
of the target file.

By default, this property is enabled. To disable it,

uncomment the following line: #workbench_
generate_target=false

28 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Property Description
absolute_session_timeout This property manages the timeout of any login
session.

The value of this property is expressed in seconds.

For example, absolute_session_
timeout=1200 means that every login session
lasts only 1200 seconds (20 minutes).
Important: If the value of the absolute_session
_timeout parameter is positive, but lower than
the value of session_timeout, the value of
session_timeout will be used as absolute. For
example, if absolute_session_timeout=7200
and session_timeout=7800, it is as if both were
configured to 7800.

You can disable this property by setting its value

to 0 or by commenting it.
session_timeout This property manages the timeout of idle login
sessions.

The value of this property is expressed in seconds.

For example, session_timeout=1200 means
that logged in users who do not perform any
activity for 1200 seconds (20 minutes) are logged
out automatically.
The session timeout value you configure in the
general.properties file should have the same
value both in the ws-api and in the ws subfolders.
Important: If the value of the absolute_session
_timeout parameter is positive, but lower than
the value of session_timeout, the value of
session_timeout will be used as absolute. For
example, if absolute_session_timeout=7200
and session_timeout=7800, it is as if both were
configured to 7800.

You cannot disable this property. However, to

make sure that sessions almost never expire, you
can set its value to a very large number such as
18000 (five hours).

If you set its value to 0, users cannot log in to

WorldServer anymore. If you comment the
property, the default value (7200) is applied.
security.password.encryption.algorithm You can select another type of password
encryption than the default PBKDF2 by
configuring the security.password.encryp-
tion.algorithm=<value> property.
ws.enforce.navigation.panel You can enable or disable the slide-out navigation
pane by setting the ws.enforce.
navigation.panel parameter to true or false.
Also, you must specify the URL to the new user
interface as the value of the navigation.
panel.url property.

Installation and Upgrade Guide 29

 2 Installing and configuring WorldServer

Property Description
prefer_shallow_soap_objects The prefer_shallow_soap_objects property
was added in WorldServer 10.4.5. When you add it
and enable it (prefer_shallow_soap_objects=
true), it addresses an issue related to bad
performance and high memory usage caused by
webservices deep copies for heavy duty resources.
This property will use shallow copies (which do
not expand embedded resources) for the
following resources: WSGroup, WSClient, WSRole,
WSLocale, WSWorkgroup, WSProject. It is
recommended for systems that integrate with SDL
Web and Live Content Architect.
By default, this property is disabled (=false). You
need to add it if you want to enable it. It is not set
to true by default because some integrations
may rely on webservices deep copies.

Read the comments in the general.properties file to see the entire range of available properties.

Enabling entity historyYou can enable the entity history logging category, which adds
information related to changes between users and groups to the task history log, by adding the
following lines to the general.properties file in the ws-legacy folder:

log4j.appender.history.File=<path-to-log-folder>\history.log
log4j.appender.history=org.apache.log4j.RollingFileAppender
log4j.appender.history.MaxFileSize=100000KB
log4j.appender.history.MaxBackupIndex=5
log4j.appender.history.layout=com.idiominc.ws.log.entityhistory.pattern.
EntityEventPatternLayout
log4j.appender.history.layout.ConversionPattern=[%d] %E %O %u: %m%n
log4j.category.com.idiominc.ws.log.entityhistory.EntityHistoryLogger=debug,
history
log4j.additivity.com.idiominc.ws.log.entityhistory=false

, where E is the changed entity, O is the operation performed on the entity, and u is the user who
performed the operation.
Example of history log entries:

[2017-01-25 17:28:39,106] WORKGROUP_LINK DELETE (admin,1) : User 2219 was

removed from workgroup 1002
[2017-01-25 17:28:39,151] ROLE_LINK DELETE (admin,1) : User 2219 was removed
from workflow role 14
[2017-01-25 18:27:02,218] GROUP_LINK ADD (admin,1) : User 2125 was added to
workflow role 11

Attention: If you add the lines to a general.properties file that is common to all applications instead
of adding them to the one in ws-legacy, the following exception will be displayed:

INFO: Initializing Spring FrameworkServlet 'ws'

log4j:ERROR Could not instantiate class [com.idiominc.ws.log.entityhistory.
pattern.EntityEventPatternLayout].
java.lang.ClassNotFoundException: com.idiominc.ws.log.entityhistory.pattern.

30 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

EntityEventPatternLayout

This exception is caused by the fact that the ws application cannot access the legacy code base.

Enabling the stats engine

You can enable the stats engine logging category by adding the following line to the general.
properties file in the ws-api folder:

log4j.appender.stats.File=<path-to-log-folder>\stats.log

and by uncommenting the following lines:

log4j.category.STATENG.EVENTS=debug, stats
log4j.additivity.STATENG.EVENTS=false
log4j.appender.stats=org.apache.log4j.RollingFileAppender
log4j.appender.stats.MaxFileSize=100000KB
log4j.appender.stats.MaxBackupIndex=5
log4j.appender.stats.layout=org.apache.log4j.PatternLayout
log4j.appender.stats.layout.ConversionPattern=[%d] %p %t %c: %m%n

where d stands for the date, p stands for the priority (such as debug, warning, error, info), t stands for
the thread on which the login is performed, c stands for the category, m stands for the message displayed,
and n stands for new line.

Further configurations
In addition to the properties presented earlier, you can also configure the following in the general.
properties file:

• Links on the WorldServer Home page.

• The way in which WorldServer is used in a cluster, with some machines serving as workflow engines
and others as background processing engines.
• The URL of the reporting engine.
• Recurrence and notification engines.

Configuring clustered mode settings in general.properties

Clustered WorldServer application machines share a common database. The 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 following properties of the general.properties file:
workflow_daemon background_daemon

The values of these properties determine the level of concurrency for either engine:
• A value of 0 means that the engine is disabled on this machine.

Installation and Upgrade Guide 31

 2 Installing and configuring WorldServer

For example, the following settings indicate that the background_daemon is disabled on this
machine, and that there is one workflow engine on this machine.

workflow_daemon=1
background_daemon=0

• A value of 1 (the default) means that there is a single engine of that type running on this machine.
Each engine can handle one task or one job at a time.
• A value of 2 means that there are two engines of that type running on this machine and that two
tasks or jobs can run in parallel.
The best 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 engines to 2 or 3.
To create one or more dedicated WorldServer application machines, first install WorldServer on each
machine using the standard 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 properties in general.properties to 0 on each of these
machines. This will disable the workflow engine and background engine on these machines and ensure
that the machines can be dedicated to the WorldServer application.
Whether you have multiple engines on a single machine or multiple engines on separate machines, the
scaling works the same way. Each engine looks for a task or job that it can execute. If it finds one, it
claims it, executes it, and then moves on to the next one. At any given time, each engine is capable of
handling only a single task or job, and a single task or job cannot be shared across multiple engines. If
there was one very large task or job, you would see a single engine processing it and all other engines
would be idle. On the other hand, for a large number of tasks or jobs and multiple engines, you would see
each of the engines claiming tasks to process one at a time.

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 task or job is running, in the following
format:

host-name:[clone-name:]engine-number

where:
• host-name is the name of the server.
• 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. The instances can run on a
single server or multiple servers. If you do not 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

• Configure the clone_name property. For example, for a two-machine cluster, you might specify a
name as follows:

32 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

clone_name=juliet

Then, on the other machine, you might specify the name as follows:

clone_name=romeo

The Assigned To column will now display the names you have specified instead of the internally-
generated codes.

Specifying a location for files related to background processing

For each job, WorldServer stores files related to background processing, specifically the log file and any
temporary data files related to the job. Seven days after completing or canceling the job, the WorldServer
garbage collection feature deletes the files.
By default, the files are stored in the temp directory of the system, 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: You must stop WorldServer before you change the background_file_storage property and
you must copy all the contents of the previously configured folder to the newly configured folder before
you restart WorldServer. Otherwise, WorldServer will not be able to locate the data files or log files of
already 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 or mapped network drive letters to specify the background fileshare for
clustered environments. For example:

background_file_storage=//hosting_machine/background_share

Drive letters on different nodes in the cluster do not have to match, but they must all point to the same
fileshare location.

Installation and Upgrade Guide 33

 2 Installing and configuring WorldServer

Note: Forward slashes are extremely important if you use UNC paths.

A local file path may be used only for the machine hosting the background file storage, 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 the 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.
You can turn off the Recurrence and Notification engines by setting the properties to off. Note that
turning off the Recurrence engine 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 a serial manner. Hence, there is no benefit to having a large
cluster of machines in which 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
will take over the tasks. Thus, it is a good idea to have at least two machines with these engines enabled.

Avoiding collisions between multiple engines

You can avoid collisions between multiple engines in the entire cluster by configuring <add key="
TotalNumberOfDaemons" value="0" />. This is an optional configuration, but, if configured, it will
be used as the number of runnable task steps each engine should load each time for execution (the
default value is 10). It will also be used to determine the maximum allowed collisions between engines
and other engines in a WorldServer engine cluster. Currently, you must configure this property only if
there are more than 10 engines in your cluster. If you configure this property, you must use the same value
for each member of the cluster to manage collisions caused by long running task steps. If the execution
time for a task-step exceeds 5 minutes, it will always get loaded by all available engines for running,
and will stop the engines from considering other runnable steps if other runnable steps are not also
loaded by the engine. This parameter, if configured correctly, will ensure that any runnable steps that are
not currently being executed by any other engines will always be loaded and executed simultaneously
in spite of collisions on long running task steps.

34 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Logging and terminating abandoned connections

In WorldServer, you can log and identify which connections have been idle or abandoned by using the
general.properties file. The general.properties file also contains values that you must change to
have WorldServer monitor and log events according to your needs.

Procedure
1. Open the general.properties file with a text editor.
2. To enable logging connections, add this property to general.properties:

log4j.category.com.idiominc.ws.sql.ConnectionPool.CONNECTIONS=debug

3. To configure the maximum number of statements that you can log for an active connection, add
this property to general.properties:

database_connection_log_max_statements=1

A connection log is reset for every new transaction.

4. To close idle connections, add these parameters to general.properties:

database_connection_idle_time=604800

With this property, you enable the connection pool monitor. You can configure the value, expressed
in seconds, according to your needs. If set to 0 (zero), this option is ignored.
and

database_connection_leak_idle_time=1800

With this property, you can close idle leaked connections. An active connection is considered to be
leaked when no query has been executed within the specified interval and the originating thread is
blocked for some reason.

Configuring permissions to Web services in webservices.

properties

You can configure the webservices. properties file to restrict user access or grant permissions to
WorldServer Web services of your choice.

Procedure
1. On the WorldServer machine, navigate to the configuration directory of the Web application to find
the webservices. properties file. Here are some possible locations of this file:

• If WorldServer is running on Windows under Tomcat, the webservices. properties file is

typically located in:
•
%WS_CONFIG%\<application name>

Installation and Upgrade Guide 35

 2 Installing and configuring WorldServer

•
c:\Program Files\Idiom\WorldServer\tomcat\webapps\<application
name>\WEB-INF\classes\config

• If WorldServer is running on Linux under Tomcat, the webservices. properties file is typically
located in:
•
$WS_CONFIG/<application name>

•
/usr/local/idiom/worldserver/tomcat/webapps/<application name>/
WEB-INF/classes/config

2. Open webservices. properties with a text editor and configure which Web services and
methods are available to your users.

Note: The name of the services or operations are the same as the ones from server-config.
wsdd. The following examples are services and operations from the integration with Studio. Once
defined, only the specified services will be allowed. Also, if no operations are specified for a service,
all its operations are allowed.

allowed_services=WSContext(loginUser);
UserWSUserManager(getUsers,getUser);
ExchangeWSExportImportManager(importKit);
TmWSTmManager(isLiveTmMode,getTm,getAllTms,getAllTms2);
TmWSTm(getSourceTargetLanguages,lookup2,lookupConcordance);
WorkflowWSWorkflowManager(getTask,getProject);
AssetWSAssetManager(getSegment

Configurable properties in the exchange.properties file

The exchange.properties file is a Java properties file that allows you to configure the behavior of the
WorldServer import and export functionalities.
Some properties in the exchange.properties file are not documented in the following table. The
undocumented properties are for WorldServer internal use only; do not modify them.
The following list of properties shows you the available configuration options, as well as their descrip-
tions:
catasset.failOnError
true

Rolls back the import of any asset for which a placeholder mismatch error is detected.
false (default)

Imports all valid segments except those for which a placeholder mismatch is detected.

36 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

catasset.failOnError.MaxSegmentLength
true

Rolls back the import of any asset that contains a segment that violates the maximum segment
constraint.
false (default)

Imports all valid segments except those for which a maximum segment constraint violation is
detected.
tmSegmentExportLevel

Note: This property applies to XLIFF and XLZ formats only. The settings described here also apply to
the studioTmSegmentExportLevel property.

1 (default)

WorldServer provides translation memory and terminology database entries for any segment that
has fuzzy matches only.
For these segments, WorldServer exports all TD entries, and it exports TM entries in accordance with
the user's minimum score preference. WorldServer does not export TM or TD entries for any segment
that has 100%, multiple 100%, or ICE matches.

This is the default behavior and reflects the way WorldServer currently operates.
2

WorldServer provides translation memory and terminology database entries for any segment that
has fuzzy matches or multiple 100% matches.

For segments with multiple 100% matches, all of the 100% matches and TD entries are exported (but
fuzzy matches are not exported). For segments with no 100% matches, WorldServer exports all TD
entries, and it exports TM entries in accordance with the user's minimum score preference.

WorldServer does not export TM or TD entries for any segment that has exactly one 100% match or
one or more ICE matches.

If the enable_bwb_multiple_exact_matches property in the tm.properties file is not set to

true, then multiple 100% matches are not detected and are therefore not exported.

WorldServer provides translation memory and terminology database entries for any segment that
has fuzzy matches or that has one or more 100% matches.

For segments with one or more 100% matches, all of the 100% matches and TD entries are exported
(but fuzzy matches are not exported). For segments with no 100% matches, WorldServer exports all TD
entries, and it exports TM entries in accordance with the user's minimum score preference.

WorldServer does not export TM or TD entries for any segment that has one or more ICE matches.
4

WorldServer provides translation memory and terminology database entries for any segment that
has a match.
For segments with one or more 100% matches or ICE matches, all of the 100% matches and TD
entries are exported (but any fuzzy matches are not exported). For segments with no 100% matches,

Installation and Upgrade Guide 37

 2 Installing and configuring WorldServer

WorldServer exports all TD entries, and it exports TM entries in accordance with the user's minimum
score preference.
studioTmSegmentExportLevel

Note: This property applies to WSXZ (Studio) formats only. The settings for this property are the
same as for the tmSegmentExportLevel property.

4 (default)

The 4 default setting enables Studio to deliver the same leverage for the package as WorldServer. If
you select another value (to reduce the TM/TD content in the package) Studio will have different
leverage reports than WorldServer.
termdb.import.preventDuplicates
true (default)

Enables duplicate detection and prevents duplication of term entries on import.

false

Duplicates are imported as separate term entries.

termdb.import.checkAttributes
true (default)

The values of term and term entry attributes are significant in determining whether two term entries
are duplicates.
false

WorldServer compares the terms only, and does not consider the attributes.
termdb.import.overwriteAttributes
true (default)

WorldServer replaces the term and term entry attributes of the term entry in the DB with the attributes
of a duplicate import term entry, if any.
false

The existing attributes are unchanged.

enforceXTranslatedUnit
true

Never allows the importation of segments marked as TRADOS XTranslated Units.

false (default)

Allows segments to be imported if they are marked as TRADOS XTranslated Units and they have
target changes.
displayXtranslatedWarning
true (default)

Displays a warning message when a segment marked as a TRADOS XTranslated Unit is found and it
has been translated.
false

Suppresses this message.

38 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

XlzFormat
true (default)

Displays the XLZ format as a choice when exporting translation kits.

false

Hides the XLZ format choice during export.

XliffFormat
true (default)

Displays the XLIFF format as a choice when exporting translation kits.

false

Hides the XLIFF format choice during export.

WsxzFormat
true (default)

Displays the WSXZ format as a choice when exporting translation kits.

false

Hides the WSXZ format choice during export.

TradosTtxFormat
true

Displays the TTX format as a choice when exporting translation kits.

false (default)

Hides the TTX format choice during export.

BilingualDocxFormat
true

Displays the Bilingual DOCX format as a choice when exporting translation kits.
false (default)

Hides the Bilingual DOCX format choice during export.

RegulatorBundle
true

Displays the Regulator Bundle format as a choice if the selected tasks are in review.
false (default)

If set to false, Regulator Bundle will not be displayed.

dropPrivateCharacters
true (default)

Private-use characters are converted to question marks on output and are dropped on input.
false

Private-use characters are preserved as is.

Installation and Upgrade Guide 39

 2 Installing and configuring WorldServer

IdiomTmxVersion
1.4 (default)

Write out a TMX header for Version 1.4.

1.2

Write out a TMX header for Version 1.2. Used rarely when a third-party tool does not accept TMX
Version 1.4.
determineFilterUsingDatatype
true

When performing segment alignment, use the file type that maps to the datatype of the segment in
the TMX file.
false (default)

When performing segment alignment, use the HTML file type.

Note: We recommend that you use the default value for this property. TMX often does not provide
the correct data type. If you set the value of this property to true, an incorrect file type might be used
for your content.

xliff.markICEMatchesAsTranslated
true

When exporting assets in XLIFF format, mark ICE matches as translate=no in the translation-unit
element. This causes smart XLIFF editors to ignore the translation unit altogether, so it is not editable
by translators and does not show up in word counts.
false (default)

When exporting assets in XLIFF format, do not mark ICE matches as translate=no in the
translation-unit element.
studioLocaleMapping
WorldServer language name, Studio 2015 locale code

WorldServer and Studio 2015 use different locale codes for some locales. If you encounter an error
opening a project package you need to create a new mapping. Studio uses the locale codes specified
in .NET, which are listed at the following site:

http://msdn.microsoft.com/en-us/library/system.globalization.
cultureinfo%28VS.85%29.aspx

The following mappings are pre-configured by default:

studioLocaleMapping1 = Serbian (Latin), sr-Latn-CS

studioLocaleMapping2 = Serbian (Cyrillic), sr-Cyrl-CS
studioLocaleMapping3 = Azeri (Latin), az-Latn-AZ
studioLocaleMapping4 = Azeri (Cyrillic), az-Cyrl-AZ
studioLocaleMapping5 = Uzbek (Latin), uz-Latn-UZ
studioLocaleMapping6 = Uzbek (Cyrillic), uz-Cyrl-UZ

Errors also appear if the package uses a locale code without a region code, such as en instead of
en-US. This mapping fixes that issue:

40 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

studioLocaleMapping7 = English, en-US

Remember that studioLocaleMappingN entries must be unique. Add more locales to the list as
necessary, as long as you adhere to the given format.
bdx.segment.layout
SideBySide (default)

Compare source and target segments vertically in a bilingual DOCX review document.
TopDown

Compare source and target segments horizontally in a bilingual DOCX review document.
Background colors for bilingual DOCX review documents
Determine the background colors of the segments in each TM match status in a Bilingual DOCX file.
Any color names that are defined in a .NET System.Drawing.Colorclass can be used.
The following colors are configured by default:

bdx.IceMatchColor=LightGray
bdx.ExactMatchColor=PaleGreen
bdx.FuzzyMatchColor=Wheat
bdx.NoMatchColor=White

export_backward_compatible_package
Controls if the translation kit can be opened in versions of Studio prior to SDL Trados Studio 2015.
The backward compatible version will contain the previously available single Project TM (the Idiom.
tmx file) in addition to the multiple TMX files respecting the TM Group definition in WorldServer.

Using the backward compatible option can affect the export performance since two TM lookup
operations need to be performed. Select this option only if you know that you or your translation
team are not using SDL Trados Studio 2014 or later.
true

Exports backward compatible package.

false (default)

Does not enable the export of the backward compatible package.

export.wsxz.tm.type.default
Controls the TM export type selected by default during the WSXZ export. It can have the following
values: content, link, content_and_link.
content (default)

Exports the content of the WSXZ package.

link

Exports the link of the WSXZ package.

content_and_link

Exports both the link and the content of the WSXZ package.

Installation and Upgrade Guide 41

 2 Installing and configuring WorldServer

Making various configurations in other .properties files

While you are configuring WorldServer, you are likely to modify the following files, in addition to the
ones already presented. After modifying these files, you should back them up, so you can restore them
later if you need to. This does not apply if you are using the Delta configuration, because your files are
stored in the folder specified in the WS_CONFIG system variable.
• ui.properties – This is where you can configure UI-related features.

• You can activate the slide-out navigation pane and make it available throughout all the
WorldServer UI screens. To do so, set ws.enforce.navigation.panel= true and hide the
old menu of the legacy UI by setting navigation.panel.url= <new-UI-link> in general.
properties.

• The location of the legacy UI is specified in the ws.legacy.url property.

• The location of the REST API is specified in the ws.api.url property. The version of REST
API is specified in the ws.api.version property.

• If your WorldServer session ever becomes desynchronized with the HTTP session, causing the
browser to enter an infinite request loop, set session.synchnorization. rate= 1 in
ui.properties.

Important: There are two types of user sessions in WorldServer: a backend session (the WorldServer
legacy session) and a UI session (managed by Spring). The two sessions are synchronized through
calls to the REST API and the session.synchronization. rate parameter in ui.properties
determines when those calls are made.

For example, let's assume that both the backend session and the UI session are set to 600 seconds.
If it is not absolute, the backend session can be extended by 600 seconds when a user performs an
action. The UI session uses a different logic, hence the need to synchronize the two sessions. If
session.synchronization. rate= 4, then a call is made to the REST API when there are
600/4=150 seconds left of the initial UI session, to see if the backend session has been extended
and to synchronize the UI session with it. If the response is that the backend session has been
extended, then the UI session is extended as well, but only after the call. If a UI session has expired,
but the backend hasn't expired, the login page is displayed and the user will still have to log in again.

The default value of the session.synchronization. rate parameter is 4 and you can specify
values between 1 and 5. If you specify a value lower than 1 or higher than 5, the default minimum
(1) or default maximum (5) value will be used instead. Keep in mind the benefits and drawbacks of
each possibility when configuring this parameter. For example, if you set it to 1, many unnecessary
calls will be made to the REST API, which might affect performance. On the other hand, if you set it
to 5, the UI session might expire before the backend session, which means that the user will have
to log in again, even though the backend session might still be valid.

• api.properties – Contains REST API configurations.

• tm.properties – See the "Translation Memory Administration Overview" section.

• The scoping_mode property allows customers who have upgraded from a pre-10.0 version of
WorldServer to specify whether legacy WorldServer 9.x or Studio-aligned scoping mode and
leverage implementation is used for translation projects or ad-hoc translation jobs. Allowed
values are worldserver9x or studio.

Note: For version 10.0 or later, the legacy worldserver9x option will not be available.

• Translation memory (TM) mode mechanisms let you specify date and time replacements, as
well as number and measurement replacement options. To find the settings that apply to the

42 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Studio-aligned TM mode introduced in version 10.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 whenever the TM entry is updated. By default,
TM entry identifiers are mutable; 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.

Advanced configurations
This section presents advanced administrative information about the locations in which the system
searches for configurations and localization strings, as well as the priority of each location. It also includes
information about how to configure multiple log files.

Delta configuration
As of version 11.0.1, WorldServer consists of three components: the new web interface (ws), the new
REST API (ws-api) and the legacy application (ws-legacy). In previous 10.x versions, you could specify
a certain configuration value only in one place (i.e. classpath). However, starting from version 11.0.1,
you can customize configuration files in different locations and you no longer need to have a copy of the
entire configuration file. The wsconfig folder should contain only the properties configured for that
specific environment. Moreover, configuration properties can now be shared between components (ws,
ws-api, and ws-legacy), because WorldServer uses three layers of configuration with given priori-
ties, as explained below. This mechanism makes the upgrade process easier and it separates out-of-
the-box configuration values from custom configuration values.

You can set WS_CONFIG in two ways:

• As a system variable (also known as an environment variable) that will point to the configuration
directory.
• As a Java system property (e.g. -DWS_CONFIG=<WS_CONFIG path>); if you set it as a Java system
property, it has priority over the system variable.

If you set WS_CONFIG as a system variable, three layers of configuration will be merged when searching
for a configuration key:
1. %WS_CONFIG%/<application-part-name> (where<application-part-name> is one of: ws, ws-api,
or ws-legacy). This layer should contain configuration values specific to each component.
2. %WS_CONFIG%. This layer should contain configuration values shared between components.
3. classpath. This layer contains out-of-the-box configuration values and should not be modified.

When trying to get a configuration value, the framework will search in the configuration files in the
above order, returning the most specific value and ignoring the others.
Recommended configuration
• The Tomcat application folder— the values are configured by default for all files.

Important: Do not change the values from this location.

Installation and Upgrade Guide 43

 2 Installing and configuring WorldServer

• %WS_CONFIG%/ general.properties — the common general.properties. It should contain

the database connection values (if you do not use Windows registry), temp_dir value,
session_timeout and other configurations you want to change for the WorldServer engines.
Also, this configuration should contain the navigation.panel.url = <link_to_new_ws_
interface>.

• %WS_CONFIG%/ ws-api/ general.properties — specific configurations for ws-api. The

ws-api value should always be workflow_daemon= 0 and disabled notification_engine
and recurrence_engine (workflow daemon, notification_engine and recurrence_
engine will only be serviced by ws-legacy) and at least one background_daemon.

• %WS_CONFIG%/ ws-legacy/ general.properties — specific configurations for ws-legacy.

ws-legacy should always have workflow_daemon number configured and notification_
engine and recurrence_engine enabled.

• %WS_CONFIG%/ ws-api/ api.properties — REST API configurations.

• %WS_CONFIG%/ ws/ ui.properties — UI configurations. You must provide values for configura-
tions: ws.legacy.url, ws.api.url, ws.api.version.
We do not recommend having specific general.properties for ws. Being decoupled from ws-
legacy code, only the following configurations from general.properties will be read:

• session_client_check

• use_http_only_cookies

• use_secure_urls

• temp_file_path

• password_autocomplete.

This is the minimal configuration that you need in order to run WorldServer. The other configuration
values are set by default. If you want to customize other configuration files, we recommend putting them
in %WS_CONFIG% so that ws-legacy and ws-api will be able to access them. However, we do NOT
recommend changing the configuration files in the classpath (the expanded war in Tomcat).

Note: If you use registries, the configuration set will have priority over the file configuration.

If you encounter any issues related to configurations, please refer to the “Troubleshooting configuration
issues” section in the online documentation.

Delta localization
The main principle that governs the priority of a message key is: the more specific its location is, the
higher its priority. In other words, the changes you make to localization strings in WorldServer are now
processed according to a hierarchy that is similar to the one used by configurations. Therefore, to have
your changes displayed on the interface, you must save them in high priority locations.

When searching for a localization string, the system searches in the following locations and in the
following order:
1. %WS_CONFIG%/<component-part-name>
2. %WS_CONFIG%
3. classpath

If you want to change localization strings from the standard WorldServer interface or if you have
customizations in WorldServer and want to add new strings, you can do so either by overwriting the

44 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

existing strings in the localization files or by adding new strings in the files in the WS_CONFIG folder (#1
or #2). The files in the WS_CONFIG folder should contain only new or changed strings.

Important: Do not change the localization files from classpath.

WorldServer has two localization services: one on the frontend (UI), which loads only the ui_strings.
properties file, and one on the backend, which loads both ui_strings and strings bundles. A
resource bundle is a set of files of the same type (such as ui_strings.properties, plus all its specific
localized versions).

ui_strings.properties files are only for the labels on the WorldServer user interface. They can be
generic (the ones displayed if no languages are configured) or they can be specific (per locale –
ui_strings_en. properties – or per locale and country code – ui.strings_en_US. properties).
The more specific a file is, the higher its priority. For example, within a resource bundle,
ui_strings_en_US. properties has priority over ui_strings_en. properties and over ui_
strings.properties.

Moreover, if a certain string has not been localized in a language, the system will use the value it finds in
the generic ui_strings.properties file. If a string is not found in the first bundle, the system will
try to find it in the second, and then in the third, based on their priority.

Important: In WorldServer 11.1, localization files are located by default in classpath. Do not change
them. If you intend to modify existing strings or add new strings, create a new file with the same name in
a higher priority location (#1 or #2) and include only the strings that you want to add or to change. If
you have localization files in %WS_CONFIG% (as artifacts from previous installations), but you do not intend
to make changes, delete them from locations #1 and #2.

The localization bundles in WorldServer are reloadable, which means that you should see the changes
you make in the localization files without having to restart the server. However, localization content is
cached on the backend. Therefore, some strings may not be available immediately after refreshing
the page. To see the updated values without restarting the server, we have created an endpoint through
which you can clear cache: http://<host>/ ws/ localizations/ refresh.

Configuring multiple log files

To roll back log files in Management > Administration > System Logs, you need to configure different
log files for the ws-api, ws-legacy, and ws components. Otherwise, a single log file might become
too large and difficult to roll back.

Procedure
1. In the WS_CONFIG folder, open the general.properties file with a text editor and configure the
common properties related to logging.

Installation and Upgrade Guide 45

 2 Installing and configuring WorldServer

Example: For example:

log4j.rootCategory=warn, CONSOLE, logfile

log4j.appender.logfile=org.apache.log4j.RollingFileAppender
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss,
SSS} %-5p - %m%n
log4j.appender.logfile.MaxFileSize=50MB
log4j.appender.logfile.MaxBackupIndex=10
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=[%d] %p %t %c: %m%n

2. Go to the WS_CONFIG/ws-legacy folder and open the general.properties file with a text
editor.
3. Search for the log4j.appender.logfile.File property. If it is not already there, add it.
Specify the name and the path of the log file that you want to use for ws-legacy as its value.
Example: For example:

log4j.appender.logfile.File=<drive>:/<file path>/ws_legacy.log

, where <drive> and <file path> are the drive and the exact path where you want the log file to be
stored.
4. Go to the WS_CONFIG/ws-api folder and open the general.properties file with a text editor.
5. Search for the log4j.appender.logfile.File property. If it is not already there, add it.
Specify the name and the path of the log file that you want to use for ws-api as its value.
Example: For example:

log4j.appender.logfile.File=<drive>:/<file path>/ws_api.log

, where <drive> and <file path> are the drive and the exact path where you want the log file to be
stored.
6. Go to the WS_CONFIG/ws folder and open the general.properties file with a text editor.
7. Search for the log4j.appender.logfile.File property. If it is not already there, add it.
Specify the name and the path of the log file that you want to use for ws as its value.
Example: For example:

log4j.appender.logfile.File=<drive>:/<file path>/ws.log

, where <drive> and <file path> are the drive and the exact path where you want the log file to be
stored.

Important: Make sure that logging is not configured from the Windows Registry. Otherwise, these
properties are ignored.

8. Restart WorldServer.
9. Optional: Roll back the log files that you have just configured.
• For ws-legacy: In WorldServer, go to Management > Administration > System Logs and
click the roll log icon next to the ws-legacy log file.

46 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

• For ws-api: Obtain an admin token and enter the following in your browser's address bar:
http://<ws-host>:<port>/ws-api/v1/wsgate/rollLogFile?appenderName=
logfile&token= <admin token>.
Your ws-api log file is rolled back successfully if true is displayed.
• For ws: Obtain an admin token and enter the following in your browser's address bar:
http://<ws-host>:<port>/ws/wsgate/rollLogFile?appenderName=logfile&token
= <admin token>.
Your ws log file is rolled back successfully if true is displayed.

Configurations for translation memory

modes
Each WorldServer installation has its own unique configuration. These configurations include options
related to translation memories (TMs) – operating in live mode vs. non-live mode. You should consider
which of the available options works for your environment.

Live TM mode
WorldServer translation memories (TMs) can be configured to operate in live mode. In live TM mode,
entries are added to the translation memory constantly during the translation process, and the status is
tracked to distinguish various types of entries. Translation memories are updated whenever the seg-
mented asset cache is updated. Any operation that updates the segmented asset cache will update the
translation memory (for example, saves to the Asset Interface System, uploads from desktop translation
tools, and so on).

Note: Live TM mode is enabled by default. To check this, open the tm.properties file and make sure
that the value of the enable_live_translation_memory property is true.

In addition to enabling real-time sharing of translation memory, live translation memory mode makes
it possible to effectively update projects by restarting tasks without losing work.

The combination of live translation memory mode and segment status makes it possible for translations
to go into translation memory as soon as possible for the benefit of all translators. At the same time,
translators can distinguish between translations that have been through a review process and those that
might have just been added.

As translators work, the source and target text are copied from the segment cache to the translation
memory. The segment translation status (Pending Review, Reviewed, Rejected, or no status) deter-
mines if a segment is added to or updated in the translation memory and what translation status the
corresponding entry should have.

Installation and Upgrade Guide 47

 2 Installing and configuring WorldServer

Differences between live TM mode and non-live mode

The following table summarizes some of the differences in behavior between live translation memory
mode and non-live mode:

Area Live mode on Live mode off

TM update Whenever segment cache is On explicit calls to update TM.
touched. (Note that all entries added to
TM are set to Reviewed.)
Browser Workbench No Save and Update TM button. Has a Save and Update TM
button as in previous
WorldServer versions.
XLZ import No Update the translation Has an Update the translation
memory using imported assets memory using imported assets
check box. check box as in previous versions
of WorldServer.
Import of other translation kit Segments with a none status are No special behavior.
formats (besides XLZ) set to Pending Review.
User type permissions and ACL The following user type Same as in previous versions of
permissions permissions are meaningless and WorldServer.
hidden:
• Can save asset and update
TM
• Can modify TM during
upload
If a user that has only Read ACL
permissions for a TM opens an
asset in Browser Workbench, the
workbench does not present a
Save button and displays this
message: WARNING: You do not
have permission to update
translation memory "<TM>".
Write permission
is required when using Live
Translation Memory.
Please contact your WorldServer
Administrator.
For the user to be able to work in
the Browser Workbench in Live
TM mode, the administrator
must give that user Write ACL
permissions for that TM.
Logging Anytime No special behavior.
WSAssetTranslation.
saveTranslationToTm() is
called, a warning is logged with a
stack trace.

48 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Area Live mode on Live mode off

Leverage TM entry translation status TM entry translation status does
affects segment status. not affect segment status unless
Segment Asset automatic
action is used with Set
Translation Statuses? and
Maximum Translation
Status for 100% Matches
arguments set to Yes and
Pending.

Legacy-only configurations in WorldServer

11.x
You can configure WorldServer 11.x work only in legacy by removing the 11.x sections of the interface
and using only the legacy ones. However, this brings about several changes in the functionality of the
Language Cloud machine translation adapter.

Configuring WorldServer 11.x to use only the legacy

interface (with the installer)
If you have grown accustomed to the legacy interface, but have a newer version (11.x) of WorldServer,
you can remove the 11.x sections of the interface and use only the legacy ones.

Procedure
1. Install WorldServer with the installer.
2. Test the installation and make sure that you can log in to WorldServer.
3. If the Idiom service is started, stop it.
4. Go to <ws-home>/tomcat/ webapps, and then delete the ws folder, along with the WAR files
associated with it.
5. Rename the ws-legacy folder and WAR file from <ws-home>/tomcat/ webapps.

Tip: In the WS_CONFIG folder, make sure that no other folders related to ws are left from the initial
installation. The only folders that you should keep are the ones related to ws-legacy and ws-api.
Do not forget to rename these folders to match the name of the WAR files from tomcat/webapps.

6. In the transportconfig. properties file, uncomment the appropriate line and change the
value of the enable_new_create_project_wizard property to false.
7. Start (or restart) the Idiom service.
8. In your browser's address bar, type: http://<ws-ip>:<port>/<war-name>/login, where
<ws-ip> and <port> are the IP address and port of the server on which WorldServer is installed,
whereas <war-name> is the name you gave to the ws-legacy WAR file when you renamed it.

Installation and Upgrade Guide 49

 2 Installing and configuring WorldServer

Example: For example, a possible address is: http://12.345.67.890:8085/ worldserver/

login.
9. Optional: On your desktop, create a shortcut that points to the new address.

Tip: If you want modify the shortcut created during the installation to access WorldServer, you can
only do so if the ws-legacy folder and the WAR file are renamed as ws. Otherwise, you need to
create a new shortcut.

Configuring WorldServer 11.x to use only the legacy

interface (through Tomcat)
If you have grown accustomed to the legacy interface, but have a newer version (11.x) of WorldServer,
you can remove the 11.x sections of the interface and use only the legacy ones.

Procedure
1. Install Tomcat as a service.
You can use the installer provided in the WorldServer distribution kit.
2. If the Tomcat service is started, stop it.
3. Copy the ws-legacy.war and ws-api.war files to <tomcat-home>/webapps, and then rename
the ws-legacy file.
4. Create a folder named WS_CONFIG.
5. Copy the necessary configuration files in the WS_CONFIG folder from another instance of World-
Server or from classpath and configure them.

Tip: The WS_CONFIG folder is created and populated automatically when installing WorldServer
with the installer. You have to re-create the same structure of the folder when you copy the
configuration files. To see the exact structure and the files you need to copy, go to a WorldServer
instance installed with the installer.

6. Add WS_CONFIG as an environment variable and specify the location of the WS_CONFIG folder as its
value.
7. In the transportconfig. properties file, uncomment the appropriate line and change the
value of the enable_new_create_project_wizard property to false.
8. Start the Tomcat service.
9. In your browser's address bar, type: http://<ws-ip>:<port>/<war-name>/login, where
<ws-ip> and <port> are the IP address and port of the server on which WorldServer is installed,
whereas <war-name> is the name you gave to the ws-legacy WAR file when you renamed it.

50 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Example: For example, a possible address is: http://12.345.67.890:8085/ worldserver/

login.
10. Optional: On your desktop, create a shortcut that points to the new address.

About machine translation adapters in WorldServer

legacy
Without the 11.x interface, you can use existing SDL BeGlobal and SDL Language Cloud adapter
configurations in legacy, but you can create new configurations only for the SDL BeGlobal adapter.

Before you decide to remove the 11.x interface and use only the legacy part of WorldServer, you should
take into consideration the following points about machine translation adapters:
• You can add the Language Cloud adapter as a custom component in legacy, but you can create
new configurations only through the WorldServer 11.x interface. Therefore, if you remove the 11.x
sections of the interface, you cannot create or view Language Cloud adapter configurations.
• If you add the Language Cloud adapter and create configurations before removing the 11.x sections
of the interface, you can still use these configurations in legacy by going to Tools > Machine
Translations > Language Cloud Adapter, and then selecting the appropriate configuration from
the MT Adapter Configuration list.
• You can create configurations for the BeGlobal adapter both in WorldServer 11.x and in WorldServer
legacy and you can also view or modify existing ones.

Security 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 docu-
mented.)
• Configuration options through which internal WorldServer users can access the system through a
standard, non-secured connection (HTTP), whereas external users can access the system through a
secure connection (HTTPS).
• Configuration options through which you can enable secure page URLs, so that WorldServer pages
can only be accessed by the users who have the permissions required to do so.
• Software Developer Kit options through which you can implement URL security in your custom
servlets.

Important: For maximum security, configure these settings so that external users always access
WorldServer via HTTPS.

Installation and Upgrade Guide 51

 2 Installing and configuring WorldServer

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 one for securing the HTTPS connection
behind a firewall.
First, set up your application server (Tomcat) to listen on one IP address and port using HTTP; then, set
up another Web server to listen on a different IP address or port using HTTPS. Set up the second (front
end) server to act as a reverse proxy and feed any requests it gets to the first instance above. Enforce
security on the proxy server with a firewall.
The sequence for setting up these measures might be as follows:

Procedure
1. Make machine1:8080 your normal Tomcat instance. All the internal WorldServer users should go
to http://machine1:8080/ws/login.

Note: For instructions about setting up Tomcat for SSL, see <WS_home>\ tomcat\ conf\ server.
xml.orig. You will be instructed to “Uncomment the SSL HTTP/1.1 Connector entry in
$CATALINA_HOME/ conf/ server.xml and tweak as necessary.” Then, find and uncomment the
following:

<Connector port="8443"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" disableUploadTimeout="true"
acceptCount="100" debug="0" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS" />

2. Set up a front end Web server listening on a different IP address or port, such as machine2:443.
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.

3. After you have set up your infrastructure like this, set up your firewall to 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. Figure: Secure WorldServer Connection Setup

Enabling URL page security

52 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

About this task

You can make URLs for WorldServer pages check that valid users are accessing new pages from secure
locations. To enable URL security, you must modify a setting in the general.properties file.

Procedure
1. Go to the WEB-INF/ classes/ config folder of the installed Web application to find the general.
properties file.
2. Open the file in a text editor.
3. Change the use_secure_urls setting to true.
4. Save the file.
5. Restart WorldServer. (All properties changes take effect after a restart.)

What to do next
You should enable the session_client_check property. When you set it to on, the session_
client_check property ensures that a session can only be used by the same browser that created it. If
the same URL is used from another browser, the session is considered invalid and the user has to log in
again. This applies to the legacy and TransPort components of WorldServer. As a security measure, in
WorldServer 11.x, users always have to log in again if they copy the same valid URL into another browser.
To enable the session_client_check property, your browser must accept cookies.

Note: Changes to properties take effect after you restart WorldServer.

You should make this change when WorldServer is not in active use. Users who are logged in when you
enable this setting will receive an Access Denied message when they click on links. They will need to close
their browser session and log in again.

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 is supported with enhanced URL security starting with WorldServer 10.1.

Installation and Upgrade Guide 53

 2 Installing and configuring WorldServer

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 the samples are included in the wssdk_<version.build>.zip file in your WorldServer distribution
kit (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).

Uploading SDK sample objects into WorldServer

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. Browse to the SDK sample you want to upload (for example, <path you unzipped to>\ samples\
dist\ autoaction_samples. zip) and click OK.

54 Installation and Upgrade Guide

 Installing and configuring WorldServer 2

Results
You will now see the SDK samples you uploaded both in the list on the Management > Administration
> Customization page and in the page corresponding to that type of object. For example, if you
uploaded the SDK sample automatic actions, you will see them in the list of available actions in the
workflow editor when you add an automatic action. All components defined in the uploaded archive
will be added to WorldServer even if they are not of the type you selected from the list. For example, if
your component archive file has auto actions and triggers and you load it from the auto action view, both
the automatic actions and the triggers will be loaded. You will only see the automatic actions listed,
because you are on the auto action page. If you go to the triggers page, you will see the components
that were also added in that area.
In the uploaded components list, the components that have been uploaded as samples have a check
box next to them, so that you can delete them. Core out-of-the-box objects do not have check boxes next
to them.

Note: In addition to these SDK samples that you can upload to WorldServer, SDL provides sample
objects that are installed with WorldServer and which you can import into WorldServer by going to
Management > Administration > Import Objects. Some of the sample objects that you can import
have dependencies on already uploaded SDK sample objects. For example, the “Advanced Quote
Approval Process Workflow” depends on the SDK sample “Set Quote Status” automatic action that has
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, the import will fail and it will tell you
which object is required.

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
• File type configurations
• User types for typical term browsing operations To import these samples, do the following:

Procedure
1. Go to Management > Administration > Import Objects - Step 1 of 2, browse to the
XML file of the sample you want, and click Upload File.
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. Select the primary objects that you want to import, and then click Next.
3. Confirm the objects that you want to import by clicking Import.

Installation and Upgrade Guide 55

 2 Installing and configuring WorldServer

Note: Some of the sample objects that you can import have dependencies on already uploaded
SDK sample objects. For example, the "Advanced Quote Approval Process Workflow" depends on the
SDK sample "Set Quote Status " automatic action sample that has 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, the import will fail and it will tell you which object is
required.

56 Installation and Upgrade Guide

 3

Installing SDL Online Editor

 3 Installing SDL Online Editor

Before you can use SDL Online Editor on your environment, you need to deploy it, to configure World-
Server to connect to it, to grant the appropriate permissions to your user types, and to add two new
automatic actions to your workflows. SDL Online Editor is usually deployed through Chef Solo on a
different machine than WorldServer.

Before you begin

To install SDL Online Editor, you need:

• A separate machine only for SDL Online Editor.

Note: You have to install SDL Online Editor on a different machine than the one on which you
installed WorldServer or the File Type Support (FTS) Server. Install SDL Online Editor only after you
have installed WorldServer and the FTS Server.

• Administrator permissions on the SDL Online Editor machine.

• Windows Server 2012 R2 or 2016 (64 bit) on the SDL Online Editor machine.
• Microsoft .NET Framework 4.5.2 on the SDL Online Editor machine.
• The SDL Online Editor deployment kit (chef_solo_ue. zip). You can find it in the integrations
\SDL Online Editor folder of the WorldServer distribution kit.

• Prior knowledge about Chef Solo and about deployments performed through Chef Solo.
Minimum requirements for the SDL Online Editor machine: 2 CPU cores at 2.40 GHz each and 4 GB of
RAM.
Recommended configuration for the SDL Online Editor machine: at least 4 CPU cores at 2.40 GHz each
and 8 GB of RAM.

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

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.

Note: If you encounter errors or other issues during the installation, delete the C:\Chef and C:\chef_
solo_ue folders and start over from the beginning.

Procedure
1. Deploy SDL Online Editor through Chef Solo.
2. Configure WorldServer to connect to SDL Online Editor.
3. Optional: Change the location of the SDL Online Editor log files.
4. Grant the appropriate SDL Online Editor permissions to your user types.
5. Modify your workflows to include the automatic actions that are specific to SDL Online Editor.

58 Installation and Upgrade Guide

 Installing SDL Online Editor 3

Deploying SDL Online Editor through Chef

Solo
Deploying SDL Online Editor is the first step towards making SDL Online Editor work on your
environment. You do not need an Internet connection to deploy SDL Online Editor.

Before you begin

To deploy SDL Online Editor, you need:

• A separate machine only for SDL Online Editor.

Note: You have to install SDL Online Editor on a different machine than the one on which you
installed WorldServer or the File Type Support (FTS) Server. Install SDL Online Editor only after you
have installed WorldServer and the FTS Server.

• Administrator permissions on the SDL Online Editor machine.

• Windows Server 2012 R2 or 2016 (64-bit) on the SDL Online Editor machine.
• Microsoft .NET Framework 4.5.2 on the SDL Online Editor machine.
• The SDL Online Editor deployment kit (chef_solo_ue. zip). You can find it in the integrations
\SDL Online Editor folder of the WorldServer distribution kit.

• Prior knowledge about Chef Solo and about deployments performed through Chef Solo.
Minimum requirements for the SDL Online Editor machine: 2 CPU cores at 2.40 GHz each and 4 GB of
RAM.
Recommended configuration for the SDL Online Editor machine: at least 4 CPU cores at 2.40 GHz each
and 8 GB of RAM.

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

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.

Note: If you encounter errors or other issues during the installation, delete the C:\Chef and C:\chef_
solo_ue folders and start over from the beginning.

Installation and Upgrade Guide 59

 3 Installing SDL Online Editor

Procedure
1. Copy the SDL Online Editor deployment kit to the machine where you want to deploy SDL Online
Editor.
2. On the same machine, start a Windows PowerShell session as an administrator.
3. Run the following commands:

cp -Recurse <kit location> C:\chef_solo_ue

cd \chef_solo_ue\utils
.\script.ps1

, where <kit location> is the location where you copied the SDL Online Editor deployment kit (for
example, E:\chef_solo_ue).
The contents of the kit are copied and deployed and the following Windows services are installed:
• SDL BCM Service
• SDL Editor Service
• SDL Editor Service Router
• SDL Semantic Logging Service

Important: Do not modify the commands or the location where the contents are extracted
(C:\chef_solo_ue).

4. Go to C:\Program Files\SDL\Editor Service\bin and open the SDL.EditorService.

Host.exe.config file with a text editor.
5. Change the value of the AuthenticationServiceUrl property to
http://<ws-host>:<port>/ws-api/v1/onlineAssets/{0}.

Important: Throughout the entire topic, <ws-host> is the name or IP address of the machine
where WorldServer is installed and <port> is the number of the port on which WorldServer is
installed.

Example:
Forexample, http://11.234.56.78:8080/ws-api/v1/onlineAssets/{0}.
6. Change the value of the UserDetailsServiceUrl property to
http://<ws-host>:<port>/ws-api/v1/users/me/details.
Example:
Forexample, http://11.234.56.78:8080/ws-api/v1/users/me/details.
7. Change the value of the ProfileProviderUrl property to
http://<ws-host>:<port>/ws-api/v1/lp/ue/profile.

60 Installation and Upgrade Guide

 Installing SDL Online Editor 3

Example:
Forexample, http://11.234.56.78:8080/ws-api/v1/lp/ue/profile.
8. Change the value of the TqaProfileProviderUrl property to
http://<ws-host>:<port>/ws-api/v1/lp/ue/tqa/profile.
Example:
Forexample, http://11.234.56.78.8080/ws-api/v1/lp/ue/tqa/profile.
9. Change the value of the ProfileProvider, TqaProfileProvider, AuthenticationProvider,
and TranslationSettingsProvider properties to WS.
Example:
For example, add key="ProfileProvider" value="WS", add key="TqaProfileProvider"
value="WS", and so on.
10. Change the value of the WsServiceRoot property to http://<ws-host>:<port>/ws-api/v1.
Example:
For example, http://11.234.56.78:8080/ ws-api/ v1.
11. Save and close the SDL.EditorService. Host.exe.config file.
12. Go to C:\Program Files\SDL\Editor Service Router\bin and open the
Sdl.EditorServiceRouter. Host.exe.config file with a text editor.
13. Change the value of the EsPoolUrl to <oe-host>:80, where <oe-host> is the name or IP address
of the machine on which SDL Online Editor is installed.
Example:
For example, 87.654.32.11: 80.
14. Change the value of the AuthenticationServiceUrl property to
http://<ws-host>:<port>/ws-api/v1/onlineAssets/{0}.
Example:
Forexample, http://11.234.56.78:8080/ws-api/v1/onlineAssets/{0}.
15. Change the value of the UserDetailsServiceUrl property to
http://<ws-host>:<port>/ws-api/v1/users/me/details.
Example:
Forexample, http://11.234.56.78:8080/ws-api/v1/users/me/details.
16. Change the value of the AuthenticationProvider property to WS.
Example:
For example, AuthenticationProvider= WS.
17. Save and close the Sdl.EditorServiceRouter. Host.exe.config file.
18. Go to C:\Program Files\SDL\BCM Service and open the Sdl.BcmService.Host.exe.
config file with a text editor.
19. Change the value of the PoolAddress property to <oe-host>:80, where <oe-host> is the name
or IP address of the machine on which SDL Online Editor is installed.

Installation and Upgrade Guide 61

 3 Installing SDL Online Editor

Example:
For example, 87.654.32.11: 80.
20. Go to C:\Deployment\ ES\ Dev and copy the DLL files from that folder to C:\Program Files\SDL
\Editor Service\bin.
21. Restart the SDL Editor Service Router service.
22. Restart the SDL Editor Service.
23. Restart the SDL BCM Service.
24. Verify that the SDL BCM Service is working properly by typing <oe-host>:8080/ bcms/ health in
your browser's address bar, and then pressing Enter:

• If the service is working properly, the status is UP (<Status>UP</Status>).

• If the service is not working properly, the page is not displayed.
25. Verify that the SDL Editor Service is working properly by typing <oe-host>:80/ api/ es/ health
in your browser's address bar, and then pressing Enter:

• If the service is working properly, the status in UP (<Status>UP</Status>).

• If the service is not working properly, the status is DOWN (<Status>DOWN</Status>).
26. Verify that the SDL Editor Service Router service is working properly by typing <oe-host>:90/ api/
esrouter/ health in your browser's address bar, and then pressing Enter:
If the service is working properly, the status is UP ("status":"UP").
27. Optional: If any of the services is not working properly, do the following:
a. Restart your machine.
b. Start the SDL Editor Service Router service.
c. Restart the SDL Editor Service.
d. Start the SDL BCM Service.
e. Verify again by using the links mentioned earlier. For the deployment to be successful, all the
services need to be working properly.

What to do next
Configure WorldServer to connect to SDL Online Editor.

Configuring WorldServer to connect to SDL

Online Editor
After deploying SDL Online Editor, you need to configure a couple of properties on your WorldServer
environment to make sure that WorldServer can connect to SDL Online Editor.

62 Installation and Upgrade Guide

 Installing SDL Online Editor 3

Procedure
1. On the WorldServer host machine, go to the WS_CONFIG directory and open the general.
properties file with a text editor.
2. Add the following properties:

• sdl_online_editor_enabled=true

• bcm_service.url=http://<oe-host>:8080, where <oe-host> is the name or IP address of

the machine on which you deployed SDL Online Editor.
• sdl_online_editor.url=http://<oe-host>, where <oe-host> is the name or IP address
of the machine on which you deployed SDL Online Editor.
3. Save and close the general.properties file.
4. Go to the WS_CONFIG\ws directory and open the ui.properties file with a text editor.
5. Add the following properties:

• es.language_host= <oe-host>, where <oe-host> is the name or IP address of the machine

on which you deployed SDL Online Editor.
• es.router.url=<oe-host>:90, where <oe-host> is the name or IP address of the machine
on which you deployed SDL Online Editor.
6. Save and close the ui.properties file.
7. Restart WorldServer.

What to do next
If you want the SDL Online Editor log files to be saved to a different location that the default one, change
the location of your log files. If not, grant the appropriate SDL Online Editor permissions to your user
types.

Changing the location of the SDL Online

Editor log files
SDL Online Editor keeps log files for three of the services installed along with it: BCM Service, Editor
Service, and Editor Service Router. By default, these are stored in the bin\logs subfolder of each service.
For example, C:\Program Files\SDL\Editor Service Router\bin\logs. You can change the
location where each of your SDL Online Editor log files is stored by changing an attribute in its cor-
responding configuration file.

About this task

WorldServer and SDL Online Editor are usually installed on different machines, which means that their
logs are also stored on different machines. However, if you configure the SDL Online Editor log files to be
stored on the same machine and in the same folder where the WorldServer log files are stored, the SDL
Online Editor log files will also be displayed on the WorldServer user interface, on the Management >
Administration > System Logs page.
To store the SDL Online Editor log files on the WorldServer machine and in the same folder as the
WorldServer log files, you need to have the same service account user with the same name and permis-
sions on both machines. The WorldServer service, as well as the SDL Online Editor services whose logs
you want to store on the WorldServer machine, should all run under that user.

Installation and Upgrade Guide 63

 3 Installing SDL Online Editor

Procedure
1. Go to <service-location>\bin, where <service-location> is the path to the folder corresponding
to the service for which you want to change the location of the log file.
Example:
For example, C:\Program Files\SDL\Editor Service Router\bin.
2. Open the Sdl.<service-name>.Host.exe.config file with a text editor.
In this case, <service-name> is the name of the service for which you want to change the location of
the log file.
Example:
For example, open the Sdl.EditorServiceRouter. Host.exe.config file with Notepad++.
3. Search for the fileName attribute.
You can find this attribute on a line that starts with the following:

<target name="logFile" xsi:type="File" fileName="${basedir}\logs

\EditorServiceRouter.log"

4. If the section that contains the fileName attribute is commented out, uncomment it.
5. Change the value of the attribute from "${basedir}\logs\<service-name>.log" to the
location where you want the log file to be stored.
Example:
For example, fileName="C:\My Logs\EditorServiceRouter.log".
6. Save the file.
7. Restart the service for which you changed the location of the log file.
8. If necessary, change the locations where the log files of other services are stored.

Granting permissions for SDL Online Editor

To translate and review assets in SDL Online Editor, your users need to have the appropriate permissions
in WorldServer. You can grant permissions per user type. By default, administrators have all the permis-
sions related to SDL Online Editor, while users belonging to custom user types do not have any such
permissions.

Procedure
1. In WorldServer, go to Management > User Setup > User Types.
2. Click the user type to which you want to grant permissions.
3. On the User Type: <name> page, under "Edit/Translate" button, select SDL Online Editor.
The users in the current user type can now open assets in SDL Online Editor.

Important: The sdl_online_editor_enabled property works in conjunction with the SDL

Online Editor permission that you need to grant to the appropriate user types. Consider the fol-
lowing scenarios:
• If sdl_online_editor_enabled= false and the SDL Online Editor permission is granted,
the SDL Online Editor button is not displayed at all on the WorldServer 11.x user interface. On

64 Installation and Upgrade Guide

 Installing SDL Online Editor 3

the legacy interface, users can see the button, but a message informing them that they need
to configure SDL Online Editor is displayed when they click it.
• If sdl_online_editor_enabled= true and the SDL Online Editor permission is not granted,
The SDL Online Editor button is not displayed at all, regardless of the user interface.

Moreover, even if sdl_online_editor_enabled is true and the SDL Online Editor permission is
granted, you still need to add the appropriate automatic actions to your workflows for users to be
able to open the asset in SDL Online Editor.

4. At the bottom of the same page, under SDL Online Editor, grant some or all of the following permis-
sions, according to your needs:
• SDL Online Editor – Use this option to select or clear all the check boxes under this one.
• Track Changes – Select this check box to allow the users in the current user type to track
changes.
• Translation Memory – Select this check box to allow the users in the current user type to
search and update the translation memory. The Lookups pane is displayed by default when a
user with this permission opens an asset in SDL Online Editor.
• Comments – Select this check box to allow users in the current user type to view, add, or
modify comments.
• Edit Source – Select this check box to allow users in the current user type to split and merge
segments.
• Review Tab – Select this check box to give users access to the Review tab on the SDL Online
Editor user interface.
• Filter Segments – Select this check box to allow users to filter segments.
• Quality Assessment – Select this check box to allow users to assess the quality of a translation.
5. Do one of the following:
• Click Save to change the changes you made to the current user type.
• Modify the name of the user type and click Save As New to save your changes as a different
user type.

What to do next
Modify your workflows to include the automatic actions that are specific to SDL Online Editor.

Automatic actions required for SDL Online

Editor
The final step towards installing SDL Online Editor is to include two automatic actions in your workflows:
Enable Online Editing and Save Online Asset. Enable Online Editing prepares an asset to be modified in
SDL Online Editor by uploading it online, while Save Online Asset ensures that the asset is synchronized
in WorldServer and can be modified in WorldServer after a human step has been completed.

Add the Enable Online Editing automatic action before each human step that you want users to perform
in SDL Online Editor and the Save Online Asset automatic action after each such human step.

Consider the following workflow:

Installation and Upgrade Guide 65

 3 Installing SDL Online Editor

There are two human steps (Translate and Review), but only one of them (Translate) has Enable Online
Editing before it and Save Online Asset after it. This means that users will be able to use SDL Online Editor
only if the task they are working on is in the Translate step. This also means that they will use another
tool to review the asset.

Important: Always make sure that the Enable Online Editing automatic action comes after the Segment
Asset automatic action in your workflow.

Also, make sure that each human step that you want users to perform in SDL Online Editor has either
the Translate or the Review step type in the step's advanced options. To check this, double-click the step
on the workflow, and then, in the Human Step Properties dialog box, click Advanced. In the
Advanced Options dialog box, the value selected in the Step Type list should be either Translate or
Review.

66 Installation and Upgrade Guide

 Installing SDL Online Editor 3

This is important for two reasons:

1. In steps configured with the Translate step type, the Assessment tab is not displayed in SDL Online
Editor and users cannot assess translations. The Assessment tab is displayed only in steps config-
ured with the Review step type and only if you granted the Quality Assessment permission in
WorldServer to the user types who are supposed to perform those steps.
2. Different statistics are displayed on the SDL Online Editor status bar depending the step type, as
shown in the following table:

Installation and Upgrade Guide 67

 3 Installing SDL Online Editor

Step type Statistics displayed

Translate
• The number of words in the asset.
• The total number of segments in the
asset.
• The number of untranslated segments in
the asset.
• The completion rate of the translation.
Review
• The number of penalty points assigned to
existing assessments. This number is
usually 0, because WorldServer does not
support penalty points.
• The total number of segments in the asset.
• The number of segments that have the Not
Translated, Draft, or Translated status.
• The completion rate of the translation.

Useful notes about the administration of

SDL Online Editor
A list of tips and notes that might help WorldServer administrators improve their users' experience with
SDL Online Editor and understand why certain features work in a certain way.

Translation memory modes in SDL Online Editor

The way in which you configure the enable_live_translation_memory property in the tm.
properties file determines a different saving behavior in SDL Online Editor:

• If you configure the enable_live_translation_memory property to true, the segments are

saved in the project TM as soon as users confirm them.

Note: With this configuration, segments with ICE matches have the Reviewed status in WorldServer
and the Translation Approved status in SDL Online Editor or in SDL Trados Studio. Also, segments
with 100% matches have the Pending Review status in WorldServer and the Translated status in SDL
Online Editor or in SDL Trados Studio.

• If you configure the enable_live_translation_memory property to false, the entire asset is

saved in the project TM only when the project goes through the Save Online Asset automatic action
(if Update TM is set to Yes).

68 Installation and Upgrade Guide

 Installing SDL Online Editor 3

Importing TMs in the background

If users interact with a TM while another TM (or even the same TM) is being imported in the background,
those interactions may result in errors. Therefore, as a best practice, make sure to schedule TM imports
only outside of business hours.

Legacy filters and TM entry scores

If you have legacy filters configured on your environment, to avoid inconsistencies in TM entry scores
between Browser Workbench and SDL Online Editor, add the legacy_scoping_mode_disabled
property in the tm.properties file and set it to true.

User names and comments

In Browser Workbench, the person who adds a comment is displayed as user name (full name), whereas,
in SDL Online Editor, only the full name of the person who added the comment is displayed. For example,
msmith (Michael Smith) in Browser Workbench and Michael Smith in SDL Online Editor. To differentiate
more easily between multiple users with the same full name in SDL Online Editor, you might want to
modify them and include their initials or their middle names (for example, Michael E. Smith or Michael
Eugene Smith).

Completed or canceled projects and tasks

If a project or a task is completed or canceled, its assets are removed from the BCM database. Moreover,
the URLs of these assets are no longer available if you retrieve and open them from the task history.

Installation and Upgrade Guide 69

 3 Installing SDL Online Editor

70 Installation and Upgrade Guide

 4

Upgrading WorldServer
 4 Upgrading WorldServer

When you upgrade to a newer version of WorldServer, your users will not have access to the program
for a certain period of time. You need to plan that period in advance and inform users before you upgrade.

About this task

You should first perform the upgrade procedure on a staging system, and then use that system to test
the new functionality before actually upgrading your production system. A full upgrade of WorldServer
also involves changing the underlying database schema.
This procedure describes a basic WorldServer upgrade. For information about upgrading in clustered
mode, see the "Upgrading WorldServer in clustered mode" topic.

Important: If you are upgrading from a 10.x version of WorldServer and you use web services, you
need to change the endpoint to which you connect to <ws host>:<port>/ws-legacy/ services,
where <ws-host> is the name or IP address of the machine on which WorldServer is installed and <port>
is the number of the port on which WorldServer is installed.

Procedure
1. Install the supported version of the Java JDK.

Note: For information about the supported JDK version, see the "Before installing WorldServer"
section. Apache Tomcat is included in the WorldServer installation kit.

2. Download the version of WorldServer that you want to upgrade to from the WorldServer distribution
site.
3. Stop WorldServer.
You can stop and start WorldServer from the application server on which it is deployed.
4. Back up the appropriate files and components, including the WS_CONFIG folder.

Tip: Make sure that all the custom properties you have set are in the WS_CONFIG folder.

5. Set the appropriate environment variables, including JAVA_HOME, WS_HOME, WS_CONFIG, as well
as variables specific to the application server.
6. Test the current database schema, and then upgrade the WorldServer database schema.
7. If you are not using the WorldServer installer to install Apache Tomcat and the Java Runtime Environ-
ment, make sure you have the supported Tomcat and Java Runtime Environment versions installed.
8. Upgrade the WorldServer software.
Perform this step only once, regardless of the version you are starting from.
9. Validate your upgrade.

72 Installation and Upgrade Guide

 Upgrading WorldServer 4

Results
You have finished upgrading WorldServer. You can now start WorldServer and verify that the program
works as expected.

Note: You must clear your browser's cache before running an upgraded version of WorldServer for the
first time.

Backing up installation files and other

components
There are certain files and components that you should back up before you upgrade WorldServer.

Procedure
1. Make a backup copy of the entire folder tree of your installation (<WS_HOME>).

Note: In the locations given below, <WS_HOME> is the top-level directory where WorldServer is
installed. By default, this is:

For Windows:

c:\Program Files\Idiom\WorldServer

For Linux:

/usr/local/idiom/worldserver

2. If you are using Apache Tomcat on Linux and you have an existing Output and Artwork framework,
also back up $TOMCAT_HOME/ conf/ server.xml.
3. Back up your WorldServer database.
4. Back up all filesystem mounts to which WorldServer connects.
5. Save any reports you have created.

Permissions required for WorldServer

database users
If you want to run install or upgrade scripts on the WorldServer database as a user that is not a system
administrator, you need to grant that user certain permissions. You also need to grant these permissions
to database sa users configured for the System Monitor tool.

Installation and Upgrade Guide 73

 4 Upgrading WorldServer

For Oracle systems

For Oracle systems, make sure that the user has READ rights on the following tables:
• SYS.V_$SESSION

• SYS.V_$LOCKED_OBJECT

• SYS.V_$SQLTEXT_WITH_NEWLINES

• SYS.V_$SQL

• SYS.DBA_OBJECTS You can achieve this if you connect as sysdba and run the following commands:

GRANT SELECT ON SYS.V_$SESSION TO <USERNAME>;

GRANT SELECT ON SYS.V_$LOCKED_OBJECT TO <USERNAME>;
GRANT SELECT ON SYS.V_$SQLTEXT_WITH_NEWLINES TO <USERNAME>;
GRANT SELECT ON SYS.V_$SQL TO <USERNAME>;
GRANT SELECT ON SYS.DBA_OBJECTS TO <USERNAME>;
COMMIT;

where <USERNAME> is the name of the database user and is provided as an argument to Oracle SQL
Developer.

For Microsoft SQL systems

For Microsoft SQL systems, make sure that the user has READ rights on the following tables:
• sys.dm_tran_locks

• sys.dm_os_waiting_tasks

• sys.partitions

• sys.dm_exec_requests

• sys.dm_exec_sessions

• sys.databases

• sys.dm_exec_connections

• sys.dm_exec_query_stats You can achieve this by running the following command:

GRANT VIEW SERVER STATE TO <USERNAME>

where <USERNAME> is the name of the database user.

Upgrading the database schema

You can upgrade an existing Oracle or SQL database schema by running the appropriate upgrade
scripts from the upgrade folder of the WorldServer distribution kit.

After you upgrade your database, you must upgrade the WorldServer software and the database objects
and validate your database objects.

Note: This topic includes instructions for upgrading from WorldServer 9.4.0 onwards. If you are using
an earlier version of WorldServer, please contact SDL Technical Support.

74 Installation and Upgrade Guide

 Upgrading WorldServer 4

In most cases, the database schema upgrade will be performed by a database administrator. You should
inform this administrator that the files required for the schema upgrade are in the upgrade folder of
the WorldServer distribution kit.

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 program and database instance will be
down (specify the exact time period).
2. Disable all access to the production WorldServer database at the planned time.
3. Back up your WorldServer system — both the files and database(s).
4. Follow the documented steps to upgrade the WorldServer database, keeping these notes in mind:
• It may take a while for the main upgrade script to finish running; the time depends on the size
and tuning of the database, as well as on the configuration of the database server.
• Read all log files carefully before proceeding to another step and be patient.
• If you run into problems, send the log files to SDL Technical Support.
5. Run the correct upgrade scripts for your Oracle or SQL Server database, and then verify that the
upgrade script was executed successfully.
The upgrade scripts are in the upgrade folder of the WorldServer distribution kit. 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 (Linux) or
testschema.bat (Windows).

Note: See the release notes for any additional information about upgrades. Cumulative updates and
hotfixes may also require database upgrades.

Upgrading Oracle database schemas

For most versions of WorldServer, you can upgrade Oracle databases on the database server machine
only one version at a time. For example, you cannot upgrade directly from version 10.4.3 to version 11.0.1;
you have to upgrade from version 10.4.3 to version 10.4.4 first, then you can jump from version 10.4.4
to version 11.0.0, and only then can you upgrade from version 11.0.0 to version 11.0.1. Always take into
account the versions of the available upgrade scripts before planning your upgrade.

Before you begin

• Make sure you have a user with the required roles and system privileges granted in Oracle SQL
Developer. If you do not have such a user, create one.
• Required roles: connect and resource
• Required privileges: Create synonym, Create view, and Create table

Tip: To assign these roles and privileges, you can commit a grant statement that includes the
following:

Installation and Upgrade Guide 75

 4 Upgrading WorldServer

GRANT CONNECT, CREATE VIEW, CREATE SYNONYM, CREATE TABLE, RESOURCE TO

<username>;

• Make sure you have a database connection for the WorldServer version you want to upgrade from.
For example, if you want to upgrade from version 10.4.3, make sure you have a 10.4.3 database
connection.

Procedure
1. Associate the database connection with the user:
a. In Oracle SQL Developer, under Connections, right-click the appropriate database connection,
and then, on the shortcut menu, click Properties.
b. In the Username box, type the name of the user with all the roles and system privileges.
c. In the Password box, type the password of that user.
d. Select the SID option and change its value to wsdb.
e. Click Test, and then, if the result is successful, click Connect.
2. Copy the appropriate upgrade scripts to a local folder.
You can find these scripts in the upgrade folder of the WorldServer distribution kit.
Example: For example, if you want to upgrade from version 10.4.3 to version 11.0.1, go to the
upgrade folder of the WorldServer 11.0.1 distribution kit and copy the following upgrade scripts:

• WS-Upgrade-10.4.3-to-10.4.4.ora.sql

• WS-Upgrade-10.4.4-to-11.0.ora.sql

• WS-Upgrade-11.0.0-to-11.0.1.ora.sql

Important: Make sure that you run each script on the database connection associated with the
user. Click Commit after running each script.

3. Run the upgrade scripts.

Results
You have now upgraded your Oracle database schema.

What to do next
At this point, you have to validate your upgrade. Make sure you have finished running all the database
upgrade scripts before you test your upgrade with the testschema script.

Upgrading SQL Server database schemas

For most versions of WorldServer, you can upgrade SQL Server databases on the database server machine
only one version at a time. For example, you cannot upgrade directly from version 10.4.3 to 11.0.1; you
have to upgrade from version 10.4.3 to version 10.4.4 first, then you can jump from version 10.4.4 to
version 11.0.0, and only then can you upgrade from version 11.0.0 to version 11.0.1. Always take into
account the versions of the available upgrade scripts before planning your upgrade.

76 Installation and Upgrade Guide

 Upgrading WorldServer 4

Before you begin

• Make sure you have selected Mixed Mode Authentication when installing SQL Server.
• Perform the following procedure with the "sa" user and select SQL Server Authentication from the
Authentication list when you log in to Microsoft SQL Server Management Studio.
• Make sure you have a database for the WorldServer version you want to upgrade from. For example,
if you want to upgrade from version 10.4.3, make sure you have a 10.4.3 database.

Note: The name of the database must not start with a number.

Procedure
1. Copy the appropriate upgrade scripts to a local folder.
You can find these scripts in the upgrade folder of the WorldServer distribution kit.
Example: For example, if you want to upgrade from version 10.4.3 to version 11.0.1, go to the
upgrade folder of the WorldServer 11.0.1 distribution kit, and copy the following upgrade scripts:

• WS-Upgrade-10.4.3-to-10.4.4.ms.sql

• WS-Upgrade-10.4.4-to-11.0.ms.sql

• WS-Upgrade-11.0.0-to-11.0.1.ms.sql
2. Run the upgrade scripts.

Results
You have now upgraded your SQL Server database schema.

What to do next
At this point, you have to validate your upgrade. Make sure you have finished running all the database
upgrade scripts before you test your upgrade with the testschema script.

Upgrading the WorldServer software

After you finish upgrading your database, you must upgrade WorldServer on your application server.

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 upgrading from a WorldServer 10.0 32-bit installation to a
later version on a 64-bit environment.
2. Do one of the following:
• For Windows: Run setup_64.exe for 64-bit systems and extract the WS11<build number>_
win.zip distribution file.
The installer installs new versions of WorldServer, Tomcat, and Java Runtime Environment. You do
not need to download or install the ws.war, ws-legacy.war, and ws-api.war files. These files are
included in the distribution kit of the operating system.
• For Linux: Extract the WS11<build number>_unix.tar.gz distribution kit.
3. Make sure that WorldServer is stopped.

Installation and Upgrade Guide 77

 4 Upgrading WorldServer

You can stop and start WorldServer via the application server onto which it is deployed.
4. Deploy your WorldServer upgrade.
5. Optional: Install the WorldServer Report Center.
6. Optional: If you implemented additional custom code in an earlier version of WorldServer, recompile
the code against the new version of WorldServer and upload it again.

Note: If you need help with this upgrade, please contact SDL Professional Services.

7. Optional: If you keep an exchange.properties file with custom properties in the WS_CONFIG
folder, do the following:
a. Open the file and search for a line called studioLocaleMapping51 = Norwegian, no.
b. If the studioLocaleMapping51 = Norwegian, no line is in the file, comment it out or
delete it.
c. Save and close the exchange.properties file.
8. Restart WorldServer.
9. Optional: If you are upgrading from a version earlier than 11.1 to WorldServer 11.1 or later and you
want to use the Convert PDF to Word 2007-2010 automatic action, upgrade all of your automatic
actions by doing the following:
a. Extract the contents of the WorldServer SDK archive to a location on your machine.
You can find the SDK archive in the WorldServer distribution kit.
b. In WorldServer, go to Management > Administration > Customization.
c. In the Custom component type list, select Automatic Actions.
d. Click Add.
e. In the new window, click Browse, and then select the autoaction_libraries. zip file from
the extracted SDK archive.
You can find this file in the libraries\dist folder of the WorldServer SDK.
f. Click OK.

Upgrading SDL Online Editor

Before you upgrade to a newer version of SDL Online Editor, you need to obtain the updated SDL Online
Editor deployment kit. You can usually find this kit in the integrations\SDL Online Editor folder
of the latest WorldServer distribution kit.

Procedure
1. Copy the SDL Online Editor deployment kit to the machine where you want to deploy SDL Online
Editor.
2. Go to the chef_solo_ue\ utils\ nuggets folder of the updated SDL Online Editor kit.
3. Copy the NUPKG files from that folder to C:\chef\ nuggets.
4. Back up the Sdl.EditorService. Host.exe.config file (you can find it in C:\Program Files
\SDL\Editor Service\bin) and the Sdl.EditorServiceRouter. Host.exe.config file (you
can find it in C:\Program Files\SDL\Editor Service Router\bin) to a secure location of
your choice.

78 Installation and Upgrade Guide

 Upgrading WorldServer 4

5. Go to C:\chef_solo_ue\ environments and open the chef_solo_env. json file with a text
editor.
6. In the section corresponding to each service, change the value of the nugetSource property to
reflect the latest versions that you copied from the SDL Online Editor kit to C:\chef\ nuggets.
These sections are:
• cc_bcm for the SDL BCM Service

• cc_es for the SDL Editor Service

• cc_esr for the SDL Editor Service Router service

• cc_ue
Example: For example, "C:\\ Chef\\ nuggets\\ Sdl.BcmService-4. 0.0-b197.nupkg" for the
SDL BCM Service, "C:\\ Chef\\ nuggets\\ Sdl.EditorService-1. 11.0-b1021.nupkg" for
the SDL Editor Service, and so on.
7. In the section corresponding to each service, change the value of the version property to reflect
the latest versions that you copied from the SDL Online Editor kit to C:\chef\ nuggets.
Example: For example, "4.0.0-b197" for the SDL BCM Service, "1.11.0-b1021" for the SDL
Editor Service, and so on.

Important: For each section, the version must be the same both under nugetSource and under
version.

8. Save and close the chef_solo_env. json file.

9. Start a Windows PowerShell session as an administrator.
10. Run the following command:

cd \chef_solo_ue\utils
.\script.ps1

Note: Do not open the Services window while you run the command. Also, if the command is
unsuccessful and certain services appear as disabled, you need to restart your machine and run the
command again.

11. Restore the backed up configuration files to their initial locations (C:\Program Files\SDL
\Editor Service\bin for Sdl.EditorService. Host.exe.config and C:\Program Files
\SDL\Editor Service Router\bin for Sdl.EditorServiceRouter. Host.exe.config).
12. Go to C:\Deployment\ ES\ Dev and copy the DLL files from that folder to C:\Program Files\SDL
\Editor Service\bin. Replace the existing files.
13. Restart the SDL Editor Service Router service.
14. Restart the SDL Editor Service.
15. Restart the SDL BCM Service.
16. Verify that the SDL BCM Service is working properly by typing <oe-host>:8080/ bcms/ health in
your browser's address bar, and then pressing Enter:
• If the service is working properly, the status is UP (<Status>UP</Status>).
• If the service is not working properly, the page is not displayed.
Throughout this topic, <oe-host> indicates the name or IP address of the machine on which you

Installation and Upgrade Guide 79

 4 Upgrading WorldServer

want to upgrade SDL Online Editor.

17. Verify that the SDL Editor Service is working properly by typing <oe-host>:80/ api/ es/ health
in your browser's address bar, and then pressing Enter:
• If the service is working properly, the status in UP (<Status>UP</Status>).
• If the service is not working properly, the status is DOWN (<Status>DOWN</Status>).
18. Verify that the SDL Editor Service Router service is working properly by typing <oe-host>:90/ api/
esrouter/ health in your browser's address bar, and then pressing Enter:
If the service is working properly, the status is UP ("status":"UP").
19. Optional: If any of the services is not working properly, do the following:
a. Restart your machine.
b. Start the SDL Editor Service Router service.
c. Restart the SDL Editor Service.
d. Start the SDL BCM Service.
e. Verify again by using the links mentioned earlier. For the upgrade to be successful, all the
services need to be working properly.

Results
You have upgraded your version of SDL Online Editor successfully.

Validating your upgrade

You can validate your upgrade to make sure that your new WorldServer instance works as expected.

Procedure
1. Make sure that the WS_HOME environment variable points to your WorldServer installation.

Note: If you set WS_HOME to a location that has spaces in the name, you cannot use quotes around
your path when you define it. Use a path like this:
• WS_HOME=c:\program files\idiom\worldserver\tomcat\webapps\ws-legacy If you
surround the path in quotes, the batch files will fail with the following error:

Exception in thread "main" java.lang.NoClassDefFoundError: files\idiom

\worldserver\tomcat\webapps\ws\WEB-INF\classes;c:\Program

For a Tomcat installation:

Make sure your TOMCAT_HOME and CATALINA_HOME environment variables are set as well.
• For Windows:

set WS_HOME=<TOMCAT_HOME>\webapps\ws-legacy
set CATALINA_HOME=<TOMCAT_HOME>

• For Linux:

80 Installation and Upgrade Guide

 Upgrading WorldServer 4

export WS_HOME=<TOMCAT_HOME>/webapps/ws-legacy
export WS_CATALINA=<TOMCAT_HOME>

2. If applicable, set execute permissions on the wsupgrade scripts.

> cd <upgrade directory>

> chmod 777 testschema.sh

They do not apply to WorldServer 10.2.

3. Use the testschema script to validate the new version of WorldServer with the upgraded database.
At a minimum, you may want to run the following script for this release, which redirects the output
to a log file so you can check to see that the schema test succeeded.
For Windows:

upgrade\1110\testschema.bat > testschema.log

For Linux:

upgrade/1110/testschema.sh > testschema.log

The testschema script verifies all the steps of the incremental upgrade process and that the entire
schema complies with the latest version of WorldServer.

What to do next
Once you have validated your upgrade, you have to start WorldServer, verify that the program works as
expected, and notify your users that WorldServer is online again.

Upgrading WorldServer in clustered mode

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.
• You need to run the schema upgrade SQL script only once, from one of the nodes. You also need to
run the wsupgrade script (which upgrades WorldServer objects) only once. Note that this infor-
mation does not apply to WorldServer 10.2.

Procedure
1. Download the latest version of the distribution kit on a central WorldServer node.
2. Back up the WS_CONFIG folder from each node.
Thus, you will be able to restore your configurations if your data ever becomes corrupted. Also,
make sure that all the custom properties you have set are in the WS_CONFIG folder.
3. Run testschema.sh (Linux) or testschema.bat (Windows).
4. Upgrade the database from the first server.
This is the only schema upgrade you need to perform.
5. On the first server application, install the new WorldServer software and, if WorldServer requires a
new version, install new versions of Java and Apache Tomcat.

Installation and Upgrade Guide 81

 4 Upgrading WorldServer

6. If relevant, run wsupgrade.sh (Linux) or wsupgrade.bat (Windows) from the first server to
complete Java-based upgrades of WorldServer objects.

Note: This information does not apply to WorldServer 10.2.

7. Run the testschema.sh (Linux) or testschema.bat (Windows) testing script to verify the
database schema upgrade.
8. Start WorldServer on the first application server and check that it is working properly.
9. On each subsequent machine, install the new WorldServer software and, if WorldServer requires a
new version, install versions of Java and Apache Tomcat.
10. Check if any new configuration properties have been introduced in the current release and specify
values for them in the WS_CONFIG folder.
11. Start all instances and test the newly upgraded installation.

82 Installation and Upgrade Guide

 5

Updating WorldServer
 5 Updating WorldServer

SDL sometimes releases updates to existing versions of WorldServer to address various issues. When
installing an update, you replace your existing ws.war file with new ws-legacy.war, ws-api.war, and
ws.war files, and expand them by restarting the application server. You do not have to upgrade the
WorldServer binaries or database schema.

Installing an update
Procedure
1. Back up your WorldServer installation and configuration files, including the WS_CONFIG folder.
Make sure that all the custom properties you have set are in the WS_CONFIG folder.
2. Obtain the ws.war, ws-api.war, and the ws-legacy.war files for the Service Pack from SDL
Technical Support.
3. Stop the application server (Tomcat).
You stop and start WorldServer via the application server on which it is deployed.
4. Move your ws, ws-api, and ws-legacy folders to a place from which you can recover them if the
Service Pack installation fails.
5. Put the new ws.war, ws-api.war, and ws-legacy.war files in the folders where the old ones
were.
6. Restart the application server (Tomcat) to unpack the WAR files.
7. Stop the application server again.
8. Run the testschema.sh (Linux) or testschema.bat (Windows) test script to verify the database
schema upgrade.
9. Start the application server again.

Note: Contact SDL Technical Support for any changes to files that are not included in the World-
Server WAR files.

Results
The update is now installed. To test it, start WorldServer and verify that the program works as expected.

Redeploying onto Apache Tomcat

Before you begin

To deploy the new ws.war, ws-legacy.war, and ws-api.war files, just place them in the location
where the previous WAR file was and restart Tomcat. Make sure that you have backed up your World-
Server configuration files before you execute these instructions, including the WS_CONFIG folder, and
make sure that all the custom properties you have set are in the WS_CONFIG folder.
These instructions assume you have obtained the new WAR files from SDL Technical Support.

84 Installation and Upgrade Guide

 Updating WorldServer 5

Procedure
1. Copy the new ws.war, ws-legacy.war, and ws-api.war files to <TOMCAT_HOME>\webapps (for
Windows) or ${WS_HOME}/apache-tomcat-8.0.36/ webapps (for Linux).
2. Restart Tomcat and wait for the ws.war, ws-legacy.war, and ws-api.war files to be expanded
completely.
When finished, the .complete file appears in the <TOMCAT_HOME>\webapps\ws,
<TOMCAT_HOME>\ webapps\ ws-legacy, or <TOMCAT_HOME>\ webapps\ ws-api folders forWin-
dows or in the corresponding folders for Linux.
a. On Windows, start the Tomcat service (called Idiom Process Monitor).

Note: If you deployed WorldServer onto Tomcat manually, instead of deploying it with the
installer, there will not be an Idiom Process Monitor service and you must use a startup script
instead.

b. On Linux, run the following command as root:

> /sbin/service worldserver start

Results
The update is now in place and the WorldServer login screen indicates the update number right after
the version number.

Important: Should you need to roll back, stop Tomcat, back up the new ws.war, ws-legacy.war, and
ws-api.war folders (by renaming them), revert the original ws.war, ws-legacy.war, and ws-api.war
folders to their original names and restart Tomcat.

Installation and Upgrade Guide 85

 5 Updating WorldServer

86 Installation and Upgrade Guide

 6

Installing the Report Center

 6 Installing the Report Center

The WorldServer Report Center ( Tools > Report Center ) is based on a reporting engine called Jasper-
Reports Server Enterprise. This engine is also used for the reports you see on the WorldServer Home page
right after you log in. To use the Report Center in WorldServer, you have to install JasperReports Server
and configure it appropriately.

This section describes the requirements and the installation procedures for the JasperReports Server
(JRS), as well as the process of uploading the reports repository. Starting with WorldServer 10.4.4, there
are two reports repositories available: one to use with SQL, namely <distribution archive>\
integrations\ JasperSoft_6.3.0\ jrs_repository_sql. zip, and the other to use with Oracle,
namely <distribution archive>\ integrations\ JasperSoft_6.3.0\ jrs_repository_ora.
zip. You must upload and deploy the correct reports repository to use this reporting option.

For more information about JasperReports, extract the reports repository in the WorldServer distribution
and see the documents folder available there.

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 World-
Server license agreement with SDL plc.

JasperReports Server installation overview

The WorldServer installation procedure for the JasperReports Server adapts the standard instructions to
support the features provided by WorldServer.

When you install the JasperReports Server (JRS), note the following points about a WorldServer-specific
installation:
• 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.

• JRS should be installed to run on the same database server as WorldServer, but on different
databases.
• Use the instructions for a minimal installation, to avoid installing unnecessary sample databases.

JasperReports Server installation

prerequisites
Before you begin the installation of JasperReports Server, you need to keep in mind the following:
• Know where your application server is installed, how to configure it, and how to deploy new Web
applications. You need write permissions for various folders or locations in your application server
deployment.
• Make sure you have write permissions for the WorldServer configuration files.

88 Installation and Upgrade Guide

 Installing the Report Center 6

• Know the location and login credentials for the WorldServer database server.

Note: Starting with WorldServer 11.0, JasperReports Server is no longer installed on the same
instance as WorldServer. The JRS data resides in a separate database instance on the same database
server as WorldServer.

• You can find the JasperReports Server installation kit in the <distribution archive>\
integrations\ JasperSoft_6. 3.0 folder, which is included in the WorldServer ZIP file (for
Windows) and TAR file (for Linux).
• Also, make sure the JAVA_HOME and CATALINA_HOME properties point to the same recommended
prerequisites.

Installing JasperReports Server

By installing the JasperReports Server (JRS) engine, you can always view up-to-date information in the
WorldServer Report Center.

Before you begin

Make sure you have installed Microsoft SQL Management Studio (MSSQL DB) or Oracle SQL Developer
(Oracle DB) on your local machine. You also need a working version of WorldServer 11.x (with Java
Development Kit 8 and Tomcat 8) on the same machine. JRS 6.3.0 works with Java Development Kit
(JDK) 8 and Tomcat 8, so you can use the same Tomcat and JDK versions you used when you installed
other WorldServer 11.x components (ws-api, ws, ws-legacy).

Important: If possible, place WorldServer and JRS on different Java virtual machines. If you already
have an instance of Tomcat on your computer, make sure that it is stopped before you start to install
JRS.

About this task

The following procedure applies to the configuration of the JasperReports Server engine for WorldServer
11.x. Only users with administrator permissions can install JasperReports Server. You can find the Jasper-
Reports Server installation kit on the WorldServer FTP, in <distribution archive>\ integrations\
JasperSoft_6.3.0.

Important: If you encounter any issues while performing one of the steps, stop the installation process
and start over from the very beginning. This also includes deleting the jasperserver database that was
created automatically on your local machine.

Procedure
1. Go to the JasperReports Server installation kit and extract the jasperreports-server-6.
3.0-bin.zip package to a path of your choice, such as C:\Jasper.

Note: Throughout the entire procedure, this path will be referred to as <js-install>. Always
remember to replace <js-install> with the actual path.

2. The jasperreports-server-6. 3.0-bin.zip package contains a folder called Reports, in

which you can find Tomcat 8 and JDK 8. Copy that folder to one of the following paths:

Installation and Upgrade Guide 89

 6 Installing the Report Center

• If you installed WorldServer 11.x by using the installer, copy the Reports folder to C:\Program
Files\Idiom.

• If you installed WorldServer 11.x by using Tomcat 8, copy the Reports folder to C:\Program
Files\Apache Software Foundation.

Note: Throughout the entire procedure, this path will be referred to as <tomcat8-home>. Always
remember to replace <tomcat8-home> with the actual path.

3. Open the command prompt (CMD) as an administrator and enter the following commands in the
order in which they are presented:

Command Notes
set JAVA_HOME=<tomcat8- Make sure you replace <tomcat8-home> with the actual path
home>\Reports\jre (such as C:\Program Files\...).
set Path=%JAVA_HOME%\bin This is to set the Path variable.
;%Path%
java -version This is to check that the system is now running on Java 8.
cd C:\<js-install> Make sure you replace <js-install> with the path where you
\jasperreports-server-6. extracted the jasperreports-server-6.3.0-bin.zip
3.0-bin\buildomatic package.
js-install-service.bat Make sure you replace <tomcat8-home> with the actual path
"<tomcat8-home>\Reports" (such as C:\Program Files\...) and <user-home> with the
"<user-home>" path of the user's home folder (such as C:\Users\jsmith).

Important: Do not close the command prompt until you have finished installing JasperReports
Server.

You have now installed Tomcat 8 as a service. This service is named SDL WorldServer Reports.
4. Go to <tomcat8-home>\tomcat\conf, open the server.xml file, and then make sure that the
Tomcat ports in the following entries are different from the ports used by WorldServer:

Connector port="<port>" protocol="org.apache.coyote.http11.

Http11Protocol"

Server port="<port>" shutdown="SHUTDOWN"

"Connector port="<port>" protocol="AJP/1.3" redirectPort="<port>"

5. Go to <tomcat8-home>\ Reports\ tomcat\ bin and check if it contains a file called

SDLWorldServerReportsw. exe. If it does not contain a file with this name, rename the
tomcat8w.exe file to SDLWorldServerReportsw. exe.
6. Go to <js-install>\ buildomatic\ sample_conf and copy the sqlserver_master. proper-
ties or oracle_master. properties file (depending on the type of database you have on
your local machine) to <js-install>\buildomatic, and then rename it to default_master.
properties.
7. Open the default_master. properties file and set the following properties:

90 Installation and Upgrade Guide

 Installing the Report Center 6

Property Description
name
appServerTypeThis should always be tomcat8.

appServerDir This path should be <tomcat8-home>\\Reports\\tomcat (for example,

C:\\Program Files\\Idiom\\Reports\\tomcat).

dbType If you copied and renamed the correct file in the previous step, do not change the
value of this property.
dbHost The name of the database server or its IP address.
dbUsername The username that will be used to log in to the database.
dbPassword The password that will be used to log in to the database. Do not encrypt it.
js.dbName Optional: If you want to change the name of the database, uncomment this
property and specify a new name.
webAppNameProOptional: If you want to change the folder name (thus, making it part of the URL),
uncomment this property and specify a new name.
encrypt Set this property to true for database passwords to be encrypted in
configuration files. During the installation, this property creates certain
encryption keys in the user's home folder. Pass this folder to js-install-
service.bat as a second argument or set the following Java option:-Duser.
home=<user-home>

Note: Make sure the information you provide is correct, especially the Tomcat path and the
database access credentials.

8. Go to <tomcat8-home>\bin and open the SDLWorldServerReportsw. exe file.

9. Click the Java tab, and then, in the Java Options box, add the following properties:

• -Djs.license.directory=C:\Jasper\jasperreports-server-6.3.0-bin

• -Xms512m

• -Xmx1024m

• -XX:MaxPermSize=512m

• -XX:ReservedCodeCacheSize=64m

• -XX:+UseCodeCacheFlushing

• -XX:+UseConcMarkSweepGC

• -Duser.home=<user-home>

Note: Some of these properties may already have been added. In this case, make sure that the
correct values are specified.

10. At the command prompt, enter the following command: <js-install>\buildomatic\js-

install.bat minimal.
This avoids installing sample data that does not apply to WorldServer.
11. Go to the JasperReports Server installation kit folder (<distribution archive>\ integrations\
JasperSoft_6. 3.0) and copy the appropriate jrs_repository archive (jrs_repository_ora
if you have an Oracle database on your machine or jrs_repository_sql if you have a Microsoft

Installation and Upgrade Guide 91

 6 Installing the Report Center

SQL database) to the <js-install> path (for example, C:\Jasper).

Tip: Make sure that the path does not contain white spaces. Otherwise, issues may occur.

12. At the command prompt, enter the following command: <js-install>\buildomatic\js-

import.bat --update --input-zip <js-install>\ jrs_repository_<sql or ora>.zip
It might take a while to import all the reports.
13. Open the general.properties file in the WS_CONFIG folder and add the following lines:

report_center_url=http://<jasper-IP>:<port>/jasperserver-pro/flow.html?_
flowId=searchFlow&mode=search&filterId=resourceTypeFilter
&filterOption=resourceTypeFilter-reports

where <jasper-IP> is the IP address of the machine where JasperReports Server is installed and
<port> is the Tomcat 8 port where JasperReports Server is installed (by default, 8081).

ws_dashboard_url=http://<jasper-IP>:<port>/jasperserver-pro/flow.html?_
flowId=dashboardRuntimeFlow&dashboardResource=/Dashboards/WSDashboard
&viewAsDashboardFrame=true

where <jasper-IP> is the IP address of the machine where JasperReports Server is installed and
<port> is the Tomcat 8 port where JasperReports Server is installed (by default, 8081).
14. Goto <tomcat8-home>\ Reports\ tomcat\ webapps\ jasperserver-pro\ WEB-INF andopen
the applicationContext-worldserver. xml file.
15. Configure the wsLoginUrl and wsSoapUrl properties as follows:

<property name="wsLoginUrl">
<value>http://<WS-IP>:<port>/ws-legacy/login</value>
</property>
<property name="wsSoapUrl">
<value>http://<WS-IP>:<port>/ws-legacy/servlet/rpcrouter</value>
</property>

where <WS-IP> is the name or IP address of the machine where WorldServer 11.x is installed and
<port> is the port number where WorldServer is installed.
16. Start the SDL WorldServer Reports service.
17. Depending on how you installed WorldServer 11.x, do one of the following:
• If you installed WorldServer 11.x by using the installer, restart the Idiom Process Monitor
service.
• If you installed WorldServer 11.x by using Tomcat 8, restart the Apache Tomcat 8 service.
18. In your browser, log in to ws-legacy (http://<WS-IP>:<ws-port>/ws-legacy/ login), and then
log in to JasperReports (http://<WS-IP>:<jasper-port>/jasperserver-pro/ login.html).
Use the superuser/superuser credentials to log in to JasperReports.

Tip: If the page is not displayed, reduce the -Xmx memory from 1024m to 512m. You may have
assigned more memory that the VM can sustain. If reducing memory does not work, take a close
look at the Jasper logs. You can find the logs at: <tomcat8-home>\ Reports\ tomcat\ webapps\
jasperserver-pro\WEB-INF\logs\jasperserver.log.

19. In the WorldServer Report Center, click View > Repository, and then, in the Folders tree, go to
<root> > Organizations > WorldServer > DataSources.

92 Installation and Upgrade Guide

 Installing the Report Center 6

20. Click WorldServerDB, and then click Edit.

21. In the Set Data Source Type and Properties page, specify the following information:

Field Value
JDBC Other
Driver
JDBC
Driver • For Microsoft SQL: tibcosoftware.jdbc.sqlserver.SQLServerDriver
(required) • For Oracle: tibcosoftware.jdbc.OracleDriver
URL
(required) • For Microsoft SQL: jdbc:tibcosoftware:sqlserver://<db-host-name>:<
port>;DatabaseName=<ws-database-name>
• For Oracle: jdbc:tibcosoftware:oracle:@<db-host-name>:<
port>:<SID>

Make sure you replace <db-host-name>, <port>, and <ws-database-name> or

<SID> with values that match the configuration of your WorldServer database.

User Name The user name that will be used to log in to the database.
(required)
Password The password that will be used to log in to the database.

22. Click Test Connection, and then click Save.

23. Copy (overwrite) the jasperserver. license file from the jasperreports-server-6. 3.0-
bin.zip package to the following path: <tomcat8-home>\ Reports\ tomcat\ webapps\
jasperserver-pro\WEB-INF.
You can obtain the license file, as well as the installer files, from the WorldServer FTP.

Results
At this point, you should be able to see the reports from Tools > Report Center in WorldServer 11.x.

Upgrading JasperReports Server from

version 4.2.1 to version 5.2
Starting with version 10.4, the WorldServer distribution archive includes the JasperReports Server (JRS)
5.2 installation kit. However, if you still use JRS 4.2.1 with WorldServer 11.x, you can upgrade to JRS 5.2.

Before you begin

Make sure you have installed Microsoft SQL Management Studio (MSSQL DB) or Oracle SQL Developer
(Oracle DB) on your local machine. You also need a working version of WorldServer 11.x (with Java
Development Kit 8 and Tomcat 8) on the same machine. JasperReports Server only works with Java
Development Kit (JDK) 7 and Tomcat 7, so you cannot use the same Tomcat and JDK versions you used
when you installed other WorldServer 11.x components (ws-api, ws, ws-legacy).

Installation and Upgrade Guide 93

 6 Installing the Report Center

About this task

The following procedure applies to upgrading the JasperReports Server engine for WorldServer 11.x.
Only users with administrator permissions can install JasperReports Server. You can find the Jasper-
Reports Server installation kit on the WorldServer FTP, in <distribution archive>\integrations
\JasperSoft_5.2.

Procedure
1. Go to <js-install>\ buildomatic.

Note: Throughout the entire procedure, the path where JRS 4.2.1 is installed and where you will
install JRS 5.2 will be referred to as <js-install>. Always remember to replace <js-install>
with the actual path.

2. Open the command prompt (CMD) as an administrator and enter the following command:
js-export.bat --everything --output-zip js-421-export.zip

Note: Do not close the command prompt until you have finished installing JasperReports Server.

3. Back up the current JRS database.

4. Move <tomcat-home>\ webapps\ jasperserver-pro to a backup location.
5. Extract the jasperreports-server-5. 2-bin.zip archive to the <js-install> path.
6. Go to <js-install>\ buildomatic\ sample_conf and copy the sqlserver_master. proper-
ties or oracle_master. properties file (depending on the type of database you have on
your local machine) to <js-install>\ buildomatic, and then rename it to default_master.
properties.
7. Open the default_master. properties file and set the following properties:

Property name Description

appServerType This should always be tomcat7.
appServerDir This path should be <tomcat-home>
\\Reports\\tomcat (for example,
C:\\Program Files\\Idiom\\Reports
\\tomcat).
dbType Do not change this property.
dbHost The name of the database server or its IP
address.
dbUsername The username that will be used to log in to the
database.
dbPassword The password that will be used to log in to the
database. Do not encrypt it.
js.dbName Optional: If you want to change the name of the
database, uncomment this property and specify
a new name.
webAppNamePro Optional: If you want to change the folder name
(thus, making it part of the URL), uncomment
this property and specify a new name.

94 Installation and Upgrade Guide

 Installing the Report Center 6

Note: Make sure the information you provide is correct, especially the Tomcat path and the
database access credentials.

8. Make sure the SDL WorldServer Reports service is stopped.

9. At the command prompt, enter the following command: <js-install>\buildomatic\js-
upgrade-newdb.bat -input-zip c:\js-421-export.zip
JasperReports Server will take a little longer to load when you open it for the first time, because the
repository will be upgraded.
10. Start the SDL WorldServer Reports service.
11. Open the general.properties file in the WS_CONFIG folder and make sure it contains the
following line:

report_center_url=http://<jasper-IP>:<port>/jasperserver-pro/flow.html?_
flowId=searchFlow&mode=search&filderId=resourceTypeFilter
&filterOption=respirceTypeFilter-reports

where <jasper-IP> is the IP address of the machine where JasperReports Server is installed and
<port> is the Tomcat 7 port where JasperReports Server is installed (by default, 8081). If it does not
contain this line, add it yourself.
12. Restart the SDL WorldServer Reports service.
13. Depending on how you installed WorldServer 11.x, do one of the following:

• If you installed WorldServer 11.x by using the installer, restart the Idiom Process Monitor
service.
• If you installed WorldServer 11.x by using Tomcat 8, restart the Apache Tomcat 8 service.
14. Open JasperReports in your browser: http://<localhost>:<port>/ jasperserver-pro/
login.html.
Use the superuser/superuser credentials to log in.
15. In the WorldServer Report Center, clickView > Repository, and then, in the Folders tree, go to
<root> > Organizations > WorldServer > DataSources.
16. Right-click WorldServerDB, and then click Edit.
17. In the Set Data Source Type and Properties page, specify the following information:

Field Value
JDBC Driver Other

JDBC Driver (required)

• For Microsoft SQL: com.microsoft.
sqlserver.jdbc.SQLServerDriver
• For Oracle: oracle.jdbc.OracleDriver

Installation and Upgrade Guide 95

 6 Installing the Report Center

Field Value
URL (required)
• For Microsoft SQL: jdbc:sqlserver:
//<host name>:<port>;DatabaseName
=<databasename>
• For Oracle: jdbc:oracle:thin:@<host
name>:<port>:<SID>

Make sure you replace <host name>, <port>,

and <databasename> or <SID> with values
that match the configuration of your
WorldServer database.
User Name (required) The user name that will be used to log in to the
database.
Password The password that will be used to log in to the
database.

18. Click Test Connection, and then click Save.

Results
At this point, you should be able to see the reports from Tools > Report Center with JasperReports
Server 5.2.

Platform notes
The installation of the JasperReports Server (JRS) with WorldServer implies certain differences from the
standard procedures described in the JRS documentation. Note the following:
• When you run the js-install.bat or js-install.sh script, install only the minimal configura-
tion in all cases. This avoids installing sample data that does not apply to WorldServer. For example,
on Windows, the command would be js-install.bat minimal
• The JasperSoft documentation refers to changing JVM parameters to run JRS (section 6.2.1 in the
JRS installation guide). Though the installation guide states this is required, existing Tomcat
deployments may already have specific settings that should not be changed.

The following sections provide more information for various platforms.

Linux permissions
On Linux installations, after you extract the jasperreports-server-6. 3.0-bin.zip archive, make
sure the files in the following folders are executable:
buildomatic
If necessary, run chmod u+x <js-install>/buildomatic/*.
buildomatic/bin
If necessary, run chmod u+x <js-install>/buildomatic/ bin/ *.

96 Installation and Upgrade Guide

 Installing the Report Center 6

apache-ant/bin
If necessary, run chmod u+x <js-install>/apache-ant/ bin/ *.

Windows 7 and Windows Server 2012 R2/2016

• When you install JasperReports on Windows 7 or Windows Server 2012 R2 or 2016, start a cmd shell
as an administrator, so you can perform the installation.
• If you edit configuration files in C:\Program Files (x86) or C:\Program Files, your editor
must also run as administrator. Otherwise, any changes you make will not be displayed in the actual
file and you will not see a message informing you of the problem.
• You should run the <js-install>\ buildomatic\ js-install-service. bat to install JRS as
the new SDL WorldServer Reports service. To edit the service, also run c:\Program Files\Idiom
\Reports\tomcat\bin\SDLWorldServerReportsw.exe.

Microsoft SQL Server

• The database user you choose for installing the JRS repository must have permission to create
databases (dbcreator might be enough). You may want to revoke sysadmin permissions after
installation.
• You cannot put the JRS data into the same database WorldServer is using. They can live on the
same server, but they cannot share a schema.

Oracle
Note the following about the Chapter 5 of the JasperReports Server Installation Guide instructions for
Oracle.
• There is no mention of the Oracle SID parameter in the JRS installation guide, but the property sid
does appear in the oracle_master. properties. If you are using a non-default SID on your
target Oracle database (default is orcl), adjust the sid property as required.
• In practice we have found that you do not have to define the 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 any need to
enter the SYSDBA username and password into the default_master. properties file.
The JRS installation creates a jasperserver schema instance by default, with the password password.

Configuring reporting over HTTPS

Installation and Upgrade Guide 97

 6 Installing the Report Center

Procedure
1. Make sure your application server is configured for HTTPS access.
For more information, see the Security settings and connections topic.
2. Modify the WSSingleSignOnFilter Java bean in the applicationContext-worldserver. xml
file to use HTTPS URLs.
3. Configure the report_center_url property in the WorldServer general.properties file to use
an HTTPS URL.

Log file
Enable single sign-on debug logging with an entry in the following file: <tomcat-home>/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-home>/webapps/ jasperserver-pro/ WEB-INF/
logs/ jasperserver. log and the Tomcat console window.

User permissions in Jasper Reports Server

WorldServer users and user types are automatically added to the Jasper Reports Server (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, do the following:
1. Log in to WorldServer as an administrator.
2. Go to Tools > Report Center.
3. Right-click on a report, and then click Permissions.
4. Set the permissions as necessary.
• If an individual user's permission to a report is set to No Access, that user may still be able to view
the report if their role's permission is set to Read-Only.

Note: For more information, see the JasperReports Administrator Guide included in the distribution
kit.

• Administrators can use the JRS Manage > Users page to assign permissions to users and roles, or
to delete users and roles.
• You should not change the predefined ROLE_Administrator and admin users in the WorldServer
organization. System users and roles (outside the WorldServer organization) should not be
altered either.

98 Installation and Upgrade Guide

 Installing the Report Center 6

• Roles and users which are added automatically from WorldServer are marked as "User/Role is
externally defined". You can delete these objects, but they will be recreated automatically the
next time the user goes to 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: JRS 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 you
can ignore them or delete them.

Installation and Upgrade Guide 99

 6 Installing the Report Center

100 Installation and Upgrade Guide

 7

Installing the File Type Support

Server
 7 Installing the File Type Support Server

WorldServer handles and segments assets through the file types used by the File Type Support (FTS)
Server. You can run this separate, Windows-only server either as a Windows service (recommended) or
through a Windows console.

WorldServer identifies translatable text based on the file type of the asset. Because the exact makeup of
translatable text versus other content varies greatly across different file formats, this process is very
file-format specific, but it also has some common features across multiple file types.

Note: Starting with WorldServer 2011 (WorldServer version 10.0), WorldServer only supports SDL file
types for new installations which require the FTS Server. If you are upgrading your WorldServer instal-
lation to version 10.0 and later, you can use both the SDL file types and WorldServer legacy filters.

Installing the File Type Support Server on

Windows
The File Type Support (FTS) Server only runs on Windows machines, but, once you have installed it, you
can connect it to a WorldServer installation on Linux as well. FTS Server is a 32-bit program and runs in
32-bit mode even on a 64-bit machine.

To install the File Type Support Server:

1. Download the FileTypeSupportServer. msi file from the WorldServer FTP website to a known
location on a Windows machine.
2. If necessary, install the .NET Framework 4.5.2 software on that machine.
• Download the .NET Framework 4.5.2 redistributable file (dotNETFx452_Full_setup. exe.
exe) from the WorldServer FTP site.

• Double-click the file and install .NET version 4.5.2.

3. Double-click the FileTypeSupportServer. msi file, and then click Next.
4. On the Destination Folder page, specify the folder where you want the FTS Server to be installed.
5. On the FTS Server Configuration page, specify the folder shared by WorldServer and FTS Server,
as well as the number of FTS Server processes to run.

Important: The shared folder must be the same as the one specified as the value of the ftsserver
_shared_directory property in the general.properties file.

Moreover, the number of processes must match the number of processors on the FTS Server
machine.

6. On the FTS Server Windows Service Configuration page, specify a user account that runs the FTS
Server service and its corresponding password. If you do not specify them, the local system
account will be used to run the service.
7. On the Database Connection page, specify the database type, the name of the SQL Server or
Oracle server, the name of the WorldServer database, as well as the username and password of the
SQL Server or Oracle user.

102 Installation and Upgrade Guide

 Installing the File Type Support Server 7

Note: All the information you specify on this page must match the information you specified when
you installed WorldServer.

8. Click Install, and then click Finish.

The SDL File Type Support Server service is started automatically.

Note: All potential warnings or errors are written to the Windows Application Event Viewer.

Notes related to the File Type Support Server installation

• To install FTS Server, you should use the same userid that currently "owns" the WorldServer instance.
• The FTS Server requires that you use the database username and password used by WorldServer.
You should enter plain text characters in both boxes. The installation wizard encrypts the password,
matching the encrypted password used by WorldServer. If you do not know the username or
password for the database used by WorldServer and cannot obtain them, contact WorldServer
technical support.
• Windows permissions are extremely important for the proper operation of the FTS Server and of
the WorldServer application server. Both installations must be owned by users with identical domain
permissions.
• If you need more information about .NET Framework version 4.5.2, refer to the Microsoft Download
Center .

FTS Server properties are managed by the Sdl.WorldServer. FileTypeSupport. Server.

HostProcess. exe.config file, which is created during the installation process. The
Sdl.WorldServer. FileTypeSupport. Server.Launcher.exe.config file immediately starts the
designated number of processes. These processes 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 click Properties.
3. Click the Log On tab.
4. Select This account and enter the username and password of the WorldServer user.
5. Click OK.
6. Right-click the SDL File Type Support service again and click Restart.

Office file type requirements

Two Microsoft Office file types have special installation requirements on the FTS Server:
• Rich Text Format (RTF) File Type
• Microsoft Excel 2000-2003 File Type
To process these file types, you must install Excel 2007 and Word 2007 or later (or the 2003 versions with
the Office 2007 compatibility pack) on the machine that runs the FTS Server. Both are covered if you
install Office 2007 or later.

Installation and Upgrade Guide 103

 7 Installing the File Type Support Server

What to do next
You must now configure the WorldServer instance to communicate with the FTS server.

FTS Server configurations for Windows

After you install the File Type Support (FTS) Server, you must configure your WorldServer instance on
Windows to communicate with it.

To make WorldServer instances installed on Windows work with the FTS Server, you need to do the
following:
• Make sure that the WorldServer service (IdiomRun) is running under a Windows domain account.
• Make sure that the FTS Server service (ftsserver) is running under a Windows domain account.
• Make sure the Windows domain account has the appropriate permissions for the folder where AIS
file system mounts are stored.
• Configure the ftsserver_shared_directory property in the general.properties file under
WS_CONFIG.

• Configure the FTS Server file types in WorldServer.

When deploying WorldServer and the FTS Server in a mixed Linux/Windows environment and using
NFS, you must configure Windows Active Directory with Identity Management for Linux. By doing so, you
can map Windows usernames to Linux usernames.

All WorldServer and FTS Server service 'run-as' users must have read/write access to:
• The folder paths in Universal Naming Convention (UNC) format for AIS filesystem mounts in
WorldServer.
• The UNC path defined in the ftsserver_shared_directory property of the general.
properties file. For example, //<server name>/<path name>.

Note: The UNC paths for NFS-mounted folders are not accessible from Windows Explorer on
Windows 2008 R2/2012 R2 (this is a limitation in Windows); they are only accessible via Explorer
using the mounted drive letter for the folder (for example "N:").

• The UNC path defined in the temp_file_path property of the general.properties file. For
example, //<server name>/<path name>).

Domain account for WorldServer

To use the FTS Server, the WorldServer service must run under a user name that has a Windows domain
account and that has the same domain permissions as the user account that is running the FTS Server.

104 Installation and Upgrade Guide

 Installing the File Type Support Server 7

User permissions
The users 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 \\<server name>\<path name> folder
you specified in the FTS Server configuration.
2. Right-click the folder and select Sharing and Security.
The <folder name> Properties dialog box is displayed.
3. Click the Sharing tab.
4. Click Share this folder.
5. Click Permissions.
The Permissions for <folder name> dialog box is displayed.
6. Click Add.
7. In the Select Users, Computers, or Groups dialog box, enter the user names both for
WorldServer and for the FTS Server.
8. Click OK.
9. On the <folder name> Properties dialog box, click the Security tab.
10. Click Add.
11. In the Select Users, Computers, or Groups dialog box, enter the user names both for
WorldServer and for the FTS Server.
12. Click OK and return to the Windows Explorer window.
• Temp file path
In the WorldServer general.properties file, you need to set the value of the temp_file_path
property to a shared location when the FTS Server is installed on a separate machine than World-
Server (recommended installation).
1. From Windows Explorer, navigate to the folder specified as the WorldServer temp_file_path.
2. Follow the steps mentioned earlier for the Sharing and Security tabs of the folder.
The same user names must have permissions for all WorldServer and FTS Server resources.
• AIS mounts
1. From Windows Explorer, navigate to the folder that serves as the AIS mount for both servers.
If you don't know the location of the AIS mount for your WorldServer installation, do the follow-
ing:
a. In WorldServer, go to Management > Asset Interface System > AIS Mounts.
b. Double-click the AIS mount you want to use with the FTS Server.
c. Note the folder path in the File System Connector Configuration area. Use that path to
complete this step.
AIS mounts used with the FTS Server must use UNC pathnames within WorldServer.
2. Follow the steps mentioned earlier for the Sharing and Security tabs of the folder.
The same users must have permissions for all WorldServer and FTS Server resources.

Installation and Upgrade Guide 105

 7 Installing the File Type Support Server

The FTS Server can use more than one AIS mount. Make the changes described earlier for each
mount in your environment.

WorldServer properties
WorldServer uses a configuration entry in the general.properties file to specify the shared FTS
Server directory.
1. Open the general.properties file with a text editor.
2. Search for the ftsserver_shared_directory property.
3. Change its value to the same UNC path you used for the shared folder when installing the FTS
Server.
You can also find this path in the Sdl.WorldServer. FileTypeSupport. Server.HostProcess.
exe.config file of the FTS Server.
4. Open the Log.Launcher.config file with a text editor.
You can find this file in the folder where you installed the FTS Server. For example, C:\Program
Files (x86)\SDL\FileTypeSupportServer.
5. Search for SDLrollingFileAppender and change the value of the File parameter to
<ftsshareddirectory>\ logs\ engine.log, where <ftsshareddirectory> is the UNC path you
used for the shared folder when installing the FTS Server.
For example:

<appender name="SDLrollingFileAppender" type="log4net.Appender.

RollingFileAppender,log4net">
<param name="File" value="C:\Program Files (x86)\SDL
\FileTypeSupportServer\logs\engine.log"/>
<param name="AppendToFile" value="true"/>

Important: WorldServer and the FTS Server must not record information in the same log file.
Make sure that you configure them to use separate log files.

SDL file type setup

Perform the following tasks for the specific SDL file types you plan to use with the FTS Server.
• Set up file type groups for implementing FTS Server file types
WorldServer administrators should consider using file type groups for FTS Server file types. You can
set up a file type group of FTS Server file types and apply that group to a specific set of assets that
use the same MIME type.
• Set up file type configuration settings
You can find information about individual file type settings in the File types topic of the Online Help
or on the WorldServer documentation portal.

106 Installation and Upgrade Guide

 Installing the File Type Support Server 7

FTS Server configurations for Linux

After you install the File Type Support (FTS) Server, you must configure your Linux instance of WorldServer
to communicate with it.

To make WorldServer instances installed on Linux work with the FTS Server, you need to take the
following into consideration:

• Certain configurations require an understanding of Samba or NFS.

• The Samba interoperability suite can be used on 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 Services for NFS, NFS can also be
used to export filesystems to the FTS Server.

When deploying WorldServer and FTS in a mixed Linux/Windows environment using NFS, you must
configure Windows Active Directory with Identity Management for Linux. By doing so, you can map
Windows usernames to Linux usernames.

Filesystem sharing for FTS Server and WorldServer

The FTS Filesystem Options diagram provides a reference for the host names, Samba and Windows
share names, AIS mount names, and user account names used in the FTS and WorldServer configurations.

All exported filesystems must appear to the FTS Server as Windows shares. It is important to remember
the following points:
• The WorldServer user and FTS Server connection user should be the same, to ensure that the same
permissions apply in both cases. In the documentation examples, WorldServer and FTS Server
are running as the worldserver user.
• For the non-Windows filesystem to work as a Windows mount, the filesystem name must match the
machine name.

Installation and Upgrade Guide 107

 7 Installing the File Type Support Server

AIS mount definitions

For each mount in WorldServer used with FTS Server, you must configure the following:
• The AIS mount name
• The folder path must be written as a Windows share name, such as: //solarishost/ mount1

Note: The share name must be defined using forward slashes. Otherwise, Linux will not recognize the
pathname and the creation of the AIS mount will fail.

108 Installation and Upgrade Guide

 Installing the File Type Support Server 7

FTS Server connections using Samba

FTS Server can run with Linux-hosted filesystems that are local or NFS-mounted. FTS Server can also run
with Windows-hosted filesystems mounted on Linux hosts.

Basic Samba configurations

In general, Samba must be configured to:
• Allow filesystem sharing.
• Map the Windows user account under which the FTS Server is running to a local Linux account, so
that FTS can read and write files under the Samba shares.
• Allow guest access to the Samba shares.
You can find the Samba configuration file that supports the previous description at the following
location: /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>) associates incoming Windows
usernames to local Linux user accounts. To allow FTS access to the files in the Samba shares, the FTS
connection must use the same username as the account that WorldServer is running under.

# Unix_name = SMB_name1 SMB_name2 ...

root = administrator admin
worldserver = *

• Windows users administrator and admin are mapped to the local Linux root user.
• Every other Windows user is mapped to the local Linux worldserver user.

Note: In this scenario, the FTS Server Windows user account fts is mapped to the 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 folder on the host Linux system
that is to be accessed by FTS Server. This example shows the following [sharename] sections:

[mount1]
path = /mnt/ftsAisAssetDir
public = yes
browseable = yes

Installation and Upgrade Guide 109

 7 Installing the File Type Support Server

guest ok = yes
guest only = yes
writable = yes

[mount1] Identifies the Samba share that will be visible from a Windows system.
path The actual (local) filesystem folder that contains the assets to be processed.
browseable = yes Allows the share to be seen in a list of available shares.
guest ok = yes Allows connection to the share with no password.
guest account = Specifies the username used for access to the share.
nobody
guest only = yes Allows only guest connections to the share (restricts privileges to the
defined guest account).
writable = yes Allows the creation of files and folders under the share.

Local filesystem configuration

For each Samba share defined on a given host, you must configure the following:
• The asset directory associated with the Samba share. For example: /mnt/ ftsAisAssetDir
• A top-level directory with the same name as the local host name. For example: mkdir /linuxhost
• A soft link to each Samba share exported by the host – within the top-level host-named folder that
points to the physical assets folder. For example: ln -s /mnt/ftsAisAssetDir /linuxhost/
mount1

NFS-mounted filesystem configuration

If WorldServer is running on one host (e.g. linuxhost) that has files mounted on another host (e.g.
secondlinuxhost), FTS Server can process those files with the following configuration:
• The NFS server machine (secondlinuxhost, in this example) must export the filesystem (asset
directory) to be mounted by remote clients:
share –o rw /export/ftsAssets

• The NFS client machine (linuxhost, in this example) must mount the remote filesystem on the NFS
server machine to a local folder. For example:
mount secondlinuxhost:/export/ftsAssets /mnt/ftsAssets

With this configuration, the remote filesystem appears to the local host as a local filesystem. The local
filesystem configuration applies, as above, with the following exceptions:
• A top-level folder with the same name as the remote host name must be created, such as:
mkdir /secondlinuxhost

• A soft link to each Samba share exported by the remote host must be created within this top-level
folder that maps that Samba share to the local NFS mount corresponding to that share, such as:
ln -s /mnt/ftsAssets /secondlinuxhost/mount2

110 Installation and Upgrade Guide

 Installing the File Type Support Server 7

Linux filesystem mounts using Samba

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 the Server Message Block File System (SMBFS) or its newer
replacement, the Common Internet File System (CIFS).

The following configuration is required to mount a remote Windows filesystem on a Linux host:
• A folder must be created to be used as the mount point for the remote Windows share, such as:
mkdir /path/to/winshare

• The remote Windows share must be mounted to this folder, such as:
mount –t cifs –o username=<WinUser>,password=<WinPassword> //winhostfiles/
mount3 /path/to/winshare

• A top-level folder must be created with the same name as the remote Windows machine, such as:
mkdir /winhostfiles

• A soft link to each Windows share exported by the Windows host must be created within this
top-level, host-named folder that points to the CIFS-mounted assets folder, such as:
ln -s /path/to/winshare /winhostfiles/mount3

Configuring NFS AIS mounts for FTS Server on Linux

About this task
You may want to access an NFS AIS mount for FTS Server when your WorldServer instance is running on
Linux. Installed NFS environments are often highly customized, so you may want to use the following
steps as guidelines for your installation. For example, you can use the server names in this example or use
names of your own.

Note: The relationships between the servers must be maintained as shown in the example. The example
generally uses the configuration steps for the Services for Unix (SFU) utility on Windows Server 2012
R2 or 2016.

When deploying WorldServer and FTS in a mixed Linux/Windows environment and using NFS, you
must configure Windows Active Directory with Identity Management for Linux. By doing so, you can
map Windows usernames to Linux usernames.

Procedure
1. Configure the NFS Server (linux-nfs-server1).
a. Create a folder to share: mkdir /export/nfsmnt
This example uses a subfolder under nfsmnt called NFSTesting for WorldServer/FTS resource
files. That subfolder also has an AISmount folder that contains the filesystem AIS assets.
b. Change the ownership of the folder to that of the user ID with which the NFS client will run:

• chown wasadmin:wasadmin /export/nfsmnt

• chmod 755 /export/nfsmnt

c. Check the NFS Server installation: yum list nfs-utils
d. Install NFS Server, if necessary: yum install nfs-utils portmap

Installation and Upgrade Guide 111

 7 Installing the File Type Support Server

e. Edit the /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 service 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, use Windows Services for UNIX
on the FTS Server machine (windows-fts-server2).
a. Install Windows Services for UNIX on your server.
b. Configure user name mapping according to your environment.
c. Validate that the FTS Server machine can now see the folders in Windows Explorer by navigating
to \\linux-nfs-server1.global.sdl.corp\export\nfsmnt.
The FTS Server machine can now see the folders using a UNC-style syntax.
d. With Windows Explorer opened to \\ linux-nfs-server1.global.sdl.corp\ export\
nfsmnt, validate that you can create files and folders on the NFS share from the Windows OS
and that the correct file permissions are applied.
e. Install the SDL File Type Support Server using \\ linux-nfs-server1.global.sdl.corp\
export\ nfsmnt\ ftsShared as the FTS Shared folder.
f. Configure the FTS Server 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= zzInterix
3. Configure NFS mount on WorldServer machine (linux-worldserver-server3)
a. Create a folder on the WorldServer machine that is the FQDN of the NFS Server: mkdir
/mnt/linux-nfs-server1.global.sdl.corp
b. Configure a temporary NFS mount: mount -t nfs linux-nfs-server1: /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-server1:/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/nfsmnt
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

112 Installation and Upgrade Guide

 Installing the File Type Support Server 7

The WorldServer machine can now see the folders using a UNC-style syntax.
4. Install and configure WorldServer (linux-worldserver-server3)
a. Deploy the wa.war, ws-legacy.war and ws-api.war files.
b. Modify the standard variables in the general.properties file (database_username,
database_password, etc).
c. In the general.properties file, 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 variables updated in the general.properties file.
5. Configure your file system AIS mount in WorldServer.
a. Log in to WorldServer as admin .
b. Go 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 the mount.

Upgrading the FTS Server from the installer

The installation procedure for the File Type Support (FTS) server automatically handles version upgrades
as well. The installer removes the existing FTS Server instance before installing the new one.
1. Double-click the File Type Support Server installer and confirm the upgrade by clicking Yes.
2. Go through the screens by clicking Next, and optionally, change any existing configurations.

Note: You must back up the server configuration (.properties) files before the upgrade, so that
you can restore them afterwards. If, for any reason, the installation fails during the upgrade, the
previous installation will be restored.

3. When finished, click Finish.

Note: You can perform upgrades on FTS Server 10.0.0 and newer. FTS Server instances 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.

Installation and Upgrade Guide 113

 7 Installing the File Type Support Server

Mapping language resource templates to

file type configurations
You can use the language resource templates (LRTs) that you create in SDL Trados Studio to define
segmentation rules for WorldServer file type configurations. For example, you might have two configu-
rations for the Rich Text Format File Type (RTFConfig1 and RTFConfig2) and two language resource
templates (LRT1 and LRT2). Thus, you can configure the assets segmented with RTFConfig1 to follow the
segmentation rules from LRT1 (e.g. paragraph segmentation) and the assets segmented with RTFCon-
fig2 to follow the segmentation rules from LRT2 (e.g. sentence segmentation).

About this task

A language resource template defines segmentation rules for any number of source languages. However,
keep in mind that deploying a language resource template may affect the segmentation of all the
projects that have not been segmented yet and that it impacts TM leverage against existing TM resources.
This procedure applies to the first time you add a language resource template to the File Type Support
(FTS) Server. If you replace a mapped language resource template file with a newer version, you need to
restart the FTS Server. The newer file must have the same name as the original file and you must copy
it to the same location (by overwriting the original file). Make sure you back up the original file before
overwriting it.

Important: If your WorldServer environment uses multiple instances of the FTS Server, you need to
synchronize and duplicate the mappings between language resource templates and file type
configurations.

Procedure
1. Create the appropriate language resource templates in SDL Trados Studio and copy them to the
machine where the FTS Server is installed.
2. Stop the FTS Server.
3. Go to the folder where the FTS Server is installed and open the Sdl.WorldServer.
FileTypeSupport. Server.HostProcess. exe.config file with a text editor.
4. Inside the configSections element, make sure that there is a custom section called
languageResourceTemplates.
Example: You can define this section as in the following example:

<configSections>
<sectionGroup name="spring">
<section name="context" type="Spring.Context.Support.ContextHandler
, Spring.Core, Version=1.1.0.2, Culture=neutral,
PublicKeyToken=c28cdb26c445c888"/>
</sectionGroup>
<section name="languageResourceTemplates" type="Sdl.WorldServer.
FileTypeSupport.Server.Util.Configuration.LanguageResourceTemplates,
Sdl.WorldServer.FileTypeSupport.Server.Util" />
</configSections>

5. Optional: In the languageResourceTemplates section, use the defaultLanguageResourceT-

emplate element to specify the location of a default LRT that should be used when a file type does
not have any specific LRTs defined.

114 Installation and Upgrade Guide

 Installing the File Type Support Server 7

Example: For example:

<languageResourceTemplates defaultLanguageResourceTemplate="C:\New
folder\Segmentation Rules\Default_Language_Resource_Template.sdltm.
resource">
</languageResourceTemplates>

6. In the languageResourceTemplates section, under templates, map each LRT to its correspond-
ing file type configuration.
Example: For example:

<languageResourceTemplates defaultLanguageResourceTemplate="C:\New
folder\Segmentation Rules\Default_Language_Resource_Template.sdltm.
resource">
<templates>
<add name="Docx Default segments using * separator" filterIn-
foId="70" languageResourceTemplate="C:\New folder\Segmentation
Rules\TXT_Language_Resource_Template.sdltm.resource" />
<add name="Docx D2 segments using # separator" filterInfoId="70"
filterConfigId="1057" languageResourceTemplate="C:\New folder
\Segmentation Rules\Docx_Language_Resource_Template.sdltm.resource"
/>
<add name="Txt segments using * separator" filterInfoId="43"
filterConfigId="1045" languageResourceTemplate="C:\New folder
\Segmentation Rules\TXT_Language_Resource_Template.sdltm.resource"
/>
</templates>
</languageResourceTemplates>

In this example, each template mapping entry has the following attributes:

Installation and Upgrade Guide 115

 7 Installing the File Type Support Server

Attribute Required or optional Description

name Required A name that describes the
mapping. It must be unique
within the
languageResourceTemplates
section.
filterInfoId Required Distinct numerical identifiers
for each file type configuration.
filterConfigId Optional for default configura- To find out the values of these
tions, required for others attributes:
a. On the WorldServer user
interface, go to
Management >
Linguistic Tool Setup >
File Types.
b. Expand the node of the
appropriate file type.
c. Right-click the name of the
configuration.
d. Copy the address (or the
link) of the configuration.
e. Paste it in a new window
or tab. You can copy the
values of the filterInfoId
and filterConfigId
attributes from the URL that
you paste.

7. Start the FTS Server.

Running the FTS Server

When you install the FTS Server, it automatically launches the SDL File Type Support Server service. This
service restarts the FTS Server after the Windows computer is restarted and requires no special
attention.

Note: In a test environment, the FTS Server can also be run in the system console from 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.

116 Installation and Upgrade Guide

 Installing the File Type Support Server 7

Monitoring FTS processing

On the Assignments > Filter Engine Queue page in WorldServer, you can monitor the status of jobs
assigned to the 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 related to how FTS processing is monitored.
A separate table on the Management > Administration > System Logs page provides a record of FTS
Server activity. Logs default to a maximum of 10MB, at which point they roll over to a new log file.

Installation and Upgrade Guide 117

 7 Installing the File Type Support Server

118 Installation and Upgrade Guide