sdlknowledgecentercontentmanager 12.0.0 · pdf filexulrunner xulrunner is a runtime...

SDL Knowledge Center Content Manager12.0.0 - Upgrade Guide

Content Manager 12.0.0

December 2015

Welcome to Content Manager Upgrade Guide

This document presents a description of all needed checks and actions necessary for an

upgrade from the previous version of Content Manager to the latest version.

Legal NoticesCopyright and trademark information relating to this release.

Copyright © 2011-2015 SDL Group.

ii SDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

SDL Group means SDL PLC. and its subsidiaries and affiliates. All intellectual property

rights contained herein are the sole and exclusive rights of SDL Group. All references to

SDLor SDLGroup shall mean SDLPLC. and its subsidiaries and affiliates details of which

can be obtained upon written request.

All rights reserved. Unless explicitly stated otherwise, all intellectual property rights

including those in copyright in the content of this website and documentation are owned

by or controlled for these purposes by SDL Group. Except as otherwise expressly

permitted hereunder or in accordance with copyright legislation, the content of this site,

and/or the documentation may not be copied, reproduced, republished, downloaded,

posted, broadcast or transmitted in any way without the express written permission of

SDL.

SDL Knowledge Center 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 4

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.

iiiSDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

Customer supportOn the SDL Support page you can find information to request assistance, browse the

knowledge base or log a ticket for the technical support team.

About this task

If you need to contact customer or technical support to request assistance, go to the SDL

Support page. From here, click a tab link to access the desired support area, for example

Product support or Knowledge base.

Note: You need to have a valid SDL user account to log in and submit a ticket. If you

do not have one, contact the designated representative at your site, as identified in your

service agreement.

To log a support ticket, follow these steps:

Procedure

1. On the “SDL Support” page, click the Product support tab link.

2. In the product table, browse for the SDL product you want to log a ticket for, then

click the Log a Ticket link. For further details about the support provided for the

product, click the Learn more tab link.

AcknowledgementsSDL products include open source or similar third-party software.

7zip

Is a file archiver with a high compression ratio.

Apache Ant

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.

iv SDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

http://www.sdl.com/support/

http://www.sdl.com/support/

http://www.7-zip.org/

http://ant.apache.org/

http://dockpanelsuite.com/

http://sourceforge.net/projects/dita-ot/

https://http://xmlgraphics.apache.org/fop/

GeckoFX

Gecko is a free and open source layout engine used in many applications developed by the Mozilla 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.

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

InstallAnywhere

InstallAnywhere is the leading multi-platform 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-cookie

jQuery plugin for reading, writing and deleting cookies.

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.

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.

vSDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

https://developer.mozilla.org/en-US/docs/Mozilla/Gecko

https://github.com/jquery/globalize

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/

https://github.com/carhartl/jquery-cookie

http://johannburkard.de/resources/Johann/jquery.highlight-4.js

http://jqueryui.com/

https://github.com/douglascrockford/JSON-js

http://www.JSON.org

http://json.codeplex.com/

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.

Apache Lucene, SOLR

The Apache Lucene™ project develops open-source search software.

MVCWeb Projects

Auxiliary MVCWeb Project libraries to serve ISHCM and ISHSTS. Typical libraries like WebGrease, StringTemplate (antlr3),

AutoMapper, RouteDebugger, 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 andMyThes. 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

Xalan-Java

Xalan-Java is an XSLT processor for transforming XMLdocuments into HTML, text, or other XMLdocument types. It implements

XSL Transformations (XSLT) Version 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, Tomcat Embed

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.

Apache Xerces

The Apache Xerces Project is responsible for software licensed to the Apache 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.

vi SDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

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/

http://thinktecture.github.io/

http://tomcat.apache.org

http://wixtoolset.org/

http://xerces.apache.org/

https://developer.mozilla.org/en-US/docs/XULRunner

ContentsLegal Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Customer support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Chapter 1 Content Manager requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Content Manager hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Content Manager software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Installer User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2 Content Manager upgrade guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Preparing for the upgrade - backing up the database . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Backing up the project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Backup the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Backing up the closed data files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Export from Oracle database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Uninstalling Content Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Installing and configuring the database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Oracle RDBMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Oracle database configuration requirements . . . . . . . . . . . .. . . . . . . . . . . . 20

Copy template files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Activating the Oracle Listener service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Creating the Oracle 11 database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Creating the Oracle 12 database with a template . . . . . . . . . . . . . . . . . . 24

Importing the data with Oracle 11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Importing the data with Oracle 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Enabling network transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Upgrading the Content Manager server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Configuring database connection strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

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

Preparing for the server upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Executing the InstallTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Enabling network transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Post upgrade tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Verifying Microsoft SQL System Administration role permissions . . . . . . . . . 48

Running DBUpgradeTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Adding the relying party entries for webUI and WCF Services for

commercial STS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Configure Security Token Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Configure application server for Windows Authentication . . . . . . . . . . . . 56

viiSDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

Configure SQL Server database for Windows Authentication . . . . . . . . 57

The Administrator setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Creating TRANSLATORSERVICE role and ServiceUser user . . . . . . . . . . . . 60

Translation management integration configuration . . . . . . . . . . . . . . . . . . . . . . . 61

Application Configuration for TranslationBuilder . . . . . . . . . . . . . . . . . . . . 61

Application configuration for TranslationOrganizer . . . . . . . . . . . . . . . . . . 62

Validation XML configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Enabling services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Configuring Content Manager to support team editing . . . . . . . . . . . . . . . . . . . 76

Installing Content Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Enable the Quality Assistant plugin for Content Editor . . . . . . . . . . . . . . . . . . . 79

Introduction to SDL Knowledge Center scalability . . . . . . . . . . . . . . . . . . . . . . . 80

SDL Knowledge Center environment with ISHSTS . . . . . . . . .. . . . . . . . . 82

SDL Knowledge Center environment with ADFS . . . . . . . . . . . . . . . . . . . . 84

Front end server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Back end server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Network load balancing . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 97

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

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

Verifying the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Rebuilding the full text index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

How-to references for advanced users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Adding the bookmap template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Adding a topic template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Adding an image template . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . 111

Adding a publication template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Content Delivery upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Advanced topics for installers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

InstallTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Database Upgrade Tool (DBUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Background task component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Repository configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Server roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Best practices for creating a Trisoft InfoShare BackgroundTask

service with a specific role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Setting the MSDTC timeout on Microsoft Windows Server . . . . . . . . . . . . . . 165

Configuring MSDTC to listen on a specific port . . . . . . . . . . . . . . . . . . . . . . . . . 166

Firewalls and blocked ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Installing desktop clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Installing the Authoring Bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Installing Publication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Installing Condition Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Installing Content Importer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Chapter 3 Troubleshooting the database installation . . . . . . . . . . . . . . . . . . . . . . . . 177What to do if Oracle database import fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

What to do in case of "ORA-12638" error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

viii SDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

Chapter 1

Content Manager requirementsAll requirements for the Content Manager application, web, and batch servers are

described.

Content Manager hardware requirementsBefore you install or upgrade the server, you must check the hardware requirements prior

to completing the pre-installation tasks.

Hardware

The performance of Content Manager 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. Content Manager 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 Content Manager 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.

Database

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 Content Manager should be

checked against the specifications supplied by the database vendor for the current

hardware on which it is installed.

An example Microsoft Windows server machine. could minimally have the following

specifications:

■ CPU: dual core Xeon® 2.0 GHz

■ Internal Memory: 8 GB RAM

1SDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

Database storage demands must account for the following:

■ All XML content and related metadata

■ All images

■ Published output (for example: PDF, CHM, and so on).

As a rule of thumb, multiply the size of all images by 3 to get an estimate of the

starting size for your database. A normal documentation project can use 100 GB for

its storage needs for about 2 to 3 years.

Web and Application layer

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

to scale and have redundancy over multiple servers. The Content Manager System

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

variations, you may want to contact the 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.

A recommended server configuration should include a quad core Xeon® X5550 2.66

GHz processor system with at least 12 MB Level 3 cache and 8 GB RAM, dual port

Gigabit Ethernet, and a smart array RAID controller with 256 MB memory.

Storage demands: The consumers of storage are the actual installed Content Manager

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 then suggest a dual CPU server. A second server can be added quite easily

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

Client requirements

Client machines running desktop applications such as Publication Manager should

have at least a 2.0 GHz CPU and 4 GB RAM.

Network requirements

Due to its stateless model, Content Manager passes large quantities of data. A 10 Mbit

network connection provides a more than acceptable throughput.

Content Manager requirements

2 SDL Knowledge Center Content Manager 12.0.0 - Upgrade Guide

Content Manager software requirementsInformation about third-party or client software that is packaged, configured and tested

for this software version release.

The following overview includes information about:

■ Third-party software that is configured or integrated in this server-side compo-

nent release.

■ Third-party software, such as the operating systems, databases, and runtimes that

are quality-assurance tested.

■ Client hardware and software compatibility.

Third Party Software supported versions

We specify the third party tools version we used during SDL Knowledge Center

release testing. Other versions work as well as long as the third party tools can confirm

compatibility with our tested version. Some of our dependencies have shorter release

cycles than SDL Knowledge Center, such as Java runtimes, web browsers or XML

editors, you working on a later version than the one specified in this documentation is

therefore to be expected. Should you discover an incompatibility between one of

these later version of a third party tool and Knowledge Center, report an issue to

support. Customer support will accept the issue only if it is reproducible for the listed

versions.

Restriction: The relation between the Authoring Bridge and the XML editors is not

specified below. Installation packages for Authoring Bridge are not always available for

all XML editors.

Note: Names, trademarks, designs, logos, service marks, intellectual property, and so on,

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

Application server

■ Microsoft Windows Server 2012R2 (64-bit)

■ Java Runtime 1.8.0_60 (64-bit)

■ Java Development Kit 1.8.0_60 (64-bit)

■ Java Help 2.0.05

■ Microsoft Server .NET Framework 4.5

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

■ Microsoft PowerShell 4.0.

■ DITAOpen Toolkit 1.8.5



Tip: Standard installation package holds a DITAOpen Toolkit version.

■ Microsoft XML Parser 6.0 Service Pack 2 (32-bit and 64-bit)

Tip:Microsoft Windows 2012R2 ships with XML Parser 6.0 as part of the

Application Server role.

■ Microsoft XML Parser 4.0 Service Pack 3 (32-bit)

■ HTML Help Workshop 1.3

■ AntennaHouse XSL Formatter 6.2 M12

Database server

Database systems and versions

■ Oracle RDBMs 11g

■ Oracle RDBMs 12c

■ Microsoft SQL Server 2014 SP1

■ Microsoft SQL Server 2012 SP2

Client

■ Microsoft Windows 7 (32-bit)


■ Microsoft Windows 8.1 (64-bit)


■ Internet Explorer 11

■ Internet Explorer 10

■ Google Chrome (latest version)

■ Mozilla Firefox (latest version)

■ Content Editor

■ JustSystems XMetaLAuthor Enterprise 10.0

■ JustSystems XMetaLAuthor Enterprise 9.0

■ JustSystems XMetaLAuthor Enterprise 10.0 Japanese

■ Syncro Soft <oXygen/> XMLAuthor 17.1 (Windows 32-bit)

■ Syncro Soft <oXygen/> XMLAuthor 16.1 (Windows 32-bit)

■ PTCArbortext Editor 7.0 (Windows 32-bit)

About XML editors

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



Note: Although multiple third-party XML editors are supported, we recommend

choosing and using a single third-party editor. SDL is not responsible for third-party

editor XML and DITA handling; behavior may differ depending on the XML editor. If

you use more than one editor, you may experience cross-compatibility issues related

to DITA handling. If you decide to use multiple third-party XML editors and if you

experience cross-compatibility issues with DITA handling, contact the XML editor

vendor to address these issues.

About web browsers

Note: The browser must be configured to allow the following:

■ Cookies

■ Pop-up windows for Content Editor, when the application is called from the

Content Manager web client.

Note: Designed for a minimum resolution of 1024 x 768 pixels. Optimal resolution:

1280 x 1024 pixels or higher.

Installer User RequirementsThe users who can install Content Manager must have permissions and access as required.

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

install the Content Manager 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 Content Manager database. The user must be

able to:

■ create a database

■ run scripts to set up the database



Chapter 2

Content Manager upgrade guidePreparation, upgrade, post-upgrade tasks.

Preparing for the upgrade - backing up thedatabase

You should always make a complete backup of the Content Manager environment before

upgrading so you can restore to the current environment if necessary.

Note:

■ Before beginning the upgrade it is recommended that you warn all users that the

system will be temporarily unavailable.

■ No updates should be allowed beyond this point in time.

■ You should plan to copy the whole of the Content Manager environment to a

secure destination.

■ The whole of the Content Manager environment includes all Content Manager

websites, Content Manager website components, the Full Text Collection, the

database backup(s), and the Content Manager registry keys.

■ Identify and plan to backup any custom files and information in the same way.

Backing up the project

This backup operation makes a copy of everything installed and generated in this project.

About this task

This does a backup of the business components and used configuration and makes a full

copy of:

■ the Full Text Collection

■ all PublishService, ImportService, ExportService generated data

■ all generated logging


Note: This backup can take a lot of time. You can do an initial clean up of all data that

needs no backup or do a manual backup of the necessary files and settings.

Procedure

1. Login to the Windows system as the Administrator user or a user with Administrator

privileges (a user in the Administrator group).

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

5. Select the project that you want to backup and a location where you can safely store

everything.

Backup the database

Follow the procedure to backup the Microsoft SQL Server or Oracle RDBMs database

based on your current configuration.

Note: The complexity of the Oracle backup is much greatger than that of the SQL

Server. The the SQL Server algorithm is described by its Windows UI. The Oracle

procedure is explained by command line tools so that it is valid for both a Windows and

UNIX environment).

Backing up Microsoft SQL Server

Follow this procedure to backup your SQLServer.

Procedure

1. Open SQL Server Management Studio.

2. Open the Databases folder.

3. Right click on your database

4. Select Tasks > Back Up.

5. Backup type should be Full.

6. Enter a Name for the backup.

It is recommended that you use the format: yyyymmdd.projectname.bak to name thebackup.

7. Ensure that Backup set will expire: After 0 days

8. In the Destination pane at the bottom of the window, click Add.

9. Add a destination folder such as: yyyymmdd.projectname\SQLServer\Dump.

Content Manager upgrade guide


10. Click Options in the left pane and verify that the information is accurate:

■ Backup to the existing media set.

■ Append to the existing backup set.

■ Verify backup when finished.

11. Click OK.

The backup of the database starts.

Backing up Oracle RDBMs

The description makes use of command line programs so that a person with a mixture of

Windows and UNIX knowledge can follow the procedure on any Oracle hosting machine.

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.

The procedure includes suggestions about how to do the steps. It is out of scope of this

document to give a step-by-step explanation on basic Oracle maintenance. An Oracle DBA

can choose any option desired, as long as an exact restoration of the Content Manager

environment can be made.

Note:

■ The description refers to a Windows environment concerning system variables

and file paths.

■ The default database name is ISH.

■ The procedure is different depending on the Oracle version you will import back

in.

Backing up the closed data files

You can just make a copy of closed data files. This action applies to cases when you are

not planning to change the location of the files, the character set or the Oracle version, so

you won't need to perform a complete export.

Procedure

1. For making a copy of closed data files, open a command line window and set the

ORACLE_SID and ORACLE_HOME environment variables. For example, on

Windows:

set ORACLE_SID=ISHset ORACLE_HOME=C:\Oracle\Product\<version>\db_1

2. Start SQLPLUS /NOLOG:



SQLPLUS /NOLOG

3. Force a database to close by typing the following. The goal is to do this quickly

enough so that no-one can make a connection and alter the database, ensuring that

you copy a stable file version.

shutdown abortstartup openshutdown normal

All pending connections are closed by force. The startup open checks the database

and the shutdown normal closes all database files.

Export from Oracle database

A full database export is the way to go when you need to be independent from version,

character set or location. Exporting from the previous Oracle version for importing to the

latest supported version requires a specific procedure.

Exporting for an Oracle 11 import

Exporting the database when planning to import it back in Oracle 11 requires the use of

the export command.

Procedure

1. Navigatetothefile\Database\Dump\Oracle\export\export.par.

2. Edit the export.par file to ensure the correct tnsnames entry and location of

database log and dump file.

3. In a command prompt window, go to the directory where the export.par file is

located and issue the following command:

exp parfile=export.par

The dump file is exported in the dump directory, you can import it back after you

have uninstalled the old version of Content Manager.

Exporting for an Oracle 12 import

Exporting the database when planning to import it back in Oracle 12 requires the use of

the expdp command.

Procedure

1. Copy the file expdp.par from C:\IShCD\ yyyymmdd.CD.InfoShare<

version_num>.ProjectName.IT\Database\Dump\Oracle\expdpto

the dump directory (DATA_PUMP_DIR) on the database server.



Note: The dump directory should be in the line of C:\Oracle\ admin\ <

DatabaseName>\dpdump.

2. Goto the database server.

3. Adapt the file names for the DUMPFILE and LOGFILE in the expdp.par file.

4. Open a Command Prompt and set the following variables:

Set ORACLE_SID=ISH

Set ORACLE_HOME depending on your Oracle version:

Oracle 11 set

ORACLE_HOME=c:\oracle\product\11.

2.0\dbhome_1

Oracle 12 set


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

5. Start sqlplus as sysdba

6. Check if there is a dump directory "DATA_PUMP_DIR"

SELECT directory_path FROM dba_directories WHERE directory_name =’DATA_PUMP_DIR’;

7. Make sure the dedicated isource database user has read and write access to the directory

GRANT read, write ON DIRECTORY data_pump_dir TO isource;

8. Exit SQLPlus, so you are back at the command prompt.

9. Execute the following command

expdp parfile="C:\Oracle\admin\<DatabaseName>\dpdump\expdp.par"

10. Provide the user name and password for the dedicated isource database user.

The dump file is exported in the dump directory, you can import it back after you

have uninstalled the old version of Content Manager.



Uninstalling Content ManagerRemoval of all Content Manager items of the installed environment is required before

starting an upgrade.

About this task

All items which were installed and in the installplan.xml are removed from your system.

Items which are not removed are:

■ the Full Text Collection,

■ all PublishService, ImportService, ExportService generated data,

■ all generated logging,

■ files that have changed after the initial installation (such as configuration files)

Procedure

1. Login to yourWindows system as theAdministrator user or a user withAdministrator

privileges (a user in the Administrator group).

2. In Windows Explorer, go to the location where the previous installation software is

located, or to the CD that was used to install the current environment, to access the

correct version of the tool for uninstalling the software. Go to:

C:\IShCD\yyyymmdd.CD.InfoShare<version_num>.ProjectName.IT\

__InstallTool


4. Select the uninstall option.

5. Select the project that you want to remove.

6.

Note: If the tool ends with errors you can always go into installtool.log to check

what went wrong.

Let Installtool run and everything will be uninstalled when it's done



Installing and configuring the databaseserver

The Content Manager 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 Server

Database 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 Content Manager 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 as Dictionary 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 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

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

Creating a database

Create a database for the Content Manager data collection.

Procedure

1. Open SQL Server Management Studio.

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

3. Enter a database name (e.g. InfoShare).

4. Click Options in the left pane.

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 2012 enter: SQL Server 2012 (110)

■ If installing on SQL Server 2014 enter: SQL Server 2014 (120)

8. Click OK.



Importing data from the SQL dumpfile

Import the sample Content Manager 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 General tab of the Restore Database window, select that you want to restore

from a Device.

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

b. Click Add in the resulting Specify Backup window.

c. Locate and select the latest available dump provided on the installation CD in:

■ for SQLserver 2012:\Database\Dump\SQLServer2012

■ for SQLserver 2014:\Database\Dump\SQLServer2014

Note: If the SQL server 2014 dump is not provided, you can use the

SQL server 2012 dump.

d. Click OK.

e. The Database field under Source is populated with the name of the database

in the backup file.

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

created (e.g. InfoShare). This is the database that is to be populated with the datafrom the backup/dump file.

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

default to another database name.

4. In the Files tab of the Restore DatabaseWindow:

a. For the Rows Data select the data file path of the database you created (e.g.C:\Program Files\Microsoft SQL Server\MSSQL11.MSSQLSERVER\MSSQL\DATA\InfoShare.mdf).

b. For the Log select the log file path of the database you created (e.g.C:\Program Files\Microsoft SQL Server\MSSQL11.MSSQLSERVER\MSSQL\DATA\InfoShare_log.ldf).

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

6. Click OK. The database is restored.

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

a. Open the Properties window,

b. Go to the Files tab,



c. Check and adapt (if necessary) the logical name.

File type Logical Name

Rows Data Set Logical Name to <dbname>(e.g. InfoShare)

Log Set Logical Name to <dbname>_Log (e.g. InfoShare_Log)

d. 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 that was

created when importing the sample data, as well as the schema of the same name if one

exists.

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 if one is present.

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, locate and open the tree under

Infoshare.

2. Open Security > Schemas.

3. Right-click on isource if it appears in the list, then click Delete.

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

ADelete 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…

ALogin - New window displays.

4. In the Login name field, enter an user name (e.g. isource).

5. SQL Server Authentication should be selected. Enter a Password (e.g. isource) and

Confirm password for SQL Server Authentication.

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

Note: Keep in mind to change the connect string whenever you change the password

of the database user!

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.

This allows the Content Manager DatabaseUpgradeTool (DBUT) to fully execute all

necessary tasks to update your database with new releases.

: If you want to reduce the server roles for everyday working, you can take a look at

“Optionally minimize the database user's roles and permissions ” on page 18

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.



: If you want to reduce the permissions for day to day usage, you can check out the

information in: “Optionally minimize the database user's roles and permissions ” on

page 17

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.

Optionally minimize the database user's roles and permissions

Describes how to optionally reduce the roles and permissions of the database user for

everyday usage

About this task

Optionally execution to minimize the permissions for normal operations outside of the

upgrade time frame.

Remember: The following steps must be executed by another user which is an

administrator on the database server.

Procedure

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

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

3. Right-click on the database user (e.g isource) and click on Properties

4. Revoke server role sysadmin

The server role sysadmin allows to perform any activity on the server. Content

Manager DBUpgradeTool (DBUT) requires this server role for instance to create the

standard database job and add extra (error) messages. So, in order to allow DBUT to

fully execute all necessary tasks during an upgrade, we advice to grant the server

role sysadmin again before every upgrade. However, during everyday usage you can

revoke sysadmin using the following steps:

a. Click Server Roles in the left pane.

b. Deselect sysadmin in the right pane. Make sure that public is still selected.

5. Revoke database role db_owner

Remember: Revoking the database role db_owner only makes sense after already

revoking the server role sysadmin.

a. Click User Mapping in the left pane.



b. Select the correct database in the upper right pane.

c. In the bottom pane, uncheck the box next to db_owner. Make sure that

public is still selected.

6. Click OK.

7. After revoking the database role db_owner, add the minimal required permissions

In order for the Content Manager application to work without issues, the database user

need the following permissions

■ SELECT

■ INSERT

■ UPDATE

■ DELETE

■ CREATE TABLE

■ CREATE VIEW

■ CREATE FUNCTION

■ CREATE PROCEDURE

■ REFERENCES

■ ALTERANY SCHEMA

■ EXECUTE

You can grant the necessary permissions to the database user using the following

steps:

a. In SQL Server Management Studio open the file corresponding with your

SQL Server version

■ C:\InfoShare\App<projectsuffix>\TriDK\Database\

SQLServer2012\Create\GrantPermissionsToDBUser.

sql

b. If your database user is not "isource", change "isource" to the correct database

user

c. Run the script as an administrator

d. Connect with the database user (e.g. isource) and run the following query to

check that the database user has the required permissions

SELECT * FROM fn_my_permissions(null, ’DATABASE’)



Oracle RDBMS

The 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 instructions refer to a Windows environment when noting system

variables and file paths.

These instructions guide a knowledgeable person through the configuration so that no

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

pertaining to each step.

Note: The default database name is ISH.

Note: In case of issue, be sure to check the troubleshooting section dedicated to the

database installation.

Configuring Oracle RDBMS


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

All servers require a reboot before new settings become active.

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.

The provided configuration instructions are written for administrators who have

knowledge of the Oracle and Microsoft environments.

Make sure that you satisfy the following requirements before you begin:

■ Having a DBA role is required for a database migration.

■ Reboot after Oracle installation for making sure that all Oracle environment

settings are available to you.

Also note:

■ All executed actions should be done in the same command window for making

sure that shell specific settings, such as ORACLE_SID or ORACLE_HOME, areavailable.

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



Copy template files

The Content Manager database is created using the Oracle Database Configuration

Assistant. When it is installed with the Assistant, Content Manager uses a template with

SPFile.

To prepare your environment for the Oracle configuration, you must first copy the template

file to your server. The path is different depending on the Oracle version you are using.

The versions mentioned below have been quality tested with this version of Content

Manager.

Table 1: Oracle 11.2

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

Table 2: Oracle 12.1

From: \Database\Dump\Oracle\Oracle121.Admin\DBCATemplates\SDL-

Trisoft.InfoShare-Database-Template.dbt

To: C:\Oracle\product\12.1.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.

Activating the Listener service for Oracle 11

Steps for activating the Listener service for Oracle 11.2

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.

This ensures that an OracleOraDb<nn>g_home1TNSListener service exists in theServices 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.

Activating the Listener service for Oracle 12

There are two possibilities for activating the Listener service for Oracle 12.2. Either a

general listener is available and you then select this one, or you need to create a specific

listener for your database and then you activate that one. Here is the procedure for creating

a new listener and activating it.

Procedure

1. Start the Net Configuration Assistant. This Assistant is provided by Oracle.

2. Select the "Listener Configuration" radio button on the opening window, then click

"Next".

3. Select the "Add" radio button on the following window, then click "Next".

4. Type in a name for the new listener, then click "Next".

5. Choose "TCP" as selected protocol in the list, then click "Next".

6. Select the " Use the standard port of 1521" radio button on the following window,

then click "Next". You may specify another port instead if you know what you're doing.

7. Complete the creation process by clicking "Next" again.

Creating the Oracle database

You must create the Oracle database instance for the Content Manager repository. This is

the place where the data is stored.

Creating the Oracle 11 database

The Oracle 11 database is created using the Database Configuration Assistant. The actions

performed with this Assistant are version dependent.

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.

Optionally you are prompted with:

Configuring database with Database Control requires alistener to be configured in the current Oracle home. Youneed to run Netca to configure a listener before you canproceed. Otherwise you may choose to continue withoutDatabase 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.

The database is created.

Creating the Oracle 12 database with a template

The Oracle 12 database is created using the Database Configuration Assistant (DCA).

The creation steps are version dependent and can be performed with the help of a template.

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. GotoCD_Package\Database\Dump\Oracle\Oracle121.Admin\DBCATemplates where CD_Package is the root folder of the CD package.

3. Open the ReadMe.txt, and copy the template "

SDL-Trisoft.InfoShare-Database-Template.dbt" to the location specified in the

ReadMe.txt file.



4. Start the Database Configuration Assistant (DCA). This Assistant is provided by

Oracle.

5. On the "Database Operation" page, select the "Create Database" radio button, then

click "Next".

6. On the "Creation Mode" page, select the "Advanced Mode" radio button, then click

"Next".

7. On the "Database Template" page, select the "

SDL-Trisoft.InfoShare-Database-Template" template, then click "Next".

8. On the "Database Identification" page, type in the "Global Database Name", then

click "Next".

9. On the "Management Options" page, check the "Configure Enterprise Manager (EM)

Database Express" box, and specify the port in the field below, then click "Next".

Note:Make sure that the specified port is unique.

10. On the "Database Credentials" page, fill in the required fields (passwords), then click

"Next".

11. On the "Network Configuration" page, select the Listener that was previously created

for this database (refer to the chapter dedicated to the activation of the Listener

service), then click "Next".

12. Leave the currently selected defaults on the "Storage Location" page, just click

"Next".

13. On the "Database Options" page, leave all the boxes in the "Database Components"

page unchecked, just click "Next".

14. On the "Initialization Parameters" page, leave the currently selected defaults but

make sure the "Use Automatic Memory Management" box is checked, then click

"Next".

15. On the "Creation Options" page, click on "Create the database", then click "Next".

16. Finish/complete the creation of the database.

Creating the designated ISOURCE database user

You must create the ISOURCE designated database user for the new database.

Procedure

1. If the folder C:\oracle\ admin\ ISH\create on the server does not exist, createit now.

2. CopyCD_Package\Applications\TriDK\Database\Oracle\create\isrcuser.i (where CD_Package is the root folder of the CD package) to the folderC:\oracle\ admin\ ISH\create and make sure the file is writable.

The examples are specific for Windows. Be sure to modify the paths, commands and

username/passwords to match your environment.

3. OpenC:\oracle\admin\ISH\create\isrcuser.i inNotepad and if neededadapt the username and password of the designated user to match your environment.



4. Open a Command Prompt and set the following variables:

Set ORACLE_SID=ISH

Set ORACLE_HOME depending on your Oracle version:

Table 3: Creating the designated ISOURCE database user

Oracle 11 set


2.0\dbhome_1

Oracle 12 set


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

5. Start SQLPLUS /NOLOG from the same window:

SQLPLUS /NOLOG

6. At a command prompt where the variables for ORACLE_SID and ORACLE_HOME

are set, type:

SPOOL C:\oracle\admin\ISH\create\dbadmin2.logCONNECT SYS/CHANGE_ON_INSTALL AS SYSDBA@C:\oracle\admin\ISH\create\isrcuser.iCONNECT ISOURCE/isource@?/RDBMS/ADMIN/catdbsyn.sqlSPOOL OFF;

Note: If the folder C:\oracle\ admin\ ISH\ create is missing the error

SP2-0606: Cannot create SPOOL file "C:\oracle\admin\ISH\create\dbadmin2.log, is

displayed when issuing the command below.

Importing the data

Import the sample data either for validating the configuration or for training purposes.

This action follows different paths depending on the Oracle version you are using.



Importing the data with Oracle 11

When you are working with Oracle 11 the use of "import" (imp) is recommended.

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

Importing the data with Oracle 12

When you are working with Oracle 12 the use of "Data Pump Import" (impdp) is

recommended. First you grant the ISOURCE user write permissions, then you proceed to

the import.

Procedure

1. If the folder C:\oracle\ admin\ ISH\dpdump on the server does not exist, createit now.

2. CopyCD_Package\Database\Dump\Oracle\impdp\impdp.par(where

CD_Package is the root folder of the CD package) to the folder C:\oracle\ admin\ISH\dpdump and make sure the file is writable.

The examples are specific for Windows. Be sure to modify the paths, commands and

username/passwords to match your environment.

3. OpenC:\oracle\admin\ISH\dpdump\impddp.par inNotepad and adapt thename of the export file (DUMPFILE parameter) and, if needed, the designated schemaowner (SCHEMAS parameter).

4. Open a command prompt

5. Set ORACLE_SID=ISH



6. SetORACLE_HOME=C:\Oracle\product\12.1.0\dbhome_1

7. Start SQLPlus: sqlplus SYS AS SYSDBA

8. Make sure the ISOURCE user has read and write access to the folder:

GRANT read, write ON DIRECTORY data_pump_dir TO isource;

9. Make sure the file from the Data Pump Export is copied to the DATA_PUMP_DIR:

SELECT directory_path FROM dba_directories WHERE directory_name = ’DATA_PUMP_DIR’;

10. Exit SQLPlus, so you are back at the command prompt.

11. For the import, execute the following command:

impdp isource parfile="C:\oracle\admin\ISH\dpdump\impdp.par"

Validating the database

The newly imported Oracle database needs some packages, triggers and more to be

(re-)compiled for the database to be valid.

Before you begin

You first need to make sure that ORACLE_SID and ORACLE_HOME variables are set

correctly (this is normally done during the ISOURCE user creation).

1. Open a Command Prompt and set the following variable:

Set ORACLE_SID=ISH

2. Set ORACLE_HOME depending on your Oracle version:

Table 4: Creating the designated ISOURCE database user

Oracle 11 set


2.0\dbhome_1

Oracle 12 set


1.0\dbhome_1

Procedure

1. Start SQLPLUS /NOLOG from a shell where the ORACLE_SID and ORACLE_

HOME variables are set correctly. At the command prompt, type:

SQLPLUS /NOLOG

2. Enter the following statements to validate the database. Do not use a script file.



CONNECT SYS/CHANGE_ON_INSTALL AS SYSDBA@?/rdbms/admin/utlrp;

All objects in the database should be valid.

Editing the tnsnames.ora database connection file

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

on systems that communicate with the Oracle database server. This file defines the

information for a connection to the database server and to the database instance for the

Content Manager repository.

About this task

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.

Analyzing the database

After the import, you need to run a script that will create statistics used by the queries.

Before you begin

You first need to make sure that ORACLE_SID and ORACLE_HOME variables are set

correctly (this is normally done during the ISOURCE user creation).

1. Open a Command Prompt and set the following variable:

Set ORACLE_SID=ISH

2. Set ORACLE_HOME depending on your Oracle version:

Table 5: set ORACLE_HOME

Oracle 11 set


2.0\dbhome_1

Oracle 12 set


1.0\dbhome_1

Procedure

1. At a command prompt where the variables for ORACLE_SID and ORACLE_HOME

are set, type:

SQLPLUS /NOLOGCONNECT ISOURCE/isource

2. Execute the FullAnalyze. sql script located on the CD:

■ CD-Package\Database\Common\Oracle\Tools\FullAnalyze.sql



Enabling network transactions

The Microsoft Distributed Transaction Coordinator (MSDTC) must allow network

transactions. This must be done on all Content Manager servers: application, database

(Oracle RDBMs and Microsoft SQL Server) and batch servers.

About this task

By default, the security configuration for the MSDTC is set to forbid 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.



Upgrading the Content Manager serverYou must install and configure the application and web server to use the Content Manager

application and connect to the repository. The Content Manager server installation is

automated however, certain changes and options must be made before the installation can

become operational.

Configuring database connection strings

Use 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 the connection for Microsoft SQL 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 sure



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

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.

Creating and testing the connection for Oracle RDBMs

An Oracle oriented environment makes use of Oracle Provider for OLE DB.

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

If the connection is valid, a message is displayed to notify that the connection is

working correctly.

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

Editing the tnsnames.ora database connection file

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

on systems that communicate with the Oracle database server. This file defines the

information for a connection to the database server and to the database instance for the

Content Manager repository.

About this task

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.

Preparing for the server upgrade

A complete Content Manager database has to be available to install or upgrade a Content

Manager server.

About this task

Note: The install tool makes no changes to your database.



Procedure

1. Extract the Content Manager 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 from the previous installation in the

folder with the name that uses the format:

C:\IShCDs\yyyymmdd.CD.InfoShare.ver.num.ProjectName.IT\__

InstallTool\

This is the file that was edited for your current environment and installation.

3. Copy the file to the new installation folder with the name:

C:\IShCDs\yyyymmdd.CD.InfoShare.ver.num.ProjectName.IT\__

InstallTool\

This makes accessible to the install tool, the inputparameters.xml file with the

customized information for your environment.

4. Open the file in an ascii editor (for instance, NotePad) and make certain all<currentvalue> items in the file are correct for this installation. For instance, all UDLfile, check paths, and so on are correct and that the resulting file is a well-formed xml file.

If you cannot access an InputParameters. xml file that has been edited for your

environment, refer to the information for the InputParameters. xml file to

make necessary edits before upgrading and using the install tool.

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 Content Manager server that has no instances of Content

Manager (or "SDL Trisoft" or "Architect") 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 Content Manager.

■ A valid security certificate is available for (HTTPS) the web server application.

Enabling https on the IIS website

Content Manager requires that https is enabled on the IIS website that is used for Content

Manager.



Before you begin

Follow this procedure on the main Content Manager 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 Content Manager 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.

ACreate 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 Content Manager. 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.

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

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 Content

Manager 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 Content Manager installer.

<defaultvalue>

Contains a predefined value as an example. Do not use the predefined value as a

default value; its only purpose is to serve as an example.

<description>

Contains details describing how the current value of the parameter is used.



<validate>

Defines whether the value of the parameter is validated or not. If the element is

empty, no validation is performed. The <validate> values are provided, and theyshould not be modified.

Parameters

This section lists and describes the parameters contained in the inputparameters.

xml file. You must define these parameters for the installation to work correctly.

Note: To obtain the required connectstring parameter:

■ In a text editor, for example Notepad, open the connection.udl file you cre-

ated in the installation directory (typically, C:\InfoShare).

■ Browse to the line beginning with Provider=. For Oracle:

Provider=OraOLEDB.Oracle.1;Password=isource-password;Persist Security Info=True;User ID=isource;Data Source=data_source_name

For MSSQL:

Provider=SQLOLEDB.1;Password=isource-password;PersistSecurity Info=True;User ID=isource;Initial Catalog=database;Data Source=server-name

■ Copy the line and paste it in the inputparameters. xml file to specify theconnectstring parameter.

osuser

The user name for the designated operating system account.

ospassword

The password for the designated operating system account. Set the password so that it

never expires.

projectsuffix

A suffix that specifies the particular instance of Content Manager, if you are installing

multiple Content Manager instances 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 are valid values:

■ oracle

■ sqlserver



apppath

The root directory for the Content Manager 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 containing the data directory. This directory stores all data exported

from Content Manager.

By default, this parameter is set to C:\InfoShare.

workspacepath

The temporary directory where installation files are stored.

By default, this parameter is set to C:\InfoShare\ _Workspace.

infoshareauthorwebappname

The name of the web client application.

By default, this parameter is set to ISHCM.

infosharewswebappname

The name of the web services application.

By default, this parameter is set to ISHWS.

infosharestswebappname

Specify the name of the website with the Content Manager Secure Token Service

(STS).

Follow the same patterns as infoshareauthorwebappname and infosharews-webappname

Note: There is no default value for this parameter.

websitename

The name of the web site where 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 Content Manager 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 Content Manager

box takes place.



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 the JavaHelp output type.


ps_webworks_automap_application

The fully qualified path and filename of WebWorks.


solrlucene_service_port

The port the SolrLucene service uses. This port must be unique for each Content

Manager instance installed on a server.

solrlucene_stop_port

The port that is used to stop the SolrLucene service. This port must be unique for each

Content Manager instance installed on a server.

servicecertificatethumbprint

Specify the thumbprint of the service certificate.

In a typical Content Manager setup, the service certificate is the SSL certificate of the

IIS web site where a standard Content Manager setup is going to be installed.

■ Open Internet Information Services (IIS) Man-

ager > Servername > Server Certificates

■ Right-click the certificate of the IIS web site that is going to be used forContent Manager, then click View.

■ Select the details tab, then click the Thumbprint field.



The bottom pane displays the details of the Thumbprint field.

■ Select the entire value, then press CTRL + C to copy it to the clipboard.

■ Paste it in the servicecertificatethumbprint/ currentvalueparameter of the inputparameters. xml file.

■ Delete any spaces and any control characters.

For example, the preceding Thumbprint would be represented asA43489159A520F0D93D032CCAF37E7FE20A8B419 in the servicecertifica-tethumbprint parameter.

servicecertificatevalidationmode

Specify the validation mode of the service certificate.

Specify the level of validation used to verify the service certificate (servicecer-tificatethumbprint):

■ ChainTrust

Validates the certificate using a trust chain (it validates the certificate, the

CA(s), and it checks if the certificate is not revoked using CRL or OCSP).

■ PeerTrust

Verifies if the certificate is in the TrustedPeople certificate store of the

computer.

■ PeerOrChainTrust

Verifies if the certificate is valid, based on either a ChainTrust or aPeerTrust validation.

■ 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 Content Manager to use either the ISHSTS or another STS, such as

Microsoft ADFS.

Depending on whether you use ISHSTS or ADFS, do one of the following:



Content Manager STS

Content Manager STS uses the same certificate as the one that is used on the IIS

web site where Content Manager is going to be installed. Therefore, the thumbprint

of the signing certificate is the thumbprint of the IIS web site certificate.

■ Open Internet Information Services (IIS) Manager > -

Servername > Server Certificates

■ Right-click the certificate of the IIS web site that is going to be used for Con-

tent Manager, then click View.


The bottom pane displays the details of the Thumbprint field.


■ Paste it in the issuercertificatethumbprint/currentvalueparameter of the inputparameters.xml file.


ADFS

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 Management > AD

FS > Service > Certificates, right-click the primary token

signing certificate, then choose View certificate.



■ Paste it in the issuercertificatethumbprint/currentvalueparameter 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 it checks if the certificate is not revoked using CRL or OCSP).

■ PeerTrust

Verifies if the certificate is in the TrustedPeople certificate store of the

computer.



■ PeerOrChainTrust

Verifies if the certificate is valid, based on either a ChainTrust or aPeerTrust validation.

■ None

The certificate is not validated, it is always valid.

issuerwstrustbindingtype

Specify the binding type for the issuerwsfederationendpointurl parameter.

Depending on the authentication mode supported by the server defined in theissuerwstrustendpointurl parameter, specify one of the following values:

■ UserNameMixed when the issuerwstrustendpointurl expects username/password credentials.

■ WindowsMixed when the issuerwstrustendpointurl expects windowscredentials.

Note:When WindowsMixed is specified, the issueractorpassword and the servicepassword parameter values are ignored and should therefore be left empty.

issueractorusername

When delegating, specify the user name of the actor.

■ When issuerwstrustbindingtype is UserNameMixed, specify the user

name of a user defined in the Content Manager user repository.

■ When issuerwstrustbindingtype is WindowsMixed, use the value of osuser .

Note: If you configure authentication with a different STS solution, specify the

appropriate value based on the requirements for the selected STS and Identity Provider

(IdP).

Note: Since ADFS performs Windows authentication, use the value of osuser.

Note:When issuerwstrustbindingtype is WindowsMixed, actor credentialsautomatically correspond to the identity credentials of the user running the process:osuser.

issueractorpassword

When delegating, specify the password of the actor.

■ When issuerwstrustbindingtype is UserNameMixed, specify the password matching the user defined with issueractorusername.

■ When issuerwstrustbindingtype is WindowsMixed, leave this fieldempty.





(IdP).

Note: Since ADFS performs Windows authentication, leave this field empty.

Note:When issuerwstrustbindingtype is WindowsMixed, actor credentialsautomatically correspond to the identity credentials of the user running the process:ospassword.

issuerwstrustendpointurl

Specify the endpoint of the STS for the active profile.

■ When authenticating with ISHSTS, the base URL for authentication endpoints

isbaseurl/infosharestswebappname/issue/wstrust/ ,wherebaseurl and infosharestswebappname are the designated values for thebaseurl and the infosharestswebappname parameters, respectively.The authentication endpoints are:

■ mixed/username for user name/password authentication. In thiscase, issuerwstrustbindingtype becomes UserNameMixed;

■ mixed/windows for Windows authentication. In this case,issuerwstrustbindingtype becomes WindowsMixed.

■ When authenticating with ADFS STS, specify https://adfshost/

adfs/services/trust/13/windowsmixed, andverify that

this ADFS endpoint is enabled. To check if the ADFS endpoint is enabled,

perform the following actions:

■ Open AD FS Management > AD FS > Service > End-

points.

■ Check that /adfs/ serices/ trust/ 13/windowsmixed is enabled.

In this case, issuerwstrustbindingtype becomes UserNameMixed.

■ If you configure authentication with a different STS solution, specify the

appropriate value based on the requirements for the selected STS and Identity

Provider (IdP).



issuerwsfederationendpointurl

Specify the endpoint of the STS for the passive profile.

■ When authenticating with ISHSTS, specify:baseurl/infosharestswebappname/issue/wsfed, where baseurland infosharestswebappname are the values specified for the baseurland the infosharestswebappname parameters, respectively.

■ When authenticating with ADFS STS, specify https://adfshost/

adfs/ls/.

■ If you configure authentication with a different STS solution, specify the

appropriate value based on the requirements for the selected STS and Identity

Provider (IdP).

issuerwstrustmexurl

This is the metadata address (Mex) of the STS for the active profile. It is used when

generating proxy classes. For example:

ISHSTS:baseurl/infosharestswebappname/issue/wstrust/mex

ADFS:https://adfshost/adfs/services/trust/mex

Other STS: Value based on that specific STS.

serviceusername

Specify the user name for the Content Manager translation organizer service.

■ When issuerwstrustbindingtype is UserNameMixed, specify the user

name of the service user defined in the Content Manager user repository.

■ When issuerwstrustbindingtype is WindowsMixed, leave this fieldempty.



(IdP).


Note:When issuerwstrustbindingtype is WindowsMixed, actor credentialsautomatically correspond to the identity credentials of the user running the process:osuser.

servicepassword

Specify the password matching serviceusername.

■ When issuerwstrustbindingtype is UserNameMixed, specify the password matching the user defined with serviceusername.

■ When issuerwstrustbindingtype is WindowsMixed, leave this field empty. For this to work also change <validate>askpasswordtwiceifempty</validate> to <validate/>.





(IdP).


Note:When issuerwstrustbindingtype is WindowsMixed, actor credentialsautomatically correspond to the identity credentials of the user running the process:ospassword.

Executing the InstallTool

Use the Content Manager InstallTool to install and merge all standard and customer

specific project files.

Procedure

1. Login to your Windows system as a Content Manager user with the Administrator

user role.

2. In Windows Explorer, go to

C:\IShCD\yyyymmdd.CD.InfoShare<version_num>\ProjectName.IT\

__InstallTool


4. Select the Install option by entering the number 2.

5. Hit enter to respond to all questions; the default options should be sufficient.

All standard and customer specific project files are merged and installed. All required

services are up and running (the Crawler, SolrLucene, IISAdmin, W3SVC).

Enabling network transactions

The Microsoft Distributed Transaction Coordinator (MSDTC) must allow network

transactions. This must be done on all Content Manager servers: application, database

(Oracle RDBMs and Microsoft SQL Server) and batch servers.

About this task

By default, the security configuration for the MSDTC is set to forbid 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.

Post upgrade tasksAfter you complete the upgrade of your Content Manager server, you should complete a

number of post-installation tasks. The post-installation tasks help you to verify the

installation and configure the components that you have just installed.

Verifying Microsoft SQL System Administrationrole 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 the SQL Server Management Studio.

Windows 2012: To access the SQL Server Management Studio if not readily

accessible, click theWindows Powershell icon on the bottom toolbar then at the

prompt type: Ssms.exe

Note: If prompted and required, connect to the server.

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.

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

Running DBUpgradeTool

DBUpgradeTool, 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 Content Manager database (up and running).

■ An available, full and correctly installed Content Manager server.

The installation ensures that the upgrade files and connections are in place to

allow a successful upgrade.

■ Exclusive access to the Content Manager database for DBUpgradeTool.

Be sure to stop all components and services, such as 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 Content Manager installation directory, open: \ App\

Setup\DBUpgradeTool\

3. Locate and double-click on DBUpgradeTool. exe



4. Optional, for ADFS only

Use DBUpgradeTool to configure the FishExternalID of the administrator user with a

value such as domain\ username, for the user who is to login in the system as theadministrator. To do this:

■ Run DBUpgradeTool, 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 Content

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

The result is an upgrade from an older or same version to the installed version when

applicable.

Troubleshooting DBUpgradeTool

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.

In case you need to request assistance, you need to provide the following information:

■ A screenshot of the failed execution of DBUpgradeTool

■ Thelogfile:\App\Setup\DBUpgradeTool\DBUpgradeTool.log

Adding the relying party entries for webUI andWCF Services for commercial STS

After the Content Manager installation you have to create the Relying Party Trust for the

website and the WCF services on the STS Server if you are not using ISHSTS. This is

required to allow logins to Content Manager.

About this task

These post-installation steps have to be done when you are using a commercial STS such

as ADFS (ADFS is used as example here). If you are using ISHSTS 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 certificate that is used by the Content Manager

WCF Services.

This is the same value as the certificate whose thumbprint is used in the

inputparameters parameter servicecertificatethumbprint. With the typical

Content Manager 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

Content Manager then click View.

d. Click on the Details tab then click Copy to File and export the certificate to

the file system (only export the public key) e.g. SDL.ISH.cer.

2. Copy the PowerShell scripts which are created in the directory \ InfoShare\ App\

Setup\STS\ADFS\Scripts\ scripts to a temporary directory on theADFS

server e.g. C:\SDL.ISH. Copy also the certificate C:\SDL.ISH from 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

Content Manager 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 c:\SDL.ISH

6. Before running the script, load the ADFS PowerShell module by issuing the command:



Import-Module ADFS

7. Execute the command:

.\SDL.ISH-ADFSv3.0-RP-Install.ps1 "C:\SDL.ISH\SDL.ISH.cer"

Now if you open AD FS Management you should see two new Relying Party entries

with the base URLs you use for the Content Manager instance.

Removing the relying party entries for webUI and WCF Services

If you want to remove the Relying Party entries, for instance because Content Manager 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 Content Manager 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 the ADFS PowerShell module by issuing the command:

Import-Module ADFS

4. Execute the command:

.\SDL.ISH-ADFSv3.0-RP-UnInstall.ps1

Now if you open AD FS Management you should see that the two Relying Party

entries are removed.

Configure Security Token Service

Client installations can be used only if you properly configure a Security Token Service

(STS). The default system that manages user identity for Knowledge Center is ISHSTS.

Content Manager Security Token Service Requirements

Required Identifiers and certificates for a Security Token Service configuration applicable

to Content Manager.

Profiles

Content Managerrelies on both the Passive profile and the Active profile to do Federated

Authentication.



Content Manager

service nameProfile Remarks

ISHCM Passive profile Refers to web applications.

Token encryption is optional.

ISHWS Active profile Refers to SOAP based web services

implementing the WS Trust

protocol.

Token encryption is mandatory.

Identifiers and encryption certificates

For each service Content Manager expects the following combination of identifiers and

encryption certificate to be configured on a Security Token Service.



Content Manager servicename

Identifiers Encryption certificate

ISHCM ■ https://example.com

/ISHCM/

None

ISHWS ■ https://example.com

/ISHWS/

■ https://example.com

/ISHWS/Wcf/API25

/Application.svc


/ISHWS/Wcf/API25

/Baseline.svc


/ISHWS/Wcf/API25

/DocumentObj.svc


/ISHWS/Wcf/API25

/EDT.svc


/ISHWS/Wcf/API25

/EventMonitor.svc


/ISHWS/Wcf/API25

/Folder.svc


/ISHWS/Wcf/API25

/ListOfValues.svc


/ISHWS/Wcf/API25

/MetadataBinding.

svc


/ISHWS/Wcf/API25

/OutputFormat.svc


/ISHWS/Wcf/API25

/PublicationOutput.

svc


/ISHWS/Wcf/API25

/Search.svc


/ISHWS/Wcf/API25

/Settings.svc


/ISHWS/Wcf/API25

/TranslationJob.svc


/ISHWS/Wcf/API25

/TranslationTem-

plate.svc


/ISHWS/Wcf/API25

/User.svc


/ISHWS/Wcf/API25

/UserGroup.svc


/ISHWS/Wcf/API25

/UserRole.svc


/ISHWS/Wcf/API20

/Application.svc


/ISHWS/Wcf/API20

/DocumentObj.svc


/ISHWS/Wcf/API20

/EDT.svc


/ISHWS/Wcf/API20

/EventMonitor.svc


/ISHWS/Wcf/API20

/Folder.svc


/ISHWS/Wcf/API20

/MetaDataAssist.svc


/ISHWS/Wcf/API20

/OutputFormat.svc


/ISHWS/Wcf/API20

/Publication.svc


/ISHWS/Wcf/API20

/PublicationOutput.

svc


/ISHWS/Wcf/API20

/Reports.svc


/ISHWS/Wcf/API20

/Search.svc


/ISHWS/Wcf/API20

/Settings.svc


/ISHWS/Wcf/API20

/Workflow.svc


/ISHWS/Wcf/API/

Application.svc


/ISHWS/Wcf/API/

ConditionManage-

ment.svc

The public key of the

certificate referenced

through theservicecertifica-tethumbprint inputparameter.



Claims in the token

Content Manager maps an incoming token to a user in the users repository by the external

identifier.

The mapping is done through the token's attribute matching the claim typehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/name.

For a token to be useful for Content Manager, the token's subject name should match a

user in the Content Manager users repository.

Token claims example

For a user that can be identified as user@company. com, the External ID in the usersrepository is expected to be user@company. com.

A valid incoming token must have at least the following attributes defined in it:

<saml:AttributeStatement><saml:Attribute AttributeName="name" AttributeNamespace="http://schemas.xmlsoap.org/ws/2005/05/identity/claims">

<saml:AttributeValue>[email protected]</saml:AttributeValue>

</saml:Attribute></saml:AttributeStatement>

ISHSTS with Windows Authentication

You need to perform several settings before ISHSTS can provide WindowsAuthentication.

Both server and SQL server database must be properly configured. You can either make

these settings manually or use the scripts provided with the package.

ISHSTS is automatically configured through the installation.

InstallTool creates an application pool such as TrisoftAppPoolISHSTS based on theinput parameter infosharestswebappname. The application pool is assigned an identitybased on the input parameter osuser. This user is responsible for hosting the endpointsprovided by ISHSTS

For Windows Authentication endpoints to work, the following changes based on the

requirements of Service Principal Names defined in the Active Directory must be

made, either manually or through a script.

Note: The following needs to be applied per installation server and are valid only for

deployments that do not include network balanced front end servers

Application pool identity

A change of the application pool identity in order to use the integratedApplicationPoolIdentity. This changes the user who hosts the endpoints to an



account that the correct Service Principal Names is assigned to. The expectedService Principal Names are

■ http/baseurl

■ host/baseurl

Note: The new user is identified locally as IIS AppPool\

infosharestswebappname and it requires certain permissions to access resources.When this user accesses network resources it is identified as the computer accountDomain\ Computer$ where the Domain and Computer are netbios based. e.g.TESTDOMAIN\SERVER01$

Read permissions

Read permissions to the token signing certificate's private key are assigned to the IIS

AppPool\infosharestswebappname. The token signing certificate in ISHSTS is

configured through the InstallTool parameterissuercertificatethumbprint

Read/write permissions to the three target installation paths defined in the input

parameters are assigned to the IIS AppPool\infosharestswebappname:

■ webpath

■ datapath

■ apppath

Integrated authentication

If the database is SQL Server and the connection string utilizes integrated

authentication then we grant the computer account permissions to the database.

The only permission required is SELECT

Configure application server for Windows Authentication

Here is how you execute the script that configures the server for ISHSTS with Windows

Authentication.

Before you begin

This task requires a PowerShell session that with Execution Policy set toUnrestricted.

If it is not set, you need to set it permanently by executing the following:

Set-ExecutionPolicy Unrestricted

The task requires administrator privileges.

Note: InstallTool has already transformed the script based on the input parameters.

Procedure



1. Locate the PowerShell script SDL.ISH-ISHSTS-Configure for Windows

Authentication.ps1 in the folder\InfoShare\App\Setup\STS\

ISHSTS\Scripts

2. Open PowerShell with elevated administrator privileges. Run As Administrator.

If the PowerShell session is not running with administrator privileges, the script

will launch a new session and administrator privileges will be requested to the user.

3. Navigate to the script folder\InfoShare\App\Setup\STS\ISHSTS\

Scripts

a. cd \InfoShare\App\Setup\STS\ISHSTS\Scripts

4. Execute script SDL.ISH-ISHSTS-Configure for Windows

Authentication.ps1

a. .\SDL.ISH-ISHSTS-Configure for Windows Authentication.ps1

Example: PowerShell session

cd \InfoShare\App\Setup\STS\ISHSTS\Scripts& ’.\SDL.ISH-ISHSTS-Configure for Windows Authentication.ps1’

Configure SQL Server database for Windows Authentication

Here is how you execute the script that allows the server's computer account to access a

SQL Server database.

Before you begin

The task applies for SQL Server database when the connection string used integrated

authentication.

The task requires sysadmin rights on the SQL Server

Note: InstallTool has already transformed the script based on the input parameters.

Procedure

1. Locate the script GrantComputerAccountPermissions. sql in the \

InfoShare\App\Database\Common\dependingonyour versionofSQL

Server

■ For SQLServer 2012 the script path is \ InfoShare\ App<

Projectsuffix>\Database\Common\SQLServer2012\Tools\

GrantComputerAccountPermissions.sql

■ For SQLServer 2014 the script path is \ InfoShare\ App<

Projectsuffix>\Database\Common\SQLServer2014\Tools\

GrantComputerAccountPermissions.sql

2. Execute the script on the target sql server instance



Example: SQL Server script that grants necessary permissions

If the target database is INFOSHAREDB and the computer account is TESTDOMAIN\

SERVER01$ then the script looks like this.

USE [master]GOCREATE LOGIN [TESTDOMAIN\SERVER01$] FROM WINDOWS WITHDEFAULT_DATABASE=[INFOSHAREDB]GOUSE [INFOSHAREDB]GOCREATE USER [GLOBAL\MEDEVASARAFIA01$] FOR LOGIN [TESTDOMAIN\SERVER01$]GOUSE [INFOSHAREDB]GOGRANT SELECT TO [TESTDOMAIN\SERVER01$]GO

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.

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 Content Manager web client as an administrator user.

2. In the web Content Manager, 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 Content Manager_home directory in

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

XMLBackground-

TaskConfiguration.xml

Save



Creating TRANSLATORSERVICE role andServiceUser user

Configuring the translation builder by adding the TRANSLATORSERVICE role and

creating a user ServiceUser is a mandatory step for the interaction between Content

Manager and Content Delivery.

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

■ 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

Translation management integration configuration

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 Content Manager 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 Content Manager. This value is initialized from install

parameters.

password

The password of the user to access Content Manager. 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 Content Manager 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 Content

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

retriesOnTimeout

Number of times the single server call can fail and be retried before the job is moved

to failed status. Default value is 3.

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 Content

Manager to the locale of SDLWorldServer

<mappings><add trisoftLanguage="en" worldServerLocaleId="1145" /><add trisoftLanguage="nl" worldServerLocaleId="1147" /><add trisoftLanguage="fr" worldServerLocaleId="1146" /></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 Content Manager 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 Content

Manager must be configured within a template element:

<templates><add templateId="81143C38-0C96-4A8C-9BBB-87C1CF464FE3" templateName="My template" /><add templateId="70407FBC-86FA-4A9D-8E6D-35E1AE85DB73" templateName="Trisofttemplate" /></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 Content Manager .

■ 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"ishvaluetype="value" /></ishfields></requestedMetadata>

■ The metadata that will be used for grouping items in SDL TMS.



<groupingMetadata><ishfields><ishfield name="FAUTHOR" level="lng"ishvaluetype="value" /><ishfield name="DOC-LANGUAGE" level="lng"ishvaluetype="value" /></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><ishfield name="FAUTHOR" level="lng"ishvaluetype="value" /><ishfield name="DOC-LANGUAGE" level="lng"ishvaluetype="value" /></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.

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 Content Manager and SDL TMS

The following are items that will help you better understand the integration of Content

Manager and SDL TMS and considerations when configuring translation and workflow.

Content Manager

Required for Content Manager 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 last group indicates that

Chinese can be used as source language (pivot) for translating to Japanese and

Korean.

<languagepaths><languagepath from="nl" to="fr"/><languagepath from="en" to="de"/><languagepath from="en" to="es"/><languagepath from="en" to="fr"/><languagepath from="en" to="it"/><languagepath from="en" to="zh"/><languagepath from="zh" to="ja"/>



<languagepath from="zh" to="ko"/></languagepaths>

■ Translation templates come from SDL TMS and are automatically pushed to

Content Manager by TranslationOrganizer.

■ Content Manager 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 InTranslation 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 Content Manager to start getting

the translation

■ "Completed" step which is used by Content Manager 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 Content Manager and SDLWorldServer


Manager and SDLWorldServer and considerations when configuring translation and

workflow.

Content Manager







Korean.

<languagepaths><languagepath from="nl" to="fr"/><languagepath from="en" to="de"/><languagepath from="en" to="es"/><languagepath from="en" to="fr"/><languagepath from="en" to="it"/><languagepath from="en" to="zh"/><languagepath from="zh" to="ja"/><languagepath from="zh" to="ko"/></languagepaths>

■ Translation templates come from SDLWorldServer and are automatically pushed

to Content Manager by TranslationOrganizer.





TRANSLATORSERVICE.


that defines a workflow for the integration:



















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.

■ Content Manager 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.Refer to the SDLWorldServer manuals for the further details.

■ 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 Content Manager 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.

Refer to the SDLWorldServer manuals for the further details.

Integration requirements for Content Manager and File System


Manager and File System and considerations when configuring translation and workflow.

Content Manager







Korean.

<languagepaths><languagepath from="nl" to="fr"/><languagepath from="en" to="de"/><languagepath from="en" to="es"/><languagepath from="en" to="fr"/><languagepath from="en" to="it"/><languagepath from="en" to="zh"/><languagepath from="zh" to="ja"/><languagepath from="zh" to="ko"/></languagepaths>



■ Translation templates are based on configured source and pivot languages, and

are automatically pushed to Content Manager by TranslationOrganizer.



TRANSLATORSERVICE.


that defines a workflow for the integration:



















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.

Validation XML configuration files

As part of the introduction of the SettingsAPI 2.5, a schema was made for all configuration

XML files.

■ Configuration files received a version number

<InfoShareStates version="1.0">...</InfoShareStates>

■ Configuration files are validated against this schema when they are submitted

through the user interface (UI). The rest of the application assumes that the

configuration files in the database are valid.

Resubmit the legacy configuration XML files using the Web Client, Settings tab. The

configuration file is validated and some corrections are made. For example, a @version

attribute with the value, 1.0 is added. If there are validation errors when resubmitting the

configuration files, remove all statuses in the status definitions with value "Not found as

LOV Value".

<Status Elm="..." value="Not found as LOV Value"/>

Enabling services

After 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

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



Configuring Content Manager to support teamediting

To enable team editing in Content Delivery, you need specify values including the URI of

your Content Delivery web application in two different configuration settings.

Specify the Collaborative Review URI in Content Manager

To enable team commenting in the Content Manager and/or team editing in Content

Delivery, you need to specify the Collaborative Review URI in the Content Manager

settings.

Procedure

1. Log on to the SDL Knowledge Center web client as a user with administrative

permissions.

2. Click the slide-out navigation pane, and then click Content Manager.

3. Specify the Collaborative Review URI:

a. On the Settings tab, click Default Settings.

b. Under Collaborative Review URI, specify the web address of the Content

Delivery web application:

https://fully-qualified-server-name:port#/LiveContent/

where:

■ fully-qualified-server-name is the fully qualified server name. For example, servername.domain.company.com.

■ port# is the port on which Content Delivery is configured. For examp

le, 8443 .

Modify the Knowledge Center output type settings

Follow these steps to change the Content Manager configuration as part of the steps to

enable team editing.

Procedure

1. Log on to the SDL Knowledge Center web client as a user with administrative

permissions.

2. Click the slide-out navigation pane, and then click Content Manager.

3. On the Settings tab, click Output Formats.

4. Modify the Content Manager output type to specify the Content Delivery web

application settings.



5. Select the Content Delivery output type and click Properties.

The Output Format Properties window pops up.

6. Ensure certain fields are correctly filled or cleared for the Content Delivery

output type.

a. In the Advanced Section, ensure that Resolve Variables is cleared.

b. In the Content Delivery section, specify details forContent Delivery web

application in the following fields.

URI of the server

The fully qualified Content Delivery server name, in this format:

https://fully-qualified-server-name:port#/LiveContent/

where:

■ fully-qualified-server-name For example,servername.domain.company.com.

■ port# is the port on which Content Delivery is configured. For ex

ample, 8443 .

Skin used

The skin to use for the Content Delivery output type.

User name

Provided in combination with the password for a user who has at least edit

privileges in SDL Knowledge Center

Note: If you are using ADFS for SSO, leave the User name and

Password fields blank.

Password

Provided in combination with the password for a user who has at least edit

privileges in SDL Knowledge Center

Note: If you are using ADFS for SSO, leave the User name and

Password fields blank.

Installing Content Editor

The Content Editor is installed as part of Content Manager. You just need to install the

license file and enable the capability.

Installing the Content Editor license file

After completing the Content Manager installation, install the Content Editor license file

(which is obtained from SDLTechnical Services) in order for you to gain access to Content

Editor.



Content Editor is installed automatically when you install Content Manager. When you

set up multiple Content Manager servers, then you need a valid license key for Content

Editor on each of your servers.

You must copy the Content Editor license file into the installation directory on the Content

Manager Web server. Typically, this location is:

\Web<projectsuffix>\Author\Editors\Xopus\license.

Key features of the license

■ A license key has a fixed number of concurrent or simultaneous users

assigned to it, and is in the format of a text file.

■ During installation, the license key(s) need to be placed in the license folder

of your Content Editor web application.

■ The license key filename has the following format : {serverdomain}.txt.

■ Every time you start or close the Content Editor editor, it connects to the SDL

license server to verify the license key.

■ The SDL license server registers the number of users but no user information.

■ If for any reason the user's computer cannot reach the SDL license server

(user working in a closed network or the SDL license server is down) then the

verification step is skipped and Content Editor still works.

■ The connection to the SDL license server has no noticeable impact on

performance.

■ Communicating with the SDL license server does not compromise your

security since Content Editor does not send any user information nor does it

send any of your content.

Note: If Content Editor is used outside the bounds of the license agreement, the

usage is flagged and SDL is notified.

Enable Content Editor

To enable Content Editor, you must modify several configuration files in the Content

Manager web application.

Before you begin

Before performing this process, you must purchase a license for Content Editor from

SDL.



Procedure

1. On the Content Manager web application server, go to the \\ <Server>\ c:\

InfoShare\Web<projectsuffix>\Author\ASP\XSL folder inside the

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

Enable the Quality Assistant plugin for ContentEditor

Follow this procedure to enable the Quality Assistant in the Content Editor.

Before you begin

■ Content Editor must be enabled for the suite.

■ Quality Assistant must be installed.

■ You should know the URI of Quality Assistant.

About this task

If you plan to open and edit topics from the Content Delivery server, then in addition to

this task you should also specify the base URL for your Quality Assistant(Quality

Assistant) server in a Quality Assistant 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 .

Introduction to SDL Knowledge Center scalability

A number of deployment scenarios offers an overview of different 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

SDLKnowledge Center and its components, scalability refers to the ability of the system to

increase capabilities like:

■ Total web output;

■ Web services output;

■ Total computation output for the items being executed on the server like

publication, translation, and so on.

This introduction starts with a simple scaling out case, and it granularly adds complexity

and explores scaling out by explaining several cases. Examples include:

■ set up the product and components in a cluster,

■ with or without a single sign-on (SSO) solution. For example, ISHSTS or ADFS.

SDL Knowledge Center network cluster

Example of a combined Content Manager, Content Delivery and QualityAssistant network

cluster setup.

The following network diagram shows how the Content Manager, Content Delivery and

Quality Assistant servers are organized within a network.

Content Delivery's functionality and feature sets target different types of users, therefore

the dedicated servers are organized in distinct areas:



Figure 1: Network diagram

Related tasks

■ “One server deployment” on page 87

■ “One server for all roles” on page 87

■ “Simple cluster” on page 88

■ “Multi server deployment” on page 94

■ “Advanced server cluster” on page 95



SDL Knowledge Center environment with ISHSTS

Example of a combined Content Manager, Content Delivery, and Quality Assistant

network setup with ISHSTS integration.

The following clusters can fit in one SDL Knowledge Center deployment:

■ Content Manager Advanced server cluster

■ Content Delivery cluster

■ Quality Assistant cluster.

Content Manager

A collection of front end servers behind a network load balancer serve interactive

functionality, whereas a collection of back end servers serve non-interactive functionality.

ISHSTS is a 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. ISHWS, targeted from within the cluster,

DNS resolving and network routing should be taken into consideration depending

on the network topology.

■ ISHSTS cannot be shared across different servers. As a result:

■ Every ISHSTS on every server on the cluster requires configuration for all

federated services for which it can potentially issue a token.

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

■ ISHSTS on every Back end server has configuration based on the specific

hostname and certificate of the server. This ISHSTS will be used by all

entities of the same Back end server. All federated services integrated with

Content Manager are required to be configured on the ISHSTS 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.



Content Delivery

The content delivery servers can be scaled out behind a network load balancer with

affinity. Commenting and analytics are provided from independent installations that each

serve as a common repository for all nodes within the cluster.

A distribution node is the target of publications. Then this node will distribute the data to

all content deliver server nodes within the cluster so they can serve exactly the same

information. This node is also the target of publishing from the Content Manager

The review installation provides the functionality for Content Delivery. The source of the

comments is the common commenting repository as is the analytics also. This installation

is integrated with ISHSTS to provide the Single Sign On experience.

Quality Assistant

Multiple servers can be part of network load balancing cluster with affinity. All servers

must be configured identically to pull the same information from external sources

Diagram



Figure 2: SDL Knowledge Center advanced deployment with ISHSTS

Related information


■ “Front end server” on page 89

■ “Back end server” on page 91

■ “Web role” on page 155

■ “Best practices to configure a node in network load balancing” on page 97

SDL Knowledge Center environment with ADFS

Example of a combined Content Manager, Content Delivery, and Quality Assistant

network setup with ADFS integration.

The following clusters can fit in one SDL Knowledge Center deployment:



■ Content Manager Advanced server cluster

■ Content Delivery cluster

■ Quality Assistant cluster.

Federation

ADFS is used as a Security Token Service for the federated services of Content Manager,

Content Delivery. and Quality Assistant.

Content Manager

A collection of Front end servers behind a network load balancer serve the interactive

functionality and a collection of Back end servers serve the non interactive functionality

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. Content Manager ISHWS, 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.

Content Delivery

The Content Delivery servers can be scaled out behind a network load balancer with

affinity. Commenting and analytics are provided from independent installations that each

serve as a common repository for all nodes within the cluster.

A distribution node is the target of publications. Then this node will distribute the data to

all content deliver server nodes within the cluster so they can serve exactly the same

information. This node is also the target of publishing from the Content Manager

The review installation provides the functionality for Content Delivery. The source of the

comments is the common commenting repository as is the analytics also. This installation

is integrated with ADFS to provide the Single Sign On experience.

Quality Assistant

Multiple servers can be part of network load balancing cluster with affinity. All servers

must be configured identically to pull the same information from external sources.

Diagram



Figure 3: SDL Knowledge Center advanced deployment with ADFS

Related information








One server deployment

The basic deployment option consists of one server.

The following functionality must be active in the Quality Assistant installation for the

product to operate correctly:

■ Web site

■ Agent.

The following diagram shows a conceptual representation of the one server deployment:

Figure 4: One server deployment

Depending on the load and the intensity of usage, the execution of the above components

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 tasks

■ “SDL Knowledge Center network cluster” on page 80





One server for all roles

The basic deployment option consists of one server that is responsible for all roles.

For Content Manager 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 5: 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 tasks






Related information

■ “Default background task role” on page 157

■ “Full text indexing role” on page 156

■ “Translation role” on page 159


Simple cluster

The 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 6: Two server deployment

Related tasks






Related information



Related tasks


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/ ISHCM/ or the web service client targets an endpoint

likehttps://publichostname/ISHWS/Wcf/API25/Application.svc,

then the hostname is publichostname. This must match the SSL certificate's subjectname. Depending on the scenario, the publichostname should or should not match theserver's fully qualified domain name, for example mecdevapp01.

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


Related information



Related tasks


Related tasks


Related tasks

■ “Best practices to specialize back end servers” on page 99

Related tasks

■ “SDL Knowledge Center environment with ISHSTS” on page 82

Related tasks

■ “SDL Knowledge Center environment with ADFS” on page 84

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 92

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/ISHCM/andhttps://mecdevapp01.global.sdl.corp/ISHWS/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 re-purposing 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 information







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

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\TridkApp\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\TridkApp\InfoShareAuthor] "SolrLuceneBaseUrl"="http://10.98.124.

5:8080/solr"

Full text indexing is now directed to the server as specified in the registry forSolrLuceneBaseUrl.

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 90

■ “How to configure a back end server” on page 92

Multi server deployment

The multi server cluster deployment shows how to scale out.

All servers within the node are identical The servers types are:

Creating multi server deployment and adding them as nodes on a network load balancer

requires the following:

■ The network load balancer has to be configured with affinity. This means that

every request originating from the same client will be served always by the same

server.

■ The configuration between different instances of the Agent must be identical so

the loaded information set is also the same across the nodes in the cluster.

Figure 7: Multi server deployment

Related tasks








Advanced server cluster

When 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 a Content Manager 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 8: 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 tasks






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.Content Manager 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 network load 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 Content Manager requires traffic to be

encrypted over ssl and https schema endpoints, special attention is required regardingthe 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/ ISHCM/ and the web service client targets an

endpointlikehttps://nlbhostname/ISHWS/Wcf/API25/Application.

svc. The nlbhostname is completely independent from the server name of each node,but it forces the certificate used to configure the Web role to have this subject name. Thismeans that a proper certificate has to be created based on the balancer's properties andshared 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 9: Content Manager 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 10: Specialized Content Manager 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 istargeted in the Settings > XML Background 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 11: 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 > XML Background Task Settings. For example:

<service role="Generic"><matrix><group name="SynchronizeToLiveContent" maxExecutions="1"><handlers><add ref="SYNCHRONIZETOLIVECONTENT" />

</handlers></group><group name="Others" maxExecutions="2"><handlers><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 > XML Background 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 > XML Background Task Settings service roles names

like Publish16GB 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 161

■ “Best practices for creating a Trisoft InfoShare BackgroundTask service with a

specific role” on page 162

Verifying the installation

Follow these procedures to test and verify the critical parts of the new Content Manager

installation.

About this task

In general the following should never result in an error and cause no harm on a production

system. Testing more complex setups, such as the batch servers is out-of-scope.

Procedure

1. Log in into the Content Manager Web client as an existing user.

For example, go to http://servername/InfoShareAuthor and login using an existinglogin name and password, or the admin name and password.

2. Test the inbox by selecting the Inbox tab then select one of the inbox tabs in the left

pane.

Test is successful if the inbox is displayed in the right pane in a table format.

3. Create a folder in the repository:

a. Select the Repository tab.

b. Create a folder by clicking the New Folder icon in the upper left pane.



c. Enter a name.

d. Click Ok.

Test is successful if the folder is created (shown in the left pane). Remove the folder

after verifying using the Delete Folder button in the upper left pane.

4. Test publishing; if a publication is not available, skip this test.

a. Select the Repository tab.

b. Locate a publication (traverse the left pane) and select the publication (in the

right pane).

c. Select an output type in the bottom pane.

d. Click Publish.

A confirmation window is displayed.

e. Click OK in the confirmation window.

The publication output status (bottom right pane of the search window)

changes to Pending.

Test is successful if the output status changes to Draft; refresh the view to confirm

that the status changes to Draft.

5. Execute a full text search:

a. Select the Search tab.

b. Enter a term in the Search term field.

Be sure to enter a word that you know exists in your topics. For example,

enter the search word: the.

c. Click Search.

Test is successful if search results are displayed in the right pane.

6. Verify web services, synchronization, and network availability by starting the Client

Tools such as Publication Manager, Condition Manager or Authoring Bridge.

Test is successful if you can view the repository through the client tools and can view

or preview a topic in the repository.

7. Verify requested customizations to your system such as PDF stylesheets, extra

metadata, or extra development for integration with other systems (such as SDL-TMS,

PLMs, SingleSignOns).

Ask your Content Manager administrator or documentation manager what

customizations, if any, were requested.



Verifying URLs

If your environment includes reverse proxy servers, after you install Content Manager,

you need to check that certain URLs are accessible.

Procedure

1. Using Windows Internet Explorer, ensure that you can reach the following URLs:

■ BaseURL/ISHWS/Application.asmx?wsdl

■ BaseURL/ISHWS/Application.asmx?disco

where BaseURL is the value specified for the baseurl parameter, and ISHWSWS is thevalue specified for the infosharewswebappname parameter. These parameters are set inthe inputparameter. xml file that is used by the Content Manager 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.

Verify read access to the database by viewing an inbox

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 Content Manager web client.

Note: The web client address is a combination of the value in the parameters in the

inputparameters.xml file:baseurl/infoshareauthorcmwebappname/

For example, if:

<param name="baseurl"><currentvalue>https://example.corp</currentvalue>

and

<param name="infoshareauthorwebappname"><currentvalue>ISHCM</currentvalue>

then the URL is:https://example.corp/ISHCM/

Enter a Content Manager 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.

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 by creating 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 Content Manager 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.

ANew Folder window displays.

4. Enter a name in the Folder Name field. For example enter the folder name, Test.

5. Click OK.

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 the repository

You must create the user account and configure the connection to the repository to allow

a user to connect and access data in the Content Manager 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 Content Manager application server

■ URL of the Content Manager web services.

For example: http://example.com/ ISHWS/

■ URL of the Content Manager web client.

Procedure

1. Perform one of the following actions:



Application Action

Publication Manager Click Tools > Accounts.

XML authoring tool Click SDL Knowledge Center > Accounts.

The repository window is displayed.

2. Click Add.

3. Enter an Account Name and the URL of the Content ManagerWeb 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.

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

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 Content Manager

Information Portal documentation for information about adding output formats.

Procedure


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.

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.

A confirmation dialog displays.

7. Click OK to confirm and begin the publish process.

8. To display progress, click Refresh.

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


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.

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

Rebuilding the full text index

You can rebuild the full text index when, or if it is no longer synchronized with the

current database.

Before you begin

■ You must be a member of the system administration user group.

■ You must have full access to the application server.

■ The crawler service must be running.

Note: It is recommended that you rebuild the index outside regular business hours as

the initialization uses database resources. In addition, the index may take a while to rebuild

depending on the size of the repository.

Procedure

1. On the application server, open the \ InfoShare\ App<projectsuffix>\

Crawler\Configuration folder.

2. Execute the StartDataFolderCleanup. bat file to remove the existing index.

3. Execute the StartReindex. bat file to rebuild it based on the exiting repository

and project.

How-to references for advanced users

Advanced procedures for configuring the system for administrators who have had Content

Manager training are described.

Adding templates to the repository

You can add map, topic, graphic, or publication templates to your repository and make

them available to users when creating new objects.

When working in Content Manager you can create new objects by clicking the New

button in your editor or by creating a reference in Publication Manager. When creating

a new object, the Select Template window displays with a list of available templates. The

templates that are listed, are located in the repository under System > Editor

templates.

Adding the bookmap template

You can add the bookmap template to the Content Manager repository for users to apply

when creating a bookmap.



Before you begin


■ You must have permission to edit and store objects in the Content Manager

repository.

Procedure

1. Login to the Content Manager web client.

2. To add a value to the LOV:

a. Select the Settings tab.

b. Select Lists of Values (LOV) in the left pane.

c. From the Available List of Values, selectMap type.

d. Click Get Values.

e. Click Add.

f. In the Add Value window add the name of the template in the Name field.

For example, enter Book Map.

g. Optionally, add a Description which explains the proper use of the template.

h. Click OK.

3. Create the BookMap template:

a. In the Content Manager web, select the Repository tab.

b. Open System > Editor template then select Maps.

c. Click the New Object icon in the top right pane.

d. Enter the Bookmap in the Title field and select Bookmap from the list in the

Content Type field.

e. Click Next.

f. Click Next in the Add Map Document Version window.

g. Click Browse next to the File field in the Add Map Document Language

window.

h. Select the \InfoShare\Web\Author\EnterViaUI\System\

Editor Templates\ Maps\Bookmap.dita file.

The file is located on your Content Manager application server. If you are on

a client system, copy the file locally so you can select it.

4. Release the Bookmap template so users can select it.


b. Open System > Editor template then select Maps.

c. Select the Bookmap in the upper right pane.

d. Select the language in the bottom right pane.

e. Click Properties from the menu on the bottom right.



f. In theMap Document Language Properties window, select Released from

the Status list.

g. ClickModify.

Adding a topic template

You can add a topic template to the Content Manager repository for users to apply when

creating topics.

Before you begin



repository.

Procedure


2. To add a value to the LOV:

a. Select the Settings tab.

b. Select Lists of Values (LOV) in the left pane.

c. From the Available List of Values, select Topic type.

d. Click Get Values.

e. Click Add.

f. In the Add Value window add the name of the template in the Name field.

For example, if adding the DITA specialize Learning Plan template, enter

Learning Plan.

g. Optionally, add a Description which explains the proper use of the template.

h. Click OK.

3. Create the topic template:


b. Open System > Editor template then select Topics.

c. Click the New Object icon in the top right pane.

d. Enter the the name of the template in the Title field and select Topic from the

list in the Content Type field.

e. Click Next.

f. Click Next in the Add Topic Document Version window.



g. Click Browse next to the File field in the Add Topic Document Language

window.

h. Select the template file to add.

4. Release the template so users can select it.


b. Open System > Editor template then select Topic .

c. Select the template you added in the upper right pane.

d. Select the language in the bottom right pane.

e. Click Properties from the menu on the bottom right.

f. In the Topic Document Language Properties window, select Released from

the Status list.

g. ClickModify.

Adding an image template

You can add the template to create new images in the client tools.

Before you begin



repository.

Procedure


2. Create an empty image template:

a. Open System --> Editor template then select Illustrations.

If the Illustrations folder does not exist, create one by clicking on the New

Folder icon in the upper left pane.

b. Click the New Object icon in the upper right pane.

c. Enter the name of this image in the Title field.

d. Select or enter other optional information if necessary, then click Next in this

and the next, add language, window.

e. Select the Resolution from the list.

f. Verify that the Format matches the type of template file you have.

g. Click Browse next to the File field in the Add Image Document Language

window.

h. Select the file to use as a template.



Note: For example, Content Manager delivers an empty template file on the

application server that can be used as a template for png images:

\InfoShare\Web\Author\EnterViaUI\System\Editor

Templates\Illustrations\EmptyGraphic.png

3. Release the template so users can select it.

a. Under the Repository tab in the Content Managerweb client, open System -->

Editor template then select Illustrations.

b. In the upper right pane, select the template you added.

c. Select the version and language in the bottom right pane

d. Click Properties from the menu on the bottom right

e. In the Image Document Language Properties window, select Released

from the Status list.

f. ClickModify.

Adding a publication template

You add publication templates that you configure with output type(s), conditions or other

options which can then automatically be available for new publications that use the

template.

Before you begin


repository.

Procedure

1. Login to Content Manager Publication Manager.

2. Click Publication > New

A Select Template window displays.

3. Select New Publication.

4. Click Next.

5. Open the System > Editor Templates folder then select Publications.

6. Click Next in the bottom right pane.

7. Enter the Title for this publication template.

8. Complete other optional fields if needed.

9. Click OK.

10. The new publication is opened in Publication Manager.

11. Click the Output tab to Add and configure output formats that are to be available for

publications based on this template.



12. Optionally, click the Conditions and/or Variables tab to add conditions or variables

that are to be used by publications based on this template.

13. Click Publication > Close.

Content Delivery upgrade

Content Delivery has added features.

If you were using an earlier version of Content Delivery and just upgraded to the latest

one, you must republish your documents to your Content Delivery server to use the new

review and edit features of the product.

Advanced topics for installersThe following can be referenced for additional information when installing or upgrading

your systems.

InstallTool

InstallTool is a command line driven application which allows you to install Content

Manager, 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 Knowledge Center

■ eliminate the most common mistakes when installing Knowledge Center

■ provide reproducible installations over DEV, QA and PROD

■ provide a framework for system integrators to deploy a customer-specific Content

Manager application

■ make it easier to have multiple Content Manager 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

Content Manager 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 Content Manager official structure

containing the raw data.

InstallPlan.xml

The InstallPlan is generated by Content Manager 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 Content Manager 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 Content Manager 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.



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

DBUpgradeTool (DBUT) overview

The DBUT allows upgrading using a Database Upgrade Tool, similar to InstallTool.

The tool can handle statements from the Upgrade such as:

■ Oracle RDBMs indexes, views, packages for Content Manager

■ Microsoft SQL Server indexes, views, stored procedures and functions for Content

Manager

■ TriDK XML Setup and small Content Manager 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 Content Manager

grouped them together in one tool, developed to:

■ reduce the time needed to upgrade the Content Manager 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.

DBUpgradeTool 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 DBUpgradeTool and following the instructions.

The Content Manager database should be up, and all database satellites and services

should be down to allow exclusive access for the tool, to the database.

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 Content Manager database to

the Content Manager 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 Content Manager 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 Content Manager support if you

do not have the necessary Walkthrough documents to upgrade.

A server installed by the Content Manager 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 Content Manager version

ATrisoft.Setup.DBUpgradeTool.Plan.xml

This file is created by Content Manager and describes the complete upgrade order and

is part of every Content Manager version.

Warning: Do not make changes to this file.

Unimplemented features of the DatabaseUpgradeTool

DatabaseUpgradeTool must know about all Content Manager 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



Background task component

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

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.

There is only one queue for background tasks. There can be any number of background

task services picking up tasks.

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 Content Manager database and is accessible via the

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

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 information

■ “Admin.XMLBackgroundTaskConfiguration.xml” on page 124

■ “Understanding the availability matrix” on page 121

■ “Usage of variables inside the background task configuration” on page 118

■ “Understanding the isolation level of the handler” on page 123

Usage of variables inside the background task configuration

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" /><authorization type="authenticationContext" /><execution timeout="01:00:00" recoveryGracePeriod="00:10:00" isolationLevel="Process" useSingleThreadApartment="true" /><activator><comIEventHandler projectName="IshPluginsIso" className="cout"><configuration><parameters><parameter name="exportlocation" type="value">%ISHPROJECTDATAPATH%\ExportService\Data\DataExports</parameter><parameter name="exportspeclocation" type="value">%ISHPROJECTDATAPATH%\ExportService\Data\WatchFolder</parameter><parameter name="separatelng" type="value">yes</parameter><parameter name="requestedmetadata" type="ishfields"><ishfields><ishfield name="FSTATUS" level="lng" />



</ishfields></parameter><parameter name="raiseevent" type="value">ZIPFILES</parameter><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 theContentManager server:\Infoshare\App\BackgroundTask\Bin\

BackgroundTask.exe.config

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.BackgroundTaskConfigurationSection, Trisoft.InfoShare.BackgroundTask,Version=11.0.0.0, Culture=neutral, PublicKeyToken=555d9fcb450e0935"/>

</configSections><startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=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 117

Related information


Related tasks


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.

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="CREATETRANSLATIONFROMREPORT" /><add ref="CREATETRANSLATIONFROMLIST" /><add ref="CREATETRANSLATION" /><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><add ref="SYNCHRONIZETOLIVECONTENT" />


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

Looking at the first group Translations, the service will try to execute any background

task with the configured handler for exampleCREATETRANSLATIONFROMREPORT. Whilea CREATETRANSLATIONFROMREPORT instance is executing the service is allowed topick one more item from the queue matching the configured handlers of this specific groupincluding CREATETRANSLATIONFROMREPORT, for example RELEASETRANSLATIONS.As long as both background tasks are executing the service is not allowed to execute anymore from this group because the limit 2, defined in maxExecutions attribute, isreached. Once one of the tasks finishes then the service is allowed once again to executebackground tasks from the this group. The above reasoning is applied to every configuredgroup and the service will always try to execute a background task from any group thatstill hasn't reached its maxExecutions 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.

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


Repository configuration files

Describes the configuration files used by Content Manager.

Admin.XMLBackgroundTaskConfiguration.xml

The Admin.XMLBackgroundTaskConfiguration. xml file contains the data

that enables the handling and processing of background tasks.

Changelog

File version Content Manager version Notes

1.0 11.0.0 n/a

1.1 11.0.1 IntroducingIBackground-TaskHandler, anextra handler .NET

element to configure

handlers in .NET.

Introduction

The background task configuration is accessible from the Content Manager web client

using Settings > XML Background Task Settings

Important:Whenever you change the background task configuration, you need to

restart 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

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



Name Description

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.

aggregationRecovery @maximumRetries Specifies the maximum number of

attempts for the aggregation recovery



Example

<service role="Default"><matrix><group name="Translations" maxExecutions="2"><handlers><add ref="CREATETRANSLATIONFROMREPORT" /><add ref="CREATETRANSLATIONFROMLIST" /><add ref="CREATETRANSLATION" /><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><add ref="SYNCHRONIZETOLIVECONTENT" />


</handlers></group>

</matrix><leaseRecovery isEnabled="true" interval="00:05:00" /><poller isEnabled="true" interval="00:00:05" /><aggregationRecovery isEnabled="true" gracePeriod="00:10:00" interval="00:10:00" maximumRetries="3" />

</service>

Handler definition

XML elements

Name Description

handler Contains the handler definition.

handler @eventType Defines the name of the event type.

scheduler Defines the schedule for the background

task.



Name Description

scheduler @executeSynchronously Specifies whether the background task is

executed synchronously or

asynchronously.

authorization Specifies the authorization used for the

background task.

authorization @type Defines the authorization type.

Note: For all legacy COM+

IEventHandler handlers, the

authorization must be

"authenticationContext".

execution Container for the background task

execution configuration.

execution @timeout Defines the timeout interval for the

background task in TimeSpan format.

execution @recoveryGracePeriod If the background task times out, this

attribute defines the grace period interval

in TimeSpan format; when the grace

period expires, the service starts

recovery.

execution @isolationLevel Defines if the background task is

executed in the same process as the

service (None), in a new process

(Process), or in a newAppDomain within

the same process as the service

(AppDomain).

execution @useSingleThreadApartment Defines whether 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 Container for the activator configuration.

comIEventHandler Container for the COM+ IEventHandler

activator configuration.

comIEventHandler @projectName Defines the project name (e.g

ISAuthorIso).

Note: The project needs to be part of the

Trisoft-InfoShare-AuthorIso COM+

application.



Name Description

comIEventHandler @className Defines the class name (e.g

CTranslationMgmt).

configuration Contains all required information for the

background task execution. The data 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 119

net Contains the configuration for the .NET

activator.

net @name Specifies the handler name.

parameters Contains parameters required to execute

the background task.

parameter Contains a value for a single parameter

required to execute the background task.

parameter @name Specifies the name of the parameter

required to execute the background task.

errorHandler Configures the error handling of the

background task service which is limited

to deciding if the task should be retried or

not when a specific error is thrown by the

background task handler.

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

actions Configures the actions during error

handling

add Configures the action for a specific error



Name Description

add @errorNumber Contains the error number

Note: The value for the error number can

also be an asterisk (*) to indicate that this

configuration is valid for all exceptions

which are not explicitly configured.

add @action Specifies the action for a specific error.

The possible values are

■ "Retry" to indicate that the

background task must be retried

for this error.

■ "Ignore" to indicate that the

background task should not be

retried for this error.

add @delay Optional attribute indicating if the retry

must be delayed or can be done

immediately

Example

<handler eventType="CREATETRANSLATIONFROMREPORT"><scheduler executeSynchronously="false"/><authorization type="authenticationContext"/><execution timeout="01:00:00" recoveryGracePeriod="00:10:00" isolationLevel="None" useSingleThreadApartment="true"/><activator><comIEventHandler projectName="ISAuthorIso" className="CTranslationMgmt"><configuration><parameters><parameter name="batchsize" type="value">1000</parameter></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 (not 24 hours)

Related tasks


Related tasks


Related tasks


Related tasks


Admin.XMLChangeTrackerConfig.xml

The Admin.XMLChangeTrackerConfig. xml file is used to configure comparison

behavior between two XML files. Change tracking is available through the HTML

preview and through publishing.

Changelog


1.0 10.0.0 n/a

Overview

The Change Tracker component compares two versions of an XML file. You can configure

how XML element and attributes are compared.

This configuration file is accessible from the Content Manager web client, select

Settings > XML Change Tracker Settings

XML elements

The XML elements perform the following functions :



<Preview>

Stores the change tracking configuration for the HTML preview in both desktop

clients and web client.

<Publish>

Stores the change tracking configuration for publishing. By default, this configuration

is the same as in the <Preview> element.

<ElementsToSkipChildrenPropagation>

Lists all element for which change tracking marks changes on the element itself.

Changes are not propagated to child elements and / or attributes. In other words, if the

element is changed, this will be visible on the element itself, and not on its child

elements.

For example, when the attribute @href on the element <image> is changed, the image

should be marked as changed and not only child elements.

<ElementsToSkipChildrenPropagation><Name>image</Name><Name>hazardsymbol</Name><Name>glosssymbol</Name><Name>topicref</Name><Name>topichead</Name><Name>topicgroup</Name><Name>abbrevlist</Name><Name>amendments</Name><Name>appendix</Name><Name>appendices</Name><Name>backmatter</Name><Name>bibliolist</Name><Name>bookabstract</Name><Name>booklist</Name><Name>booklists</Name><Name>chapter</Name><Name>colophon</Name><Name>dedication</Name><Name>draftintro</Name><Name>figurelist</Name><Name>frontmatter</Name><Name>glossarylist</Name><Name>indexlist</Name><Name>notices</Name><Name>part</Name><Name>preface</Name><Name>tablelist</Name><Name>toc</Name><Name>trademarklist</Name><Name>anchorref</Name><Name>keydef</Name><Name>mapref</Name><Name>topicset</Name><Name>topicsetref</Name>



<Name>glossref</Name></ElementsToSkipChildrenPropagation>

<ElementsForParentPropagation>

Lists all elements for which change tracking marks changes on its parent element (if

possible).

<ElementsForParentPropagation><Name>entry</Name><Name>stentry</Name><Name>colspec</Name><Name>thead</Name><Name>sthead</Name><Name>tbody</Name><Name>dlhead</Name><Name>dthd</Name><Name>ddhd</Name><Name>dt</Name><Name>dd</Name><Name>proptype</Name><Name>propvalue</Name><Name>propdesc</Name><Name>proptypehd</Name><Name>propvaluehd</Name><Name>propdeschd</Name><Name>shape</Name><Name>coords</Name><Name>cmd</Name><Name>stepresult</Name><Name>pt</Name><Name>pd</Name><Name>chhead</Name><Name>choption</Name><Name>chdesc</Name><Name>copyryear</Name><Name>copyrholder</Name><Name>relheader</Name><Name>relcolspec</Name><Name>relcell</Name>

</ElementsForParentPropagation>

<AttributesToIgnore>

Lists all attributes that are to be ignored when comparing changes between two

versions.

For example, <Name>width</Name> means that changes to the width of a table rowshould not marked as changed.

<AttributesToIgnore><Name>navtitle</Name><Name>conref</Name>



<Name>width</Name><Name>height</Name><Name>class</Name><Name>style</Name><Name>id</Name><Name>colnum</Name><Name>colname</Name><Name>align</Name><Name>char</Name><Name>charoff</Name><Name>colwidth</Name><Name>colsep</Name><Name>rowsep</Name>

</AttributesToIgnore>

<Name>

The element name or the attribute name.

Admin.XMLExtensionConfiguration.xml

The Admin.XMLExtensionConfiguration. xml file contains the configuration

for extensions like integrations with external sources (e.g. taxonomy system,...)

Changelog


1.0 12.0.0 n/a

Introduction

The extension configuration is accessible from the Content Manager web client using

Settings > XML Extension Settings

This configuration file contains:

■ the configuration of the metadata bindings which link a metadata field with an

external source

■ the configuration of the search extensions

■ the configuration of the translation management extension

■ the source definitions specifying for each source the configuration which is

required by the handler

Note: Out-of-the-box, the extension configuration will be empty.

<infoShareExtensionConfig version="1.0"/>



MetadataBindings

XML elements

Name Description

metadatabindings Contains the configuration for linking

metadata fields with (external) sources

metadatabinding Links a metadata field with an (external)

source

metadatabinding @ishfieldname The element name of the metadata field

metadatabinding @sourceref The reference to the source definition

Example

<metadatabindings><metadatabinding ishfieldname="FCONTINENTS" sourceref="CitiesConnector" /><metadatabinding ishfieldname="FCOUNTRIES" sourceref="CitiesConnector" /><metadatabinding ishfieldname="FCITIES" sourceref="CitiesConnector" />

</metadatabindings>

Search

The configuration of the search extensions lists the sources that will enhance the search

query

Note: If there are multiple query enhancements configured, they are executed in order

of configuration.

XML elements

Name Description

search Contains the configuration for the

(external) sources extending the search

queryenhance Contains the configuration for the

(external) source enhancing the search

query

queryenhance @sourceref The reference to the source definition



Example

<search><queryenhance sourceref="CitiesConnector" />

</search>

Translation Management

The configuration of the translation management extensions specifies the handler which

will generate the file for the target language during translation management.

Note: Currently this is only supported for xml files.

XML elements

Name Description

translationmanagement Contains the configuration for the

(external) sources which will generate

the file of the target language

targetxmlfilegeneration Contains the configuration for the

(external) source generating the xml file

for the target languages

targetxmlfilegeneration @sourceref The reference to the source definition

Example

<translationmanagement><targetxmlfilegeneration sourceref="PreTranslation"/>

</translationmanagement>

Source definition

XML elements

Name Description

sources Contains the source definitions

specifying for each source the

configuration which is required by the

handler

source Contains the source definition with the

configuration for a specific handler

source @id The name of the source

source @handler The reference to the handler

implementation



Name Description

initialize Contains all information for the handler

which is passed to the handler during

initialization

parameters Contains parameters required by the

handler

parameter Contains a value for a single parameter


Note: The value inside the parameter can

be anything even a full xml structure.

The requirements for the value are

depending on what the handler needs.

parameter @name Specifies the name of the parameter


Example

<sources><source id="CitiesConnector" handler="CitiesConnector"><initialize><parameters><parameter name="continentsfieldname">FCONTINENTS</parameter><parameter name="continentsfieldlevel">logical</parameter><parameter name="countriesfieldname">FCOUNTRIES</parameter><parameter name="countriesfieldlevel">logical</parameter><parameter name="citiesfieldname">FCITIES</parameter><parameter name="citiesfieldlevel">logical</parameter>...</parameters>

</initialize></source>

</sources>

Admin.XMLInboxConfiguration.xml

The file Admin.XMLInboxConfiguration.xml is used to configure the inbox definitions

and the actions that can be executed on those inboxes.



Changelog


1.0 10.0.0 n/a

Overview

This configuration file is accessible from the Content Manager web client, select

Settings > XML Inbox Settings

XML elements

The Admin.XMLInboxConfiguration.xml contains the root elementInboxDefinitions.

Within InboxDefinitions the XML elements configure the following:

<Actions>

The actions specify which ToStatus must be set for the items in the inbox.

■ Each action is identified by an id containing a label.

■ The ToStatus is configured using the element name of the status

<Actions><Action id="Change2ToBeReviewed">

<ToStatus ref="VSTATUSTOBEREVIEWED" /></Action><Action id="Change2Released">

<ToStatus ref="VSTATUSRELEASED" /></Action>...

</Actions>

<Inbox>

The Inbox which is identified by a name specifies the following:

■ Which users can see the inbox via the userrole

■ Which objects are part of the inbox via InboxQuery

■ Which actions can be executed via the Buttons

Note: The Buttons are only used in the Web Client

<Inbox name="Reviewer" userrole="Reviewer"><InboxQuery><UserRelation field="FREVIEWER" operator="equal"value="$ME" /><MetaDataCondition><CardType value="CTMASTERL" />



<CardType value="CTMAPL" /><CardType value="CTLIBL" /><CardType value="CTIMGL" /><ISHField ref="FSTATUS" operator="equal" value="VSTATUSTOBEREVIEWED" valueoption="isrcElement" />

</MetaDataCondition></InboxQuery><Buttons><Button label="Release documents" action="Change2Released" /><Button label="Send documents back to author" action="Back2Draft" />

</Buttons></Inbox>

InboxQuery

Name Description

UserRelation Optional element that can be used to

filter the users that can access the inbox

to the users which are specified in the

specified field.

MetaDataCondition Required element which generates the

metadata filter

MetaDataCondition\CardType The CardType element specifying theelement name of the type of the objects

that must be part of the inbox

The possible values are:

■ CTMASTERL

■ CTMAPL

■ CTIMGL

■ CTLIBL

■ CTTEMPLATEL

Note:Minimally one CardType must be

configured.

MetaDataCondition\ISHField The ISHField element specifying themetadata filter

Note:Minimally one field must be

configured.

MetaDataCondition\ISHField\@ref The element name of the field



Name Description

MetaDataCondition\ISHField\@operator The operator used for the value specified:

■ in

■ notin

■ equal

■ notequal

■ lessthan

■ greaterthan

■ lessthanorequal

■ greaterthanorequal

MetaDataCondition\ISHField\@value The value

MetaDataCondition\ISHField\

@valueoption

Optional attribute which can be used to

indicate that the specified value is the

element name of a LovValue (e.g. status)

<infoSharePluginConfig version="2.0"><namespaces><namespace prefix="ditaarch">http://dita.oasis-open.org/architecture/2005/</namespace>

</namespaces><write ishcondition="ISHType in (’ISHMasterDoc’, ’ISHModule’, ’ISHLibrary’)"><body><sequence><plugin name="CHECKREVIEWERFILLEDIN" handler="OnFieldChangeCompare" ishcondition="ISHLevel=’lng’"><description>Checks that the ’Reviewer’ is filled inwhen the ’FSTATUS’ field is changed to ’To beReviewed’</description><workingset><ishfields><ishfield name="FSTATUS" level="lng" /><ishfield name="FREVIEWER" level="lng" /></ishfields></workingset>

<initialize><parameters><parameter name="ConditionMetadataField">FSTATUS</parameter><parameter name="ConditionMetadataFieldLevel">lng</parameter><parameter name="ConditionMetadataFieldValueType">element</parameter><parameter name="ConditionMetadataFieldToValue">VSTATUSTOBEREVIEWED</parameter><parameter name="CompareMetadataField">FREVIEWER</parameter><parameter name="CompareMetadataFieldLevel">lng</parameter><parameter name="CompareMetadataFieldOperator">notempty</parameter></parameters></initialize></plugin>

...</sequence>

</body></write>

</infoSharePluginConfig>

Example

<InfoShareInbox version="1.0"><InboxDefinitions><Actions><Action id="Change2ToBeReviewed"><ToStatus ref="VSTATUSTOBEREVIEWED" />

</Action>...

</Actions><Inbox name="Reviewer" userrole="Reviewer"><InboxQuery><UserRelation field="FREVIEWER" operator="equal" value="$ME"/><MetaDataCondition><CardType value="CTMASTERL" /><CardType value="CTMAPL" /><CardType value="CTLIBL" /><CardType value="CTIMGL" /><ISHField ref="FSTATUS" operator="equal" value="VSTATUSTOBEREVIEWED" valueoption="isrcElement" /></MetaDataCondition>

</InboxQuery><Buttons><Button label="Release documents" action="Change2Released" /><Button label="Send documents back to author" action="Back2Dra



ft" /></Buttons>

</Inbox>...

</InboxDefinitions></InfoShareInbox>

Admin.XMLStatusConfiguration.xml

The Admin.XMLStatusConfiguration. xml file contains the data defining an

XML status configuration.

Changelog


1.0 10.0.0 n/a

2.0 11.0.0 The

customerfunctionattribute was

removed from the

Admin.XMLStatusConfiguration.xml

file. Customer

functions are now

part of the IWriteplugins.

3.0 12.0.0 The

OutOfDateStatesand

OutOfDateDraftStatesdraft status

definition values

were removed from

the InfoShareS-tates section.

Overview

This configuration file is accessible from the Content Manager web client: select

Settings > XML Status Settings



XML elements

Name Description

InfoShareStates Root node of the XML status

configuration

StateDefinition Contains status definitions

DraftStates Contains status definitions for draft

statuses

ReleasedStates Contains status definitions for released

statuses

Status Defines a draft status

Status @Elm Element name of the status

Status @value Value of the status

Transitions Defines allowed status transitions

FromStatus Defines a "from" status

FromStatus @ref References an element name for the

"from" status

FromStatus @userrole The user role the status transition is

defined for

ToStatus Defines a "to" status

ToStatus @ref References an element name for the "to"

status

InitialStates Defines initial status for a given user role

InitialStates @userrole The user role the initial status is defined

for

Status Defines an initial status

Status @ref References an element name of the initial

status

MetaDataCondition Defines the allowed conditions for the

status transition

Cardtype Specifies a card type the status transition

is allowed for

Cardtype @value Defines the card type

ISHField Defines a condition field

ISHField @ref The element name of the condition field

ISHField @operator Condition operator

ISHField @value Condition value



</FromStatus><FromStatus ref="VSTATUSTRANSLATED" userrole="Translator"><ToStatus ref="VSTATUSTOBETRANSLATED" />

</FromStatus><FromStatus ref="VSTATUSRELEASED" userrole="Administrator"><ToStatus ref="VSTATUSEXPIRED" />

</FromStatus><FromStatus ref="VSTATUSSYSTEM" userrole="Administrator"><ToStatus ref="VSTATUSSYSTEMREADONLY" />

</FromStatus><FromStatus ref="VSTATUSTOBETRANSLATED" userrole="TRANSLATORSERVICE"><ToStatus ref="VSTATUSINTRANSLATION" />

</FromStatus><FromStatus ref="VSTATUSINTRANSLATION" userrole="TRANSLATORSERVICE"><ToStatus ref="VSTATUSTRANSLATED" />

</FromStatus></Transitions><InitialStates userrole="TRANSLATORSERVICE"><Status ref="VSTATUSTOBETRANSLATED"><MetaDataCondition><Cardtype value="CTMAP" /><Cardtype value="CTIMG" /><Cardtype value="CTLIB" /><Cardtype value="CTTEMPLATE" /><Cardtype value="CTMASTER" />

</MetaDataCondition></Status>

</InitialStates><InitialStates userrole="Author"><Status ref="VSTATUSDRAFT"><MetaDataCondition><Cardtype value="CTMASTER" /><Cardtype value="CTMAP" /><Cardtype value="CTIMG" /><Cardtype value="CTLIB" /><Cardtype value="CTTEMPLATE" />


</InitialStates><InitialStates userrole="Administrator"><Status ref="VSTATUSDRAFT"><MetaDataCondition><Cardtype value="CTMASTER" /><Cardtype value="CTMAP" /><Cardtype value="CTIMG" /><Cardtype value="CTLIB" /><Cardtype value="CTTEMPLATE" />




</InitialStates></InfoShareStates>

Admin.XMLTranslationConfiguration.xml

The file Admin.XMLTranslationConfiguration.xml contains the configuration for the

metadata that is applied when auto-generating target languages and defining source and

pivot languages.

Changelog


1.0 10.0.0 n/a

2.0 12.0.0 The XML schema

has been significally

re-worked.

Parameters

deletedElements,

chgAttribute and

objectInfoOnRoot

are no longer

supported

ComparisonElements

section and

isNumericRegExp

parameter are moved

to pretranslation

extension

configuration.

InfoshareTrans-

lationMgmts section

is replaced by

translationobject

section

GenerationScheme

section is replaced

by languagepaths

section

Overview

This configuration file is accessible from the Content Manager web client. Select

Settings > XML Translation Settings



XML elements

<parameters>

The <parameters> element contains a number of parameters used to configure a

variety of settings.

The following table provides an overview:

Name Description

ResolutionRestriction ■ When Translation Management is

enable on illustrations, the

parameter ResolutionRest-riction can be used to limitthe resolutions which must be

created by Translation Manage-

ment.

■ In the standard configuration,

there are no resolutions specified.

This means when Translation

Management is enabled on illus-

trations, all resolutions in the

source language are also created

by Translation Management in

the target languages.

MaxInheritedLanguageDepth ■ The target languages can be

specified in the metadata of the

current object but can also be

inherited from requested and

inherited languages of the parent

objects. The code to inherit the

languages recursively retrieves

the parents objects and adds extra

languages. The parameter MaxI-nheritedLanguageDepthspecifies how many levels are to

be used.

■ Since a typical object has three

(3) levels (map, topic, illustra-

tion), the default value is 2.

<parameters><parameter name="ResolutionRestriction">

</parameter>

<parameter name="MaxInheritedLanguageDepth">2</parameter></parameters>

<translationobject>

Defines how target languages, that are generated by Content Manager's Translation

Management, get the necessary metadata values.

All language-level metadata fields that are defined as mandatory must be configured,

otherwise Content Manager's Translation Management fails to generate the target

language objects.

The <ishfields> element specifies the metadata fields that must be copied from source.

If this configuration depends on certain conditions, ishcondition attribute can be

used to provide those.

<translationobject><copyfromsource><ishfields ishcondition="ISHType in (’ISHMasterDoc’,’ISHModule’, ’ISHLibrary’)">

<ishfield name="FISHWORDCOUNT" level="lng"/><ishfield name="FISHCONDITIONS" level="lng"/><ishfield name="FISHLINKS" level="lng"/><ishfield name="FISHHYPERLINKS" level="lng"/><ishfield name="FISHIMAGELINKS" level="lng"/><ishfield name="FISHVARINUSE" level="lng"/><ishfield name="FISHVARASSIGNED" level="lng"/><ishfield name="FISHFRAGMENTLINKS" level="lng"/><ishfield name="FISHTARGETS" level="lng"/><ishfield name="FAUTHOR" level="lng"/><ishfield name="FREVIEWER" level="lng"/><ishfield name="FTRANSLATOR" level="lng"/>

</ishfields><ishfields ishcondition="ISHType in (’ISHIllustration’,’ISHTemplate’)">

<ishfield name="FAUTHOR" level="lng"/><ishfield name="FREVIEWER" level="lng"/><ishfield name="FTRANSLATOR" level="lng"/>

</ishfields></copyfromsource>

</translationobject>

The following condition names can be used for determining which fields need to be

copied from the source:

Condition name Description

ISHType The type of the object

FMAPID The unique identifier of the logical level

(= LogicalId)


VERSION The version number of the object

DOC-LANGUAGE The language(s) of the object

Note: The value can be a label (e.g. "en")

or an element name (e.g. "VLANGUA-

GEEN")

FSOURCELANGUAGE The source language of the object



GEEN")

FRESOLUTION The resolution of the illustration

Note: The value can be a label (e.g.

"Thumbnail") or an element name (e.g.

"VRESOLUTIONTHUMBNAIL")

EDT The element name of the EDT (e.g.

"EDTXML")

ISHUserGroup The element names of the user groups

which has write access to the object (e.g.

"VUSERGROUPSYSTEMMANAGE-

MENT")

<languagepaths>

Provides allowed translation paths.

The <languagepath> element defines the source language - target language

combination that is allowed in the system. The order is important because it defines

the priority of the language combination. For instance, if you define 'nl - fr'

combination before 'en - fr' one, then, when creating a target language object in

French, the system will prefer to use the Dutch object as a source, when available.

Only if not available in Dutch, the system will use the English object as a source.

<languagepaths><languagepath from=’en’ to=’aa’/><languagepath from=’en’ to=’ab’/><languagepath from=’en’ to=’af’/>...<languagepath from=’en’ to=’yo’/><languagepath from=’en’ to=’zh’/><languagepath from=’en’ to=’zu’/>

</languagepaths>

Admin.XMLWriteObjPluginConfig.xml

The Admin.XMLWriteObjPluginConfig. xml file contains the configuration used

when writing plugins.



Changelog


2.0 11.0.0 This is the first

version of

Admin.XMLWriteObjPluginConfig.xml;

it replaces and

supersedes

Admin.XMLPluginConfig.xml.

Overview

This configuration file is accessible from the Content Manager web client. Select

Settings > XML Write Plugin Settings.

XML elements

Name Description

infoShare-

PluginCon-

fig

Root node of the plugin XML configuration

namespac-

es

Contains namespace elements

namespace Provides the matched namespace for the namespace prefix used in the

XPath expression in the plugin parameters

namespace

@prefix

The prefix that is used for the provided namespace

write Describes a sequence of plugins that will be executed within the current

action. Write element can define the condition that will be used to make

sure that no more than 1 write element can be found by the plugin engine

for the current action in the current conditions. If there is more than 1 write

element applicable for the current action, the main operation fails.

write

@ishcondi-

tion

The condition which determines when the current write sequence should be

activated

body The element that contains a sequence of the body plugins (plugins that are

executed as a part of a main operation)

sequence The element that contains a sequence of body plugins

plugin Describes a single plugin

plugin

@name

The name of the plugin



Name Description

plugin

@handler

The reference to the plugin implementation

plugin

@ishcondi-

tion

The condition which determines when the current plugin should be

activated

description Plugin description

workingset Describes all the metadata fields that the plugin can read or write in. These

fields are guaranteed to be loaded by the plugin engine.

ishfields Contains ishfields

ishfield Describes an ishfield

initialize Describes everything that should be passed to the plugin instance upon

initialization

parameters Contains parameter elements

parameter The parameter that is passed to the plugin

Note: The parameter can contain anything from a string to a new XML

structure.

<infoSharePluginConfig version="2.0"><namespaces><namespace prefix="ditaarch">http://dita.oasis-open.org/architecture/2005/</namespace>

</namespaces><write ishcondition="ISHType in (’ISHMasterDoc’, ’ISHModule’,’ISHLibrary’)"><body><sequence><plugin name="CHECKREVIEWERFILLEDIN" handler="OnFieldChangeCompare"ishcondition="CurrentAction in (’Create’, ’Update’,’Checkin’, ’SetMetadata’, ’CheckOut’, ’UndoCheckOut’)and (ISHLevel=’lng’)"><description>Checks that the ’Reviewer’ is filled inwhen the ’FSTATUS’ field is changed to ’To be Reviewed’</description>

<workingset><ishfields><ishfield name="FSTATUS" level="lng" /><ishfield name="FREVIEWER" level="lng" /></ishfields></workingset><initialize><parameters><parameter name="ConditionMetadataField">FSTATUS</parameter><parameter name="ConditionMetadataFieldLevel">lng</parameter><parameter name="ConditionMetadataFieldValueType">element</parameter><parameter name="ConditionMetadataFieldToValue">VSTATUSTOBEREVIEWED</parameter><parameter name="CompareMetadataField">FREVIEWER</parameter><parameter name="CompareMetadataFieldLevel">lng</parameter><parameter name="CompareMetadataFieldOperator">notempty</parameter></parameters></initialize></plugin>...<plugin name="SETTITLE" handler="BlobSetXmlNode"ishcondition="EDT=’EDTXML’ and VERSION=’1’ and CurrentAction=’Create’"><description>Set title for new objects using themetadata title</description><workingset><ishfields><ishfield name="FTITLE" level="logical" /></ishfields></workingset><initialize><parameters><parameter name="OnNodeXPath">(/*[contains(@class,’map/map ’)][title]) | (/*[contains(@class,’ topic/topic’)][title])</parameter><parameter name="NodeType">node</parameter><parameter name="NodeName">title</parameter><parameter name="OverwriteExisting">Yes</parameter><parameter name="Value"><value type="MetadataField"><parameter name="MetadataField">FTITLE</parameter><parameter name="MetadataFieldLevel">logical</parameter></value></parameter></parameters></initialize>



</plugin>...

</sequence></body>

</write></infoSharePluginConfig>

Remarks

■ The metadata fields specified in the workingset section of each plugin shouldNOT be specified with an ishvaluetype. The specified fields are added to thecontext as an internal field object from which the plugin can request all value types.

Supported conditions

The following condition names can be used for determining if the plugin must be executed

(for topics, maps, illustrations, libraries and templates):



ISHLevel This controls when to execute the plugin

depending on the level of metadata that are

updated.

The allowed values are: "logical",

"version" and "lng".

When updating the language level

metadata, the system operates as if the

metadata from all levels are updated.

This means that in this update context, the

ISHLevel condition will be true for all

allowed values.

FMAPID The unique identifier of the logical level (=

LogicalId)

VERSION The version number of the object

DOC-LANGUAGE The language(s) of the object



GEEN")

FSOURCELANGUAGE The source language of the object



GEEN")




FRESOLUTION The resolution of the illustration


"Thumbnail") or an element name (e.g.

"VRESOLUTIONTHUMBNAIL")

EDT The element name of the EDT (e.g.

"EDTXML")

ISHUserGroup The element names of the user groups

which has write access to the object (e.g.


MENT")

CurrentAction The API method which is currently

executed like "Create", "Update",

"Checkin", "SetMetadata",...

The following condition names can be used for determining if the plugin must be executed

for publications:



ISHLevel This controls when to execute the plugin

depending on the level of metadata that are

updated.

The allowed values are: "logical",

"version" and "lng".

When updating the language level

metadata, the system operates as if the

metadata from all levels are updated.

This means that in this update context, the

ISHLevel condition will be true for all

allowed values.

FMAPID The unique identifier of the logical level (=

LogicalId)

VERSION The version number of the publication

DOC-LANGUAGE The language(s) of the publication output



GEEN")

FISHPUBLNGCOMBINATION The language combination of the

publication output (e.g. "en+fr+de")




FISHOUTPUTFORMATREF The output format of the publication output


"Content Delivery") or an element name

(e.g. "VOUTPUTFORMATSDLLIVE-

CONTENTREACH")

EDT The element name of the EDT matching

the output format (e.g. "EDTZIP")

ISHUserGroup The user groups which has write access to

the publication (e.g.


MENT")

CurrentAction The API method which is currently

executed like "Create", "Update",

"SetMetadata",...

Server roles

An overview of the different server roles which can be recognized within a Content

Manager installation

In a standard Content Manager 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

■ ISHCM which is the Content Manager Web Client

■ ISHWS which hosts all web services

■ ISHSTS which is the internal Security Token Service

Since the Web role is required on every Content Manager installation, an out-of-the-box

Content Manager installation will enable all web endpoints.

The Web role is used to serve external clients, but it is also used to serve the internalroles like the Translation role and the Default background task role. When it is used forexternal web endpoints, the Web role can be scaled out via Network Load Balancing(NLB).

Related tasks




Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related tasks


Related information



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


Related tasks


Related tasks


Related information


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 BackgroundTaskOne" 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 Content Manager Web Client as an administrator user.

■ Click Settings > XML Background 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.

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 tasks


Related information



Related tasks


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:

■ CREATETRANSLATIONFROMREPORT

■ CREATETRANSLATIONFROMLIST

■ CREATETRANSLATION

■ 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 Content Manager 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 157



In the first scenario, you need to configure a new service role in XMLBackground Task

Settings

1. Login to Content Manager Web Client as an administrator user

2. Click Settings > XML Background Task Settings.

3. Add an extra service definition with role Translation

<service role="Translation"><matrix><group name="Translations" maxExecutions="2"><handlers><add ref="CREATETRANSLATIONFROMREPORT" /><add ref="CREATETRANSLATIONFROMLIST" /><add ref="CREATETRANSLATION" /><add ref="RELEASETRANSLATIONS" /></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>

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 tasks


Related information



■ “How to create a new BackgroundTask service with a role” on page 162

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 Content Manager Web Client as an administrator user.

2. Click Settings > XML Background Task Settings.

3. Add an extra service definition with role Publish:

<service role="Publish"><matrix><group name="Export" maxExecutions="2"><handlers><add ref="EXPORTFORPUBLICATION" /><add ref="INBOXEXPORT" /><add ref="REPORTEXPORT" /><add ref="SEARCHEXPORT" /><add ref="PUBLICATIONEXPORT" />

</handlers></group></matrix><leaseRecovery isEnabled="true" interval="00:05:00"/>



<poller isEnabled="true" interval="00:00:10" /><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.

Related tasks


Related tasks


Related information


■ “Best practices for creating a Trisoft InfoShare BackgroundTask service with a

specific role” on page 162

Best practices for creating a Trisoft InfoShareBackgroundTask service with a specific 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


Related tasks


Related information

■ “How to create a new BackgroundTask service with a role” on page 162

■ “How to adapt the role of an existing BackgroundTask service” on page 164

How to create a new BackgroundTask service with a 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 Content Manager installation yet.

■ Check the name of the service role via Settings > XML Background

Task Settings. If the name is newServiceRole, there should be a XMLfragment like the following:

<service role="newServiceRole">

<matrix>...</matrix><leaseRecovery isEnabled="true" interval="00:05:00"/><poller isEnabled="false" interval="00:00:10" /><aggregationRecovery isEnabled="false" gracePeriod="00: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 Content

Manager CD

2. Goto to the service definition for Trisoft-InfoShare-BackgroundTask

<serviceapp name="Trisoft-InfoShare-BackgroundTask"><servicename>Trisoft InfoShare#!#installtool:PROJECTSUFFIX#!# BackgroundTask One</servicename><filepath>#!#installtool:APPPATH#!#\App#!#installtool:PROJECTSUFFIX#!#\BackgroundTask\Bin\BackgroundTask.exe--service "Trisoft InfoShare#!#installtool:PROJECTSUFFIX#!# BackgroundTask One" Default

</filepath>...

</serviceapp>

3. Replace the Default role with newServiceRole

<serviceapp name="Trisoft-InfoShare-BackgroundTask"><servicename>Trisoft InfoShare#!#installtool:PROJECTSUFFIX#!# BackgroundTask One</servicename><filepath>#!#installtool:APPPATH#!#\App#!#installtool:PROJECTSUFFIX#!#\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 windowsservice with the specified service role

Related tasks


How to adapt the role of an existing BackgroundTask 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 > XML Background Task

Settings.

If the name is newServiceRole, there should be a XML fragment like the following:

<service role="newServiceRole">

<matrix>...</matrix><leaseRecovery isEnabled="true" interval="00:05:00" /><poller isEnabled="false" interval="00:00:10" /><aggregationRecovery isEnabled="false" gracePeriod="00:10:00" interval="00:10:00" maximumRetries="3" />

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



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-box and present in the XML Background Task Settings.

d. Edit the data and change Default to the new service role namenewServiceRole

The data should now look like.

D:\InfoShare\App\BackgroundTask\Bin\BackgroundTask.exe--service "Trisoft InfoShare BackgroundTask One"newServiceRole

e. Save the data.

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

Setting the MSDTC timeout on Microsoft WindowsServer

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 Content Manager servers.

Procedure

1. Go to 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 Services.

7. Restart the Distributed Transaction Coordinator Service


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

Configuring MSDTC to listen on a specific port

You can configure the Microsoft Distributed Transaction Coordinator (MSDTC) to listen

on a specific RPC server port

About this task

To configure DTC to listen on a specific RPC server port you add or modify the following

registry key value.

Procedure

1. Open a regedit window and add or modify the following:

■ Path: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSDTC\

■ Name: ServerTcpPort

■ Type: REG_DWORD

■ Value: <Numerical value of the port on which DTC is to

listen>

For example, 0x00001f90 = decimal value port 8080

2. Access the Control Panel > Administrative Tools > Services

window and restart the Distributed Transaction Coordinator service for the changes

to take effect.

3. To confirm that the MSDTC service is listening on the configured server port, at a

command prompt enter netstat.exe.

Firewalls and blocked ports

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.

Note: 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 Content Manager 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 Content Manager 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 Content Manager

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:

■ Content Manager End User components

■ Content Manager Author components

■ Content Manager 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,30,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 Content

Manager 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 Content Manager 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

(MSDTC) can locate each other using their NETBIOS names.

Used by:

■ All Content Manager 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.



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

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:

■ Content Manager Publishing components


Settings:


SMTP TCP 25 IN/OUT



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

Microsoft SQL Server

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

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



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

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

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

Enterprise manager or the Database Management Studio. Content Manager 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

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://SUPPORT.MICROSOFT.COM/KB/287932

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

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


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

■ Content Manager End User Website

■ Content Manager Author Website

■ Content Manager WebServices

Settings:


HTTPS TCP 443 IN/OUT



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



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

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

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

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

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 Content Manager client

tool software installed, as the software installed on the server.

Installing the Authoring Bridge

The 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 the Authoring Bridge

before uninstalling XMetaL.

■ 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 Content Manager

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.

The installation begins.

4. Click the Close button to exit the installation. The SDL Knowledge Center menu is

now available in your authoring toll's menu bar.



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 sure that the

user account exists.

■ Make sure 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.

■ Known issue with XMetaL: If the Authoring Bridge is uninstalled, the SDL

Knowledge Center menu will remain in the menu bar, with all menu options

greyed out. The user must start XMetaL while pressing the CTRL key in order

to have XMetaL clean up the menu bar and remove the SDL Knowledge

Center menu.

Installing Publication Manager

The 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 Manager

The 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 Content Manager 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 .

The installation begins.

6. When the installation is complete, click Close to exit.

Installing Content Importer

You can install Content Importer without closing other applications or restarting your

system. If you upgrade Content Importer, you do not need to uninstall the existing version.

Before you begin

The Microsoft .NET Framework must be installed.

Procedure

1. Click the .msi file.

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 (x86)\

SDL\Content Importer\12.0.

b. 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 Content Importer:

■ ResolutionList.xml

■ ContentImporter.xsl



■ Content Importer executable file

■ .dll files

The documentation is written to the help subdirectory.



Chapter 3

Troubleshooting the databaseinstallation

When the database returns errors after creation or import, check the available corrective

actions.

What to do if Oracle database import failsIf the import fails, you may want to remove the designated ISOURCE database user and

all the objects it owns before you can try again.

Procedure

1. Start SQLPLUS /NOLOG from a shell where the ORACLE_SID and ORACLE_

HOME variables are set correctly; at a command prompt type:

CONNECT SYS/CHANGE_ON_INSTALL AS SYSDBADROP USER ISOURCE CASCADE;

2. Recreate the ISOURCE user.

What to do in case of "ORA-12638" errorA freshly installed Oracle database sometimes results in ORA-12638 errors. If you are

running a dedicated Content Manager Oracle server, you can resolve problems by altering

the SQLNET.AUTHENTICATION_SERVICES setting.

Note: If you are not running a dedicated Content Manager 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).


sdlknowledgecentercontentmanager 12.0.0 · pdf filexulrunner xulrunner is a runtime...

Documents