SDLLiveContentArchitectInstallation Guidesdl.ssl.cdn.sdlmedia.com/file/635418983021087870CW.pdfSoftwarecompatibility Information about third party or client software is packaged, configured

SDL LiveContent Architect InstallationGuide

SDL LiveContent Architect 11.0

July 2014

Legal Notices

Copyright and trademark information relating to this product release.

Copyright © 2011-2014 SDL Group.

SDL Group means SDL PLC. and its subsidiaries. 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/or its subsidiaries 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.

SDL LiveContent is a registered trademark of SDL Group. All other trademarks are the property of their respective owners. The

names of other companies and products mentioned herein may be the trademarks of their respective owners. Unless stated to the

contrary, no association with any other company or product is intended or should be inferred.

This product may include open source or similar third-party software, details of which can be found by clicking the following

link: “Acknowledgments ” on page 165

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.

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 SDL LiveContent Architect Installation Guide

Contents

1 Introduction and Overview ................................................... 1Third party component requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Software and hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Security Token Service Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Installer User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Basic installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Planning for SDL LiveContent Architect installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Installation considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Identifying firewalls and blocked ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Identifying reverse proxies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Platform virtualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Defining the bindings in the target web site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Microsoft Windows Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Microsoft Windows Server 2008R2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Java Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Java Development Kit . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 40

Prerequisites for publishing engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Microsoft Windows 2012R2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Java Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Java Development Kit . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 40

Prerequisites for publishing engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

2 Installing and configuring the database server .......................... 45Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Configuring Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Creating a database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Importing data from the SQL dumpfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Removing the database user and schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Creating a new database user and schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Oracle RDBMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Oracle database configuration requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Editing the tnsnames.ora database connection file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Changing the SQLNET.AUTHENTICATION_SERVICES . . . . . . . . . . . . . . . . . . . . 53

Oracle versions configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Preparing the Oracle 11g environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Creating the Oracle 11g database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Enabling network transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

IIISDL LiveContent Architect Installation Guide

3 Requirements Checklist ..................................................... 61

4 Installing the SDL LiveContent Architect server ......................... 63Configuring database connection strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Creating and testing Oracle RDBMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Creating and testing the connection for Microsoft SQL Server . . . . . . . . . . . . . . . . . 66

Preparing for the server installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Prerequisites for the server installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Enabling https on the IIS website . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

inputparameters.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Executing the InstallTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Enabling network transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

5 Post-installation tasks ....................................................... 81Verifying Microsoft SQL SystemAdministration role permissions . . . . . . . . . . . . . . . . . . 81

Completing the database configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Troubleshooting DatabaseUpgradeTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Adding the relying party entries for webUI and WCF Services . . . . . . . . . . . . . . . . . . . . . . 83

Removing the relying party entries for webUI and WCF Services . . . . . . . . . . . . . . 85

The Administrator setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Completing the Administrator setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Enabling services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Enable Content Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Installing the SDL LiveContent Create license file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Enable the SDL Enrich plugin for SDL LiveContent Create . . . . . . . . . . . . . . . . . . . . . . . . 88

Translation management integration configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Translation services configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Configuring the translation builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Translation Job Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Integration requirements for SDL LiveContent Architect and SDL TMS . . . . . . . . . 99

Integration requirements for SDL LiveContent Architect and SDL

WorldServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Integration requirements for SDL LiveContent Architect and File System . . . . . . 104

Introduction to scalability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

One server for all roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Simple cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Front end server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

How to configure a front end server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Back end server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

How to configure a back end server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Redirecting full text indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Advanced server cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Network load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Best practices to configure a node in network load balancing . . . . . . . . . . . . . . . . . 114

Best practices to specialize back end servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

LiveContent environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

SDL LiveContent Environment with InfoShareSTS . . . . . . . . . . . . . . . . . . . . . . . . . 119

LiveContent Environment with ADFS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Verifying the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

IV SDL LiveContent Architect Installation Guide

Verifying URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Verify read access to the database by viewing an inbox . . . . . . . . . . . . . . . . . . . . . . 124

Verify read and write access to the database by creating a folder . . . . . . . . . . . . . . 125

Creating an account and connecting to the repository . . . . . . . . . . . . . . . . . . . . . . . . 125

Running a client tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Testing publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Executing the full text search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Verifying customer specific components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

6 Reference .................................................................... 129InstallTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

InstallTool overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

The InstallTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Unimplemented features of the InstallTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Database Upgrade Tool (DBUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

DatabaseUpgradeTool (DBUT) overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

The DatabaseUpgradeTool (DBUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Unimplemented features of the DatabaseUpgradeTool . . . . . . . . . . . . . . . . . . . . . . . 132

Background task component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Overview of the background task configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Usage of variables inside the background task configuration . . . . . . . . . . . . . . . . . . 135

Understanding the availability matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Understanding the isolation level of the handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Respository Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Admin.XMLBackgroundTaskConfiguration.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Server roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Web role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Full text indexing role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Default background task role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Translation role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Publish role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Best practices for creating a Trisoft InfoShare BackgroundTask service with a

specific role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

How to create a new BackgroundTask service with a role . . . . . . . . . . . . . . . . . . . . 154

How to adapt the role of an existing BackgroundTask service . . . . . . . . . . . . . . . . . 156

7 Installing desktop clients .................................................. 159Software compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Installing the Authoring Bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Installing Publication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Installing Condition Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Installing SDL DITA2Trisoft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

8 Acknowledgements ........................................................ 165

VSDL LiveContent Architect Installation Guide

VI SDL LiveContent Architect Installation Guide

Chapter 1

Introduction and OverviewThe overall configuration, installation, and SDL LiveContent Architect components for

information contributors, reviewers, and translators of content, who access the repository

through an internal company network, are described in this section.

Third party component requirementsThird party components for the SDL LiveContent Architect application, web, and batch

servers are described.

Software and hardware requirements

Before you install or upgrade the server, you must check the software and hardware

requirements and complete the pre-installation tasks. The pre-installation tasks ensure

you do not encounter issues when installing and configuring the necessary SDL

LiveContent Architect software components.

Before starting an SDL LiveContent Architect installation, check the hardware, basic

operating system setup, and third party software as required and qualified with for version

of SDL LiveContent Architect. Focus on the preparation steps which should be verified

or executed before installing SDL LiveContent Architect.

Hardware

The performance of SDL LiveContent Architect depends primarily on the CPU power

and the I/O characteristics of the hardware. High CPU power is needed to allow the

system to make calculations on-the-fly, for example, for publishing. The I/O

performance largely influences the system’s speed to gather and assemble information

from the database to serve user requests. SDL LiveContent Architect imposes no

specific requirements for data storage, as it holds generic versions that become specific

versions by calculation on a user's request.

Know that the hardware required for a specific SDL LiveContent Architect

implementation depends on the specific requirements and settings of the project (for

example, the number of concurrent users). The exact definition of the hardware

requirements is typically done at the beginning of the project.

1SDL LiveContent Architect Installation Guide

Database

The system requires one of the following. The supported version numbers are noted in

Software compatibility.

■ AUNIX-based SDL LiveContent Architect database server running Oracle.

■ AMicrosoft Windows SDL LiveContent Architect database server running Oracle

or MS SQL Server, Standard or Enterprise edition

Also note the following requirements for the database server:

■ It is important that the system has enough storage available to host your data.

■ To be able to execute database transactions, the Microsoft Distributed Transaction

Coordinator (MSDTC) settings of the database server have to match the ones on

the application server. All servers require a reboot before these settings become

active.

The database server may be on any platform supported by the database vendor. Hardware

and platform requirements for the database server should be obtained from the database

vendor. The specifications supplied by SDL LiveContent Architect should be checked

against the specifications supplied by the database vendor for the current hardware on

which it is installed.

Web and Application layer

Server operating system (OS) supported for this release is noted in Software

compatibility.

The server can be on a single system however for performance reasons, it is advised

to scale and have redundancy over multiple servers. The SDL LiveContent Architect

SystemArchitecture document helps you determine the setup. Due to the many setup

variations, you may want to contact the SDL LiveContent Architect support team to

discuss your specific setup.

The minimum server configuration: A recent quad core system(s) containing 8 GB of

RAM or more. Virtualized environments are supported if they are guaranteed to behave

like a Windows OS installed on a physical machine. If performance is, or becomes

an issue, you are advised to use physical servers.

Storage demands: The consumers of storage are the actual installed SDL LiveContent

Architect software components, the full-text-index collection, exported, and published

content. Considering a normal documentation project, with an initial database

reservation of 100 GB, the server should have at least 50 GB. The typical setup is two

servers, one handling the synchronous operations and one server handling the

asynchronous/background operations. Initially you can start with one server handling

all operations; we suggest a dual CPU server. A second server can be added quite

easily afterwards if load needs to be reduced on the primary server.

Introduction and Overview

2 SDL LiveContent Architect Installation Guide

Software compatibility

Information about third party or client software is packaged, configured and tested for

this software version release.

The following information includes:

■ The Third Party software which is configured or integrated in this release of the

server side components.

■ The Third Party software such as the operating systems, databases, and runtimes

which are quality assurance tested.

Attention:While versions other than those listed may work, know that they are

not quality assured so if a problem is encountered customer support will only

accept the issue if it is reproducible for the listed versions.

■ Client hardware and software compatibility

Restriction: The relation between the SDL LiveContent Architect Authoring Bridge

and the XML editors is not specified below. Installation packages for SDL LiveContent

Architect Authoring Bridge are not always available for all xml editors.

Note: The names, trademarks, designs, logos, service marks, intellectual property, and so

on, of the products shown are exclusive property of their respective owners.

SDLLiveContent Architect and Database Servers

Hardware and operating systems, databases and versions, and other third party

software:

■ Microsoft Windows Server 2008R2 (64-bit)

Note: Is deprecated and will be removed after this release.


■ Oracle RDBMs 11.2

■ Microsoft SQL Server 2008R2 SP1

■ Microsoft SQL Server 2012 SP1

■ Java Runtime 1.7.0_21 (64-bit)

■ Java Development Kit 1.7.0_21 (64-bit)

■ Java Help 2.0.05

■ Microsoft Server .NET Framework 4.5

■ Microsoft .NET Framework Visual C++ Redistributable 2012 (64-bit)

■ DITAOpen Toolkit 1.7.5



■ Microsoft XML Parser 6.0 Service Pack 2


■ HTML Help Workshop 1.3

■ Microsoft Powershell v3.0

Tip:

■ Microsoft Windows 2012R2 has PowerShell v3.0 as a standard feature.

■ Microsoft Windows 2008R2 requires the Windows Management

Framework 3.0 to be installed to havePowerShell v3.0.

Desktop client

Hardware and operating systems:

■ Microsoft Windows 7 (x86)


■ Microsoft Windows 8.1 (x64)

Editor software

Restriction: Only 32-bit mode for the editors is approved and qualified.

■ SDL LiveContent Create

■ JustSystems XMetaL 9.0

■ JustSystems XMetaL 8.0 and 8.0 J(apanese)

■ Syncro Soft <oXygen/> XMLAuthor 16.0


■ PTCArbortext Editor 6.0


■ Adobe FrameMaker 10




Note: Although multiple third-party XML editors are supported in this release of SDL

LiveContent Architect, use of a single third-party editor is recommended. SDL is not

responsible for how the third-party editors handle XML and DITA and the behavior might

differ for each XML editor. As a result, if you use more than one, you may find

cross-compatibility issues with the way the different editors handle DITA. If you decide

to use multiple third-party XML editors and find cross-compatibility issues with DITA,

SDL recommends that you work with the vendor of the XML editor to resolve the issue.

Web Browsers

■ Internet Explorer 11


■ Google Chrome (latest version)

■ Mozilla Firefox (latest version)

Note: The browser must be configured:

■ to allow cookies.

■ to allow pop-up windows for SDL LiveContent Create when the application is

called from the SDL LiveContent Architect web client.

Note: Designed for a minimum resolution of 1024 x 768; optimal resolution is 1280

x 1024 or higher.

Security Token Service Requirements

SDL LiveContent Architect integrates with a Security Token Service to externalize

authentication and to provide the Single Sign On experience among all SDL LiveContent

products.

The Security Token Service must support specific protocols and token formats to allow

the integration.

The following are the protocol requirements for a Security Token Service, categorized

based on Active or Passive profile.

■ Passive profile protocol requirements

■ WS Federation

■ Active profile protocol requirements

■ WS Trust 1.3

■ Part of WS Trust 1.4. Only the part that specifies the ActAs element is

required to support identity delegation

The Security Token Service is also required to generate security tokens using the SAML



1.1 format.

In the following diagram all required connections between clients and for SDL

LiveContent Federated services are shown. Every arrow shows the schema (HTTP or

HTTPS) and the dependent protocol or technology being utilized.

Installer User Requirements

The users who can install SDL LiveContent Architect must have permissions and access

as required.

An administrator user who has authorized access on the machines to be installed can

install the SDL LiveContent Architect software. The user must be able to:

■ logon to the machine and have full access to the file system

■ alter the registry

■ have full access to the Services, Message Queuing, Indexing, Internet Information

Services and Component Services

A database administrator must set up the SDL LiveContent Architect database. The user

must be able to:

■ create a database

■ run scripts to set up the database



Basic installationSDL LiveContent Architect accommodates access for many types of users from inside

and outside the internal network through secure networks, firewalls, DMZ, or VPNs.

Information contributors, people that write, review, or translate content, access the

repository through an internal company network. The database and application servers

are connected to the secure internal network.

Information contributors, located at remote sites, can also access the repository typically

over a virtual private network (VPN).

The diagram below illustrates how information contributors and information consumers

are connected to the system:

Planning for SDL LiveContent Architectinstallation

To ensure a successful installation, whenever you upgrade or install SDL LiveContent

Architect, you should always complete the planning steps before starting the installation.



Installation considerations

Before you install SDL LiveContent Architect, make sure that you have completed the

necessary planning steps.

Consider the following as part of your pre-installation planning process.

■ Does your environment contain firewalls?

■ Are certain ports blocked in your environment?

■ Does your environment include reverse proxy servers? If it does, you need to

verify certain SDL LiveContent Architect URLs after you install SDL LiveContent

Architect.

Identifying firewalls and blocked ports

This topic provides information about identifying firewalls and blocked ports.

Before installing SDLLiveContentArchitect, you need to review the firewalls and blocked

ports in your installation environment. There is a variety of possibilities regarding

network and firewall configurations. Only some of typical firewall configurations are

described. A user knowledgeable about networking can infer the required ports and

protocol settings needed for more complex configurations.

Attention: The following description is intended to guide you in your network and

firewall configuration. Its intention is not to be a complete how-to guide for setting up

firewalls. Several settings are subject to change in newer software versions. Be certain to

refer to the latest reference materials.

Network configuration using a single firewall

The first firewall is located between the Internet and the internal network

This is the first line of protection from the world wide web. All information passed

through the SDL LiveContent Architect web sites or web services are based on the HTTPS

protocol.

The techniques described in the section for HTTPS (SSL) could be required depending

on the task of the SDL LiveContent Architect server.

Network configuration using two firewalls

The first firewall is located between the Internet and the DMZ as described above and the

second is located between the DMZ and the intranet

The second line of protection protects servers which are open to the general public from

the more critical company intranet servers. The zone between the first and second line of

protection is also called the DMZ (DeMilitarized Zone).



The following techniques could be required depending on the task of the SDL LiveContent

Architect server

■ MSDTC - when inter-server database or transactions are required

■ NetBIOS when inter-server communication is required, such as MSDTC

■ SMPT - when SMTP communication is required

■ Database engines

■ Microsoft SQL Server access is required

■ Oracle RDBMs access is required

■ HTTP(S)

MSDTC

The Ports and protocols used by Microsoft Distributed Transaction Coordinator.

The Distributed Transaction Coordinator (MSDTC) service is a component of modern

versions of Microsoft Windows that is responsible for coordinating transactions spanning

across multiple resource managers such as databases, message queues, and file systems.

■ MSDTC is included in Windows 2000 and later operating systems.

■ MSDTC performs the transaction coordination role for components, usually with

COM and .NET architectures.

In MSDTC terminology, the director is called the transaction manager.

MSDTC uses Remote Procedure Call (RPC) dynamic port allocation. By default, RPC

dynamic port allocation randomly selects port numbers above 1024 and port 135 (the RPC

Endpoint Mapper port).

MSDTC relies on NetBIOS. Make sure the NetBIOS ports are open. For further details

about the ports, refer to the NetBIOS section.

Used by:

■ SDL LiveContent Architect End User components

■ SDL LiveContent Architect Author components

■ SDL LiveContent Architect Database

Settings:

1. Create the following registry key to narrow down the port range assigned to RPC

(used by MSDTC). Define this range as necessary. for example: 5000-6000. Note that

you have to open these ports on the firewall as well.

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Rpc\Internet]

"Ports"=hex(7):35,00,30,00,30,00,30,00,2d,00,36,00,30,00,3

0,00,30,00,00,00,00,00

"PortsInternetAvailable"="Y"

"UseInternetPorts"="Y"



You can use a registry editor like Regedit.exe to create the Ports key. Create thekey in the correct registry location, assign it a Multi-String value type, then set it to5000–6000.

Important: After saving the registry edits, you need to restart the server for the

changes to become effective.

2. Match the open ports in your firewall settings

What Protocol Port Direction

Outbound 5000 TCP 5000 IN/OUT




Outbound ... TCP ... IN/OUT




Attention: Information was validated as of the release of this document. However,

third-party sources cannot be fully guaranteed at all times. Check with your SDL

LiveContent Architect customer support representative if you have any questions.

For more information, refer to:

■ “http://support.microsoft.com/kb/250367/EN-US”

■ “http://msdn2.microsoft.com/en-us/library/ms942998.aspx ”

■ “http://en.wikipedia.org/wiki/MSDTC”

NETBIOS

NETBIOS is the Network Basic Input/Output System. It is the ports and protocols used

by all communication between the SDLLiveContentArchitect server and database servers.

The NetBIOS API allows applications on separate computers to communicate over a

local area network. It normally uses TCP/IP (NBT), giving each computer in the network

both a NetBIOS name, and an IP address corresponding to a (possibly different) host

name.

Attention: Ensure that all the members of the Distributed Transaction Coordinator (MS-

DTC) can locate each other using their NETBIOS names.

Used by:



HTTP://SUPPORT.MICROSOFT.COM/KB/250367/EN-US

http://msdn.microsoft.com/en-us/library/ms942998(v=CS.70).aspx

http://en.wikipedia.org/wiki/MSDTC

■ All SDL LiveContent Architect components

Settings:


NetBIOS Session

Service

TCP 139 IN/OUT

NetBIOS Name

Service

UDP 137 IN/OUT

NetBIOS Datagram

Service

UDP 138 IN/OUT

SMB over TCP TCP 445 IN/OUT

If the NETBIOS name cannot be resolved to an IP address because there is no DNS

server in the network segment, add the IP NETBIOS name entry to the %WINDIR%\

system32\drivers\etc\hostsfile.

Note: If, for example, you have a server cluster, all servers must be able to ping the Virtual Name of the cluster, the physical node names, and the internal cluster name.

SMTP

Ports and protocols used by the Simple Mail Transfer Protocol (SMTP).

Simple Mail Transfer Protocol (SMTP) is the standard for e-mail transmissions across the

internet. Formally SMTP is defined in RFC 821 (STD 10) as amended by RFC 1123

(STD 3) chapter 5. The protocol used today is also known as ESMTP, and it is defined in

RFC 2821.

Used by:

■ SDL LiveContent Architect Publishing components


Settings:


SMTP TCP 25 IN/OUT


■ “http://msdn2.microsoft.com/en-us/library/ms942998.aspx”

■ “http://en.wikipedia.org/wiki/SMTP”

Microsoft SQL Server

Ports and protocols used by Microsoft SQL Server database engine (SQLServer).



http://msdn.microsoft.com/en-us/library/ms942998(v=cs.70).aspx

http://en.wikipedia.org/wiki/SMTP

Microsoft SQL Server is a relational database management system (RDBMS) produced

by Microsoft. Its primary query language is Transact-SQL, an implementation of the

ANSI/ISO standard Structured Query Language (SQL) which is used by Microsoft.

Used by:




Settings:


SQLServer TCP 1433 IN/OUT

Microsoft SQL Server by default uses TCP 1433 but this can be changed using SQLServer

Enterprise manager or the Database Management Studio. SDL LiveContent Architect

uses MSDTC for transaction actions (insert, update, delete) so NetBIOS and MSDTC

firewall settings also apply.


■ “http://support.microsoft.com/kb/287932”

■ “http://msdn.microsoft.com/en-us/library/ms942998.aspx”

■ “http://en.wikipedia.org/wiki/Microsoft_SQL_Server”

Oracle RDBMS

Ports and protocols used by the Oracle RDBMS.

Oracle Database, Oracle RDBMS, or simply Oracle is a relational database management

system (RDBMS) software product released by Oracle Corporation that has become a

major feature of database computing.

Used by:




Oracle Services for Microsoft Transaction Server settings



HTTP://SUPPORT.MICROSOFT.COM/KB/287932

http://msdn.microsoft.com/en-us/library/ms942998.aspx

http://en.wikipedia.org/wiki/Microsoft_SQL_Server

Extra installation of Oracle Data Access Components on the Web and Application server,

more specifically Oracle Services For Microsoft Transaction Server, Oracle Data

Provider for .NET and Oracle Provider for OLE DB, are required. To ensure that Windows

uses the correct transaction libraries you must change HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSDTC\MTxOCI entriesOracleOciLib,OracleSqlLib andOracleXaLib (information about this is provided in the installation procedures).

The Oracle MTS Recovery Service is automatically installed with Oracle Services for

Microsoft Transaction Server. The Oracle MTS Recovery Service accepts requests to

resolve in-doubt MS DTC-coordinated transactions started on this computer. The port

number on which the Oracle MTS Recovery Service listens for requests on this computer

is configured during installation of the Oracle client (default port 49152).


Listener

(runs on the

database server)

TCP 1521 (default) IN/OUT

OraMTS TCP 49152 (default) IN/OUT


■ “http://en.wikipedia.org/wiki/Oracle_Database”

■ “http://download.oracle.com/docs/cd/B28359_01/win.111/b32010/config.htm#BHCFFHBI”

HTTPS (SSL)

Ports and protocols used by Microsoft Internet Information Server (IIS).

HTTPS is a URI scheme used to indicate a secure HTTP connection. It is syntactically

identical to the http:// scheme normally used for accessing resources using HTTP. Thehttps: URL indicates that HTTP is to be used but with a different default TCP port(443) and an additional encryption/authentication layer between the HTTP and TCP.

HTTPS is not a separate protocol, but refers to the combination of a normal HTTP

interaction over an encrypted Secure Sockets Layer (SSL). An https: URLmay specifya TCP port; if it does not, the connection uses port 443.

Used by:

■ SDL LiveContent Architect End User Website

■ SDL LiveContent Architect Author Website

■ SDL LiveContent Architect WebServices

Settings:


HTTPS TCP 443 IN/OUT



HTTP://EN.WIKIPEDIA.ORG/WIKI/ORACLE_DATABASE

HTTP://DOWNLOAD.ORACLE.COM/DOCS/CD/B28359_01/WIN.111/B32010/CONFIG.HTM#BHCFFHBI




■ “http://en.wikipedia.org/wiki/Https”

Identifying reverse proxies

Various reverse proxy servers can be used in combination with SDLLiveContentArchitect.

Using reverse proxy servers may result in connection problems to the SDL LiveContent

Architect repository. You can check the BASEURL to verify that it is not causing a problem

in Internet Explorer.

When you identify reverse proxy servers, verify that the following URLs do not cause

any problems in Internet Explorer:

■ BASEURL/InfoShareWS/Application.asmx?wsdl

■ BASEURL/InfoShareWS/Application.asmx?disco

The BASEURL is specified in the inputparameters. xml file used by the SDL

LiveContent Architect installer. This can be either:

■ A simple URL, such as http://VM14/;

■ A full DNS name indicating SSL usage, such as

https://techdoc.world.sld.corp.

For example:

<param name="baseurl">

<currentvalue> https://techdoc.world.sld.corp</currentvalue>

<defaultvalue>http://VM14</defaultvalue>

<validate/>

</param>

Be certain that the URLs are accessible by your users. If you are using HTTPS for the

external URL, the URLs listed above must also have an https BASEURL.

Tip: Security certificates add an extra dimension to your setup. You should first test the

reverse proxy without SLL (HTTPS).



HTTP://MSDN2.MICROSOFT.COM/EN-US/LIBRARY/MS942998.ASPX

HTTP://MSDN2.MICROSOFT.COM/EN-US/LIBRARY/MS942998.ASPX

HTTP://EN.WIKIPEDIA.ORG/WIKI/HTTPS

Platform virtualization

You can deploy SDL LiveContent Architect software in a virtual environment (such as

VMWare ESX).

You can deploy SDL LiveContent Architect software in a virtual environment if both of

the following conditions are true:

1. SDL LiveContent Architect supports the environment in its non-virtual form.

2. The platform vendor states that it supports the virtual form of this environment.

Note: If you run a software component in a virtual environment, the hardware

recommendations listed for that software component in the Product Prerequisites

document may not apply. The recommendations listed apply to the software component if

it is installed directly on such a hardware profile, and not to the software component

installed in a virtual environment that itself runs on the recommended hardware profile.

For specific virtual platform support requests, contact the platform vendor. For specific

hardware recommendations, contact your virtual hardware solution vendor to find out how

the hardware recommendation for a direct installation translates into a hardware

recommendation for a virtual installation.

Defining the bindings in the target web site

When using multiple websites IIS, the administrator of IIS should explicitly define the

bindings in the target web site to ensure that the installation serves the requests that target

it.

When an IIS has multiple websites it is not clear which website should serve the incoming

request which can make the SDL LiveContent Architect installation unstable. On a IIS

server with multiple web sites, there has to be mechanism that guides IIS to the correct web

site. That mechanism is known as binding configuration. The binding works as a key in

a Dictionary of WebSites. So simply, IIS analyzes the request, figures out the key and then

goes to the dictionary to find the proper WebSite.

Note: Productions systems should always define the bindings on the web site even if

the website is unique on the IIS. When the bindings are explicitly defined on the web site,

the web site is protected against any other request that was not indented to be served.

This is another layer of protection for the web site.

Assume the following values for SDL LiveContent Architect's baseurl and localservice-

hostname; that is, all requests that have the following host names that must be served

by this web site:

■ localhostname: devserver01

■ hostname: devserver01.global.sdl.corp



In addition to the host names, the web site must be able to serve the following schemas

for both host names:

■ http-hostname

■ https-hostname

■ http-localhostname

■ https-localhostname

Example of end points that the web site (IIS) is to serve:

■ http://devserver01/InfoShareWS/WCF/API/Application.svc

■ https://devserver01/InfoShareWS/WCF/API/Application.

svc

■ http://devserver01.global.sdl.corp/InfoShareWS/WCF/

API/Application.svc

■ https://devserver01.global.sdl.corp/InfoShareWS/WCF/

API/Application.svc

■ https://devserver01.global.sdl.corp/InfoShareAuthor/

Based on the above examples, to described the possible schema/hostname combinations

for SDL LiveContent Architect, the IIS administrator needs to explicitly define bindings

for the following combinations:

■ http

Example:devserver01.global.sdl.corp

■ http

Example: devserver01

■ https

Example:devserver01.global.sdl.corp

■ https

Example: devserver01

Configuring the http bindings can be done from the user interface.

Configuring the https bindings must be done by executing a command, such as:

%systemroot%\system32\inetsrv\APPCMD set site [WebSiteName]/bi

ndings:https/*:443:[hostname]

Where you must replace the references to [WebSiteName] and [hostname]appropriately for your configuration and site. There are alternatives that are documentedin the help of the commands.

Note: This is an IIS7 command which is not confirmed to be used with IIS6 or IIS8.



Attention:

The require SSL on IIS forbids any request with the http schema. Based on the above, it

is implicitly required that the website cannot have the RequireSSL set to true in the SSL

Settings.

The same requirement for RequireSSL on SSL Settings is applied for the infosharews-

webappname defined in the input parameters.

For more information about adding a binding to a site, refer to:

■ “http://www.iis.net/configreference/system.applicationhost/sites/site/bindings/binding”

■ “http://technet.microsoft.com/en-us/library/cc731692(v=ws.10).aspx”

Microsoft Windows ServerAdditional installation and configuration requisites are described for the SDL LiveContent

Architect product installation for the current supported versions of Microsoft Windows.

The SDL LiveContent Architect software must be installed on a Microsoft Windows 2008

R2 Server (64-bit) or Windows 2012 Server R2 (64-bit).

Note: Some components might already been installed by other software, the list specifies

on which items our software relies.

Microsoft Windows Server 2008R2

Follow these procedures if you are installing on a Microsoft Windows Server 2008R2.

If installing on a Windows Server 2012R2, skip this section and follow the procedures for

Microsoft Windows Server 2012R2.



http://www.iis.net/configreference/system.applicationhost/sites/site/bindings/binding

http://technet.microsoft.com/en-us/library/cc731692(v=ws.10).aspx

Note: SDL LiveContent Architect is qualified on an English version of our supported

operating systems only. Other languages of these operational systems are not used for

quality check purposes.

Setting the MSDTC timeout on Microsoft Windows 2008 R2Server

The default timeout for the Microsoft Distributed Transaction Coordinator is 60 seconds.

The transaction timeout should be set to a higher value, for example 3600 seconds.

About this task

Note: This must be done on the database server, and all SDL LiveContent Architect

servers.

Procedure

1. Go to Start > Administrative Tools > Component Services.

2. Double-click on Computers in the middle pane.

3. Right-click onMy Computer in the middle pane then select Properties.

4. Click the Options tab and set the Transaction timeout to a higher value such as

3600 seconds.

5. Click OK.

6. Go to Start > Administrative Tools > Services.

7. Restart the Distributed Transaction Coordinator Service

To execute database transactions, the Microsoft Distributed Transaction Coordinator

(MSDTC) settings of the database server have to match the ones on the application

server. All servers require a reboot before these settings become active.

Establishing a dedicated system user with formattinginformation on Microsoft Windows 2008R2

The SDL LiveContent Architect components need a dedicated OS local administrator per

server to host all components. Specifying the Region and Language settings.



Before you begin

It is expected that a designated operating system user will run all SDL LiveContent Architect related

components. This separate user allows you to change user settings with little interference with the rest of the

system.

Note: A designated operating system user is also known as a Service Account, typically

named InfoShare.

About this task

AWindows Domain user is required when using Microsoft ADFS as STS. Ask your

Active Directory system administrator to create a service account.

Procedure

1. Create the local or domain InfoShare system user:

Note: If you have to configure multiple servers, we advise to create a domain user

and make the user a local Administrator on each of the target machines as noted here.

a. Click Start > Administrative Tools > Server Manager

b. Open Configuration > Local Users and Groups, then select Users.

c. Open the Action menu and select New user.

d. Enter InfoShare as the User name.

e. Enter a Full name and Description.

f. Enter a Password. Enter the password again in the Confirm password field.

g. Select User cannot change password and Password never expires.

h. Click Create.

i. Open Configuration > Local Users and Groups then select Groups.

j. Open the local Administrators group of the machine and add the InfoSharesystem user.

Attention: This is necessary because Microsoft requires some registry keys

to be write-enabled for transactions and more. The services, Message Queues,

IIS Application Pools and Component Services Server Applications all run

within this user's context.

2. Allow the InfoShare user to run services. If not done, it can cause service startup failures.

a. As an administrator user, open Start > Administrative Tools > Local

Security Policy on your server.

b. Open Local Policies then click User Rights Assignment.

c. Select Log on as a service click Add User or Group and add the InfoShare

user created above.



d. Click OK to activate the settings.

e. Open the File menu and select Exit to close the window.

3. Set the Regional and Language of the InfoShare system user on each applicationserver:

a. Login on your system as the InfoShare user to validate the user account.

b. Click Control Panel > Clock, Language and Region.

c. Click Region and Language.

d. Click the Formats tab, for the Format field, select the entry English(United States).

Attention: To allow various code stacks like .NET, VB6, Java, etc to work

flawlessly together we strongly advise to pick a Western language entry here.

e. Set the following Date and time formatsusing Additional Settings > Time

and Additional Settings > Date. Afterwards, clickOK to activate the settings.

■ Short date: dd/MM/yyyy

■ Long date: ddddd d MMMM yyyy

■ Short time: HH:mm:ss

■ Long time: HH:mm:ss

Note: The date and time format must be set as described below. It can be

that you have to type in the specified format:

f. Click the Location tab, for the Current location field, select the entry United

States.

Note: Although optional, we saw cases on some Windows builds where a

non-Western entry was selected.

g. Click OK.

4. Set the Regional and Language of the System on each application server:

a. As an administrator user, click Control Panel > Clock, Language and

Region.

b. Click Region and Language.

c. Click the Administrative tab and select Change system locale.

d. Select English (United States).





Microsoft considers VB6 and several scripting languages non-Unicode

programs.

e. Click OK.

Changing the Local Group Policy on Windows 2008

Set the group policy so that Windows 2008 does not forcefully unload the registry.

About this task

A new User Profile Service functionality built into the OS by default forces the unload of

the user profile on Windows 2008 when the user logs off. This results in, for instance, a

COM+ application to stop working on Windows Server 2008 when the identity user logs

off and the COM+ application can no longer read registry keys in the profile of the identity

user. The policy setting Do not forcefully unload the user registry at user logoff

counters the default behavior of Windows 2008. When enabled, Windows 2008 does not

forcefully unload the registry and waits until no other processes are using the user registry

before it unloads it.

Procedure

1. As an Administrator user, click Start then in the Run field type gpedit.msc.

Result: A Local Group Policy Editor window displays.

2. Click Local Computer Policy > Computer Configuration > Administrative

Templates > System > User Profiles

3. In the right pane, double-click on Do not forcefully unload the user registry at user

logoff.

4. In the resulting window, click in the radio button Enabled.

5. Click OK.

Oracle Data Access Components 11.2.0.4 32-bit

This is required if you use Oracle RDBMs to host your database.

About this task

The Oracle Data Access Components 11.2.0.4 or ODAC – 32 bit is required if you use

Oracle RDBMs to host your database. It must be installed as the Administrator user. More

information can be found in the Oracle documentation.

The version tested with this version of SDL LiveContent Architect can be retrieved upon

request at SDL. The necessary files are part of the Oracle Database 11g Release 2 Client

(11.2.0.4.0) for Microsoft Windows (32-bit).



The package provides three parts:

■ Oracle Provider for OLE DB

■ Oracle Data Provider for .NET

■ Oracle Services for Microsoft Transaction Server

Procedure

1. In the Select Installation Type window, click Custom.

Note: The Select Installation Type window is displayed after the Welcome screen

when you launch the Oracle installation.

2. Click Next.

Result: Select Product Languages window displays.

Preferably leave only English as selected Product Languages.

3. Click Next.

Result: Specify Installation Location window displays.

4. Enter the following in the fields as note.

■ Oracle Base: C:\Oracle

■ SoftwareLocation:C:\Oracle\product\11.2.0\client_1

5. Click Next.

Result: The Available Products Components window displays.

6. Select:

■ Oracle Net




7. Click Next.

8. Accept the suggested port number by clicking Next.

Make certain that your fire wall settings match this.

9. Addan entry in theC:\Oracle\product\11.2.0\client_1\network\

admin\ tnsnames.ora file that identifies the location of the Oracle database.

If you do not know how to add entries to this file, contact your Oracle database

administrator.

Configuring .NET Framework For Windows 2008

It is required that the .NET Framework is installed.



Before you begin

This is an optional component during a Windows installation, and is not installed by default during operating

system setup.

Procedure

1. Click Start > Control Panel > Programs > Programs and Features then on the left

side of the window, select Turn windows features on or off.

2. In the (left side) Server Manager pane, click Features.

3. Click Add Features in the right pane.

Result: A Select Features window is displayed.

4. Open the .NET Framework <version> Features tree node and select the .NET

Framework <version> option.

If the feature(s) are greyed and already installed (the Next button is not available)

skip the next steps and instead, click Cancel.

5. Click Next.

6. Click Install.

Configuring HTTP Activation for WCF on Windows 2008

Windows Communication Foundation (WCF) uses the listener adapter interface to

communicate activation requests that are received over the non-HTTP protocols supported

by WCF To allow this, configure HTTPActivation.

Procedure



2. In the (left side) Server Manager pane, click Features.

3. Click Add Features in the right pane.

Result: A Select Features window is displayed.

4. Open the .NET Framework <version> Features tree node then open WCF

Activation.

5. Select HTTPActivation.

6. Click Next.

7. Click Install.

Configuring IIS and ASP Web services on Windows 2008 R2 SP2

It is required that the Web Services (IIS, ASP) be installed.



Before you begin


system setup.

Procedure



2. In the (left side) Server Manager pane, click Roles.

3. Click Add Roles (upper right).

Result:

If prompted with Before You Begin, click Next.

A Select Server Roles window is displayed.

4. In the Select Server Roles window, check the box for theWeb Server (IIS) role.

5. Click Next.

6. Under Role Services in the right pane, click Add Role Service.

7. Under Common HTTP features select:

■ Static Content

■ Default Document

■ Directory Browsing

■ HTTP Errors

8. Under Application Development select:

■ ASP .NET

■ .NET Extensibility

■ ASP

■ ISAPI Extensions

■ ISAPI Filters

9. To speed up file transfer over the network, we advice to enable compression. Under

Performance select Static Content Compression and Dynamic Content

Compression.

10. Under Health and Diagnostics select:

■ HTTP Logging

■ Request Monitor

11. UnderManagement Tools select:

■ IIS Management Console

12. Click Next.

13. Click Install.



Configuring Application Server Role

The Application Server Role is required to be installed.

Before you begin


system setup.

Procedure



2. In the Server Manager window, right-click Roles then click Add Roles.

Result:

If prompted with Before You Begin, click Next.

An Add Roles Wizard window is displayed.

3. Select Server Roles in the left pane.

Result: The Select Server Roles window is displayed.

If the feature(s) are greyed and already installed (the Next button is not available)

skip the remaining steps and instead, click Cancel.

4. Select the Application Server role.

5. Select Role Services under Application Server in the left pane.

6. Open the Distributed Transactions tree.

7. Select the Incoming Remote Transactions and Outgoing Remote Transactions.

8. Click Next.

9. Click Install.

Microsoft XML Parser

Only required for SDL LiveContent Architect publishing engine.

About this task

Qualified version(s): Microsoft XML Parser 6.0 Service Pack 2 and Microsoft XML

Parser 4.0 Service Pack 3.

You need to install these components if you use the SDL LiveContent Architect Publishing

engine. Both the 32-Bit and 64-Bit version of Microsoft XML Parser must be installed.

Note: Both versions of Microsoft XML Parser 6.0 Service Pack 2 may already be

installed. To check, verify the existence of the file msxml6.dll in these folders:

■ C:\windows\system32

■ C:\Windows\syswow64

Be sure that Microsoft XML Parser 4.0 Service Pack 3 is also installed.



The MS XML software tested with this version of SDL LiveContent Architect can be

retrieved online from SDL upon request.

Related information

■ “Software compatibility” on page 3

Java

The JRE and JDK tested with this version of SDL LiveContent Architect can be retrieved

online from SDL LiveContent Architect upon request.

The Java version specified below is for the SDL LiveContent Architect packaged

DITA-OT as noted for this version of SDL LiveContent Architect.

With SDL LiveContent

Architect version:JRE/JDK version and

bitness

Used by:

11.0.0 Java Development Kit

1.7.0_21 (64-bit)

Publishing engine: DITA

Open Toolkit 1.7.5

Java Runtime 1.7.0_21

(64-bit)

Search engine:

TrisoftSolrLucene.exe

Java Runtime Environment

The 64-bit version of the Java Runtime Environment 1.7.0_21 (64-bit) must be installed.

Important: If you install JDK 64 bit, by default the 64 bit JRE is installed.

Java files tested with this version of SDL LiveContent Architect can be retrieved online

from SDL upon request.

Related information


Java Development Kit

Only required for the SDL LiveContent Architect Publishing engine.

Qualified version(s): Java Development Kit 1.7.0_21 (64-bit)

The 64-Bit version of the Java Development Kit must be installed.

When you install JDK you only need the Development Tools. (Source Code and Public

JRE is not required.)



Related information




Microsoft .NET Framework Visual C++ Redistributable

It is required that the Microsoft .NET Framework Visual C++ Redistributable be installed

About this task

Qualified version(s): Microsoft .NET Framework Visual C++ Redistributable 2012 (x64)

Only the 64-bit version of Microsoft .NET framework Visual C++ Redistributable must

be installed for this version of SDL LiveContent Architect.

The software (versions) tested with this release of SDL LiveContent Architect can be


Related information


Microsoft Windows Management Framework 3.0 (PowerShell)

It is required that PowerShell v3 is installed.

By installing the Windows Management Framework 64-Bit edition, you will get the

powershell 32 and 64-Bit version of this executable.

The file tested with this version of SDL LiveContent Architect can be retrieved online


Microsoft Server .NET Framework

It is required that the Microsoft .NET Framework be installed.

Qualified version(s): Microsoft Server .NET Framework 4.5

If the component is not installed, InstallTool errors with a notice such as:

RegAsm.exe - .NET Framework Initialization Error

The NET Framework tested with this version of SDL LiveContent Architect can be


Related information


Configuration requirements

After installation, some components need to be configured to conform to SDLLiveContent

Architect requirements.

It is expected that a designated operating system user will run all SDL LiveContent

Architect related components.



Note: A designated operating system user is also known as a Service Account.

It is recommended that you do a system reboot to ensure that all installed components

finish their installation.

Prerequisites for publishing engine

These software packages are required on the server that handles SDL LiveContent

Architect publishing.

Java Help 2.0.05

Only required if you use the SDL LiveContent Architect Publishing engine to generate

Java Help files.

The suggested installation path is C:\JavaHelp which results in the availability of the

following:C:\JavaHelp\jh2.0\src.jarSDLLiveContentArchitect InstallTool

input parameters allow you to indicate the path before installation using variable

ps_javahelp_home.

The javahelp-2_0_05. zip file tested with this version of SDL LiveContent Architect can

be retrieved online from SDL upon request.

Related information


HTML Help Workshop 1.3


On a 64-bit operating system the default installation path is C:\Program Files

(x86)\HTML Help Workshop

The htmlhelp.exe file tested with this version of SDL LiveContent Architect can be


Related information


Antenna House XSL Formatter

Required if you use the SDL LiveContent Architect Publishing engine and the Antenna

House XSL Formatter software by Antenna House to render your output.

To allow the proper rendering of non-Western language such as Thai or the East Asian

languages, you must have the specialized fonts available. SDL LiveContent Architect

expects that all available complex script, right-to-left and East Asian language support are

available.

The file tested with this version of SDL LiveContent Architect was Antenna House XSL

Formatter 6.0 and can be retrieved online from SDL upon request.



Note: You may use a later version of Antenna House XSL Formatter; check with your

SDL customer support representative if you have any questions.

Configuring IIS applicationHost.Config

This part describes which actions should be taken to change the applicationHost.Config

to allow the definition of website specific settings in the web.config of the SDL

LiveContent Architect websites and to set the necessary mimetype definitions for

compression.

Before you begin

The steps for configuring IIS and ASPWeb services must have been executed, especially the static and

dynamic compression feature for IIS needs to be installed

About this task

TheApplicationHost.config file can be found in the folder %WINDIR%\ system32\

inetsrv\ config. It is the root file of the configuration system when you are using IIS

7 and above. It includes definitions of all sites, applications, virtual directories and

application pools, as well as global defaults for the web server settings. It has definitions

for locking-down most IIS sections to the global level, so that by default they cannot be

overridden by lower-level web.config files in the hierarchy. To make configuration

easier, we will unlock some of these global level settings, so we can define these settings

in the web.config of the SDL LiveContent Architect websites.

Procedure

1. Make the necessary changes to allow the definition of website specific settings in the

web.config of the website

a. Start cmd.exe as Administrator

b. Execute the following statements in the cmd window

%windir%\system32\inetsrv\appcmd unlock config

/section:system.webServer/asp /commit:apphost


/section:system.webServer/serverRuntime /commit:apph

ost


/section:system.webServer/defaultDocument /commit:apph

ost


/section:system.webServer/staticContent /commit:apph

ost


/section:system.webServer/directoryBrowse /commit:apph

ost


/section:system.webServer/handlers /commit:apphost




/section:system.webServer/urlCompression /commit:apph

ost

2. Set the necessary mimetype definitions for static compression

a. Start PowerShell as Administrator

b. Execute the following statements in the PowerShell window

Set-ExecutionPolicy Unrestricted -Force

Import-Module WebAdministration

# Define the mimetypes for IIS that can be statically

compressed

$staticcompression = @(

@{mimeType=’text/*’; enabled=’True’},

@{mimeType=’message/*’; enabled=’True’},

@{mimeType=’application/x-javascript’; enabled=’Tru

e’},

@{mimeType=’application/atom+xml’; enabled=’True

’},

@{mimeType=’application/xaml+xml’; enabled=’True

’},

@{mimeType=’application/octet-stream’; enabled=’True

’},

@{mimeType=’*/*’; enabled=’False’}

)

# Set the specified static mimetypes in the compress

ion settings

# in applicationHost.config

$filter = ’system.webServer/httpCompression/statictyp

es’

Set-Webconfiguration -Filter $filter -Value $staticcom

pression

c. Close PowerShell

3. Set the necessary mimetype definitions for dynamic compression





# Define the mimetypes for IIS that can be dynamically

compressed

$dynamiccompression = @(




e’},

@{mimeType=’application/soap+xml’; enabled=’True



’},

@{mimeType=’application/xml’; enabled=’True’},

@{mimeType=’application/json’; enabled=’True’},


’},


)

# Set the specified dynamic mimetypes in the compress

ion settings


$filter = ’system.webServer/httpCompression/dynamictyp

es’

Set-Webconfiguration -Filter $filter -Value $dynamicco

mpression

# Note that compression can be set per web.config file

c. Close PowerShell

Microsoft Windows 2012R2

Follow these procedures if you are installing on a Microsoft Windows Server 2012R2.

If installing on a Windows Server 2008R2, skip this section and follow the procedures for

Microsoft Windows Server 2008R2.

Note: SDL LiveContent Architect is qualified on an English version of our supported

operating systems only. Other languages of these operational systems are not used for

quality check purposes.

Setting the MSDTC timeout

The default timeout for the Microsoft Distributed Transaction Coordinator is 60 seconds.

The transaction timeout should be set to a higher value, for example 3600 seconds.

About this task

Note: This must be done on the database server, and all SDL LiveContent Architect

servers.

Procedure

1. Click Server Manager in the lower left corner.

2. Click Tools > Component Services in the upper right corner.

Result: The Component Services window is displayed.

3. Double-click on Computers in the middle pane.

4. Right-click onMy Computer in the middle pane then select Properties.



5. Click the Options tab and set the Transaction timeout to a higher value such as

3600 seconds.

6. Click OK.

7. Click Services in the (same) Component Services window.

8. Restart the Distributed Transaction Coordinator Service

To execute database transactions, the Microsoft Distributed Transaction Coordinator

(MSDTC) settings of the database server have to match the ones on the application

server. All servers require a reboot before these settings become active.

Establishing a dedicated system user

The SDL LiveContent Architect components need a dedicated OS local administrator per

server to host all components. Specifying the Region and Language settings.

Before you begin

It is expected that a designated operating system user will run all SDL LiveContent Architect related

components. This separate user allows you to change user settings with little interference with the rest of the

system.

Note: A designated operating system user is also known as a Service Account, typically

named InfoShare.

About this task

AWindows Domain user is required when using Microsoft ADFS as STS. Ask your

Active Directory system administrator to create a service account.

Procedure

1. Create the local or domain InfoShare system user:

Note: If you have to configure multiple servers, we advise to create a domain user

and make the user a local Administrator on each of the target machines as noted here.

a. Click Server Manager in the lower left corner.

b. Click Tools > Computer Management.

c. Open Computer Management > System Tools > Local Users and Groups

then select Users.

d. Open the Action menu and select New user.

e. Enter InfoShare as the User name.

f. Enter a Full name and Description.

g. Enter a Password. Enter the password again in the Confirm password field.

h. Clear User must change password at next logon then select User cannot

change password and Password never expires.

i. Click Create.



j. Click Close.

k. Under the Local Users and Groups, select Groups.

l. Open (double-click on) the local Administrators group of the machine and

add the InfoShare system user.

m. Click Apply.

Attention: This is necessary because Microsoft requires some registry keys

to be write-enabled for transactions and more. The services, Message Queues,

IIS Application Pools and Component Services Server Applications all run

within this user's context.

2. Allow the InfoShare user to run services. If not done, it can cause service startup failures.

a. As an administrator user, open Server Manager then click Tools > Local

Security Policy on your server.

b. Open Local Policies then click User Rights Assignment.

c. Open (double-click on) Log on as a service then click Add User or Group

and add the InfoShare user created above.

d. Click OK to activate the settings.

e. Open the File menu and select Exit to close the window.

3. Set the Language of the InfoShare system user on each application server:

a. Login on your system as the InfoShare user to validate the user account.

b. Click Control Panel > Clock, Language and Region.

c. Click Clock, Language and Region.

d. Click Language.

e. Make certain that English (United States) is the language listed.

■ If English (United States) is not listed, click Add a language,

select English, click Open, select English (United States), then

clickAdd.

■ If English (United States) is among other languages listed and

it does not appear first, select it then clickMove up until it appears

first.



f. Set the following Date and time formats. Click Change date, time, or

number formats on the left, in the same window as above.

g. Change format to English (United States)



h. Click Advanced Settings... button. Go to Date tab and click Apply after you

made the changes listed are made.

■ Short date: dd/MM/yyyy

■ Long date: ddddd d MMMM yyyy

Attention: The date format must be set as described below. It can be that

you have to type in the specified format.

i. Next, go to Time tab and click OKafter you made the changes listed are

made.

■ Short time: HH:mm:ss

■ Long time: HH:mm:ss

Attention: The time format must be set as described below. It can be that

you have to type in the specified format.

j. Click the Location tab, for theCurrent location field, select the entry UnitedStates.

k. Click OK.

4. Set the Region of the System on each application server:

a. If the language window from the last step is still displayed, click the back

arrow (upper left) then click Region - or - you can go back to the Control

Panel Home then click Clock, Language and Region > Region.

b. Click the Administrative tab and select Change system locale....

c. Select English (United States)



Microsoft considers VB6 and several scripting languages non-Unicode

programs.

d. Click OK.



Attention: A restart of the server is required.

Changing the Local Group Policy

Set the group policy so that Windows 2012R2 does not forcefully unload the registry.

About this task

A new User Profile Service functionality built into the OS by default forces the unload of

the user profile on Windows 2012R2 when the user logs off. This results in, for instance,

a COM+ application to stop working on Windows Server 2012R2 when the identity user

logs off and the COM+ application can no longer read registry keys in the profile of the

identity user. The policy setting Do not forcefully unload the user registry at user

logoff counters the default behavior of Windows 2012R2. When enabled, Windows

2012R2 does not forcefully unload the registry and waits until no other processes are

using the user registry before it unloads it.

Procedure

1. As an Administrator user, click the then in the Windows Powershell icon in the lower

left next to the Server Manager icon.

2. At the command prompt, type gpedit.msc.

Result: A Local Group Policy Editor window displays.

3. In the left pane, open Local Computer Policy > Computer Configuration

> Administrative Templates > System > User Profiles

4. In the right pane, double-click on Do not forcefully unload the user registry at user

logoff.

5. In the resulting window, click in the radio button Enabled.

6. Click OK.

Oracle Data Access Components 11.2.0.4 32-bit

This is required if you use Oracle RDBMs to host your database.

About this task

The Oracle Data Access Components 11.2.0.4 or ODAC – 32 bit is required if you use

Oracle RDBMs to host your database. It must be installed as the Administrator user. More

information can be found in the Oracle documentation.

The version tested with this version of SDL LiveContent Architect can be retrieved upon

request at SDL. The necessary files are part of the Oracle Database 11g Release 2 Client

(11.2.0.4.0) for Microsoft Windows (32-bit).



The package provides three parts:




Procedure

1. In the Select Installation Type window, click Custom.

Note: The Select Installation Type window is displayed after the Welcome screen

when you launch the Oracle installation.

2. Click Next.

Result: Select Product Languages window displays.

Preferably leave only English as selected Product Languages.

3. Click Next.

Result: Specify Installation Location window displays.

4. Enter the following in the fields as note.

■ Oracle Base: C:\Oracle

■ SoftwareLocation:C:\Oracle\product\11.2.0\client_1

5. Click Next.

Result: The Available Products Components window displays.

6. Select:

■ Oracle Net




7. Click Next.

8. Accept the suggested port number by clicking Next.

Make certain that your fire wall settings match this.

9. Addan entry in theC:\Oracle\product\11.2.0\client_1\network\

admin\ tnsnames.ora file that identifies the location of the Oracle database.

If you do not know how to add entries to this file, contact your Oracle database

administrator.

Configuring .NET Framework on Windows 2012

It is required that the .NET Framework is installed.



Before you begin


system setup.

Procedure

1. In the Control Panel, click Programs and Features then on the left side of the

window, select Turn windows features on or off

2. In the right pane of the Add roles and features window.

3. Click next.

4. select your server and click next.

5. Click next.

6. Open the .NET Framework 4.5 Features (Installed) tree node and select the .NET

Framework <version> option.

7. Click Next.

If the feature(s) are greyed and already installed the Next button may not be available

skip this and the next step and instead, click Cancel.

8. Click Install.

Configuring HTTP Activation for WCF on Windows 2012R2

Windows Communication Foundation (WCF) uses the listener adapter interface to

communicate activation requests that are received over the non-HTTP protocols supported

by WCF To allow this, configure HTTPActivation.

Procedure



2. In the right pane of the Add roles and features window.

3. Click Next.

4. Select your server and click Next

5. In the left pane of the Add roles and features window, click Features.

If the Features icon is greyed (not accessible), click Next until Features is displayed.

6. Open the .NET Framework 4.5 Features (Installed) tree node then openWCF

services (Installed) .

7. Select HTTPActivation.

8. Click Next.

If the feature(s) are greyed and already installed the Next button may not be available

skip this and the next step and instead, click Cancel.

9. Click Install.

Configuring IIS and ASP Web services on Windows 2012 R2

It is required that the Web Services (IIS, ASP) be installed.



Before you begin


system setup.

Procedure



2. In the Add roles and features window.

3. Click Next.

4. Select your server and click Next.

5. In the Select Server Roles window, expand theWeb Server (IIS) role.

6. Under Common HTTP features select:

■ Default Document

■ Directory Browsing

■ HTTP Errors

■ Static Content

7. Under Application Development select the following.

■ ASP .NET 4.5

■ .NET Extensibility 4.5

■ ASP

■ ISAPI Extensions

■ ISAPI Filters

8. To speed up file transfer over the network, we advice to enable compression. Under

Performance select Static Content Compression and Dynamic Content

Compression.

9. Under Health and Diagnostics select:

■ HTTP Logging

■ Request Monitor

10. UnderManagement Tools select:

■ IIS Management Console

11. Click Next.

12. Click Install.

Configuring Application Server Role

The Application Server Role is required to be installed.



Before you begin


system setup.

Procedure



2. In the right pane of the Add roles and features window, click Next.

3. Select your server and click Next

4. Open the Application Server and click next until you can select the options listed in

the tree.

■ Distributed Transactions

■ Incoming Network Transactions

■ Outgoing Network Transactions

5. Click Next.

6. Click Next.

7. Click Install.

If already installed, the Install button is not accessible. In this case, click Cancel

Microsoft XML Parser

Only required for SDL LiveContent Architect publishing engine.

About this task

Qualified version(s): Microsoft XML Parser 6.0 Service Pack 2 and Microsoft XML

Parser 4.0 Service Pack 3.

You need to install these components if you use the SDL LiveContent Architect Publishing

engine. Both the 32-Bit and 64-Bit version of Microsoft XML Parser must be installed.

Note: Both versions of Microsoft XML Parser 6.0 Service Pack 2 may already be

installed. To check, verify the existence of the file msxml6.dll in these folders:

■ C:\windows\system32

■ C:\Windows\syswow64

Be sure that Microsoft XML Parser 4.0 Service Pack 3 is also installed.

The MS XML software tested with this version of SDL LiveContent Architect can be


Related information




Java

The JRE and JDK tested with this version of SDL LiveContent Architect can be retrieved

online from SDL LiveContent Architect upon request.

The Java version specified below is for the SDL LiveContent Architect packaged

DITA-OT as noted for this version of SDL LiveContent Architect.

With SDL LiveContent

Architect version:JRE/JDK version and

bitness

Used by:

11.0.0 Java Development Kit

1.7.0_21 (64-bit)

Publishing engine: DITA

Open Toolkit 1.7.5

Java Runtime 1.7.0_21

(64-bit)

Search engine:

TrisoftSolrLucene.exe

Java Runtime Environment

The 64-bit version of the Java Runtime Environment 1.7.0_21 (64-bit) must be installed.

Important: If you install JDK 64 bit, by default the 64 bit JRE is installed.



Related information


Java Development Kit


Qualified version(s): Java Development Kit 1.7.0_21 (64-bit)

The 64-Bit version of the Java Development Kit must be installed.

When you install JDK you only need the Development Tools. (Source Code and Public

JRE is not required.)



Related information


Microsoft .NET Framework Visual C++ Redistributable

It is required that the Microsoft .NET Framework Visual C++ Redistributable be installed

About this task

Qualified version(s): Microsoft .NET Framework Visual C++ Redistributable 2012 (x64)



The software (versions) tested with this release of SDL LiveContent Architect can be


Configuration requirements

After installation, some components need to be configured to conform to SDLLiveContent

Architect requirements.

It is expected that a designated operating system user will run all SDL LiveContent

Architect related components.

Note: A designated operating system user is also known as a Service Account.

It is recommended that you do a system reboot to ensure that all installed components

finish their installation.

Prerequisites for publishing engine

These software packages are required on the server that handles SDL LiveContent

Architect publishing.

Java Help 2.0.05

Only required if you use the SDL LiveContent Architect Publishing engine to generate

Java Help files.

The suggested installation path is C:\JavaHelp which results in the availability of the

following:C:\JavaHelp\jh2.0\src.jarSDLLiveContentArchitect InstallTool

input parameters allow you to indicate the path before installation using variable

ps_javahelp_home.

The javahelp-2_0_05. zip file tested with this version of SDL LiveContent Architect can

be retrieved online from SDL upon request.

Related information


HTML Help Workshop 1.3


On a 64-bit operating system the default installation path is C:\Program Files

(x86)\HTML Help Workshop

The htmlhelp.exe file tested with this version of SDL LiveContent Architect can be


Related information




Antenna House XSL Formatter

Required if you use the SDL LiveContent Architect Publishing engine and the Antenna

House XSL Formatter software by Antenna House to render your output.

To allow the proper rendering of non-Western language such as Thai or the East Asian

languages, you must have the specialized fonts available. SDL LiveContent Architect

expects that all available complex script, right-to-left and East Asian language support are

available.

The file tested with this version of SDL LiveContent Architect was Antenna House XSL

Formatter 6.0 and can be retrieved online from SDL upon request.

Note: You may use a later version of Antenna House XSL Formatter; check with your

SDL customer support representative if you have any questions.

Configuring IIS applicationHost.Config

This part describes which actions should be taken to change the applicationHost.Config

to allow the definition of website specific settings in the web.config of the SDL

LiveContent Architect websites and to set the necessary mimetype definitions for

compression.

Before you begin

The steps for configuring IIS and ASPWeb services must have been executed, especially the static and

dynamic compression feature for IIS needs to be installed

About this task

TheApplicationHost.config file can be found in the folder %WINDIR%\ system32\

inetsrv\ config. It is the root file of the configuration system when you are using IIS

7 and above. It includes definitions of all sites, applications, virtual directories and

application pools, as well as global defaults for the web server settings. It has definitions

for locking-down most IIS sections to the global level, so that by default they cannot be

overridden by lower-level web.config files in the hierarchy. To make configuration

easier, we will unlock some of these global level settings, so we can define these settings

in the web.config of the SDL LiveContent Architect websites.

Procedure

1. Make the necessary changes to allow the definition of website specific settings in the

web.config of the website

a. Start cmd.exe as Administrator

b. Execute the following statements in the cmd window


/section:system.webServer/asp /commit:apphost


/section:system.webServer/serverRuntime /commit:apph



ost


/section:system.webServer/defaultDocument /commit:apph

ost


/section:system.webServer/staticContent /commit:apph

ost


/section:system.webServer/directoryBrowse /commit:apph

ost


/section:system.webServer/handlers /commit:apphost


/section:system.webServer/urlCompression /commit:apph

ost

2. Set the necessary mimetype definitions for static compression





# Define the mimetypes for IIS that can be statically

compressed

$staticcompression = @(




e’},

@{mimeType=’application/atom+xml’; enabled=’True

’},

@{mimeType=’application/xaml+xml’; enabled=’True

’},


’},


)

# Set the specified static mimetypes in the compress

ion settings


$filter = ’system.webServer/httpCompression/statictyp

es’

Set-Webconfiguration -Filter $filter -Value $staticcom

pression

c. Close PowerShell

3. Set the necessary mimetype definitions for dynamic compression







# Define the mimetypes for IIS that can be dynamically

compressed

$dynamiccompression = @(




e’},

@{mimeType=’application/soap+xml’; enabled=’True

’},

@{mimeType=’application/xml’; enabled=’True’},

@{mimeType=’application/json’; enabled=’True’},


’},


)

# Set the specified dynamic mimetypes in the compress

ion settings


$filter = ’system.webServer/httpCompression/dynamictyp

es’

Set-Webconfiguration -Filter $filter -Value $dynamicco

mpression

# Note that compression can be set per web.config file

c. Close PowerShell



Chapter 2

Installing and configuring thedatabase server

The SDL LiveContent Architect database can reside on an Microsoft SQL Server or

Oracle RDBMs database server.

Your database server must be installed with the approved version of database software

before beginning with these procedures.

Note: Oracle setup is more complex than an SQL server setup. This is because the SQL

Server installation and configuration is explained using a Windows user interface. If you

have the choice and are not an Oracle DBA, we advise that you install on an SQL Server

platform.

Microsoft SQL ServerDatabase setup on a Microsoft server requires configuration of the server and creation of

the database.

Configuring Microsoft SQL Server

Database setup is done on the Microsoft SQL server.

Be certain to read the pre-installation notes for SQLServer provided in this documentation.

The SQL Server installation has to be an AccentSensitive, CaseInsensitive,

Unicode-ready installation.


■ If you are doing a fresh SQL Server installation make sure that in the Database

engine Collation settings, Accent-sensitive is selected and Case-sensitive is not

selected.

■ The typical SDL LiveContent Architect collation is SQL_Latin1_General_CP1_

CI_AS (not the often mistaken collation Latin1_General_CI_AS). Depending

on the SQL Server version, the collation SQL_Latin1_General_CP1_CI_AS is

also displayed asDictionary order, caseinsensitive, for use with 1252 Character

Set.

■ You can check the collation name by issuing a query in SQLServer Management

Studio connected to your server.

■ Click New Query then enter: select ServerProperty(’Collation

’).

■ Click Execute.

■ Verify that the result shows an Accent-sensitive (AS), Case-insensitive

(CI) collation name.

For more information refer to Collations in the SQL Server help files.

Authentication based on named SQL Server login ID and on Windows accounts is

recommended.

■ Check or modify this in SQL Server Management Studio, right-click

ServerName, then click Properties and select Security on the left pane.

■ In the Server authentication pane on the right, select SQL Server and Windows

Authentication Mode.

SQL Server Agent is part of the SQL Server software.

■ Check that this Windows Service is set to automatically start upon server reboot.

Windows 2008: Check Start > Control Panel > System and

Security > Administrative Tools then double-click on Services.

Windows 2012: In the Control Panel click Administrative Tools then

double-click on Services.

■ Verify that SQL Server Agent start up type is Automatic.

To execute database transactions, the Microsoft Distributed Transaction Coordinator (MS-

DTC) settings of the database server have to match the ones on the application server.

All servers require a reboot before these settings become active.

Creating a database

Create a database for the SDL LiveContent Architect data collection.

Procedure

1. Open SQL Server Management Studio.

2. Right-click on Databases then click New Database…

3. Enter a database name.

4. Click Options in the left pane.

Installing and configuring the database server


5. In the Collation field, select: SQL_Latin1_General_CP1_CI_AS

6. In the Recovery model field, select: Full

Note: The Full Recovery model uses database backups and transaction log backups

to provide complete protection against media failure. If one or more data files are

damaged, media recovery can restore all committed transactions. In-process

transactions are rolled back. It provides you with the ability to recover the database to

the point of failure or to a specific point in time. To guarantee this degree of recovery,

all operations, including bulk operations such as SELECT INTO, CREATE INDEX,

and bulk loading data, are fully logged. The recovery model may be set to Simple to

avoid a fast growing transaction log files, but note that this reduces the number of

points-in-time for recovery.

7. In the Compatibility level field:

■ If installing on SQL Server 2008 enter: SQL Server 2008 (100)

■ If installing on SQL Server 2012 enter: SQL Server 2012 (110)

8. Click OK.

9. In the originalMicrosoft SQLServer Management Studio window, open Databases

and right-click on the database you created.

10. Click Properties.

Result: A Database Properties window displays for your database.

11. Click Files in the left pane.

12. Change or ensure the following data in the Database Properties window:

■ In the field, Owner, enter: sa

■ Logical name: dbname_Data (for example InfoShare_Data) where the file

type equals Rows Data. Set File Name to dbname.mdf

■ Logical name dbname_Log (for example InfoShare_Log) where the file type

equals Log. Set File Name to dbname_Log.ldf

13. Click OK.

Related tasks

■ “Creating and testing the connection for Microsoft SQL Server” on page 66



Importing data from the SQL dumpfile

Import the sample SDL LiveContent Architect database dump to validate the configuration

and for training purposes.

Procedure

1. In the SQL Server Management Studio window, under Databases, right-click on

the database you created.

2. Click Tasks > Restore > Database.

3. In the Restore Database window, select that you want to restore from a Device then

select the latest available dump provided on the installation CD in:

■ for SQLserver 2008:\Database\Dump\SQLServer2008

■ for SQLserver 2012:\Database\Dump\SQLServer2012

Note: If the SQL server 2008 or 2012 dump is not provided, you can use the

SQL server 2005 dump.

a. Click the ellipsis button next to the Device field.

b. Click Add in the resulting Specify Backup window.

c. Locate and select the backup file.

Result: The Database field under Source is populated with the name of

the database in the backup file.

d. In the Database field under Destination, select the name of the database you

created. This is the database that is to be populated with the data from the

backup/dump file.

Note:Make sure to select this after selecting the source otherwise it can

default to another database name.

e. Click OK.

f. Verify that the correct file is selected in the Specify Backup window, then

click OK.

4. In the Restore Database window, select Restore next to the database filename in the

lower pane then click Options in the left pane.

5. Under the Options tab, select Overwrite the existing database.

6. Click OK.

Result: The database is restored.

7. After restoring the database, use SQL Server Management Studio to check the

recovery model and verify that Full is selected for the Recovery model.



Removing the database user and schema

To ensure successful creation of a new database user and schema, delete the user and

schema that was created when importing the sample data.

About this task

A database user in SQL Server exists on two levels, as an account on the SQL Server

level and as an account on your database. Depending on the kind of initial database setup

dump you received, you could have problems creating your new database user. Therefore,

you should delete the InfoShare database designated user (by default named isource)

and schema.

Note: The user listed within the created database part is to be removed and not the

general SQL Server part listed under Security > Logins.

Procedure

1. In the SQL Server Management Studio window, under Databases, locate and open

the tree under the database you created.

2. Open Security > Schemas.

3. Right-click on isource then click Delete.

Result: A Delete Object window displays.

Note: The isource user may not exist under Schemas. If it does not exist, skip this

and the next step; continue to the step to open Security > Users.

4. Click OK to confirm the removal.

5. Open Security > Users.

6. Right-click on isource then click Delete.

Result: A Delete Object window displays.

7. Click OK to confirm the removal.

Creating a new database user and schema

Add a new user to connect to the newly created database.

Procedure

1. On the database server, open the SQL Server Management Studio.

2. In the left pane under the server name open Security.

3. Right-click on Logins then select New Login…

Result: A Login - New window displays.

4. In the Login name field, enter isource.



5. SQL Server Authentication should be selected. Enter a Password and Confirm

password for SQL Server Authentication.

By default the password is isource, however the password may be one of your choice.

Note: If you change the password, SDL is not able to assist you if you do not know

the password so it is advised to store the password in a secure place.

6. Depending on your local password policy, you can enforce password policy and

password expiration. When both are enabled, keep in mind to change the connect

string of isource at password expiration time.

7. Use the drop down list to select the Default database; select your newly created

database.

No other changes are required for the General information.

8. Click Server Roles in the left pane.

9. Select (check the boxes next to) public and sysadmin in the right pane.

Result: This allows the SDL LiveContent Architect DatabaseUpgradeTool

(DBUT) to fully execute all necessary tasks to update your database with new

releases. This is strongly advised.

10. Click User Mapping in the left pane.

11. Select (check the boxes next to) the newly created database in the upper right pane.

12. In the upper right pane, in the Default Schema field for your database, enter dbo.

13. In the bottom pane, select (check the boxes next to) db_owner and public.

14. In the Login - New window, click Status in the left pane.

15. Verify that Grant is selected for Permission to connect to the database engine and

that Enabled is selected for Login.

16. Click OK.

17. Click File > Exit.

Related tasks

■ “Creating and testing the connection for Microsoft SQL Server” on page 66



Oracle RDBMsThe installation makes use of the Oracle Database Configuration Assistant (DBCA) and

command line programs to create and set up the database. This allows for anyone with a

mixture of Windows and UNIX knowledge to be able to set up an environment on any

Oracle hosting machine.

The configuration procedure refers to a Windows environment when noting system

variables and file paths.

This procedure guides a knowledgeable person through the configuration so that no

important steps are forgotten. However, it does not provide an explanations, or all the

options for each step.

Note: The default database name is ISH.

Oracle database configuration requirements

The users who can configure Oracle must have permissions and access as required and be

familiar with Oracle and Microsoft environments.

All implicit steps that must be done were considered for inclusion in these procedures.

The procedures were written for administrators who have knowledge of the Oracle and

Microsoft environments.

Please be sure that you satisfy the following before beginning:

■ ADBA role is required for a database migration.

■ A server reboot is required after Oracle installation to make sure that all Oracle

environment settings are available to you.

■ Settings should be NLS CHARACTERSET=UTF8,NLS_LENGTH_SEMANTICS=

CHAR and NLS_NCHAR_CHARACTERSET= AL16UTF16.

Also note:

■ Executed actions should be done in the same command window so settings which

are shell specific, for example, ORACLE_SID or ORACLE_HOME are available.

■ All paths are examples only. Paths are system specific, so make sure that all file

paths are valid and contain the correct file(s), and beware of read-only flags on

files.

■ The default database name is ISH and is used in examples in the procedures.



Editing the tnsnames.ora database connection file

Edit the Oracle configuration file that defines the information for connection to the

database server and database instance for the SDL LiveContent Architect repository.

About this task

The Oracle tnsnames.ora file must be modified on the Oracle database server and

on systems that communicate with the Oracle database server.

Note: If the Oracle database server and client software was installed on the same system,

you must edit the tnsnames.ora file under each instance of Oracle_home.

Procedure

1. Login to the server as an administrator user.

2. Open theOracle_home\network\admin\tnsnames.ora file for editing.

If the file does not exist create an empty text document named tnsnames.ora in

the directory above.

3. Add the following to the file. Make sure that it is left-aligned (that is, no leading

whitespace on the first line)

net_service_name =

(DESCRIPTION =

(ADDRESS_LIST =

(ADDRESS = (PROTOCOL = TCP)

(HOST = hostname)

(PORT = 1521))

)

(CONNECT_DATA =

(SERVICE_NAME = service_name)

)

)

where:

■ net_service_name is an alias that is used for a connect descriptor. Forexample:

ISH.WORLD =

■ hostname is the IP address or name of the database server. For example:

(HOST = devserver01)

or

(HOST = 127.0.0.1)



■ SERVICE_NAME is a combination of the db_name and db_domain values intheC:\oracle\admin\ISH\pfile\PFILE\initISH.orafile.

For example:

SERVICE_NAME = ISH.ORASERVER.DOMAIN.NAME

where ISH is the db_name value and ORASERVER.DOMAIN.NAME is the

db_domain value in the initISH.ora file.

4. Save and close the file.

Changing the SQLNET.AUTHENTICATION_SERVICES

A freshly installed Oracle database sometimes results in ORA-12638 errors. If you are

running a dedicated SDL LiveContent Architect Oracle server, you can resolve problems

by altering the SQLNET.AUTHENTICATION_SERVICES setting.

Note: If you are not running a dedicated SDL LiveContent Architect Oracle server,

contact your Oracle DBA.

1. OpenOracle file\network\admin\sqlnet.ora

2. Change the value of parameter SQLNET.AUTHENTICATION_SERVICES to

(none). This setting is instead of (NTS).

Oracle versions configuration

Procedures for configuring Oracle RDBMS 11g is described.

Refer to the procedure for using the required Oracle RDBMs version 11.2.0.4 (or higher).

Related tasks

■ “Editing the tnsnames.ora database connection file” on page 52

Oracle 11g configuration

The SDL LiveContent Architect database is created using the Oracle Database

Configuration Assistant. Oracle version 11.2.0.4 or higher is required.

When installing with Database Configuration Assistant, SDL LiveContent Architect uses

a template with SPFile and without specification for the NLS_LENGTH_SEMATICS.

The database is created with NLS_LENGTH_SEMATICS = BYTE.

The SDL LiveContent Architect requested setting is NLS_LENGTH_SEMATICS =

CHAR. To correct this, SDL LiveContent Architect recommends executing the

DatabaseUpgradeTool after each creation or update of the Oracle database. The

DatabaseUpgradeTool checks and corrects the NLS_LENGTH_SEMATICS to CHAR

using a statement such as:



alter system set nls_length_semantics=char scope=both;

Preparing the Oracle 11g environment

To prepare your environment for the Oracle configuration, you must first copy the template

file to your server.

About this task

From: \Database\Dump\Oracle\Oracle112.Admin\DBCATemplates\SDL-

Trisoft.InfoShare-Database-Template.dbt

To: C:\Oracle\product\11.2.0\dbhome_1\assistants\dbca\

templates on the server

Activating the Oracle Listener service

You must start the Oracle listener service so incoming client connection requests are

received and sent to the database server.

Procedure

1. Open a command prompt window and set the ORACLE_HOME variable.

For example, in the command prompt window, enter: set oracle_home=c:\oracle\product\11.2.0\dbhome_1

2. In the same command prompt window, enter lsnrctl start.

Result: This ensures that an OracleOraDb<nn>g_home1TNSListener serviceexists in the Services Control Panel. Where <nn> is the Oracle version number.

For example:

■ OracleOraDb11g_home1TNSListener

3. Access Windows Administrative Tools then click on Services and locate the

OracleOraDb<nn>g_home1TNSListener service. Make sure it is set to Automatic.

4. Restart the OracleOraDb<nn>g_home1TNSListener service.

If your database and application server are not able to communicate with each other,

it is typically because the two-way communication is blocked by a firewall or security

settings are not matching. Refer to the topic about security and firewall configuration

for more information.



Creating the Oracle 11g database

You must create the Oracle database instance for the SDL LiveContent Architect

repository. This is the place where the data is stored.

Procedure

1. Create the database folder,C:\oracle\OraData\ ISH.

The directory is required and not created by Oracle. Make sure that all paths exist.

2. Start the Database Configuration Assistant.

3. Click Next.

4. Select Create a Database then click Next.

5. Select the SDL-Trisoft. InfoShare-Database-Template then clickNext.

6. Enter the Global Database Name and SID then click Next.

For example:

■ Global Database Name: ISH.global.SDL.corp

■ SID: ISH

7. Optionally, select the Configure Enterprise Manager and Configure Database

Control for local management then click Next.

Result:

Optionally you are prompted with:

Configuring database with Database Control requires a

listener to be configured in the current Oracle home. You

need to run Netca to configure a listener before you can

proceed. Otherwise you may choose to continue without

Database Control configuration.

If prompted to do so, add the listener service:

■ Start the Netca Oracle program as the Administrator user

■ Select the default values: Listener configuration – add – LISTENER – port

1521)

■ At a command prompt, type lsnrctl start

■ This ensures an OracleOraDb11g_home1TNSListener service exists in the

Services Control Panel.

■ At the same command prompt type: lsnrctl reload

■

Go to Start > Programs > Administrative Tools > Services and locate the

OracleOraDb11g_ home1TNSListener service. Make sure that is set to

Automatic then restart it.



Note: If your database and application server are not able to communicate

with each other, it is typically because the two-way communication is blocked

by a firewall or security settings are not matching. Refer to the topic about

security and firewall configuration for more information.

■ Continue with the Database Configuration Assistant wizard.

8. Select either Use Different Administrative Passwords or Use the Same

Administrative Password for All Accounts then enter a Password and Confirm the

password.

This password is requested later. SDL is not able to assist you if you do not know the

password so it is advised to record and store the password in a secure place.

9. Click Next.

10. For storage locations choose either:

■ Use Database File Locations from Template which points to %ORACLE_

BASE%/oradata/DB_UNIQUE_NAME.

Tip: DB_UNIQUE_NAME is a DBCA File Location Variable.

■ Use Common Location for All Database Files where you must specify a path.

For example:C:\Oracle\OraData

Note: Be sure the path exists!

11. Click Next.

12. Optionally, you can change the recovery configuration in the next window.

13. Click Next.

14. Leave the Database Components as specified by the template; click Next.

15. In the next window, optionally, you can lower the default amount of memory. By

default DBCA detects the amount of memory and takes 80% of this. If you change

this, specify at least 1GB of memory.

Leave the Character Sets, and Connection Mode parameters as specified by the

template.

Note: The template specifies that the character set as UTF8 however, the UI shows

AL32UTF8. Know that the Database ConfigurationAssistant creates the database with

the required correct character set. Explicitly changing the character set to UTF8 is

possible by deactivating Show recommended character sets only then choosing UTF8,

but this is unnecessary.

16. Click Next.

17. Leave all settings as specified in the next window and click Next.



18. Click Finish.

19. Click OK.

Result: The database is created.

Creating the designated ISOURCE database user

You must create the ISOURCE designated database user for the new database.

Procedure

1. Optionally, copy theCD_Package/Applications/TriDK/Database/Oracle/create/ isrcuser.i to a temporary location on your server.

Makesure that the\Applications\TriDK\Database\Oracle\create\

isrcuser.i file path in the command below is to the full file path of the file either

on the CD or, if copied to your system, to the temporary location on your system.

The example below is specific for Windows. Be sure to modify the path and command

for your environment.

2. Open a Command Prompt Window as Administrator and set the following variables:

Set ORACLE_SID=ISH

set oracle_home=c:\oracle\product\11.2.0\dbhome_1

Note: All commands must be entered in the same window, ensuring that every

environment variable set, is available throughout the process. The next steps presume

that you use the same shell with these variables set correctly.

3. Make sure that the folderC:\oracle\admin\ISH\create exists before

continuing.

Note: If the folder is missing the error SP2-0606: Cannot create SPOOL file

"C:\oracle\admin\ISH\create\dbadmin2.log, is displayed when issuing the command

below.

4. Start SQLPLUS /NOLOG from the same window:

SQLPLUS /NOLOG

5. At a command prompt where the variables for ORACLE_SID and ORACLE_HOME

are set, type:

SPOOL C:\oracle\admin\ISH\create\dbadmin2.log

CONNECT SYS/CHANGE_ON_INSTALL AS SYSDBA

@CD_Package\Applications\TriDK\Database\Oracle\create/isrcu

ser.i

CONNECT ISOURCE/isource

@?/RDBMS/ADMIN/catdbsyn.sql

SPOOL OFF;



Importing the data

Import the sample data to validate the configuration and for training purposes.

Procedure

1. Edit the the parameters in the\Database\Dump\Oracle\import\

ISOURCE.Rows.par file for your system and environment. Make sure that the

location of the dump files, connect strings, log files and other parameters are correct.

Typically, you would edit the following parameters:

■ FILE=..\export\export.ISOURCE.Ora<num>.ISH.dmpwhichpointsto the dump file you want to import. For example (only):

..\export\export.ISOURCE.Oracle10.2.InfoShareEmpty.dmp

■ LOG=import.ISOURCE.Rows.log which points to a logfile to which theimp.exe writes log information.

■ USERID=ISOURCE/ ISOURCE@ISH. WORLDwhich is the user account that isused to import the dump file.

2. In thesame\Database\Dump\Oracle\import\ISOURCE.Rows.par file

check the parameters to do a user to user (ISOURCE to ISOURCE) import of the data

from the dmp file. For example (only):

The file contains FROMUSER= ISOURCE and TOUSER=ISOURCE. The dump file (FRO-MUSER) contains an ISOURCE schema and the database (TOUSER) has a ISOURCE schemacreated by the isrcuser.i script.

3. At command prompt, go to the\Database\Dump\Oracle\import folder and

import the data by entering the following command:

imp parfile=import.ISOURCE.Rows.par

Removing the designated ISOURCE database user

This procedure can be used if the import fails and you want to remove the the ISOURCE

user and all the objects it owns.

Procedure

1. Start SQLPLUS /NOLOG from a shell where the ORACLE_SID and ORACLE_

HOME variables are set correctly; at a command prompt type:


DROP USER ISOURCE CASCADE;

2. Recreate the ISOURCE user.

Related tasks

■ “Creating the designated ISOURCE database user” on page 57



Validating the database

The newly imported Oracle database needs some packages, triggers and more to be

(re-)compiled for the database to be valid.

Procedure

1. Start SQLPLUS /NOLOG from a shell where the ORACLE_SID and ORACLE_

HOME variables are set correctly, at a command prompt type:

SQLPLUS /NOLOG

2. Enter the following statements to validate the database. Do not use a script file.


@?/rdbms/admin/utlrp;

Result: All objects in the database should be valid.

Enabling network transactionsThe Microsoft Distributed Transaction Coordinator must allow network transactions. This

must be done on all SDL LiveContent Architect servers; application, database (Oracle

RDBMs and Microsoft SQL Server), and batch servers.

About this task

By default, the security configuration for the Microsoft Distributed Transaction

Coordinator is set to not allow network transactions. To enable network transactions:

Procedure

1. Login to the system as the administrator user or a user with administrative privileges

(a user in the administrator group).

2. Click Start > Administrative tools > Component services.

3. Open Component Services > Computers > My Computer > Distributed

Transaction Coordinator.

4. Right-click on Local DTC and select Properties.

5. Click on the Security tab in the Local DTC Properties window.

6. The following should be checked (others should not be checked):

■ Network DTC

■ Allow Remote Clients

■ Allow Inbound

■ Allow Outbound

■ NoAuthentication Required

■ Enable XATransactions



■ Enable SNA LU 6.2 Transactions

■ The DTC Login Account, Account field should read: NTAuthority\Network

Service

7. If you made changes, click Apply.

If you are prompted about MSDTC processes being restarted, click Yes to continue.

If no changes were made, the Apply button is inactive. Continue to the next step.

8. Click OK.



Chapter 3

Requirements ChecklistUse this checklist to make sure that all the necessary pre-installation requirements are

met before installing SDL LiveContent Architect software.

Refer to the hardware and software requirements list (link inclulded below) to ensure that

the correct versions are installed per this checklist before you install SDL LiveContent

Architect.

Layer Type Requirement Completed?

DB HW Hardware requirements are

checked and verified as being

supported.

DB SW The database engine is one of

the supported versions

including the exact service

pack.

DB SW SQL Server installation has a

CaseInsensitive default

collation.

App/Web HW Hardware requirements are

checked and verified as being

supported.

App/Web Env The designated database user

(isource) has minimal system

administrator rights.

App/Web Env The designated app/web

service account for SDL

LiveContent Architect

(InfoShare) is a local

administrator and is a domain

user when using ADFS.

App/Web Env The designated app/web user

(InfoShare) has the correct

regional options set

(dd/MM/yyyy).


Layer Type Requirement Completed?

App/Web Env Do not forcefully unload the

user registry at user logoff is

enabled (Windows 2008)

App/Web SW A valid security certificate is

available for (HTTPS) the web

server application.

App/Web SW The qualified Windows release

is installed for this SDL

LiveContent Architect release.

App/Web SW Web Services IIS/ASP is

installed.

App/Web SW Application Role is installed.

App/Web SW Microsoft XML Parser 6.0

Service Pack 2 and Microsoft

XML Parser 4.0 Service Pack 3

is installed

App/Web SW Microsoft Server .NET

Framework 4.5 is installed.

App/Web SW If Oracle is used as RDBMs,

the qualified Oracle Data

Access Components for this

release is installed.

App/Web SW If Oracle is used as RDBMs,

the Oracle Client Configuration

is configured.

App/Web SW If publishing to JAVA help files

is chosen, Java Help 2.0.05 is

installed.

App/Web SW Java Development Kit 1.7.0_21

(64-bit) is installed.

App/Web SW If publishing to CHM files is

chosen, HTML Help Workshop

1.3 is installed.

App/Web SW If publishing to PDF files is

chosen, a XSL-FO renderer

such as Antenna XSL

Formatter is installed.

Requirements Checklist


Chapter 4

Installing the SDL LiveContentArchitect server

You must install and configure the application and web server to use the SDL LiveContent

Architect application, allowing you to connect to the repository. The SDL LiveContent

Architect server installation is automated however, certain changes and options must be

made before the installation can become operational.

Configuring database connection stringsUse the Microsoft Universal Data Link tool to create and test a connection string.

An SQL Server oriented environment makes use of the standard available Microsoft OLE

DB Provider for SQL Server.

An Oracle oriented environment needs to make use of Oracle Provider for OLE DB.

The introduction of Unicode requires the use of this provider together with the Enhanced

Oracle Services for Microsoft Transaction Server.

Creating and testing Oracle RDBMs

To create and test the Oracle RDBM, you must configure the tnsnames.ora file so that a

connection can be made.

Follow the steps for editing the tnsnames.ora file before creating and testing the

connection.

Editing the tnsnames.ora database connection file

Edit the Oracle configuration file that defines the information for connection to the

database server and database instance for the SDL LiveContent Architect repository.

About this task

The Oracle tnsnames.ora file must be modified on the Oracle database server and

on systems that communicate with the Oracle database server.


Note: If the Oracle database server and client software was installed on the same system,

you must edit the tnsnames.ora file under each instance of Oracle_home.

Procedure

1. Login to the server as an administrator user.

2. Open theOracle_home\network\admin\tnsnames.ora file for editing.

If the file does not exist create an empty text document named tnsnames.ora in

the directory above.

3. Add the following to the file. Make sure that it is left-aligned (that is, no leading

whitespace on the first line)

net_service_name =

(DESCRIPTION =

(ADDRESS_LIST =

(ADDRESS = (PROTOCOL = TCP)

(HOST = hostname)

(PORT = 1521))

)

(CONNECT_DATA =

(SERVICE_NAME = service_name)

)

)

where:

■ net_service_name is an alias that is used for a connect descriptor. Forexample:

ISH.WORLD =

■ hostname is the IP address or name of the database server. For example:

(HOST = devserver01)

or

(HOST = 127.0.0.1)

■ SERVICE_NAME is a combination of the db_name and db_domain values intheC:\oracle\admin\ISH\pfile\PFILE\initISH.orafile.

For example:

SERVICE_NAME = ISH.ORASERVER.DOMAIN.NAME

where ISH is the db_name value and ORASERVER.DOMAIN.NAME is the

db_domain value in the initISH.ora file.

4. Save and close the file.

Installing the SDL LiveContent Architect server


Creating and testing the connection for Oracle RDBMs

An Oracle oriented environment makes use of Oracle Provider for OLE DB in Oracle

11g.

Before you begin

You must have a valid tnsnames.ora file in place to create and test the connection. If this has not been

done, refer to the procedure for editing the tnsnames.ora database connection file.

Procedure

1. Create a new text document in your installation directory (C:\InfoShare) and

name it connection.udl.

Note:

■ Be sure that the file extension is .udl. If required, change your Windows

Explorer settings to recognize the file extension. You have created a Universal

Data Link file, which has a wizard-like program associated to create

connection strings.

■ Ensure that the filename was not appended with a .txt filename extension. If

file name extensions are not visible, modify the Windows Tools > Folder

Options > View, and check that Hide extensions for known file types is not

selected.

2. Start the associated program by executing the command:

%WINDIR%\SysWOW64\cmd.exe /c START C:\InfoShare\connection.udl

The command window launched from SysWOW64 ensures that the 32-bit database

provider in the wizard screen is found.

3. Click the Provider tab, and select Oracle Provider for OLE DB.

4. Click Next.

5. Under theConnection tab, in the first field select or enter the data source. For example:ISH.WORLD.

The data source is the net_service_name entry in the Oracle_home\ network\admin\tnsnames.ora file.

6. In the second field, select the Use a specific username and password checkbox.

a. In the User name field, enter isource.

b. In the Password field, enter the password for the isource user.

The default password is isource. If you did not use the default password, be sureto enter the password used when you created the new user. The password was specified for the isource user when configuring the Oracle server.

c. Select the Allow saving password checkbox.



7. Test the connection by clicking Test Connection.

Result: If the connection is valid, a message is displayed to notify that the

connection is working correctly.

8. Click OK to confirm.

Result: This saves the password as plain text in the UDL file. If the connect

string does not contain the password variable, no valid connections can be

made with this connection string.

Creating and testing the connection for MicrosoftSQL Server

An SQL Server oriented environment makes use of the Microsoft OLE DB Provider for

SQL Server.

Procedure

1. Create a new text document in your installation directory (C:\InfoShare) and

name it connection.udl.

Note:

■ Be sure that the file extension is .udl. If required, change your Windows

Explorer settings to recognize the file extension. You have created a Universal

Data Link file, which has a wizard-like program associated to create

connection strings.

■ Ensure that the filename was not appended with a .txt file extension. If file

extensions are not visible, modify the Windows Tools > Folder

Options > View, and check that Hide extensions for known file types is not

selected.

2. Start the associated program fromWindows Explorer by double-clicking

C:\InfoShare\connection.udl.

3. Click the Provider tab, and selectMicrosoft OLE DB Provider for SQL Server.

4. Click Next.

5. Under the Connection tab, in the first field select or enter the SQL database server

name.

6. In the second field, select the Use a specific username and password checkbox.

a. In the User name field, enter isource.

b. In the Password field, enter the password for the isource user.

The default password is isource. If you did not use the default password, be sureto enter the password used when you created the new user. The password was specified for the isource user when configuring the Microsoft SQL server.

c. Select the Allow saving password checkbox.

7. In the third field, select the Select the database on the server checkbox, and specify

the database name.



This is the name specified when you created the database. The database name was

specified when configuring Microsoft SQL server.

8. Test the connection by clicking Test Connection.

Result: If the connection is valid, a message is displayed to notify that the

connection is working correctly.

9. Click OK to confirm.

This saves the password as plain text in the UDL file. If the connect string does not

contain the password variable, no valid connections can be made with this connection

string.

Related reference

■ “Creating a new database user and schema” on page 49

■ “Creating a database” on page 46

Preparing for the server installationA complete SDL LiveContent Architect database has to be available to install a SDL

LiveContent Architect server.

About this task

Note: The install tool makes no changes to your database.

Procedure

1. Extract the SDL LiveContent Architect archive to a temporary folder on the server.

Note that Windows path depths are limited to 260 characters so it is suggest to extract

the archive to a short directory path such as C:\IShCD\

2. Locate the InputParameters. xml file in the folder with the name that uses the

format:

C:\IShCDs\yyyymmdd.CD.InfoShare.ver.num.ProjectName.IT\__

InstallTool\

3. Open the file in a text editor (for instance, Notepad). Find and edit all<currentvalue> items in the file.

The file is annotated with descriptions for the <currentvalue> parameters, forexample:

<param name="osuser">

<currentvalue>SDLPRODUCTS\serviceinfoshare</currentval

ue>

<defaultvalue>.\InfoShare</defaultvalue>

<description>The username of the designated OS user.

This user must be local administrator and have the

correct regional settings</description>



<validate />

</param>

For instance, when you specify a projectsuffix you also have to manually add the suf

fix to the value of parameters for infoshareauthorwebappname, infosharewsweba

ppname

Refer to the documentation for the InputParameters. xml file to make necessary

edits.

Make sure that all items are all correct (UDL file, check paths, and so on) and that the

resulting file is a well-formed xml file.

Prerequisites for the server installation

Check the prerequisites before using the install tool to ensure a successful installation.

Before using the install tool, be sure that the following prerequisites are satisfied:

■ You are installing on a SDL LiveContent Architect server that has no instances of

SDL LiveContent Architect (or SDL Trisoft) installed.

Make certain that any SDL COM+Applications and all Virtual Directories are

removed.

■ You have a designated InfoShare operating system user with the regional options

and Log OnAs Service configured as specified in the pre-installation tasks for

establishing a dedicated system user (Service Account).

■ The Microsoft Distributed Transaction Timeout settings are specified as noted in

the as specified in the pre-installation tasks.

■ If using STS, obtain and install the certificate before installing SDL LiveContent

Architect.

■ A valid security certificate is available for (HTTPS) the web server application.

Enabling https on the IIS website

SDL LiveContent Architect requires that https is enabled on the IIS website that is used

for SDL LiveContent Architect.



Before you begin

Follow this procedure on the main SDL LiveContent Architect server. After installing the certificate, you

must bind the website to https (included in the last step below).

About this task

Before you can enable https on the SDL LiveContent Architect website you must first

install a SSL certificate on the server. There are several ways to request and install a

certificate:

■ You can buy a certificate from a commercial certificate authority, for example,

Verisign. These commercial CAs have online how-to help pages that guide you

through the process of requesting a certificate and installing it.

■ When your company has an internal Certificate Authority, you can request

certificates yourself, or through your IT staff.

■ Use the Create Domain Certificate in IIS. To do this follow the procedure

below.

Procedure

1. Request and install the certificate.

a. In Internet Information Services (IIS) Manager, open:

ComputerName > Server Certificates.

b. In the right Actions pane, click Create Domain Certificate.

Result: A Create Certificate window displays.

c. Add the necessary information to the fields in Create Certificate:

■ Common name: Enter the complete domain name of the URL to be

used for this SDL LiveContent Architect. For example:techdoccms.sdl.com

■ Organization: enter your company name. For example: SDL

■ Organizational unit: Enter the name of the department that is

requesting the certificate. For example: SDL IT

■ City, State & Country: Enter the city, state & country where the

company is located.

d. Click Next.

An Online Certificate Authority window displays.

e. Specify Online Certificate Authority that you want to use by clicking Select

to the right of the field.

Note: If the list for Certificate Authority is empty you cannot continue and

you have to ask your IT department for instruction on how to continue.



f. Enter a Friendly Name. The Friendly Name is a more user-friendly name

for the certificate and is shown in several programs such as IIS.

Result:

You should see the requested certificate appearing in the IIS Server Certificates

list, and you can now use it.

g. Click Finish .

2. Bind the website to https:

a. Right-click the IIS Website that will be used for SDL LiveContent Architect.

b. Select Edit Bindings.

c. Click Add.

■ In the Type field, select https.

■ In the SSL certificate field select the certificate that you requested

and installed; select the Friendly Name specified in the previous step.

d. Click OK.

inputparameters.xml

The inputparameters. xml file stores key parameters that are used by the SDL

LiveContent Architect installer. This file must accurately reflect your environment for the

install tool to work correctly.

Overview

Note: If using STS, obtain and install the certificate before modifying the

inputparameters.xml file.

Each parameter in this configuration file has the following syntax:

<param name="parameter">

<currentvalue>value</currentvalue>

<defaultvalue>example_value</defaultvalue>

<description>description_of_how_used</description>

<validate>if_validated</validate>

</param>

The XML elements perform the following functions:

<currentvalue>

Contains the value that is used by the installer.

<defaultvalue>

Contains a predefined value as an example. Do not use the predefined value as a

default for the value, as it is only an example.



<description>

A description of how the current value of the parameter is used.

<validate>

Whether the value of the parameter is validated. If the element is empty, no validation

takes place. The <validate> values are provided, and they should not be modified.

Note: If using STS, obtain and install the certificate before modifying the

inputparameters.xml file.

Related tasks

■ “Verifying URLs” on page 124

Parameters

This section lists and describes the parameters in the inputparameters.xml file that you

must define for your installation.

Note: To obtain the required connectstring parameter:

■ In a text editor such as Notepad, open the connection.udl file you created in

the installation directory (C:\InfoShare)

■ Find the line that begins with Provider=. For Oracle:

Provider=OraOLEDB.Oracle.1;Password=isource-password;Pers

ist Security Info=True;User ID=isource;Data Source=data_s

ource_name

For MSSQL:

Provider=SQLOLEDB.1;Password=isource-password;Persist

Security Info=True;User ID=isource;Initial Catalog=databa

se;Data Source=server-name

■ Copy the line and paste it in the inputparameters. xml file for theconnectstring parameter.

osuser

The user name for the designated operating system account.

ospassword

The password for the designated operating system account. This password must be set

to never expire.

projectsuffix

A suffix that specifies the particular instance of SDL LiveContent Architect if you are

installing more than one instance of SDL LiveContent Architect on a server.



connectstring

The connection string for the instance of the database application.

databasetype

The type of database application that is used. The following values are valid:

■ oracle

■ sqlserver

apppath

The root directory for the SDL LiveContent Architect installation.

By default, this is set to C:\InfoShare.

webpath

The root directory for the Web site.

By default, this is set to C:\InfoShare.

datapath

The directory in which the data directory is created. This directory is where all data

exported from SDL LiveContent Architect is stored.

By default, this parameter is set to C:\InfoShare.

workspacepath

The temporary directory that is used to store installation files.

By default, this parameter is set to C:\InfoShare\ _Workspace.

infoshareauthorwebappname

The name for the web client application.

By default, this parameter is set to InfoShareAuthor.

infosharewswebappname

The name for the web services application.

By default, this parameter is set to InfoShareWS.

infosharestswebappname

Specify the name of the SDL LiveContent Architect Secure Token Service (STS) web

site.

Follow the same patterns as with infoshareauthorwebappname andinfosharewswebappname

Note: There is no default value for this parameter.

websitename

The name of the Web Site, in which all virtual directories are created.

By default it is set to Default Web Site.



baseurl

Specify the base URL that is used to access the SDL LiveContent Architect web client

This URL must specify the https:// secure protocol.

As a best practice, the HTTPS binding on IIS should have a certificate matching itsCommon Name with this host name.

localservicehostname

The host name for the local address.

This specifies the host name with which communication within the SDL LiveContent

Architect box happens.

It can be local host or the node's machine name.

ps_fo_processor

The fully qualified file name of the XSL-FO processor, for example, C:\Program

Files\AntennaHouse\AHFormatterV6\AHFCmd.exe.

ps_htmlhelp_processor

The fully qualified file name of the HTMLHelp processor, for example, C:\Program

Files (x86)\HTML Help Workshop\hhc.exe

Note: Do not use environment variables or quotation marks.

ps_java_home

The path to the JAVA HOME directory.


ps_javahelp_home

The full path to a JavaHelp JHHOME folder. This allows you to set the JavaHelp

Home folder when you want to publish with type JavaHelp.


ps_webworks_automap_application

The fully qualified path and filename of WebWorks.


solrlucene_service_port

The port that is used by the SolrLucene service. This port must be unique for each

instance of SDL LiveContent Architect that is installed on a server.

solrlucene_stop_port

The port that is used to stop the SolrLucene service. This port must be unique for each

instance of SDL LiveContent Architect that is installed on a server.



servicecertificatethumbprint

Specify the thumprint of the service certificate.

With the typical SDL LiveContent Architect setup, the service certificate is the SSL

certificate of the IIS website where a typical SDL LiveContent Architect setup is going

to be installed.

■ Open Internet Information Services (IIS) Man-

ager > Servername > Server Certificates

■ Right-click on the certificate of the IIS website that is going to be used for

SDL LiveContent Architect then click View.

■ Click on the details tab then click on the Thumbprint field.

In the bottom pane you see the details of the Thumbprint field.

■ Select the whole value then press CTRL + C on your keyboard to copy it onto

the clipboard.

■ Paste it in the servicecertificatethumprint/ currentvalue

parameter of the inputparameters. xml file.

■ Remove all spaces and control characters.

For example, the preceding thumbprint would be represented asA43489159A520F0D93D032CCAF37E7FE20A8B419 in the servicecertifica-tethumprint parameter.

servicecertificatevalidationmode

Specify the validation mode of the service certificate.

Specify the level of validation used to verify the service certificate (servicecer-tificatethumprint):

■ ChainTrust

Validates the certificate using a trust chain (it validates the certificate, the

CA(s) and checks if the certificate is not revoked using the CRL or OCSP).

■ PeerTrust

Verifies if the certificate is in the TrustedPeople certificate store of the

computer.

■ PeerOrChainTrust

Verifies if the certificate is valid by either a ChainTrust or a PeerTrustvalidation.

■ None

The certificate is not validated, it is always valid.

issuercertificatethumbprint

Specify the thumbprint of the signing certificate on the configured STS. (issuerw-strustendpointurl and issuerwsfederationendpointurl)

You can configure SDL LiveContent Architect to either use the SDL LiveContent

Architect STS (aka InfoShareSTS) or use another STS such as Microsoft ADFS 2.0.

Do one of the following depending on if you use SDL LiveContent Architect STS or

ADFS:



SDL LiveContent Architect STS

SDL LiveContent Architect STS uses the same certificate as the one that is used on

IIS Website on which SDL LiveContent Architect is going to be installed. So the

thumbprint of the signing certificate is the one of the IIS website certificate.

■ Open Internet Information Services (IIS) Manager > Servername > Se-

rver Certificates

■ Right-click on the certificate of the IIS website that is going to be used for


■ Click on the details tab then click on the Thumbprint field.

In the bottom pane you see the details of the Thumbprint field.

■ Select the value then press CTRL + C on your keyboard to copy it onto the

clipboard.

■ Paste it in the issuercertificatethumbprint/currentvalue param-

eter of the inputparameters.xml file.


ADFS 2.0

Note: If you do not have access to the ADFS server, ask someone who has access to

obtain the thumbprint of the token signing certificates.

■ Open AD FS 2.0 Management > Service > Certificates then right-click on

the Primary Token-signing certificate and choose View certificate.

■ Click on the details tab then select the Thumbprint field.

■ Select the value and press CTRL + C on your keyboard to copy it on the

clipboard.

■ Paste it in the issuercertificatethumbprint/currentvalue param-

eter of the inputparameters.xml file.


issuercertificatevalidationmode

Specify the validation mode of the issuer certificate.

Specify the level of validation used to verify the issuer certificate (issuercertifi-catethumbprint):

■ ChainTrust

Validates the certificate using a trust chain (it validates the certificate, the

CA(s) and checks if the certificate is not revoked using the CRL or OCSP).

■ PeerTrust

Verifies if the certificate is in the TrustedPeople certificate store of the

computer



■ PeerOrChainTrust

Verifies if the certificate is valid by either a ChainTrust or a PeerTrustvalidation.

■ None

The certificate is not validated, it is always valid.

issuerwstrustbindingtype

Specify the binding type for the issuerwsfederationendpointurl parameter.

Based on the authentication mode supported by the server specified in theissuerwstrustendpointurl parameter, specify one of the following values:

■ When authenticating with SDL LiveContent Architect STS, specify UserNameMixed.This value is specified when username/password authentication is expected.

■ When authenticating with AD FS 2.0 STS, specify WindowsMixed.

This value is specified when Windows authentication is expected.

Note:When WindowsMixed is specified, values specified for the issueractorusername and issueractorpassword parameters are ignored.

■ When authenticating with some other STS, specify the value based on the

requirements for that STS and IDP (ID (identity) Provider).

issueractorusername

When delegating, specify the username of the actor.

■ When authenticating with SDL LiveContent Architect STS, specify InfoShareActor.

■ When authenticating with AD FS 2.0 STS, leave this field empty.


requirements for that STS and IDP.

issueractorpassword

When delegating, specify the password of the actor.

■ When authenticating with SDL LiveContent Architect STS, specify the pass-

word defined for the InfoShareActor user.

■ When authenticating with AD FS 2.0 STS, leave this field empty.





issuerwstrustendpointurl

Specify the endpoint of the STS for the Active Profile.

■ When authenticating with SDL LiveContent Architect STS, specify:baseurl/infosharestswebappname/issue/wstrust/mixed/

username

where baseurl and infosharestswebappname are the values specified forthe baseurl and infosharestswebappname parameters.

■ When authenticating with AD FS 2.0 STS, specify: https://adfshost/

adfs/services/trust/13/windowsmixedandmakesure that

this ADFS endpoint is enabled. To do this:

■ Open AD FS 2.0 Management

■ Go to AD FS 2.0 > Service > Endpoints.

■ Makecertain that /adfs/ serices/ trust/ 13/windowsmixed is enabled.



issuerwsfederationendpointurl

Specify the endpoint of the STS for the Passive Profile.

■ When authenticating with SDL LiveContent Architect STS, specify:baseurl/infosharestswebappname/issue/wsfed

where baseurl and infosharestswebappname are the values specified forthe baseurl and infosharestswebappname parameters.

■ When authenticating with AD FS 2.0 STS, specify:

https://adfshost/adfs/ls/



issuerwstrustmexurl

This is the metadata address (Mex) of the STS for the active profile. It is used when

generating proxy classes. Example:

InfoShareSTS:baseurl/infosharestswebappname/issue/wstrust/

mex

ADFS:https://adfshost/adfs/services/trust/mex

Other: Value based on specific STS.

serviceusername

Specify the username of the service user inside the SDL LiveContent Architect user

repository. The service user is required for the translation builder.

servicepassword

Specify the password of the service user defined in the SDL LiveContent Architect

user repository.

Related information

■ “Configuring the translation builder” on page 96



Executing the InstallToolUse the SDL LiveContent Architect InstallTool to install and merge all standard and

customer specific project files.

Procedure

1. Login to your Windows system as a SDL LiveContent Architect user with the

Administrator user role.

2. In Windows Explorer, go to

C:\IShCD\yyyymmdd.CD.InfoShare<version_num>\ProjectName.IT\

__InstallTool

3. Locate and double-click on InstallTool. exe.

4. Select the Install option by entering the number 2.

5. Hit enter to respond to all questions; the default options should be sufficient.

Result:

All standard and customer specific project files are merged and installed. All required

services are up and running (the Crawler, SolrLucene, IISAdmin, W3SVC).

Related information

■ “InstallTool” on page 129

Enabling network transactionsThe Microsoft Distributed Transaction Coordinator must allow network transactions. This

must be done on all SDL LiveContent Architect servers; application, database (Oracle

RDBMs and Microsoft SQL Server), and batch servers.

About this task

By default, the security configuration for the Microsoft Distributed Transaction

Coordinator is set to not allow network transactions. To enable network transactions:

Procedure

1. Login to the system as the administrator user or a user with administrative privileges

(a user in the administrator group).

2. Click Start > Administrative tools > Component services.

3. Open Component Services > Computers > My Computer > Distributed

Transaction Coordinator.

4. Right-click on Local DTC and select Properties.

5. Click on the Security tab in the Local DTC Properties window.



6. The following should be checked (others should not be checked):

■ Network DTC

■ Allow Remote Clients

■ Allow Inbound

■ Allow Outbound

■ NoAuthentication Required

■ Enable XATransactions

■ Enable SNA LU 6.2 Transactions

■ The DTC Login Account, Account field should read: NTAuthority\Network

Service

7. If you made changes, click Apply.

If you are prompted about MSDTC processes being restarted, click Yes to continue.

If no changes were made, the Apply button is inactive. Continue to the next step.

8. Click OK.





Chapter 5

Post-installation tasksAfter you complete a new installation of SDL LiveContent Architect server, you should

complete a number of post-installation tasks. The post-installation tasks help you verify the

installation and configure the components that you have just installed.

Verifying Microsoft SQL SystemAdministration role permissions

To ensure that the database upgrade tool (DBUpgrade) works properly, the isource user

must have system administrator permissions.

About this task

To allow the DatabaseUpgradeTool (DBUT) to fully execute all necessary tasks to update

your MS SQL database now and for each new release, follow the procedure below to

ensure the database user has the necessary permissions.

Note: This procedure applies only if you are using SQLServer. This procedure does not

apply to Oracle.

Procedure

1. Access and login to SQL Server Management Studio on the database server:

Click Start All Programs > Microsoft SQL Server > SQL Server Management

Studio

2. Under the folder for the MSSQL server in the left pane, open Security > Logins.

3. Right-click on the isource user and select Properties.

Result: A Login Properties - isource window displays.

4. In the left pane of the Login Properties - isource window select Server Roles.

5. In the right pane for Server Roles select public and sysadmin.

6. Click OK.

7. Click File > Exit to exit and close the Microsoft Server Management window.


Completing the database configurationThe DBUT tool, for all supported database engines, does an overall verification of the

database and updates database objects such as views, indexes, packages and stored

procedures and modifies metadata structures

Before you begin

■ SystemAdministrator rights for the isource database user.

■ An available and complete SDL LiveContent Architect database (up and running).

■ An available, full and correctly installed SDL LiveContent Architect server.

The installation ensures that the upgrade files and connections are in place to

allow a successful upgrade.

■ Exclusive access to the SDL LiveContent Architect database for the

DatabaseUpgradeTool.

If necessary, stop all components and services, especially InfoShare Crawler on

all servers.

Procedure

1. Login to the server as a Windows user with the Administrator user role.

2. In Windows Explorer, in the SDL LiveContent Architect installation directory, open:

\App\Setup\DBUgradeTool\

3. Locate and double-click on DBUpgradeTool. exe

4. Optional, for ADFS only

Use the Database Upgrade Tool to configure the FishExternalID of the administrator

user with a value such as domain\ username, for the user who is to login in the systemas the administrator. To do this:

■ Run Database Upgrade Tool, choose option 1: Maintenance

■ Choose option 8: Append an user's externalid for initial STS logon

■ Choose installation then complete the appropriate value for the SDL

LiveContent Architect admin user.

5. Select the DatabaseUpgrade option.

6. Hit the Enter key to respond to all questions; the default options are sufficient for the

following questions:

■ Select your recently installed project (thereby selecting the database location

and user, upgrade script paths, version and so on).

■ Default for the application.

■ Enter a valid InfoShare administrator user account.

Result: The result is an upgrade from an older or same version to the installed

version when applicable.

Related reference

■ “The DatabaseUpgradeTool (DBUT)” on page 132

Post-installation tasks


Troubleshooting DatabaseUpgradeTool

If the DBUT suddenly dies, it results in a hanging database upgrade logged in to the

database. All other attempts to upgrade will fail since only one upgrade process is

permitted to run at a time.

To force an undo of a hanging update, execute DBUT then select

Maintenance > Terminate and your current project.

If you see errors when executing the tool contact SDL LiveContent Architect or preferably,

use the SDL LiveContent Architect Issue Tracking system, or email

[email protected]

The information you must provide when contacting SDL LiveContent Architect for

support is:

■ A screenshot of the failed execution of DatabaseUpgradeTool

■ Thelogfile:\App\Setup\DBUpgradeTool\DBUpgradeTool.log

Adding the relying party entries for webUIand WCF Services

After the SDL LiveContent Architect installation you have to create the Relying Party

Trust for the website and the WCF services on the ADFS 2.0 Server. This is required to

allow logins to SDL LiveContent Architect.

About this task

These post-installation steps have to be done when you are using ADFS as STS. If you

are using InfoShareSTS as STS do not follow these steps.

Doing this manually can be error prone, therefore SDL provides you a PowerShell script

that creates the Relying Party Trust and does the configuration. To execute the script do the

following:

Procedure

1. The ADFS server needs the service certifcate that is used by the SDL LiveContent

Architect WCF Services.

This is the same value as the certificate whose thumbprint is used in the

inputparameters parameter servicecertificatethumbprint. With the typical SDL

LiveContent Architect setup, this WCF Service certificate is the same as the IIS

Website Certificate for SSL.

a. Open Internet Information Services (IIS) Manager Servername.

b. Double-click Server Certificates in the right pane.



c. Right-click on the certificate of the IIS website that is going to be used for


d. Click on the Details tab then click Copy to File and export the certificate to

the file system (private key not necessary).

2. Copy the PowerShell scripts which are created in the directory \ InfoShare\ App\

Setup\STS\ADFS\Scripts\ scripts to a temporary directory on theADFS 2.0

server together with the certificate you exported in the previous step.

3. Login into the ADFS Server and open a administrative PowerShell command line;

right-click on the PowerShell shortcut and choose Run as administrator.

4. Set the PowerShell execution policy to Unrestricted.

Note: The scripts provided are not signed because they are generated during the

SDL LiveContent Architect installation. To execute unsigned scripts in PowerShell

you must set the execution policy to Unrestricted.

■ To check if PowerShell's execution policy is already set to unrestricted,

execute the command:

Get-ExecutionPolicy

■ If the output of this command shows something other than Unrestricted,

execute the command:

Set-ExecutionPolicy Unrestricted

5. Change the working directory of the command prompt by executing the command:

cd YourCopiedAdfsScriptsFolder

6. Before running the script, load theADFS PowerShell module by issuing the command:

Add-PSSnapin Microsoft.Adfs.PowerShell

7. Execute the command:

.\SDL.LiveContent.Architect-ADFSv2.0-RP-Install.ps1 "\

YourCertificateFolder\cerFile.cer\"

Result: Now if you open AD FS 2.0 Management you should see two new

Relying Party entries with the baseurls you use for the SDL LiveContent

Architect instance.



Removing the relying party entries for webUI andWCF Services

If you want to remove the Relying Party entries, for instance because SDL LiveContent

Architect is moved to another server or the url has changed, follow the steps below.

Procedure

1. Check if the Uninstall script for the Relying Party entries is on the ADFS server. If

not, copy it from the SDL LiveContent Architect application server directory

\InfoShare\App\Setup\STS\ADFS\Scripts\.

2. Login into the ADFS Server and open a administrative PowerShell command line;

right-click on the PowerShell shortcut and choose Run as administrator.

3. Before running the script, load theADFS PowerShell module by issuing the command:

Add-PSSnapin Microsoft.Adfs.PowerShell

4. Execute the command:

.\SDL.LiveContent.Architect-ADFSv2.0-RP-UnInstall.ps1

Result: Now if you open AD FS 2.0 Management you should see that the two

Relying Party entries are removed.

The Administrator setupNeeds to be done only if you did not receive a fully prepared database dump-backup file,

otherwise this is done and configured.

Note:

■ This is the responsibility of a functional administrator not of a technical

administrator.

■ The configurations handled in this section are all managed through the Author

website Settings tab.

■ The delivered configuration files are available in web\ Author\ EnterViaUI

or, for your customer specific files, in \ CustomerSpecificFiles\

Websites\Author\EnterViaUI.



Completing the Administrator setup

Needs to be done only if you did not receive a fully prepared database dump-backup file,

otherwise this is done and configured.

About this task

Procedure

1. Login to the SDL LiveContent Architect web client as an administrator user.

2. In the web Content Explorer, select the Settings tab.

3. To configure each of the following:

a. Under the Settings tab, go to the place as noted in the To configure, go to

column in the table below.

b. Delete the contents of the textbox.

c. Copy the contents of the file indicated in theCopy from column to the textbox.

When you copy, ensure that there are no leading empty lines.

The files are located on the server in the SDL LiveContent Architect_home

directoryin\Web\Author\EnterViaUI

To configure, go to: Copy the contents

from:

On the top menu bar,

click:

XML Inbox Settings Admin.

XMLInboxConfigura-

tion.xml

Save

XMLWrite Plug-In

Settings

Admin.

XMLWriteObjPlugin-

Config.xml

Save

XML Status Settings Admin.

XMLStatusConfigura-

tion.xml

Save

XMLTranslation

Settings

Admin.

XMLTranslationconfig-

uration.xml

Save

XML ChangeTracker

Settings

Admin.

XMLChangeTracker-

Config.xml

Save

XML Background Task

Settings

Admin.

XMLBackgroundTask-

Configuration.xml

Save



Enabling servicesAfter the install is complete, services will not start automatically, since the database is not

guaranteed to be in the right state until you run DBUT tool. Also, you might decide not

to start some services on the specific installation depending on the server role. To enable

typical services you can locate and run the Enable-DefaultServices.ps1 script.

Before you begin

■ DBUT completed successfully.

■ The Administrator setup completed successfully.

■ SystemAdministrator rights.

Procedure

1. Run the script \App\Setup\Manage\Enable-DefaultServices.ps1

Result: Typical services (Trisoft InfoShare Crawler One, Trisoft InfoShare

SolrLucene, Trisoft InfoShare BackgroundTask One, Trisoft InfoShare

TranslationBuilder One etc.) are started, startup type is set to "Automatic

(Delayed Start)".

Enable Content EditorTo enable Content Editor, you must modify several configuration files in the Content

Explorer web application.

Before you begin

Before performing this process, you must purchase a license for Content Editor from

SDL.

Procedure

1. On the Content Explorer web application server, go to the \\ <Server>\ c:\

InfoShare\Web<projectsuffix>\Author\ASP\XSL folder inside the

Content Explorer web application.

2. Enable Content Editor buttons in these configuration files:

■ FolderButtonbar.xml

■ InboxButtonBar.xml

■ LanguageDocumentButtonbar.xml

For example these buttons are labeled with comments that look like this:



.

. (the code for the button)

.





To enable these buttons in the web application, un-comment the code for those buttons

in these files.

Installing the SDL LiveContent Createlicense file

After completing the SDL LiveContent Architect installation, install the SDL LiveContent

Create license file (which is obtained from SDL Technical Services) before you to gain

access to SDL LiveContent Create.

Note: SDL LiveContent Create is installed automatically when you install SDL

LiveContent Architect.

You must copy the SDL LiveContent Create license file into the installation directory on

the SDL LiveContent Architect Web server. Typically, this location is:

C:\Infoshare\Web\Author\ASP\Editors\Xopus\license\

Enable the SDL Enrich plugin for SDLLiveContent Create

Follow this procedure to enable the Content Quality Rules (SDL Enrich) in the Content

Editor (SDL LiveContent Create).

Before you begin

■ SDL LiveContent Create must be enabled for the suite.

■ SDL Enrich must be installed.

■ You should know the URI of SDL Enrich.

About this task

If you plan to open and edit topics from the Review and Collaboration (SDL LiveContent

Reach) server, then in addition to this task you should also specify the base url for your

Content Quality Rules(SDL Enrich) server in a SDL Enrich configuration file.

Procedure

1. OpentheInfoShare\Web<projectsuffix>\Author\ASP\Editors\

Xopus\config\config.xmlfile.

Uncomment lines from 

2. OpentheInfoShare\Web<projectsuffix>\Author\ASP\Editors\

Xopus\config\sdl-enrich-config.xmlfile.

Uncomment lines from .



Translation management integrationconfiguration

The configuration of the Translation management integration with WorldServer, TMS and

File System is described.

Translation services configuration files

The configuration files for translation management are described. You can modify the

files to configure or customize translation management for your needs.

Application Configuration for TranslationBuilder

Modify the translationbuilder. exe.config file parameters noted below to

configure or customize TranslationBuilder.

The file is located on the SDLLiveContentArchitect server: \ Infoshare\ App\

TranslationBuilder\Bin\translationbuilder.exe.config



All the parameters are configured in the settings element in thetrisoft.infoShare.translationBuilder section.

maxObjectsInOnePushTranslation

Maximum number of objects in a single push translation. The default value is 1000.

maxTranslationJobItemsCreatedInOneCall

Maximum number of items created in a single transaction. The default value is 10000

completedJobLifeSpan

The time after which the completed/cancelled job is deleted. Default value is

90.00:00:00.000

jobProcessingTimeout

The time that a job can be processed by a single step without updating the job lease

before it is considered dead. Default value is 01:00:00.000.

userName

The name of the user to access SDL LiveContent Architect. This value is initialized

from install parameters.

password

The password of the user to access SDLLiveContentArchitect. This value is initialized

from install parameters.

jobPollingInterval

Interval at which jobs are polled for processing. Default value is 00:05:00.000.

pendingJobPollingInterval

Interval at which jobs that are pending the push translations are polled for processing.

Default value is 00:15:00.000.

Application configuration for TranslationOrganizer

Modify the TranslationOrganizer. exe.config file parameters noted below to

configure or customize TranslationOrganizer.

The file is located on the SDLLiveContentArchitect server: \ Infoshare\ App\

TranslationOrganizer\Bin\TranslationOrganizer.exe.config.

The parameters are configured within the section trisoft.infoShare.translationOrganizer

in three different groups:



Settings

The common parameters are configured in settings. These parameters are related to

the working of the TranslationOrganizer service or with the update of the SDL

LiveContent Architect repository.

dumpFolder

The folder where the temporary files are created. This value is initialized from install

parameters.

maxTranslationJobItemsUpdatedInOneCall

Maximum number of items updated in a single transaction. Default value is 100.

jobPollingInterval

Interval at which jobs are polled for processing. Default value is 00:05:00.000.

pendingJobPollingInterval

Interval at which jobs pending translation are polled for processing. Default value is

00:15:00.000.

systemTaskInterval

The minimal interval that system tasks (for example, template synchronisation) are

run. Default value is 00:10:00.000.

attemptsBeforeFailOnRetrieval

Number of attempts the update of single content object fails before the job is moved

to failed status. The default value is 3.

updateLeasedByPerNumberOfItems

Number of items that have to be updated before the translation job is updated. Default

value is 100.

synchronizeTemplates

Specifies whether service should synchronize templates.

WorldServer

■ The SDLWorldServer specific parameters are configured within the

worldServer/instances/addelement:

alias

An unique display name for the SDLWorldServer installation (e.g.

wsDemo, prod, dev,...).

uri

The base URI for WorldServer WS. This value has to be set manually.

userName

The user name to access WorldServer WS. This value has to be set

manually.

password

The password to accessWorldServerWS. This value has to be set manually.

externalJobMaxTotalUncompressedSizeBytes



Maximum total size of the single translation job. Default value is 5242880

bytes.

retriesOnTimeout

Number of times the single external call can fail and be retried before the

job is moved to failed status. Default value is 3.

■ The configuration must also contain a mapping of the language from SDL

LiveContent Architect to the locale of SDLWorldServer

<mappings>

<add trisoftLanguage="en" worldServerLocaleId="1

145" />

<add trisoftLanguage="nl" worldServerLocaleId="1

147" />

<add trisoftLanguage="fr" worldServerLocaleId="1

146" />

</mappings>



Note: No more than one SDLWorldServer installation instance is supported in this

release. If you are not configuring for use with SDLWorldServer, do not configure any

instances for SDLWorldServer.

TMS

■ The parameters which are specific for SDL TMS are configured within the

tms/instances/addelement.

alias

An unique display name for the SDL TMS installation (e.g. demo, prod,

dev,...).

uri

The base URI for SDL TMSWS. This value has to be set manually.



bytes.

retriesOnTimeout

Number of times the single external call can fail and be retried before the

job is moved to failed status. Default value is 3.

destinationPortNumber

Gets or sets a value indicating the TCP Port number over which

communications should be conducted.

isapiFilterLocation

Gets or sets a value indicating the path of the CTAISAPI component in

SDL TMS that will receive communication requests.

useCompression

Gets or sets a value indicating whether communications should be

compressed.

useSsl

Gets or sets a value indicating whether communications should be

conducted over a secure channel.

useDefaultProxyCredentials

Gets or sets a value indicating whether to use default credentials when

communicating with a Proxy server.

proxyServer

Gets or sets a value indicating the Uri of the Proxy server to use.

proxyPort

Gets or sets a value indicating the TCP port to use when communicating

with the proxy.

■ The configuration must also contain:



■ The mapping of the language from SDL LiveContent Architect to the

language of SDL TMS:

<mappings>

<add trisoftLanguage="en" tmsLanguage="EN-

US" />

<add trisoftLanguage="fr" tmsLanguage="FR"

/>

<add trisoftLanguage="de" tmsLanguage="DE"

/>

<add trisoftLanguage="nl" tmsLanguage="NL"

/>

</mappings>

■ The SDL TMS configurations which specify the workflow and the

language pairs. Each configuration that you want to use within SDL

LiveContent Architect must be configured within a template element:

<templates>

<add templateId="81143C38-0C96-4A8C-9BBB-8

7C1CF464FE3" templateName="My template" />

<add templateId="70407FBC-86FA-4A9D-8E6D-3

5E1AE85DB73" templateName="Trisoft

template" />

</templates>

Note: After selecting a template, only the target languages which

are configured for that SDLTMS configuration can be used as possible

target language within SDL LiveContent Architect .

■ The configuration can contain:

■ The metadata that will be extracted and passed to SDL TMS.

<requestedMetadata>

<ishfields>

<ishfield name="FAUTHOR" level="lng"

ishvaluetype="value" />

<ishfield name="DOC-LANGUAGE" level="lng"


</ishfields>

</requestedMetadata>

■ The metadata that will be used for grouping items in SDL TMS.



<groupingMetadata>

<ishfields>





</ishfields>

</groupingMetadata>

This metadata will be passed to SDLTMS together with the metadata sp

ecified in

requestedMetadata

section.

Note: No more than one SDL TMS installation instance is supported in this release.

If you are not configuring for use with SDL TMS, do not configure any instances for

SDL TMS.

File System

■ The parameters which are specific for File System are configured within the

fileSystem/instances/addelement.

alias

An unique display name for the configured File System (e.g. demo, prod,

dev,...).



bytes.

exportFolder

Export folder wherer the exported zip archives will be stored. This value is

initialized from install parameters.

■ The configuration can contain:

■ The metadata that will be extracted and exported as .met files next to

the actual files.

<requestedMetadata>

<ishfields>





</ishfields>



</requestedMetadata>

Note: No more than one File System instance is supported in this release. If you are

not configuring for use with File System, do not configure any instances for File

System.

Configuring the translation builder

Follow these steps to configure the translation builder including adding the

TRANSLATORSERVICE role, creating a user ServiceUser, and adding the status

transitions.

Procedure

1. Create a TRANSLATORSERVICE role:

a. In the web client, click the Settings tab.

b. Click User Roles in the left pane.

c. Click New in the toolbar in the right pane to display the User Role Properties

window.

d. In the User Role Properties window:

■ Enter TRANSLATORSERVICE in the Name field

■ Enter TRANSLATORSERVICE has to be uppercase in the

Description field

■ Ensure that the checkbox next to Active is checked.

e. Click OK.

2. Create a user ServiceUser with user role TRANSLATORSERVICE:


b. Click Users in the left pane.

c. Click New in the toolbar in the right pane to display the User Properties

window.

d. In the User Properties window:

■ Enter ServiceUser in the User Name field

■ Enter the Language from the select menu.

■ In the Roles field, select TRANSLATORSERVICE, Translator, and

Administrator from the select menu.

■ Select the User Groups for this user from the select menu.

■ Select Internal in the Type field.

■ Enter Domain\ ServiceUser in the External Id field.



Note: This ServiceUser needs to be a user which is created withinthe domain and has permission to run the service 'Translationorganizer'.It can be any name on the domain, ServiceUser is only an example.

■ Ensure that the checkbox next to Active is checked.

■ Click OK.

3. Add status transitions:


b. Click Status Transitions in the left pane.

c. Click Add in the bottom right pane to display the Add Status Transitions

window.

d. In the Add Status Transitions window, add the required status transitions, as

described in the Integration Requirements. Typically you configure the

following status transitions:

From Status To Status User Role

To be translated In translation TRANSLATORSER-

VICE

In translation Translated TRANSLATORSER-

VICE

Translated Translation rejected TRANSLATORSER-

VICE

Translation rejected In translation TRANSLATORSER-

VICE

Related tasks

■ “Parameters” on page 71

Translation Job Workflow

The life cycle of the translation job.



The main workflow of the translation job.



Failing steps of the translation job workflow.

■ TranslationBuilder is responsible for unlocking outdated leases of TranslationJobs

so they are part of the workflow again.

■ Manual actions can only be executed on TranslationJobs which are not having a

status controlled by the two services. This includes Definition, Completed,

Cancelled and all Failed statuses.

Integration requirements for SDL LiveContentArchitect and SDL TMS

The following are items that will help you better understand the integration of SDL

LiveContent Architect and SDL TMS and considerations when configuring translation

and workflow.

SDL LiveContent Architect

Required for SDL LiveContent Architect integration:

■ Languages are defined as described for source and pivot languages (see related

topic). For example:

The following example defines a source language of English with target languages

for German, Spanish, French, Italian and Chinese. The second group indicates

that Chinese can be used as source language (pivot) for translating to Japanese and

Korean.

<GenerationScheme>

<FromLanguage ref="en">

<ToLanguage ref="de"/>

<ToLanguage ref="es"/>



<ToLanguage ref="fr"/>

<ToLanguage ref="it"/>

<ToLanguage ref="zh"/>

</FromLanguage>

<FromLanguage ref="zh">

<ToLanguage ref="ja"/>

<ToLanguage ref="ko"/>

</FromLanguage>

</GenerationScheme>

■ Translation templates come from SDL TMS and are automatically pushed to SDL

LiveContent Architect by TranslationOrganizer.

■ SDL LiveContent Architect uses UTF-16 for the content.

■ The dedicated user (typically 'ServiceUser') having the role

TRANSLATORSERVICE.

■ Statuses and status transitions, configured for the TRANSLATORSERVICE role,

that define a workflow for the integration:

■ There is an initial status to indicate that the object is ready for translation.

This is typically the To Be Translated status.

This status is used by TranslationBuilder to create new target language

objects and by TranslationOrganizer to identify and include objects to send.

■ With the status transition from the initial status, there is a status to indicate

that the object is no longer under control of the CMS.

This is typically the In Translation status.

The status transition is: To Be Translated to In Translation.

TranslationJob option Include ’In Translation’ items forces there-sending of objects in this status.

■ With the status transition from the status above, there is a status to indicate

that the object is back in CMS control.

This is typically the Translated status.

The status transition is: In Translation to Translated.

■ The last status indicates that the translation was rejected and object should

be re-translated.

This is typically the Translation rejected status.

The status transition is: Translated to Translation rejected.

■ The status transition from Translation rejected to In

Translation allows items to be re-translated.

The system finds your configured initial and next status by executing a GetPossibleTransi-tionStatus on your object having the user role 'TRANSLATORSERVICE'. For everycall, the system expects exactly one to status as a result, so it can deterministicallypush your object from one status to the next one.



Note: TranslationBuilder starts automatically. TranslationOrganizer has to be

configured before the initial (first) start. Start TranslationOrganizer manually or change

it to start automatically using the Services option in the Control Panel. (SDL TMS URI,

language mapping and all necessary templates must be speficied) The services are:

■ Trisoft InfoShare TranslationBuilder

■ Trisoft InfoShare TranslationOrganizer

Defining and configuring the TRANSLATORSERIVCE role and the status transition

are described in Configuring the translation builder.

SDL TMS

Required for SDL TMS integration:

■ Configurations specifying the workflows and all necessary language pairs.

Remember:When a configuration is selected, only the target languages (and

workflows) which are configured for the source language can be used.

■ The workflow should contain minimally the following 2 steps:

■ "Content retrieval" step which is used by SDL LiveContent Architect to

start getting the translation

■ "Completed" step which is used by SDL LiveContent Architect to indicate

that the translation was downloaded successfully.

■ Refer to the SDL TMS manuals for the further details about how to configure the

workflow in SDL TMS.

Integration requirements for SDL LiveContentArchitect and SDL WorldServer


LiveContent Architect and SDLWorldServer and considerations when configuring

translation and workflow.








Korean.



<GenerationScheme>







</FromLanguage>




</FromLanguage>

</GenerationScheme>

■ Translation templates come from SDLWorldServer and are automatically pushed

to SDL LiveContent Architect by TranslationOrganizer.



TRANSLATORSERVICE.


that defines a workflow for the integration:















be re-translated.










it to start automatically using the Services option in the Control Panel. (TheWorldServer

URI, login and password is required.) The services are:





SDL WorldServer

Required for SDLWorldServer integration:

■ A dedicated user in SDLWorldServer.

This is the user that is used by Translation Organizer to logon to SDLWorldServer.

This is the parameter userName within the worldServer section in the

configuration file.

■ SDL LiveContent Architect mount configured to use UTF-16.

Refer to the SDLWorldServer manuals for the further details.

■ Locales, Workflows, Project Types, whatever is required by WorldServer to go

through the translation process.


■ After Translate step in a workflow should be an automatic Save step.

Refer to the SDLWorldServer manuals for the further details about how to

configure the workflow in SDLWorldServer.

■ After Save step in a workflow should be Translated Content Retrieval step

which is used by SDL LiveContent Architect to start getting the translation. From

Translated Content Retrieval step there should be a transition called Retrieved.

Refer to the SDLWorldServer manuals for the further details about how to

configure the workflow in SDLWorldServer.

■ Asset path normalizer. This is optional custom component that can be implemented

separately and installed in SDLWorldServer to force SDLWorldServer TM to

consider the file name when doing match.




Integration requirements for SDL LiveContentArchitect and File System


LiveContent Architect and File System and considerations when configuring translation

and workflow.








Korean.

<GenerationScheme>







</FromLanguage>




</FromLanguage>

</GenerationScheme>

■ Translation templates are based on configured source and pivot languages, and

are automatically pushed to SDL LiveContent Architect by TranslationOrganizer.





TRANSLATORSERVICE.


that defines a workflow for the integration:















be re-translated.








it to start automatically using the Services option in the Control Panel. (SDL TMS URI,

language mapping and all necessary templates must be speficied) The services are:





File System

Required for File System integration:

■ The dedicated user (see above) configured for the integration has an access to the

folder where the zip files should be created.



Introduction to scalabilityDescribes the different deployment scenarios to build up the scaling out options

Scalability is the ability of a system, network, or process to handle a growing amount of

work in a capable manner or its ability to be expanded to accommodate that growth. For

SDL LiveContent Architect, scalability refers to the ability of the system to increase

capabilities like:

■ Total web output;

■ Web services output;

■ Total computation output for the items executing on the sever like publish,

translations, etc.

The how to scale out guide will start from a simple case and granularly build up the

complexity and scaling out specialization by explaining different cases.

One server for all rolesThe basic deployment option consists of one server that is responsible for all roles.

For SDL LiveContent Architect to operate correctly, all server roles need to be active:

1. The Default background task role provides execution for the background.

2. The Full text indexing role provides crawling and indexing functionality for the

SolrLucene search engine.

3. The Translation role provides all translation-related functionality.

4. The Web role provides all necessary web endpoints like web site, web services, and

the internal security token service.

The following diagram shows a conceptual representation of the one server deployment.

Figure 1: One server deployment with all roles active

All these roles work together to provide the expected functionality. Depending on the

load and the intensity of usage, the execution of the above roles might not work at peak

performance because of system and operating limitations.

Once the load becomes too big and this type of deployment is not sufficient, we need to

scale out the solution and introduce a cluster of servers.



Related information

■ “Default background task role” on page 149

■ “Full text indexing role” on page 148

■ “Translation role” on page 151

■ “Web role” on page 147

Simple clusterThe simple cluster deployment uses two servers. Each server focuses on delivering a

subset of the required application functionality.

The servers types are:

■ Front end server: it is responsible for all interactive and web services functionality.

■ Back end server: it is responsible for all non interactive functionality.

The following diagrams shows how the two servers work together while splitting

responsibilities:

Figure 2: Two server deployment

Related information

■ “Front end server” on page 108

■ “Back end server” on page 109

Related tasks

■ “Advanced server cluster” on page 112



Front end server

The front end server main responsibility is to provide output for web clients and web

services.

Two roles are required to accomplish this:

■ The Web role service allows executing web requests for the web client, and web

service requests.

■ The Full text indexing role provides crawling and indexing functionality for the

SolrLucene search engine.

The front end server is the public facing server handling all interactive web requests. The

Web role exposes public endpoints through the Internet Information Services,which is the default web engine on a Microsoft Windows Server operating system. All theendpoints are secured with secure sockets layer (SSL) to provide the https schema.Depending on the expected accessibility towards the endpoints between intranet andinternet, the certificate has to be configured accordingly.

The certificate's subject name must match the hostname for the endpoints that the clients

will be using. For example, if the web client is provided an endpoint like

https://publichostname/InfoShareAuthor/ or theweb service client

targets an endpoint likehttps://publichostname/InfoShareWS/Wcf/

API25/ Application. svc, then the hostname is publichostname. This mustmatch the SSL certificate's subject name. Depending on the scenario, thepublichostname should or should not match the server's fully qualified domain name,for examplemecdevapp01.global.sdl.corp.

Note: The SSL certificate's subject always matches the hostname that is visible on the

client, regardless the server's fully qualified domain name (FQDN).

Related tasks

■ “Simple cluster” on page 107

Related information



Related tasks


Related tasks

■ “Best practices to configure a node in network load balancing” on page 114

Related tasks

■ “Best practices to specialize back end servers” on page 116

Related tasks

■ “SDL LiveContent Environment with InfoShareSTS” on page 119



Related tasks

■ “LiveContent Environment with ADFS” on page 121

How to configure a front end server

Explains how to configure a server as a front end server.

Procedure

1. The Web role is enabled by default on all servers.

2. On Internet Information Services Manager make sure that the certificate'ssubject name configured on the https binding matches the hostname that the web clients, webservice clients and client tools target.

3. Enable the Full text indexing role.

Note: We recommend deploying only one full text indexing role perdatabase. If you scale out the front end server, we recommend having one front endserver to run the Full text indexing role, and redirecting all other servers to that server.

Related information




■ “Redirecting full text indexing” on page 111

Back end server

The back end server's main responsibility is to provide execution for all queued actions

initiated by user actions or web service calls, including translation functionality.

Three roles are required to accomplish this

■ The Web role allows accessing the web client and the web services from the same

server.

■ The Default background task role provides execution for the Background task

component.

■ The Translation role provides functionality for translation-related flows.

The back end server is in other words the work horse for the non-interactive and long

running flows. The Web role exposes internal endpoints through the InternetInformation Services which is the default web engine on a Microsoft WindowsServer operating system. All the endpoints are secured with secure sockets layer (SSL) toprovide the https schema. The SSL certificate has to be configured with intranetaccessibility only in mind.

The certificate's subject name must match the hostname for the endpoints that the clients

will be using. Since the accessibility to this server is only through intranet, the web client



and web service client use fully qualified domain name (FQDN) based endpoints likehttps://mecdevapp01.global.sdl.corp/InfoShareAuthor/andhttps://mecdevapp01.global.sdl.corp/InfoShareWS/Wcf/API25/

Application.svc.

The Default background task role is configured out of the box to execute all possible

handlers. This means that all dependencies must be installed and properly configured on

this server. For example third party renderer licenses must be properly configured when

this server will be used to publish. If the dependencies are not present, the Default

background task role will execute the pending items but error's will be raised.

The Translation role also requires configuration, like the target endpoints of SDL

WorldServer or SDL TMS for example.

We recommend repurposing the existing Full text indexing role, typically installed on a

front end server, by forwarding the requests of the back end server.

Related tasks


Related tasks


Related tasks


Related tasks


How to configure a back end server

Explains how to configure a server as a back end server.

Procedure

1. By default, the Web role is enabled on all servers.

2. On Internet Information Services Manager, make sure that the certificatesubject name in the https binding matches the host name the web clients and web serviceclients target.

3. Enable the Default background task role.

4. Enable the Translation role.

5. Redirect the full text indexing of the back end server to a front end server with thefull text indexing role.

Related information




■ “Redirecting full text indexing” on page 111



Redirecting full text indexing

Redirect full text indexing when configuring back end server, or when the local machine

does not have full text indexing (FTI). This can be done on any server if FTI is handled on

a different server, for back end servers when configuring asynchronous load balancing,

or when configuring network load balancing.

About this task

The configuration for full text indexing (FTI) is handled by the Crawler and SolrLucene

entries in the registry.

A default configuration is installed that connects to the localhost (127.0.0.1) port 8080.

For example:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Trisoft\TriDK\TridkAp

p\InfoShareAuthor]

"CrawlerIndexEngineType"="ApacheSolrLucene"

"SolrLuceneBaseUrl"="http://127.0.0.1:8080/solr"

"SolrLuceneHTTPTimeout"="180"

"SolrLuceneHTTPRetries"="5"

To redirect full text indexing on any server to the server holding the full text indexing

role:

Procedure

1. On the server, alter SolrLuceneBaseUrlto the URL for SolrLucene on the full textindexing (FTI) server.

Example: For example, where 10.98.124.5: 8080 is the FTI server's URL forSolrLucene, modify the server's registry to read:

[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Trisoft\TriDK\Trid

kApp\InfoShareAuthor] "SolrLuceneBaseUrl"="http://10.98.124.

5:8080/solr"

Result: Full text indexing is now directed to the server as specified in the

registry for SolrLuceneBaseUrl.

2. Reboot the server or, at minimum, a recycle is required for the application pool and

COM+ server application.

3. Disable the crawler service on the server that has been redirected to the FTI server:

■ Click Control Panel > Administrative Tools > Services

■ Double-click on the service named, Trisoft InfoShare Crawler One.

There may be more than one service. If so, follow the procedure for each.

■ Under the General tab, set the Startup type to Disabled.



4. To allow incoming requests on the server holding the full text index role from other

servers, add all the servers IPs, or server IP range to the FTI server, in the \ App\

Utilities\SolrLucene\Jetty\etc\jetty-ipaccess.xmlfile'swhite

list.

Example: For example, to allow incoming requests on the FTI server from

other servers as identified by the IP address 127.0.0.1 and IP range

10.98.0-255.0-255:

Example: On the FTI server modify jetty-ipaccess. xml to read:

<Set name="white">

<Array type="String">

<Item>127.0.0.1</Item>

<Item>10.98.0-255.0-255</Item>

</Array>

</Set>

�

5. Make sure that the Firewall on the machine hosting the full text index role allows

incoming connections on the specified IPs and/or ports.

6. Restart the TrisoftSolrLuceneWindows service on the server holding the full text

index role.

Related tasks

■ “How to configure a front end server” on page 109

■ “How to configure a back end server” on page 110

Advanced server clusterWhen the two server simple cluster is not sufficient to handle the load, and you want to

allow faster output and bigger throughput, you can add more servers with dedicated roles.

Each type of server can be scaled out. In this example case we will duplicate each server

type.

So an SDL LiveContent Architect advanced cluster is an example of a four server

deployment. With the advanced server cluster we still have the same server types as with

the simple cluster, but with more aggregated power:

■ The front end server is responsible for all interactive and web services

functionality.

■ The back end server is responsible for all non interactive functionality.

Scaling out each type of server means that we are scaling out the roles.

The following diagram shows how the two servers work together while splitting

responsibilities:



Figure 3: Four server deployment

To scale out a front end server, you need a network load balancer.

Note: Some roles can be scaled out by duplication even on the same server, if the

hardware can handle it.

Related information




Related tasks


Related tasks




Network load balancing

Network load balancing is a technology that can be used to increase the maximum capacity

and efficiency of the Web role.

A typical network load balancing deployment is a network load balancer over a cluster of

identical nodes. The network load balancer is like a proxy to the nodes. The clients only

see the balancer and are not aware of each of the specific nodes. This is also the main

reason that the nodes have to be identical.

When a network load balancer receives a request it will forward the request to one of the

nodes. There are several algorithms to drive the balancing act between the nodes. Some

algorithms are restrictive e.g. affinity and some are not.SDL LiveContent Architect does

not have any special requirements with regards to the algorithm and any node is as good as

any other at the moment it joins the cluster.

Best practices to configure a node in networkload balancing

Explains how to configure a node in a network load balancing cluster.

In a typical network load balancing deployment, the network load balancer acts as a

proxy to the nodes within the cluster. Because SDL LiveContent Architect requires traffic

to be encrypted over ssl and https schema endpoints, special attention is requiredregarding the ssl certificate used to configure the Web role.

The certificate subject name must match the host name of the endpoints that the clients

will be using. When a network load balancer (or any other proxy) is what the clients target,

then the target hostname is e.g. nlbhostname. For example, the web client targets an

endpoint like https://nlbhostname/ InfoShareAuthor/ and the web service

client targets an endpoint like https://nlbhostname/ InfoShareWS/ Wcf/

API25/ Application. svc. The nlbhostname is completely independent from theserver name of each node, but it forces the certificate used to configure the Web role tohave this subject name. This means that a proper certificate has to be created based onthe balancer's properties and shared on each Front end server before installation.

Also multiple Front end server nodes mean multiple Full text indexing roles. To force

each server to deliver the same results for each search request, we need to redirect them

to consume the same Full text indexing role instance in the cluster. Typically, this means

that the Full text indexing role is fully active on one of the nodes and disabled on the other

nodes.

In the diagram below we can identify the shared certificate used by all Front end server

nodes and that only one Full text indexing role is used as the repository.



Figure 4: SDL LiveContent Architect network load balancing deployment.

For more advanced network load balancing deployments you may even have to specialize

one of the Front end server to execute only the Full text indexing role. Although the

node has the Web role still active, it is not part of the cluster and it never receives requests.

In this case all balanced nodes are equal with regards to throughput and are not affected

by the execution of the Full text indexing role.



Figure 5: Specialized SDL LiveContent Architect network load balancing deployment.

Related information




Related tasks


Related tasks


Best practices to specialize back end servers

Explains how to specialize a back end server.

Unlike the Front end server configuration, back end servers in a cluster do not need to be

identical.

Out of the box, a back end server is configured with the following active roles:



■ Web role;

■ Default background task role, where the Default service role configuration is

targeted in the Settings > XMLBackground Task Settings.

■ Translation role.

This means that all out of the box servers have the same behavior, but it is possible to

differentiate. For example, we could set up a cluster of three back end servers where two

servers would be specialized in the publish and translation functionality respectively and

the last of the three would be configured to execute the rest. This deployment is visible in

the next diagram.

Figure 6: Advanced cluster with back end server specializations.

However, it can be useful to create for instance three back end servers with specific roles

like:

■ A back end server for publishing:

■ Web role;

■ Publish role.

■ A back end server specialized only in the translations:

■ Web role;

■ Translation role.



Note: Since the server is running as a dedicated translation server, the Trisoft

InfoShare BackgroundTask service must run with a role which only contains the

translation related eventTypes.

■ The last back end server is required to execute all items that are not picked up by

the other two. In this case all handlers relative to the publish and translation

functionality will be excluded. Those handlers need to be referenced by a service

role in Settings > XMLBackground Task Settings. For example:

<service role="Generic">

<matrix>

<group name="SynchronizeToLiveContent" maxExecutio

ns="1">

<handlers>

<add ref="SYNCHRONIZETOLIVECONTENT" />

</handlers>

</group>

<group name="Others" maxExecutions="2">

<handlers>

<add ref="BATCHPERFORMACTION" />

<add ref="THUMBNAILSUBMIT" />

<add ref="ISHBATCHIMPORT" />

</handlers>

</group>

</matrix>



<leaseRecovery isEnabled="true" interval="00:05:00"

/>



<poller isEnabled="true" interval="00:00:10" />



<aggregationRecovery isEnabled="true" gracePeriod="00:

10:00" interval="00:10:00" maximumRetries="3" />

</service>

Note: Although all back end servers can be configured to have enabled the recovery

elements in Settings > XMLBackground Task Settings, we can also specialize to this

aspect. For instance, the specialized back end servers don't do recovery and only the

generic service role is enabled to recover.



Note: Further specialization is possible based on the hardware of the server. We can

create in Settings > XMLBackground Task Settings service roles names likePublish16GB and Publish8GB with different value on the maxExecutions. Thedifferent service role names are relevant to the expected memory.

Note: Due to 32-bit process architecture restrictions, the maximum memory of each

process is restricted to 2GB. To leverage a server's higher memory capacity we can setup

multiple services on the same server where the service role name can be the same or

different.

Related information





■ “Publish role” on page 153

■ “Best practices for creating a Trisoft InfoShare BackgroundTask service with a

specific role” on page 154

LiveContent environment

SDL LiveContent Environment with InfoShareSTS

SDL LiveContent Architect, SDL LiveContent Reach, SDL Enrich integrated with

InfoShareSTS

This topic describes how an SDL LiveContent Architect Advanced server cluster

deployment fits in the SDL LiveContent deployment.

A collection of Front end server behind a network load balancer serve the interactive

functionality and a collection of Back end server serve the non interactive functionality.

InfoShareSTS is used as the Security Token Service as part of the Web role.

When designing a cluster like the above you should take special notice for the following

items.

■ Each Front end server behind the network load balancer is configured using the

same certificate referring to the same host name.

■ Every Back end server should be installed with its own certificate referring to its

unique host name.



■ For every federated service endpoint e.g. SDL LiveContent Architect

InfoShareWS, targeted from within the cluster, DNS resolving and network

routing should be taken into consideration depending on the network topology.

■ InfoShareSTS cannot be shared across different servers. As a result:

■ Every InfoShareSTS on every server on the cluster requires configuration

for all federated services for which it can potentially issue a token.

■ InfoShareSTS on every Front end server has configuration based on the

network load balancer hostname and certificate. Also it must have all

required configuration relevant to other federate services as their endpoints

are recognized from outside the cluster.

■ InfoShareSTS on every Back end server has configuration based on the

specific hostname and certificate of the server. This InfoShareSTS will be

used by all entities of the same Back end server. All federated services

integrated with SDL LiveContent Architect are required to be configured

on the InfoShareSTS on every Back end server, using endpoints relevant to

configured DNS resolving and network routing.

With a setup similar to this all user clients like browsers and client tools will target the

network load balancing hostname and thus one of the Front end server. Any client that is

running from within the cluster behind the network load balance will still have access to

any Back end server by using its designated host name.



Figure 7: SDL LiveContent advanced deployment with InfoShareSTS

Related information






LiveContent Environment with ADFS

SDL LiveContent Architect , SDL LiveContent Reach, SDL Enrich integrated with ADFS

This topic describes how an SDL LiveContent Architect Advanced server cluster

deployment fits in the SDL LiveContent deployment.

A collection of Front end server behind a network load balancer serve the interactive

functionality and a collection of Back end server serve the non interactive functionality.

ADFS is used as the Security Token Service as part of the Web role.

When designing a cluster like the above you should take special notice for the following

items.



■ Each Front end server behind the network load balancer is configured using the

same certificate referring to the same host name.

■ Every Back end server should be installed with its own certificate referring to its

unique host name.

■ For every federated service endpoint e.g. SDL LiveContent Architect

InfoShareWS, targeted from within the cluster, DNS resolving and network

routing should be taken into consideration depending on the network topology.

With a setup similar to this all user clients like browsers and client tools will target the

network load balancing hostname and thus one of the Front end server. Any client that is

running from within the cluster behind the network load balance will still have access to

any Back end server by using its designated host name.



Figure 8: SDL LiveContent advanced deployment with ADFS

Related information








Verifying the installationConduct some testing to verify critical parts of your installation.

Verifying URLs

If your environment includes reverse proxy servers, after you install SDL LiveContent

Architect, you need to check that certain URLs are accessible.

Procedure

1. Using Windows Internet Explorer, ensure that you can reach the following URLs:

■ BaseURL/InfoShareWS/Application.asmx?wsdl

■ BaseURL/InfoShareWS/Application.asmx?disco

where BaseURL is the value specified for the baseurl parameter, and InfoShareWS isthe value specified for the infosharewswebappname parameter. These parameters are setin the inputparameter. xml file that is used by the SDL LiveContent Architect

installer.

2. If you cannot access the URLs, verify that the reverse proxy servers are correctly

configured. See the documentation for the reverse proxy servers.

Related reference

■ “inputparameters.xml” on page 70

Verify read access to the database by viewing aninbox

To verify read access to the database, request to view an inbox in the web client.

Procedure

1. Open Internet Explorer and enter the address for the SDL LiveContent Architect web

client.

Note: The web client address is a combination of the value in the parameters in the

inputparameters.xml file:baseurl/infoshareauthorwebappname/

For example, if:

<param name="baseurl">

<currentvalue>https://archserver1.world.sdl.corp</currentva

lue>

and

<param name="infoshareauthorwebappname">

<currentvalue>InfoShareAuthor</currentvalue>

then the URL is:



https://archserver1.world.sdl.corp/InfoShareAuthor/

Enter a SDL LiveContent Architect username and password. If you are not sure

about the login/password and you imported the default database you can use

admin/admin to login.

2. Access the SDL product menu by clicking on the icon in the upper left of the window

and select Content Explorer.

3. If not selected, select the Inbox tab at the top of the window.

4. In the left pane, select one of the inboxes, for instance, select Reviewer.

Result: If no objects are in the inbox, an empty inbox is displayed; No objects

in inbox is reported in the right pane.

If there are objects in the inbox, a list of objects is displayed in the right pane.

Verify read and write access to the database bycreating a folder

Create, modify, and delete actions are handled through transactions and verifies read and

write access to the database.

Procedure

1. Login to the SDL LiveContent Architect web client as an existing user. For example

as the admin user.

2. Select the Repository tab at the top of the window.

3. Click the New Folder icon in the upper left of the Repository pane.

Result: A New Folder window displays.

4. Enter a name in the Folder Name field. For example enter the folder name, Test.

5. Click OK.

Result: The folder is created an displayed in the left pane.

What to do next

You can remove the test folder by selecting it in the left pane then clicking the Delete Folder icon (red X) in

the upper left pane. You are asked to confirm the delete action, click Yes to confirm and delete the folder.

Creating an account and connecting to therepository

You must create the user account and configure the connection to the repository to allow

a user to connect and access data in the SDL LiveContent Architect repository.



Before you begin

Use this procedure to create a new user account for testing purposes. You need the

following information to create the account and connect to the repository:

■ Name of the SDL LiveContent Architect application server

■ URL of the SDL LiveContent Architect web services.

For example: http://example.com/ InfoShareWS/

■ URL of the SDL LiveContent Architect web client.

Procedure

1. Perform one of the following actions:

Application Action

Publication Manager Click Tools > Accounts.

XML authoring tool Click SDLLiveContent > Accounts.

Result: The repository window is displayed.

2. Click Add.

3. Enter anAccount Name and the URL of the SDLLiveContentArchitectWeb Service.

4. Click Next.

5. If necessary, select the Authentication Method.

6. Enter the username and password.

Check Remember password if you do not want to enter the information each time

you use the application.

7. Click Next.

Result: SDL LiveContent Architect validates the account and synchronizes

files.

Running a client tool

When started, the client tools verify availability of the synchronization website and web

services.

Before you begin

■ A desktop client workstation must be installed with the client tools. If not done,

refer to the section for installing desktop clients.

■ The client tool must be configured with a user login and account.

■ To fully test the client, the database should contain data.



Procedure

1. If necesssary, create an account and connection to the repository.

2. Start a client tool such as Publication Manager, Condition Manager or Authoring

Bridge from the Start menu or desktop shortcut.

Result:

If you can view and access the repository through the client tool, and can view or

preview a topic in the repository then web services, synchronization, and network

availability have been successfully verified.

Testing publishing

You can test the publish functionality if your database contains topics, maps and

publications, and it is configured to render an output type.

Before you begin

If your database is not configured to render an output, refer to the SDL LiveContent Architect

Information Portal documentation for information about adding output formats.

Procedure


as the admin user.

2. Select the Repository tab at the top of the window.

3. Select a publication in the left pane.

4. Select a version in the upper right pane by clicking on the publication name.

Result: The available versions of the publication are listed in the lower right

pane.

5. Select a version and language for the publication in the bottom right pane.

This is done in the right and left check boxes next to the output format.

6. Click the Publish button in the menu on the bottom right.

Result: A confirmation dialog displays.

7. Click OK to confirm and begin the publish process.

8. To display progress, click Refresh.

Result: Verification is complete when the Event Description is Publish Process

ended and the status says SUCCESS.

9. Click Close.



Executing the full text search

You can test the search functionality if the database contains content.

Procedure


as the admin user.

2. Select the Search tab at the top of the window.

3. Enter a word in the Search Term field then click Search.

Result:

If there is no search result, verify if a rebuild of the full-text-index collection is

required. Note that the full-text-index collection is not immediately available after

installation since it takes some time to build.

Verifying customer specific components

If you requested customizations of the out-of-the-box SDL LiveContent Architect

software, a check that they were delivered is recommended at this time.

About this task

Customizations of the delivered software may be, for example, PDF stylesheets, extra

metadata, or extra development to integrate with other systems such as SDL-TMS, PLMs,

SingleSignOns.

If you contracted for additional customizations, check that they were delivered and

functioning as required.



Chapter 6

ReferenceThe following can be referenced for additional information when installing or upgrading

your systems.

InstallToolInstallTool is a command line driven application which allows you to install SDL

LiveContent Architect, including customer-specific files and components.

InstallTool overview

InstallTool logs all installation actions and keeps an installation history which allows you

to rollback.

InstallTool was developed to:

■ reduce the time needed to install InfoShare

■ eliminate the most common mistakes when installing InfoShare

■ provide reproducible installations over DEV, QA and PROD

■ provide a framework for system integrators to deploy a customer-specific SDL

LiveContent Architect application

■ make it easier to have multiple SDL LiveContent Architect applications on one

server

Training is available on how to build and maintain the InstallTool package. Note that the

Generate InstallPlan option cannot take into account all variations of all possible setups or

all possible options. Manual actions on the InstallPlan may be required to describe your

installation. InstallTool is only available to generate the initial file.

Executing the program consists of starting InstallTool and following the instructions. The

InfoShare Database should be up and all Microsoft components and Third Party Software

should be installed.


The InstallTool

The InstallTool package contains three parts described herein.

The InstallTool package contains:

The root of your CD location

This is folder on your file system using the SDL LiveContent Architect official

structure containing the raw data.

InstallPlan.xml

The InstallPlan is generated by SDLLiveContentArchitect or an integrator. It describes

the installation. That is, it describes every install action such as the source and target

folder for every file, COM+Applications and their content, Virtual Directories,

Registry structures, Services and so on.

An install plan is built of two types of building blocks:

■ file elements (from-to copy statements)

■ webapp/commapp/registry/serviceapp (system change statements)

These building blocks are in the following three groups:

■ Core (e.g. a DLL can only be installed once)

■ Standard (the SDL LiveContent Architect standard DITA delivery)

■ Customer Specific (your customised/project files overwriting the Standard/

DITA files

Note that if you add files to the CD, you must regenerate the install plan otherwise it

does not contain extra file elements.

InputParameters.xml

This file contains a list of variables which require a value assignment from the system

administrator. The main goal is to centrally define global settings such as AppPath,

WebPath, DataPath, ProjectName, Designated OSUser, database ConnectString, and

so on.

The file contains the prompts displayed in a graphical user interface of an install

program. All these values are inserted in the necessary places during the installation.

The InputParameters file needs to assign a value for ALL variables used somewhere in

the InstallPlan.xml or in files which use variables on the CD.

Unimplemented features of the InstallTool

InstallTool must know about all SDL LiveContent Architect options, features, and

environment changes that are impossible however, some operations are not automated.

For reasons of security and complexity, the following operations are not automated:

■ Installing SQL Server or Oracle.

■ Running scripts on an existing database.

■ Creating the designated operating system user.

Reference


■ Changing the transaction timeout settings.

■ Delta upgrading of environments (only full (un)install).

■ Checking the availability of correct Microsoft components.

There are some additional, manual configurations or edits that need to be done included

in the procedure for installing or upgrading.

Database Upgrade Tool (DBUT)Database Upgrade Tool (DBUT) allows automated database upgrading.

DatabaseUpgradeTool (DBUT) overview

The DBUT allows upgrading using a DatabaseUpgradeTool, similar to InstallTool.

The tool can handle statements from the Upgrade such as:

■ Oracle RDBMs indexes, views, packages for TriDK, EventMonitor, and

InfoShare Common

■ Microsoft SQL Server indexes, views, stored procedures and functions for TriDK,

EventMonitor and InfoShare Common

■ TriDK Xml Setup and small TriDK Migration code

Several projects have indicated that there are less and less database administrator (DBA)

people involved in upgrades. The manual upgrades by non-DBApeople are error-prone. To

reduce upgrading risks and allow better database upgrade logging SDL LiveContent

Architect grouped them together in one tool, developed to:

■ reduce the time needed to upgrade the SDL LiveContent Architect database

■ eliminate the most common mistakes when upgrading

■ provide reproducible installations for DEV, QA and PROD

■ have one log file holding all database upgrade information, the

DBUpgradeTool.log, which can be used for troubleshooting or reporting issues.

DatabaseUpgradeTool should not be used:

■ to handle customer specific upgrades and/or information

■ by integrators or customers to handle their upgrades

Executing the program consists of starting DatabaseUpgradeTool and following the

instructions.

The SDL LiveContent Architect database should be up, and all database satellites and

services should be down to allow exclusive access for the tool, to the database.

Reference


The DatabaseUpgradeTool (DBUT)

The DBUT tool has three requisites described herein.

The DatabaseUpgradeTool determines the current version of the database then runs the

necessary sql scripts and TriDK XML scripts to upgrade the SDL LiveContent Architect

database to the SDL LiveContent Architect version that is installed. The

DatabaseUpgradeTool package requires:

A running database

To allow upgrading of the database, the database must be operational (up-and-running).

Note: Automatic upgrading is only supported starting from SDL LiveContent

Architect version 3.5.4. If your database is an earlier version, you must apply the

necessary Upgrade Walkthrough documents to upgrade to 3.5.4. Contact SDL

LiveContent Architect support if you do not have the necessary Walkthrough

documents to upgrade.

A server installed by the SDLLiveContent Architect InstallTool

InstallTool makes no changes to your database. However upon installation, it verifies

that a connection can be made given the current connectstring. The results ofan installation are verified entries for:

■ database name, location, user name and password

■ application, data and website paths with strict folder structures and contents

■ project name and SDL LiveContent Architect version

ATrisoft.Setup.DBUpgradeTool.Plan.xml

This file is created by SDL LiveContent Architect and describes the complete upgrade

order and is part of every SDL LiveContent Architect version.

Warning: Do not make changes to this file.

Related tasks

■ “Completing the database configuration” on page 82

Unimplemented features of theDatabaseUpgradeTool

DatabaseUpgradeTool must know about all SDL LiveContent Architect options, features,

and environment changes however, some operations are not automated.

For reasons of security and complexity, the following operations are not automated:

■ Advanced isource permission checking

■ Changing the transaction timeout settings

■ Checking the availability of correct Microsoft components

Reference


Background task componentBackground task is an application logic that is triggered on certain events, does not

require user interaction and runs in a background by a background task service. Typical

example is publishing process: it has to be triggered by user, but after it is triggered, it does

not require user input neither does it require user to wait. Instead, the publishing process

runs in a background, and user can know that it is finished by periodically checking the

status of a publication.

Starting background tasks

Typically tasks are created by plugins. For example, it is possible to register a plugin that

will run when user changes the status of the topic and create the background task.

Typically, background task does not start executing immediately after it is created. Instead

it is added to the queue from where it can be later picked up by a background task service

which executes the task. This allows better distribution of load since the task can be

picked up by the service (or server, because background task services can run on different

servers) which is less busy.

Executing background tasks

There is only one background tasks queue which is available to every background task

service. Under the hood, it is implemented as a database table, which means that once

added, task will not get lost. Practically it means that task will survive the server reboot,

and even if the task execution fails in the middle, task remains in the queue and can be

re-started.

Every background task has an event type it is created for. For example, when you trigger

the publish, there will be a background task created with event type

EXPORTFORPUBLICATION. Task can be picked up by one of installed background

task services. You can limit event types that service is allowed to pick and amount of

background tasks with the same event type that can be executed in parallel.

When task fails for one reason or another, it is automatically re-tried later. You can adjust

this behavior by changing the limit of retry attempts.

Reference


Monitoring background tasks

Typically, background tasks update the status of the execution by writing to the event log.

For example, background task that executes publishing will update the corresponding

Publish event.

Overview of the background task configuration

The background task configuration contains all information for running the background

task services and handling the background tasks.

Introduction

The configuration is stored inside the SDL LiveContent Architect database and is

accessible via the SDL LiveContent Architect web client using Settings > XML

Background Task Settings .

Tip: For detailed information, check the

Admin.XMLBackgroundTaskConfiguration.xml file.

Configuration for the background task services

The configuration can contain different types of services. Every background service runs

with a specific role. For every role the configuration describes the behavior:

■ Should the service execute background tasks?

■ How often should it poll for a new background task?

■ Should the service recover failed background tasks?

If the service is configured to execute background tasks, the configuration specifies for

which groups of event types the service is responsible. The configuration defines for every

group how many background tasks are allowed to run in parallel.

Out-of-the-box, the services are installed with the 'Default' role and will pick up all

possible background tasks. However, it is possible to configure for instance a service with

the role 'Publish' picking up only the background tasks with event typeEXPORTFORPUBLICATION

Configuration for the handlers

The configuration contains a list with handlers. Each handler is handling one eventTypeand can be executed synchronously or asynchronously. The handler is responsible for(1) starting the activator which will execute the background task and (2) handling anyexception which occurs.

Per type of activator, the configuration not only contains the necessary information to

create and run the activator, but it also contains the configuration with parameters that are

used during the execution of the background task.

Reference


Note: These parameters can contain (environment) variables that are resolved by the

background task service configuration.

The configuration also specifies if the background task must be executed within the

same process (of the service) or within a new process, and for how long the background

task is allowed to execute. Each background task is executed within the security context of

the user that submitted the background task. How the security context is created depends

on the authorization type.

When the execution of the background fails, the configuration indicates for each error

number if the background task must be retried and how many times the background task

can be scheduled to re-execute.

Related reference

■ “Admin.XMLBackgroundTaskConfiguration.xml” on page 140

Related information

■ “Understanding the availability matrix” on page 137

■ “Usage of variables inside the background task configuration” on page 135

■ “Understanding the isolation level of the handler” on page 139

Usage of variables inside the background taskconfiguration

Referencing environment variables inside the background task configuration is useful

when exact configuration value varies from server to server and therefore cannot be

single-sourced. Environment variables are resolved at the moment backgroud task service

is being initialized with the actual values set on that specific server.

Normally background task gets its parameters from the background task configuration.

This way the background task parameters are defined in a single place and can be easily

accessed by the task regardless of which server or service executes it.

However, sometimes it is not easy (or even possible) to provide a value that would work

on every server. The typical case is the file path, which may differ from one server to

another. For example, PUBLICATIONEXPORT event type needs to know the export

location, which can be a different folder depending which server picks up the task.

To solve this problem, background task configuration allows referencing environment

variables. Environment variable can be provided as a value of any element or attribute.

PUBLICATIONEXPORT references %ISHPROJECTDATAPATH% in the value

of exportlocation and exportspeclocation parameters.

<handler eventType="PUBLICATIONEXPORT">

<scheduler executeSynchronously="false" />

Reference


<authorization type="authenticationContext" />

<execution timeout="01:00:00" recoveryGracePeriod="00:1

0:00" isolationLevel="Process" useSingleThreadApartment=

"true" />

<activator>

<comIEventHandler projectName="IshPluginsIso" className=

"cout">

<configuration>

<parameters>

<parameter name="exportlocation" type="value">%ISHPROJEC

TDATAPATH%\ExportService\Data\DataExports</parameter>

<parameter name="exportspeclocation" type="value">%ISHPR

OJECTDATAPATH%\ExportService\Data\WatchFolder</paramet

er>

<parameter name="separatelng" type="value">yes</paramet

er>

<parameter name="requestedmetadata" type="ishfields">

<ishfields>

<ishfield name="FSTATUS" level="lng" />

</ishfields>

</parameter>

<parameter name="raiseevent" type="value">ZIPFILES</para

meter>

<parameter name="filenameprefix" type="ishfields">

<ishfields>

<ishfield name="FTITLE" level="logical" />

</ishfields>

</parameter>

</parameters>

</configuration>

</comIEventHandler>

</activator>

<errorHandler maximumRetries="0" />

</handler>

When the background task service is being initialized, every environment variable is

replaced with the actual value.

Remember: It is your responsibility to make sure that every environment variable

referenced in the background task configuration is set!

Remember: Setting environment variable to empty string deletes the environment

variable!

The easy way to set the environment variables for the lifetime of the background task

service is to add them to the background task service configuration file. The file is located

on the SDLLiveContentArchitect server:\Infoshare\App\BackgroundTask\

Bin\BackgroundTask.exe.config

Reference


Variables are configured in the variables element within the section

trisoft.infoShare.backgroundTask. Background task service will read these values

during initialization and use them to set the actual environment variables.

Providing the environment variable values for PUBLICATIONEXPORT in the

background task service configuration file.

<?xml version="1.0" encoding="utf-8" ?>

<configuration>

<configSections>

<section name="trisoft.infoShare.backgroundTask"

type="Trisoft.InfoShare.BackgroundTask.BackgroundTaskCon

figurationSection, Trisoft.InfoShare.BackgroundTask,

Version=11.0.0.0, Culture=neutral, PublicKeyToken=555d9f

cb450e0935"/>



</configSections>

<startup>

<supportedRuntime version="v4.0" sku=".NETFramework,Vers

ion=v4.5" />

</startup>

<trisoft.infoShare.backgroundTask>

<variables>



<add key="ISHPROJECTAPPPATH" value="C:\InfoShare\App" />

<add key="ISHPROJECTDATAPATH" value="C:\InfoShare\Data"

/>

</variables>

</trisoft.infoShare.backgroundTask>

</configuration>

Related tasks

■ “Overview of the background task configuration” on page 134

Related information


Understanding the availability matrix

The availability matrix defines which event types and how many of their instances is the

background task service allowed to execute in parallel.

Executing background tasks consumes system resources, most importantly CPU time and

system memory. Deciding which kind of tasks and how many instances of them are

allowed to run in parallel on the same server is important because this will affect stability,

throughput and overall system performance. This decision is a compromise: increasing

the task parallelism can increase the throughput (more tasks are executed within the same

amount of time), but it puts the system under pressure and may even result in situations

when your process on the server runs out of memory.

Reference


The availability matrix is configured in the background task configuration, per server

role, under matrix element. The default background task configuration is located in \

Websites\Author\EnterViaUI\

Admin.XMLBackgroundTaskConfiguration. xml , which is delivered on every

CD, and contains the latest suggested out of box values for the matrix.

<matrix>

<group name="Translations" maxExecutions="2">

<handlers>

<add ref="PUSHTRANSLATIONS" />

<add ref="CREATETRANSLATIONS" />

<add ref="CREATEPRIVATETRANSLATIONS" />

<add ref="DELETETRANSLATIONS" />

<add ref="RELEASETRANSLATIONS" />

</handlers>

</group>

<group name="Export" maxExecutions="2">

<handlers>

<add ref="EXPORTFORPUBLICATION" />

<add ref="INBOXEXPORT" />

<add ref="REPORTEXPORT" />

<add ref="SEARCHEXPORT" />

<add ref="PUBLICATIONEXPORT" />

</handlers>

</group>

<group name="SynchronizeToLiveContent" maxExecutions="1">

<handlers>


</handlers>

</group>


<handlers>




</handlers>

</group>

</matrix>

Matrix defines groups of handlers with common features or requirements or functionality.

For every group, maxExecutions attribute specifies how many instances of the specified

background task handler can be executed concurrently. The availability matrix works

proactively by controlling what the background task service will poll each time. Only tasks

that are valid for the current state of execution and the availability matrix are allowed to

begin executing.

Here is an example flow to better understand what happens when the service begins to

execute.

Reference


Looking at the first group Translations, the service will try to execute any background

task with the configured handler for example PUSHTRANSLATIONS . While aPUSHTRANSLATIONS instance is executing the service is allowed to pick one more itemfrom the queue matching the configured handlers of this specific group includingPUSHTRANSLATIONS , for example RELEASETRANSLATIONS . As long as bothbackground tasks are executing the service is not allowed to execute any more from thisgroup because the limit 2, defined in maxExecutions attribute, is reached. Once one ofthe tasks finishes then the service is allowed once again to execute background tasks fromthe this group. The above reasoning is applied to every configured group and the servicewill always try to execute a background task from any group that still hasn't reached itsmaxExecutions limit.

Important: You can only put one event type in one group. If you configure the same

event type in 2 different groups, you will get an error when trying to submit this

configuration.

Default background task configuration comes with 2 background task service roles. The

Console background task service role is optimized for testing through the console mode.

This role will restrict the process to execute a maximum of 1 background task at any given

time.

Related tasks


Understanding the isolation level of the handler

Explains the significance of isolation level configuration value for a background task

handler.

Every handler configuration in the Background task XML settings defines anisolationLevel within the execution element .

The isolation level is allowed to have one of the following values

■ None

■ Process

When the value is None then all background tasks of this handler will execute within theprocess of the background task service.

Every operating system process has a limited amount of resources that it can access. With

the background task service, we are interested in the memory limitation. The process's

maximum memory must be shared between the requirements of the service's components

but also the running background tasks.

There is also the potential of memory leaks than can be caused by a background task.

Although the background task service is optimized against memory leaks it can run out of

memory because a background task had misused the memory.

Reference


Different combinations can result to an unstable background task service process or

handler that runs out of memory. To protect the background task service but also provide

an isolated memory space to a specific background task, the Process value wasintroduced for the isolationLevel. When this configuration is enabled for a handler,the background task service will spawn a new process with the sole goal to execute thisspecific background task instance. This way the execution is isolated within the memoryspace of a specific process that is dedicated fully for the background task. Also anymemory leak caused by the handler's execution is limited to the lifetime of this processand has no effect to the background task service process. There is an overhead though. Anew process means that everything has to be loaded resulting to slower startup times of theactual execution. The total overhead depends on the load on the server.

This way the handler receives maximum memory space and also the background task

service is protected against memory leaks. The only tradeoff is a potential overhead in the

total execution time.

Based on the above, here are some suggestions to help you get to the correct value forisolationLevel of a handler:

■ If the handler of the background task requires a lot of memory then it must be

isolated.

■ If the handler has the potential to execute for long then it should be isolated.

■ Choosing Process for the isolationLevel should take into account theoverhead of the startup time compared to the average actual execution time of thehandler

Out of the box configuration has all handlers configured to execute withisolationLevel set to None. Only for EXPORTFORPUBLICATION is configured toexecute with isolationLevel set to Process because it is very memory intensive.Because it has the potential to execute for long the extra overhead in startup time is smallrelative to the average expected execution time.

Related tasks


Respository Configuration FilesDescribes the configuration files used by SDL LiveContent Architect.

Admin.XMLBackgroundTaskConfiguration.xml

The file Admin.XMLBackgroundTaskConfiguration.xml contains all information for

handling and processing background tasks.

Introduction

The background task configuration is accessible from the SDL LiveContent Architect

web client using Settings > XMLBackground Task Settings

Reference


Important:Whenever you change the background task configuration, you need torestart every Trisoft InfoShare BackgroundTask service before the changed

configuration takes effect.

This configuration file contains

■ service definitions with all information for a specific service role

■ handler definitions with the configuration for handling background tasks

Service definition

Overview

Each service definition is identified by its role (e.g. Default).

The service definition specifies which of the following components the service is

executing:

■ The poller component tries to get the next background task which can beexecuted by this service. The background tasks which can be polled are speci-fied in the availability matrix.

■ The leaseRecovery component searches for background tasks which (prob-ably) have failed because they are blocked/leased longer than the expectedexecution time extended with the grace period.

■ The aggregationRecovery component processes aggregations whichfailed during the synchronous processing

XML elements

Name Description

service Contains the service definition

service @role Identifies the behavior of the service

matrix Contains the availability matrix which

specifies for every group of event types

the maximum number of parallel

executions

group Groups event types which have similar

execution requirements

group @name The name of the group

group @maxExecutions The maximum number of parallel

executions for this group

handlers Contains the references to the handlers

within this group

add The reference to the handler with a

specific event type

Reference


Name Description

add @ref The name of the event type which needs

to match with the eventType of one of the

handler definitions

leaseRecovery Contains the configuration for the lease

recovery

leaseRecovery @isEnabled Specifies if the current service will do

any lease recovery

leaseRecovery @interval Contains a time (in TimeSpan format)

indicating how long the service will wait

before searching for another blocked

background task.

Note: As long as there are blocked

background tasks, the service will

continue working without waiting.

poller Contains the configuration for the poller

poller @isEnabled Specifies if the current service will poll

for background tasks to execute

poller @interval Contains a time (in TimeSpan format)


before searching for another background

task.

Note: As long as there are background

tasks the service will continue working

without waiting.

aggregationRecovery Contains the configuration for the

aggregation recovery

aggregationRecovery @isEnabled Specifies if the current service will do

any aggregation recovery

aggregationRecovery @gracePeriod Specifies within which period (in

TimeSpan format) the synchronous

execution has to finish the aggregation

before the service will start the recovery

aggregationRecovery @interval Contains a time (in TimeSpan format)


before searching for another aggregation

task.

Note: As long as there are aggregation

tasks the service will continue working

without waiting.

Reference


Name Description

aggregationRecovery @maximumRetries Specifies the maximum number of

attempts for the aggregation recovery

Example

<service role="Default">

<matrix>

<group name="Translations" maxExecutions="2">

<handlers>






</handlers>

</group>


<handlers>






</handlers>

</group>

<group name="SynchronizeToLiveContent" maxExecutions="1

">

<handlers>


</handlers>

</group>


<handlers>




</handlers>

</group>

</matrix>

<leaseRecovery isEnabled="true" interval="00:05:00" />


<aggregationRecovery isEnabled="true" gracePeriod="00:10:

00" interval="00:10:00" maximumRetries="3" />

</service>

Reference


Handler definition

XML elements

Name Description

handler Contains the handler definition

handler @eventType The name of the event type

scheduler Specifies how the background task is

scheduled

scheduler @executeSynchronously Indicates if the background task must be

executed synchronously or

asynchronously

authorization Specifies which authorization is used for

the background task

authorization @type Indicates the type of authorization

Note: For all legacy COM+

IEventHandler handlers, the

authorization must be

"authenticationContext".

execution Specifies how the background task is

executed

execution @timeout Contains the time out (in TimeSpan

format) for the background task

execution @recoveryGracePeriod If the background task times out, this

attribute specifies after which extra grace

period (in TimeSpan format) the service

will start the recovery

execution @isolationLevel Specifies if the background task is

executing in the same process as the

service (None) or in a new process

(Process)

execution @useSingleThreadApartment Specifies if the background task must be

executed with Single Thread Apartment

Note: All legacy COM+ IEventHandler

handlers must be executed with Single

Thread Apartment true.

activator Contains the configuration for the

activator

comIEventHandler Contains the configuration for the COM+

IEventHandler activator

Reference


Name Description

comIEventHandler @projectName Specifies the project name (e.g

ISAuthorIso)

Note:Make sure that the project is part

of the Trisoft-InfoShare-AuthorIso

COM+ application

comIEventHandler @className Specifies the class name (e.g

CTranslationMgmt)

configuration Contains all information which is

required to execute the background task.

This part is passed to the handler

executing the background task

Note: The information within the

configuration part can contain (environ-

ment) variables which are resolved with

the BackgroundTask.exe.config. For

more information: “Usage of variables

inside the background task configuration

” on page 135

errorHandler Configures the error handling

errorHandler @maximumRetries Specifies how many attempts will be

executed when a background task fails

Note: The retry mechanism relies on the

error handling of the background task

handler. If the handler suppresses the

exception or makes a new background

task for handling the retry, there can be

more or less attempts that configured.

actions Configures the actions during error

handling

add Configures the action for a specific error

add @errorNumber Contains the error number

add @action Specifies the action for a specific error.

The possible values are "Retry" or

"Ignore".

add @delay Optional attribute indicating if the retry

must be delayed or can be done

immediately

Reference


Example

<handler eventType="PUSHTRANSLATIONS">

<scheduler executeSynchronously="false"/>

<authorization type="authenticationContext"/>

<execution timeout="01:00:00" recoveryGracePeriod="00:10:

00" isolationLevel="None" useSingleThreadApartment="true

"/>

<activator>

<comIEventHandler projectName="ISAuthorIso" className="CT

ranslationMgmt">

<configuration>

<parameters>

<parameter name="batchsize" type="value">1000</parame

ter>

</parameters>

</configuration>

</comIEventHandler>

</activator>

<errorHandler maximumRetries="3">

<actions>

<add errorNumber="*" action="Retry" delay="00:01:00"/>

</actions>

</errorHandler>

</handler>

Remarks

For the interval and period attributes, we are expecting TimeSpan format. The following

table contains some examples:

TimeSpan Explanation

00:00:05 5 seconds

00:10:00 10 minutes

01:00:00 1 hour

1.00:00:00 24 hours or 1 day

24:00:00 24 days!!

Related tasks


Related information

■ “Usage of variables inside the background task configuration” on page 135

Related tasks


Related tasks


Reference


Server rolesAn overview of the different server roles which can be recognized within a SDL

LiveContent Architect installation

In a standard SDL LiveContent Architect installation some functionality relies on the

combination of some components and configurations. The combination of components

and configurations which provide a specific functionality are referenced as a "server role".

Web role

The web role provides all web endpoints like the web site, the web services and the

internal security token service

The web role provides the following web endpoints

■ InfoShareAuthor which is the SDL LiveContent Architect Web Client

■ InfoShareWS which hosts all web services

■ InfoShareSTS which is the internal security token service

Since the Web role is required on every SDL LiveContent Architect installation, an

out-of-the-box SDL LiveContent Architect installation will enable all web endpoints.

The Web role is used to serve external clients, but it is also used to serve the internal roleslike the Translation role and the Default background task role.When it is used for externalweb endpoints, the Web role can be scaled out via Network Load Balancing (NLB).

Related tasks

■ “One server for all roles” on page 106

Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Reference


Related tasks



Related tasks


Full text indexing role

This role groups everything for the full text search functionality by SolrLucene

The full text indexing role contains all components for the full text search functionality.

■ The Trisoft InfoShare SolrLucene windows service which hosts and controls

SolrLucene

■ The Trisoft InfoShare Crawler windows service which is responsible for

gathering all data that needs to be indexed by SolrLucene

How to enable the full text indexing role?

Execute the following steps in the described order to enable the full text indexing role:

■ Goto Start > Administrative Tools > Services

■ Goto the Trisoft InfoShare SolrLucene windows service

■ Open the Properties

■ Set the Startup type to Automatic (Delayed Start)

■ Click OK

■ Start the service

■ Goto the Trisoft InfoShare Crawler One windows service

■ Open the Properties

■ Set the Startup type to Automatic (Delayed Start)

■ Click OK


■ If the server can handle more load, you can also start the Trisoft InfoShare

Crawler Two windows service

Remarks

We strongly advice you to have only one deployment of this role per database. Typically

this role is installed next to one of the Web roles, but it can also be a dedicated server.

Related tasks


Reference


Related tasks


Related tasks


Related tasks


Default background task role

This role provides everything which is necessary to execute all possible background tasks

The default background task role runs the Trisoft InfoShare BackgroundTask

service configured with a role that contains all possible eventTypes.

Prerequisites

Out-of-the-box the Trisoft InfoShare BackgroundTask One service is configured with

the Default role which contains all possible eventTypes. In this case, starting the

Trisoft InfoShare BackgroundTask One service is enough to enable the default

background task role.

However, using the following steps you can double check the configuration:

■ Find the role which is used by the Trisoft InfoShare BackgroundTask One ser-

vice


■ Goto Trisoft InfoShare BackgroundTask One service

■ Click Properties

■ Check the value for Path to executable. The value should contain

something like:

C:\InfoShare\App\BackgroundTask\Bin\BackgroundTask.

exe --service "Trisoft InfoShare BackgroundTask

One" Default

The last parameter in the command line is the name of the service role.

Out-of-the-box the role will be "Default".

■ Check that the role contains all possible eventTypes.

■ Login to SDL LiveContent Architect Web Client as an administrator user.

■ Click Settings > XMLBackground Task Settings.

■ Find all eventTypes using handlers/ handler/ @eventType.

■ Goto the server definition with the role used by the service (e.g. "De-

fault") and check that all eventTypes from the previous step arereferenced in one of the groups. If necessary, add the missingeventTypes.

Reference


Note: If you had to change the configuration, you need to restart all

Trisoft InfoShare BackgroundTask services on all servers.

Make sure that all required third-party software is installed and configured properly on

this server, because if one of the dependencies is not present the background tasks will fail.

How to enable the default background task role?

Execute the following steps to enable the default background task role:


■ Goto Trisoft InfoShare BackgroundTask One service


How to scale out?

There are 2 possibilities to scale out on the Trisoft InfoShare BackgroundTask service:

■ Adding extra services with the same role

■ Introducing specialized roles with a limited set of eventTypes.

Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related information


■ “Publish role” on page 153

Related tasks


Reference


Translation role

This role provides everything for the translation related functionality

The Translation role groups all components which are required for the translationrelated functionality:

■ The Trisoft InfoShare BackgroundTask One service running with a role that

minimally includes the following eventTypes:

■ PUSHTRANSLATIONS

■ CREATETRANSLATIONS

■ CREATEPRIVATETRANSLATIONS

■ DELETETRANSLATIONS

■ RELEASETRANSLATIONS

These background tasks will create the necessary target language objects which

can be used by the TranslationBuilder to be sent for translation

■ The Trisoft InfoShare TranslationBuilder One service will group all language

objects which needs to be translated for a specified translation job

■ Finally, the Trisoft InfoShare TranslationOrganizer One service will

■ send the files to the configured translation service (SDL TMS, SDL

WorldServer, ...)

■ retrieve the translated files back from the translation service (SDL TMS,

SDLWorldServer, ...)

■ submit the translations back into the SDL LiveContent Architect repository

How to enable the translation role?

There are 2 possible scenario's for the translation role:

■ Use the translation role on a dedicated translation server

■ Use the translation role in combination with “Default background task role ” on

page 149

In the first scenario, you need to configure a new service role in XMLBackground Task

Settings

1. Login to SDL LiveContent Architect Web Client as an administrator user

2. Click Settings > XMLBackground Task Settings.

3. Add an extra service definition with role Translation

<service role="Translation">

<matrix>


<handlers>



Reference





</handlers>

</group>

</matrix>



<aggregationRecovery isEnabled="true" gracePeriod="00:10:


</service>

4. Adapt Trisoft InfoShare BackgroundTask One service to use the roleTranslation.

For both scenario's you can now continue with the following steps:

1. Configure the TranslationBuilder and the TranslationOrganizer.

2. Start all services


■ Start the Trisoft InfoShare TranslationBuilder One service

■ Start the Trisoft InfoShare TranslationOrganizer One service

■ Start the Trisoft InfoShare BackgroundTask One service (if it is not running

already)

Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related information



■ “How to create a new BackgroundTask service with a role” on page 154

■ “How to adapt the role of an existing BackgroundTask service” on page 156

Reference


Publish role

This role is the sub set of the default background task role that is responsible for exporting

and publishing.

The publish role runs the Trisoft InfoShare BackgroundTask service configured

with a role that contains the following eventTypes

■ EXPORTFORPUBLICATION

■ INBOXEXPORT

■ REPORTEXPORT

■ SEARCHEXPORT

■ PUBLICATIONEXPORT

Prerequisites

Make sure that all required third-party software is installed and configured properly on

this server, because if one of the dependencies is not present the background tasks will fail.

How to enable the publish role?

■ Configure the role in XMLBackground Task Settings:

1. Login to SDL LiveContent Architect Web Client as an administrator user.

2. Click Settings > XMLBackground Task Settings.

3. Add an extra service definition with role Publish:

<service role="Publish">

<matrix>


<handlers>






</handlers>

</group>

</matrix>


/>


<aggregationRecovery isEnabled="false" gracePeriod="

00:10:00" interval="00:10:00" maximumRetries="3" />

</service>

■ Create a Trisoft InfoShare BackgroundTask service with the role Publish.

■ Start the service.

Reference


Related tasks


Related tasks


Best practices for creating a TrisoftInfoShare BackgroundTask service with aspecific role

The topic described how to create a Trisoft InfoShare BackgroundTask service with a

specific role

Of course, there are multiple ways to make a Trisoft InfoShare BackgroundTask

service run with a specific role.

However, if possible try to create the Trisoft InfoShare BackgroundTask service

immediately with the correct role configured by adapting the install plan.

If you want to adapt the role of an existing background task service after the installation,

refer to the corresponding section in the documentation.

Related tasks


How to create a new BackgroundTask service witha role

This topic explains how to adapt the install plan to create a Trisoft InfoShare

BackgroundTask service with the specified service role.

Before you begin

■ There is no SDL LiveContent Architect installation yet.

■ Check the name of the service role via Settings > XMLBackground Task

Settings. If the name is newServiceRole, there should be a XML fragment likethe following:

<service role="newServiceRole

">

<matrix>

...

</matrix>


/>

<poller isEnabled="false" interval="00:00:10" />

Reference


<aggregationRecovery isEnabled="false" gracePeriod="0

0:10:00" interval="00:10:00" maximumRetries="3" />

</service>

About this task

The following procedure describes how to adapt the out-of-the-box configuration of theTrisoft InfoShare BackgroundTask One windows service before installing. Ofcourse, you can also add extra services by adapting the install plan.

Procedure

1. Open the install plan (__InstallTool\ installplan. xml) from a SDL

LiveContent Architect CD

2. Goto to the service definition for Trisoft-InfoShare-BackgroundTask

Result:

<serviceapp name="Trisoft-InfoShare-BackgroundTask">

<servicename>Trisoft InfoShare#!#installtool:PROJECTSUFFIX

#!# BackgroundTask One</servicename>

<filepath>#!#installtool:APPPATH#!#\App#!#installtool:PROJ

ECTSUFFIX#!#\BackgroundTask\Bin\BackgroundTask.exe

--service "Trisoft InfoShare#!#installtool:PROJECTSUFFIX

#!# BackgroundTask One" Default

</filepath>

...

</serviceapp>

3. Replace the Default role with newServiceRole

Result:

<serviceapp name="Trisoft-InfoShare-BackgroundTask">

<servicename>Trisoft InfoShare#!#installtool:PROJECTSUFFIX

#!# BackgroundTask One</servicename>

<filepath>#!#installtool:APPPATH#!#\App#!#installtool:PROJ

ECTSUFFIX#!#\BackgroundTask\Bin\BackgroundTask.exe

--service "Trisoft InfoShare#!#installtool:PROJECTSUFFIX

#!# BackgroundTask One" newServiceRole

</filepath>

...

</serviceapp>

4. Save the modified install plan

Results

An install plan that will install a Trisoft InfoShare BackgroundTask One windows service

with the specified service role

Related tasks


Reference


How to adapt the role of an existingBackgroundTask service

This topic explains how to adapt the role of an existing Trisoft InfoShare BackgroundTask

service.

Before you begin

Check the name of the service role via Settings > XMLBackground Task Settings.

If the name is newServiceRole, there should be a XML fragment like the following:

<service role="newServiceRole

">

<matrix>

...

</matrix>


<poller isEnabled="false" interval="00:00:10" />

<aggregationRecovery isEnabled="false" gracePeriod="00:10:


</service>

Warning: Using Registry Editor incorrectly can cause serious problems that may require

you to reinstall your operating system.

Procedure

1. Modify the Default service role configured for the Trisoft InfoShareBackgroundTask One windows service.

a. Open the Registry Editor with Administrator rights.

b. Open the key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Trisoft InfoShare BackgroundTask One.

c. Open the value with name ImagePath.

Result: The current data looks like.

D:\InfoShare\App\BackgroundTask\Bin\BackgroundTask.exe

--service "Trisoft InfoShare BackgroundTask One"

Default

where Default is the default service role name configured out-of-the-boxand present in the XML Background Task Settings.

d. Edit the data and change Default to the new service role namenewServiceRole

Result: The data should now look like.

Reference


D:\InfoShare\App\BackgroundTask\Bin\BackgroundTask.exe

--service "Trisoft InfoShare BackgroundTask One"

newServiceRole

e. Save the data.

Result: At this point we have configured the Trisoft InfoShare

BackgroundTask One windows service to run with the newServiceRole.

2. Start the Trisoft InfoShare BackgroundTask One windows service

Related tasks


Reference


Reference


Chapter 7

Installing desktop clientsYou can install the desktop clients with the Authoring Bridge, Publication Manager, and

Condition Manager based on the role and responsibilities of the user. The desktop clients

must have the same (matching and compatible) version of the SDLLiveContentArchitect

client tool software installed, as the software installed on the server.

Software compatibilityInformation about third party or client software is packaged, configured and tested for

this software version release.

The following information includes:

■ The Third Party software which is configured or integrated in this release of the

server side components.

■ The Third Party software such as the operating systems, databases, and runtimes

which are quality assurance tested.

Attention:While versions other than those listed may work, know that they are

not quality assured so if a problem is encountered customer support will only

accept the issue if it is reproducible for the listed versions.

■ Client hardware and software compatibility

Restriction: The relation between the SDL LiveContent Architect Authoring Bridge

and the XML editors is not specified below. Installation packages for SDL LiveContent

Architect Authoring Bridge are not always available for all xml editors.


Note: The names, trademarks, designs, logos, service marks, intellectual property, and

so on, of the products shown are exclusive property of their respective owners.

SDLLiveContent Architect and Database Servers

Hardware and operating systems, databases and versions, and other third party

software:


Note: Is deprecated and will be removed after this release.


■ Oracle RDBMs 11.2

■ Microsoft SQL Server 2008R2 SP1

■ Microsoft SQL Server 2012 SP1

■ Java Runtime 1.7.0_21 (64-bit)

■ Java Development Kit 1.7.0_21 (64-bit)

■ Java Help 2.0.05

■ Microsoft Server .NET Framework 4.5

■ Microsoft .NET Framework Visual C++ Redistributable 2012 (64-bit)

■ DITAOpen Toolkit 1.7.5



■ HTML Help Workshop 1.3

■ Microsoft Powershell v3.0

Tip:

■ Microsoft Windows 2012R2 has PowerShell v3.0 as a standard feature.

■ Microsoft Windows 2008R2 requires the Windows Management

Framework 3.0 to be installed to havePowerShell v3.0.

Desktop client

Hardware and operating systems:



■ Microsoft Windows 8.1 (x64)

Installing desktop clients


Editor software

Restriction: Only 32-bit mode for the editors is approved and qualified.

■ SDL LiveContent Create

■ JustSystems XMetaL 9.0

■ JustSystems XMetaL 8.0 and 8.0 J(apanese)







Note: Although multiple third-party XML editors are supported in this release of SDL

LiveContent Architect, use of a single third-party editor is recommended. SDL is not

responsible for how the third-party editors handle XML and DITA and the behavior might

differ for each XML editor. As a result, if you use more than one, you may find

cross-compatibility issues with the way the different editors handle DITA. If you decide

to use multiple third-party XML editors and find cross-compatibility issues with DITA,

SDL recommends that you work with the vendor of the XML editor to resolve the issue.

Web Browsers



■ Google Chrome (latest version)

■ Mozilla Firefox (latest version)

Note: The browser must be configured:

■ to allow cookies.

■ to allow pop-up windows for SDL LiveContent Create when the application is

called from the SDL LiveContent Architect web client.

Note: Designed for a minimum resolution of 1024 x 768; optimal resolution is 1280

x 1024 or higher.



Installing the Authoring BridgeThe authoring bridge is used to access the repository using an authoring tool.

Before you begin

Before installing the Authoring Bridge, please make sure that:

■ The correct version of the .NET runtime framework is installed.

■ Any previous version of the Authoring Bridge are uninstalled first.

Note: If using XMetaL on Windows 7, you must uninstall XMetaL before

uninstalling the Authoring Bridge.

■ When using XMetaL, ensure that Full Control permissions are granted to the User

group on the C:\Program Files (x86)\XMetaL and sub directories, even for users

who are defined as Local Administrator on the client PC.

About this task

You install the Authoring Bridge msi package for the xml editor software that you are

using. This is any editor that is qualified with the installed version of SDL LiveContent

Architect such as XMetaL, Arbortext Editor, or Framemaker.

Procedure

1. Double click the Authoring Bridge install package then click the Next button.

2. Enter the location where you want to install, or accept the default location.

3. You are prompted to install the Authoring Bridge for yourself, or for anyone who may

use the computer. Choose an option then click Next.

Result: The installation begins.

4. Click the Close button to exit the installation.

Note:

■ When a user launches the authoring tool after the installation, the user account

must exist or the user cannot connect to the repository. Make certain that the

user account exists.

■ Make certain that the user has full access to the directory where the editor

software is installed. This can be an issue for certain editors and versions of

Windows software.



Installing Publication ManagerThe publication manager is used to create, modify, check the status of, and produce

publications in various formats.

Before you begin

Before installing Publication Manager, you must:

■ Install the correct version of the .NET runtime framework.

■ Uninstall any previous version of the Publication Manager.

Procedure

1. Double click PublicationManagerx.x.x.msi

2. Click Next.

3. Click Next again.

4. You are prompted to install the Publication Manager for yourself, for anyone who

may use the computer. Choose an option then click Next.

5. Click Next to start the installation.

6. Click Close to exit the installation.

Installing Condition ManagerThe condition manager is used to create and manage conditions for your publications.

Before you begin

Before installing the Condition Manager tool, please make sure that:

■ All server side Condition Manager components are installed.

■ The .NET runtime framework is installed.

Procedure

1. Double click on the Condition Manager install package, ConditionManager<xx>.msi

2. Click Run.

3. Click Next to start the installation process.

4. If required, select the Enable Synchronization option then click Next.

Note: The synchronization option enables SDL LiveContent Architect to

synchronize the set of conditions with definitions from another system, for example,

such as product configurators. Note that the synchronization process needs to be

configured separately. The option during install only makes the menu items available

in the application.



5. You are prompted to install the Condition Manager for yourself or for anyone who

may use the computer. Choose an option then click Next .

Result: The installation begins.

6. When the installation is complete, click Close to exit.

Installing SDL DITA2TrisoftYou can install DITA2Trisoft without closing other applications or restarting your system.

If you upgrade DITA2Trisoft, you do not need to uninstall the existing version.

Before you begin

The Microsoft .NET Framework 2.0 Service Pack 2 or later and Microsoft .NET

Framework 3.5.x must be installed.

Procedure

1. Click the .msi file.

Result: The installation program starts.

2. Click Next.

3. Specify installation information:

a. In the Folder field, specify the directory where the application will be installed.

By default, the application is installed to C:\Program Files\Trisoft\

DITA2Trisoft\10.1.

b. In the Install SDLTrisoft2DITA for yourself, or for anyone who uses this

computer area, click either Everyone or Just me.

c. Click Next.

4. In the Confirm Installation window, click Next.

5. When the installation is completed, click Close.

Results

The following files are written to the directory where you installed DITA2Trisoft:

■ ResolutionList.xml

■ DITA2Trisoft.xsl

■ DITA2Trisoft executable file

■ .dll files

The documentation is written to the help subdirectory.



Chapter 8

AcknowledgementsSDL LiveContent includes open source or similar third-party software.

“7zip”

Is a file archiver with a high compression ratio

“ant.jar, ant-optional.jar”

Apache Ant is a Java library and command-line tool whose mission is to drive

processes described in build files as targets and extension points dependent upon each

other. The main known usage of Ant is the build of Java applications. Ant supplies a

number of built-in tasks allowing to compile, assemble, test and run Java applications.

Ant can also be used effectively to build non Java applications, for instance C or

C++ applications. More generally, Ant can be used to pilot any type of process which

can be described in terms of targets and tasks.

“DockPanel Suite”

.Net Docking Library for Windows Forms

“DITA-OT”

The DITAOpen Toolkit is a Java-based implementation of the OASIS DITATechnical

Committee's specification for DITADTDs and schemas. It contains ANT, SAXON,...

“Apache FOP”

Apache FOP (Formatting Objects Processor) is a print formatter driven by XSL

formatting objects (XSL-FO) and an output independent formatter. It is a Java

application that reads a formatting object (FO) tree and renders the resulting pages to

a specified output. Output formats currently supported include PDF, PS, PCL, AFP,

XML (area tree representation), Print, AWT and PNG, and to a lesser extent, RTF and

TXT. The primary output target is PDF.

“GeckoFX”

Gecko is a free and open source layout engine used in many applications developed

by

Foundation and the Mozilla Corporation (notably the Firefox web browser).

“globalize”

JavaScript globalization and localization. Formats and parses strings, dates and

numbers in over 350 cultures.


http://www.7-zip.org/

http://ant.apache.org/

http://dockpanelsuite.com/

http://sourceforge.net/projects/dita-ot/

https://http://xmlgraphics.apache.org/fop/

https://developer.mozilla.org/en-US/docs/Mozilla/Gecko

https://github.com/jquery/globalize

“GNUAspell”

GNUAspell is a Free and Open Source spell checker designed to eventually replace

Ispell. It can either be used as a library or as an independent spell checker. Its main

feature is that it does a superior job of suggesting possible replacements for a

misspelled word than just about any other spell checker out there for the English

language. Unlike Ispell, Aspell can also easily check documents in UTF-8 without

having to use a special dictionary. Aspell will also do its best to respect the current

locale setting. Other advantages over Ispell include support for using multiple

dictionaries at once and intelligently handling personal dictionaries when more than

one Aspell process is open at once.

Specifically we are using GNUASpell dictionaries for de-CH, de-DE, en-CA, en-GB,

en-US, es-ES, fr-FR, fr-CH, nl-NL.

“google-code-prettify”

google-code-prettify is a Javascript module and CSS file that allows syntax

highlighting in an html page.

“Hunspell”

Hunspell is the spell checker of LibreOffice, OpenOffice.org, Mozilla Firefox 3 &

Thunderbird, Google Chrome, and it is also used by proprietary software packages, like

Mac OS X, InDesign, memoQ, Opera and SDL Trados.

“InstallAnywhere”

InstallAnywhere is the leading multiplatform development solution for application

producers who need to deliver a professional and consistent cross installation

experience for physical, virtual and cloud environments. From a single project file

and build environment, InstallAnywhere creates reliable installations for on-premises

platforms - Windows, Linux, Apple OS X, Solaris, AIX , HP-UX, and IBM iSeries

- and enables you to take existing and new software products to a virtual and cloud

infrastructure.

“Jetty”

The Jetty Web Server provides an HTTP server and Servlet container capable of

serving static and dynamic content either from a standalone or embedded

instantiations. Starting from Jetty version 7, the Jetty webserver and other core

compoments are hosted by the Eclipse Foundation.

“jQuery”

jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML

document traversal and manipulation, event handling, animation, and Ajax much

simpler with an easy-to-use API that works across a multitude of browsers. With a

combination of versatility and extensibility, jQuery has changed the way that millions

of people write JavaScript.

“jQuery Highlight”

Highlights the search keywords/terms in a preview.

“jQuery UI”

jQuery UI is a set of user interface interactions, effects, widgets, and themes built on

top of the jQuery JavaScript Library.

Acknowledgements


http://aspell.net

http://code.google.com/p/google-code-prettify/

http://hunspell.sourceforge.net/

http://www.flexerasoftware.com/products/software-installation/installanywhere/

http://www.eclipse.org/jetty/

http://jquery.com/

http://johannburkard.de/resources/Johann/jquery.highlight-4.js

http://jqueryui.com/

“jSON-js”

JSON is a light-weight, language independent, data interchange format. See

“http://www.JSON.org”/ The files in this collection implement JSON encoders/

decoders in JavaScript. JSON became a built-in feature of JavaScript when the

ECMAScript Programming Language Standard - Fifth Edition was adopted by the

ECMAGeneral Assembly in December 2009. Most of the files in this collection are

for applications that are expected to run in obsolete web browsers. For most purposes,

json2.js is the best choice.

“Json.NET”

Json.NET is a popular high-performance JSON framework for .NET.

“Knockout JavaScript library”

Knockout is a JavaScript library that helps you to create rich, responsive display and

editor user interfaces with a clean underlying data model. Any time you have sections

of UI that update dynamically (e.g., changing depending on the user’s actions or

when an external data source changes), KO can help you implement it more simply

and maintainably.

“Lucene, SOLR”

The Apache Lucene™ project develops open-source search software.

“MVCWeb Projects”

Auxiliary MVCWeb Project libraries to serve InfoShareAuthor and InfoShareSTS.

Typical libraries like WebGrease, StringTemplate (antlr3), AutoMapper, RouteDebug-

ger, WebActivator,...

“nHunspell ”

NHunspell brings the spell checking, hyphenation and thesaurus to the Microsoft®

.NET Framework. NHunspell is C# library and wraps native libraries for Hunspell,

Hyphen and MyThes. One design goal of this library and wrapper is to keep the source

code of the included libraries as unmodified as possible. New versions of the base

libraries can therefore easily adopted to NHunspell.

The integrated libraries are used in OpenOffice and they work with the dictionaries

published on OpenOffice.org.

“Red Hat Linux”

Red Hat Enterprise Linux OpenStack Platform delivers an integrated foundation to

create, deploy, and scale a secure and reliable public or private OpenStack cloud. Red

Hat Enterprise Linux OpenStack Platform combines the world's leading enterprise

Linux and the fastest-growing cloud infrastructure platform to give you the agility to

scale and quickly meet customer demands without compromising on availability,

security, or performance.

“Rx .NET”

Reactive Extensions for .NET library used to validate entered values

“serializer.jar, xalan.jar”

Xalan-Java is an XSLT processor for transforming XML documents into HTML, text,

or other XML document types. It implements XSL Transformations (XSLT) Version

Acknowledgements


https://github.com/douglascrockford/JSON-js

http://www.JSON.org

http://json.codeplex.com/

http://knockoutjs.com/

http://lucene.apache.org/

http://www.microsoft.com/web/webpi/eula/msn_webgrease_eula.htm

http://nhunspell.sourceforge.net/

https://access.redhat.com/site/products/Red_Hat_Enterprise_Linux/

http://msdn.microsoft.com/en-us/data/gg577610

http://xml.apache.org/xalan-j/

1.0 and XML Path Language (XPath) Version 1.0 and can be used from the command

line, in an applet or a servlet, or as a module in other program.

“Thinktecture IdentityServer”

Front-end Secure Token Service to serve SAML tokens.

“Apache Tomcat”

Apache Tomcat is an open source software implementation of the Java Servlet and

JavaServer Pages technologies.

“WiX”

The WiX toolset builds Windows installation packages from XML source code. The

toolset integrates seamlessly into build processes.

“xercesImpl.jar”

TheApache Xerces Project is responsible for software licensed to theApache Software

Foundation intended for the creation and maintenance of:

■ XML parsers

■ related software components

“XULRunner”

XULRunner is a runtime environment developed by the Mozilla Foundation to provide

a common back-end for previewing.

Acknowledgements


http://thinktecture.github.io/

http://tomcat.apache.org

http://wixtoolset.org/

http://xerces.apache.org/

https://developer.mozilla.org/en-US/docs/XULRunner

Documents

SDLLiveContentArchitectInstallation Guidesdl.ssl.cdn.sdlmedia.com/file/635418983021087870CW.pdfSoftwarecompatibility Information about third party or client software is packaged, configured