server installation manual, version 2014 r2 for oracle...
TRANSCRIPT
-
MANUAL SERVER INSTALLATION MANUAL VERSION 2014 R2 FOR ORACLE WEBLOGIC
-
Imprint Copyright TTS Knowledge Products GmbH. All rights reserved. Server Installation Manual, Version 2014 R2 for Oracle Weblogic 16. September 2014
-
Table of Contents
I
Table of Contents
1 GENERAL INFORMATION ................................................................................. 1
1.1 Document history ...................................................................................................... 1
1.2 Introduction ............................................................................................................... 1
1.2.1 Objective ......................................................................................................... 1 1.2.2 Target audience ............................................................................................... 2 1.2.3 Prerequisites ................................................................................................... 2 1.2.4 Contact ............................................................................................................ 2 1.2.5 Structure .......................................................................................................... 2 1.2.6 Conventions .................................................................................................... 3 1.2.7 Your feedback is highly welcome ..................................................................... 4
1.3 Application description .............................................................................................. 4
1.4 System overview and deployment scenarios ............................................................ 4
2 SYSTEM REQUIREMENTS ................................................................................ 6
2.1 Hardware and Software requirements ....................................................................... 6
3 PREPARATIONS .............................................................................................. 7
3.1 License ..................................................................................................................... 7
3.2 Database .................................................................................................................. 7
3.2.1 JDBC driver ..................................................................................................... 7 3.2.2 Microsoft SQL Server 2005 and 2008 .............................................................. 8 3.2.3 Oracle 9i, 10g and 11g .................................................................................... 8
3.3 File system ............................................................................................................... 9
3.4 Application server ..................................................................................................... 9
3.5 Solr installation ....................................................................................................... 10
4 INSTALLATION STEP-BY-STEP ........................................................................ 11
4.1 Checklist ................................................................................................................. 11
4.2 Installation environment .......................................................................................... 11
4.2.1 Setup installation environment ....................................................................... 12 4.2.2 Configure TTS Server with application-config.properties ............................... 15
4.3 Data source ............................................................................................................ 19
4.3.1 Creating a data source with the Oracle Weblogic 10.3.5 Console .................. 19 4.3.2 Configuring Connection pooling ..................................................................... 24 4.3.3 Testing the database connection ................................................................... 26
4.4 Application server settings ...................................................................................... 29
4.4.1 JVM-settings .................................................................................................. 29 4.4.2 URL-encoding................................................................................................ 29
4.5 Deployment ............................................................................................................ 30
4.6 Deployment of the Solr core ................................................................................... 35
4.7 Post installation steps ............................................................................................. 35
4.7.1 Initialization of the database schema ............................................................. 35 4.7.2 First login as administrator ............................................................................. 38
-
Table of Contents
II
4.7.3 Next steps ..................................................................................................... 41
4.8 Securing Solr .......................................................................................................... 41
4.8.1 Securing Solr via Basic Authentication .......................................................... 41 4.8.2 Configure user and groups ............................................................................ 43 4.8.3 Activate Logging ............................................................................................ 50
4.9 Troubleshooting ...................................................................................................... 52
4.9.1 The server does not start up .......................................................................... 52 4.9.2 Database is unavailable ................................................................................. 53 4.9.3 Login fails ...................................................................................................... 53
4.10 Solr installation example (single Solr instance) ....................................................... 54
4.10.1 Solr installation example for Weblogic ........................................................... 54 4.10.2 Solr.war deployment ...................................................................................... 55 4.10.3 Change Deployment order ............................................................................. 59 4.10.4 Connect to Solr admin console ...................................................................... 60 4.10.5 Modify web.xml in solr.war ............................................................................. 62
5 MIGRATING FROM PREVIOUS VERSIONS ......................................................... 64
5.1 General remarks ..................................................................................................... 64
5.2 Updating from version 7.1 to 2012 .......................................................................... 64
5.3 Updating from version 2012 to 2012 R2 .................................................................. 64
5.4 Updating from version 2012 R2 to 2013 .................................................................. 65
5.5 Updating from version 2013 to 2013 R2 .................................................................. 67
5.6 Updating from version 2013 R2 to 2014 .................................................................. 68
5.6.1 Solr Search Engine ........................................................................................ 68 5.6.2 New mandatory application properties ........................................................... 68 5.6.3 New optional application properties ............................................................... 69
5.7 Updating from version 2014 to 2014 R2 .................................................................. 72
5.7.1 Scheduler Service on Websphere .................................................................. 72
6 APPENDIX .................................................................................................... 74
6.1 Properties service ................................................................................................... 74
6.2 Data service ............................................................................................................ 79
6.2.1 JNDI data source ........................................................................................... 79
6.3 Store service ........................................................................................................... 81
6.4 User service for authentication and authorization ................................................... 82
6.4.1 Login modules ............................................................................................... 82 6.4.2 LDAP authentication ...................................................................................... 83 6.4.3 Single-Sign-On (SSO) ................................................................................... 88
6.5 Logging service ...................................................................................................... 94
6.6 Version control and Workflow service ..................................................................... 96
6.6.1 Version control ............................................................................................... 96 6.6.2 Workflow service ........................................................................................... 96
6.7 Cache service ......................................................................................................... 98
6.8 Repository service ................................................................................................ 100
6.9 Notification service ................................................................................................ 100
-
Table of Contents
III
6.10 Language service ................................................................................................. 102
6.11 Template service .................................................................................................. 103
6.12 Scheduler service ................................................................................................. 104
6.13 Configuration service ............................................................................................ 105
6.14 Feature service ..................................................................................................... 106
6.15 Miscellaneous parameters .................................................................................... 106
6.16 Search service ...................................................................................................... 108
6.16.1 Solr Search Service ..................................................................................... 108 6.16.2 Searching parameter ................................................................................... 109 6.16.3 Highlighting parameter ................................................................................. 110
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
1
1 General Information
1.1 Document history
Date Author Version Changes
02.07.2009 Maurice Gottschalk 0.1 Created
17.08.2009 Maurice Gottschalk 0.2 Ready for quality assurance
22.10.2009 Ulfert Kppen 0.3 Text QA
22.02.2010 Maurice Gottschalk 0.4 Optimizing the guide
28.05.2010 Andr Wolf 0.5 Technical QA
03.06.2010 Ulfert Kppen 1.0 Final proofreading
13.05.2011 Maurice Gottschalk 1.1 Updated guide to version 7.0
18.05.2011 Maurice Gottschalk 1.2 Ready for quality assurance
31.5.2011 Ulfert Kppen 2.0 Proofreading and QA done
09.09.2011 Maurice Gottschalk 2.1 Updated guide to version 7.1
13.02.2012 Maurice Gottschalk 2.2 Restructured and updated the guide for TTKF 2012
20.02.2012 Maurice Gottschalk 2.3 Ready for quality assurance
04.04.2012 Ulfert Kppen 3.0 Proofreading & QA done
06.09.2012 Maurice Gottschalk 3.1 Updated guide to version 2012 R2
07.09.2012 Maurice Gottschalk 3.2 Ready for quality assurance
10.09.2012 Ulfert Kppen 3.3 QA done
22.02.2013 Maurice Gottschalk 4.0
02.04.2013 Ulfert Kppen 4.1 QA done
02.11.2013 Ulfert Kppen 5.0 Updated to version 2013 R2
06.06.2014 Maurice Gottschalk 5.1 Updated guide to version 2014
1.2 Introduction
1.2.1 Objective
This document describes the requirements of the TTS Server components, named Work-
bench and Web Publisher, and their installation process.
The goal of this document is to provide an understanding of the server configuration and to
guarantee its successful installation.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
2
1.2.2 Target audience
System administrators, developers and all interested parties
1.2.3 Prerequisites
It is expected that system administrators, developers and who else may be interested have
profound knowledge of
Windows and/or Unix-based operating systems
Administration and handling of database management systems (Microsoft SQL Server / Oracle)
Administration and handling of application servers (Oracle Weblogic, IBM Websphere, Apache Tomcat)
deployment of web applications (WAR,EAR, external web application)
SQL
HTML
XML
Please read this installation guide completely and carefully!
1.2.4 Contact
TTS Support
Phone: +49 (0) 2 21 / 17 09 30 -110
Fax: +49 (0) 2 21 / 17 09 30 - 170
Application consultant
Application consultants, very skilled and experienced in TTS Server, guide you through the installation process and provide professional solutions matching your requirements. If no application consultant has been assigned yet, please contact your key account manager.
1.2.5 Structure
The first chapter sheds light on the functionalities and technologies used in TTS Server com-
ponents. The pictures is completed by presenting the System overview and deployments
scenarios.
The next section points to the System requirements concerning hardware and software.
They should be checked thoroughly and carefully.
The Preparations chapter contains information on the prerequisites to get the TTS Server
running.
The Installation chapter guides you step-by-step through the deployment of the TTS Server
components, including all necessary actions like creating database connections or defining
server configuration. Post installation steps deals with initial administration tasks. This
mailto:[email protected]
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
3
chapter closes with a Troubleshooting section, which provides solutions for common prob-
lems.
Due to the fact that the TTS Server is a highly complex application, many configuration op-
tions are provided. All sorts of settings are explained in detail in the Appendix. Each proper-
ty or parameter of the application's services is listed with its name, a description, and the
possible values.
1.2.6 Conventions
1.2.6.1 Symbols
To highlight important information on the one hand, and "nice to know" details on the other,
the following icons are used:
Attention
Hint or note
Tip
Path
1.2.6.2 Abbreviations
TTPS - TT Performance Suite
TTKF - TT Knowledge Force
TTG - TT Guide
DB - Database
EAR - Enterprise Application Archive
JNDI - Java Naming and Directory Interface
LDAP - Lightweight Directory Access Protocol
SOLR - Solr Search Engine
SSO - Single-Sign-On
WAR - Web Archive
1.2.6.3 Variables
Variables are marked with leading $:
$TTPS_HOME - installation directory of TTS Server
$SOLR_HOME - directory of the search index created by Solr and the Solr configuration
$TOMCAT_HOME - installation directory of Apache Tomcat
$WEBSPHERE_HOME - installation directory of IBM WebSphere
$WEBLOGIC_HOME - installation directory of Oracle Weblogic
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
4
1.2.7 Your feedback is highly welcome
TTS welcomes your feedback concerning the quality and usefulness of this manual. Your
comments and suggestions will be considered as valuable input for future revisions of this
manual.
You found an error? Please let us know where.
A topic is not described clearly enough? Please let us know which one.
You request more information? On which topic?
The examples do not work for you? Please let us know so we can provide additional examples.
Please feel free to send us your feedback: [email protected]. We appreciate your help!
1.3 Application description
The TTS Server consists of two components: the Workbench and the Web Publisher. Rep-
resenting a production and delivery platform, the Workbench provides author functionalities,
whereas the Web Publisher makes the contents accessible to the end users.
The server components have been developed in a platform-independent way, using technol-
ogies like Java, Eclipse, HTML, JavaScript, CSS, XML, and XSLT (to create platform-
independent document types like RTF or PDF). There are only few components that are plat-
form-dependent, like the 'recorder' software or the 'QuickAccess for Desktop Applications'
online-help-system - due to the technology used in them.
The TTS Server is based on the following technologies:
Java SE 6
Java EE 1.5
Servlets 2.5 / JSP 2.1
JavaScript
As a result of the server component's architecture, it takes but little effort to integrate the TTS
Server in existing environments, depending on the infrastructure.
Furthermore, there is no need to install ActiveX controls.
1.4 System overview and deployment scenarios
This chapter offers a short outline of the TTS Server system environment in two different de-
ployment scenarios.
The first scenario (figure 1.1), which is the minimum way in practice, involves one application
server hosting both Workbench and Web Publisher, along with the Solr web application. The
backend provides a database, file system (as repository), and an optional LDAP directory for
authentication and authorization purposes. End users access the application via HTTP(S).
For performance and security reasons, we strongly recommend a deployment scenario using
a reverse proxy.
mailto:[email protected]
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
5
Figure 1.1
The second scenario (figure 1.2) differs from the first one by being more scalable and dy-
namic, thanks to using three application servers plus a load balancer that distributes all re-
quests among the reverse proxies. One application server hosts the Workbench and one
(Preview-) Web Publisher. The other server(s) run(s) the main Web Publisher. The third one
provides with Solr web application the search engine.
Figure 1.2
Both scenarios, minimum and recommended, are field-tested concepts. The usage depends
on the customer's requirements. Nevertheless, we recommend the deployment including a
reverse proxy in any case. Moreover, if there is a huge number of end users expected, an
installation in a clustered environment is advised, since this scenario offers more flexibility,
better scalability, and higher performance.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
6
2 System requirements
2.1 Hardware and Software requirements
For the current hardware and software requirements of TTS server, please refer to the
System requirements located in the TTS Community:
http://tts.invisionzone.com/index.php?/files/category/17-system-requirements/
http://tts.invisionzone.com/index.php?/files/category/10-manuals/
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
7
3 Preparations
3.1 License
Before you start the installation process, a valid license for the TTS Server is required.
Please request the license file via your professional service consultant or TTS Support
([email protected]). Please provide the MAC addresses as well as the IP addresses of the
servers on which the components are going to be installed.
Both components, TTS Server Workbench and Web Publisher, need their own
license file. If you plan to install the applications on separate machines, the MAC
and IP address of each server has to be provided.
3.2 Database
To store data persistently, the TTS Server components require a relational database. There-
fore, a new database must be created in your database management system (DBMS).
A database user is needed to access the database. The user must be granted some permis-
sions for the database, which will be explained later, as well as permissions for Microsoft
SQL Server and for Oracle.
With regard to the server configuration, the following pieces of information are required:
Host name or IP address of the database server
TCP port of the database service
Name of the database
Names and passwords of the database users
UTF-8 should be used as character set to store data in the database. If the data-
base is used primarily for languages with a Unicode range higher than U+0800
(see www.unicode.org/charts for more information), a UTF-16 character set should
be used.
3.2.1 JDBC driver
Currently, the following JDBC drivers, as provided by the database vendors, are supported:
Microsoft SQL Server JDBC Driver: sqljdbc.jar (version 3.0)
Oracle JDBC Driver: ojdbc14.jar (version 10.1.0.5 or 10.2.0.4)
Especially for Oracle, we recommend using a driver that matches the database version, but
at least the supported versions described above.
If the server is deployed to Oracle WebLogic or IBM WebSphere, the embedded JDBC driv-
ers provided by these application servers should be used. These drivers usually feature ex-
cellent integration into the configuration and monitoring components of the application server.
mailto:[email protected]://www.unicode.org/charts
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
8
The JDBC drivers for Microsoft SQL Server and Oracle are not distributed with
TTS Server. You can download an adequate driver from the Microsoft or Oracle
websites.
3.2.2 Microsoft SQL Server 2005 and 2008
The database user must have the permission to connect to the newly created database. This
is usually done during user creation by setting the standard database. If not, access to the
database has to be granted separately via the user properties.
The database user should be granted dbo rights, since he needs to create, alter and
delete tables, procedures, functions, indices and so on.
Be aware that the port of the database might be set dynamically for a named instance.
It may therefore deviate from the default value 1433.
3.2.3 Oracle 9i, 10g and 11g
In Oracle, a tablespace must be created at first. The related data file should have a size of at
least 50 MB. To automatically assign more disk space, the "AUTOEXTEND" option must be
activated. Otherwise, the database cannot store additional data once the space limit is
reached.
The database user must be granted the following permissions:
SYSTEM PERMISSION: ROLE: CONNECT
SYSTEM PERMISSION: CREATE SESSION
SYSTEM PERMISSION: CREATE TABLE
SYSTEM PERMISSION: CREATE SEQUENCE
SYSTEM PERMISSION: CREATE PROCEDURE
Furthermore, you need to grant the database user unlimited quota to the created tablespace.
On request, TTS Support can provide you with SQL scripts that can be used to gener-
ate the required tablespace and user and to set the specific rights for the user.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
9
3.3 File system
The following directories are required for the TTS server components. One for the repository
to save the document and guide contents. The other one is used as a data store for runtime
files. The user of the application server needs complete access to those directories, to read,
write, execute, and delete files.
Sample file system structure
$TTPS_HOME/repository/repository_1
$TTPS_HOME/repository/repository_2
$TTPS_HOME/repository/repository_n
$TTPS_HOME/repository/guide
$TTPS_HOME/store
Please refer to the hardware requirements section for information on the hard disk
space that is required for both the repository and the data store.
Please make sure the created directories are accessible to all installed instances
of the TTS server. This also holds true if the instances are running on different
machines.
3.4 Application server
The application server must be a Java application server supporting JavaServlet 2.5, Ja-
vaServer Pages 2.1, and Java EE 5. All the servers with their supported versions mentioned
in the system requirements, namely Apache Tomcat, IBM WebSphere, and Oracle Web-
Logic, meet these requirements.
In this guide, we assume that the application server on which the TTS Server will be running
has already been installed. For manuals and installation guides of the application server,
please visit the websites mentioned in the software requirements section.
For performance reasons, it is recommended to install the TTS Server Workbench and
two TTS Server Web Publishers (one for preview purposes) on separate server in-
stances. Please refer to the System overview and deployment scenarios chapter for
the recommended deployment scenario.
Only the Web Publisher can be operated in a clustered environment. The Work-
bench is not designed to work on more than one cluster node. Therefore, it must
only be deployed to a single cluster node.
In a scenario with one Workbench and several Web Publishers, an internal distributed
cache keeps data consistent and up-to-date between the different server components.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
10
3.5 Solr installation
The TTS Server infrastructure uses Apache SolrTM for indexing and searching.
Apache SolrTM is a web application available from the Apache Software Foundation. Please
install Solr according to their installation instructions.
Please use a Solr version that matches your Java JRE version. The Solr versions 4.8.0
and higher require Java 7.
The TTS Server Components require the Solr version 4.7.1 or higher.
You can install Solr
either in the same servlet container as the TTS Server Components,
or in a separate servlet container, possibly on a different machine.
Please use a dedicated Solr instance for the TTS Server infrastructure.
During installation, be sure to define an appropriate location for the index. If not speci-
fied, Solr will place the index in a default location, which might be situated inside your
application server webapps space. This is not recommended. Instead, select a location
of your choice and define it as the solr home directory.
You will need the following properties for the TTS Server Components installation:
The Solr home location, e.g. C:\solr
Solr's URL and Port, e.g. http://127.0.0.1:8983/solr
http://127.0.0.1:8983/solr
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
11
4 Installation step-by-step
4.1 Checklist
Before you start deploying TTS Server, please make sure that the following requirements are
met:
The installation files are available.
The licenses for the components are available.
Database and Database user(s) have been created.
All required paths on file system are available.
Details of distributed caching (Multicast-IP-address and port and so on).
The application server is installed properly.
The Solr search engine is installed, and a solr home directory is configured.
Currently, many customers use Apache Tomcat to run the TTS server. This application serv-
er is open source, free to use, and sufficient for most customers' demands.
If the TTS server is used enterprise-wide, possibly worldwide, for a large number of authors
and end users, an alternative application server - which is more suited for an enterprise set-
ting - should be considered. Therefore, IBM WebSphere or Oracle Weblogic are supported
as well. These are commercial, offer high performance, stability, scalability (via clustering),
better maintenance, and convenient monitoring.
Before you start TTS Server for the first time, you are strongly advised to read
the Post installation steps chapter.
4.2 Installation environment
You need to configure the TTS Server components before you can deploy and start the ap-
plication successfully. The basic configuration comprises server properties, database con-
nection, andfile system paths. Once these settings have been provided, the server can be
run in default mode.
Additional settings may be necessary for services and features like user authentication and
authorization, caching, or workflow and versioning. They are explained in detail in the ap-
pendix.
The actual configuration is carried out via a file named application-config.properties. Please
note that the application has fall-back-mechanism to load configuration parameters by scan-
ning several external locations before using the system's default value:
1. Properties file with default name application-config.properties
2. Context parameters
3. JVM arguments
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
12
4.2.1 Setup installation environment
As best practice we recommend to setup a simple installation environment to keep things in
order. Therefore just create the following folder structure:
$TTPS_HOME/apps
$TTPS_HOME/logs
$TTPS_HOME/repository
$TTPS_HOME/repository/guide
$TTPS_HOME/store
$TTPS_HOME/temp
The apps folder is there to store the single .WAR files of the Workbench and the Web Pub-
lisher. Depending on the application server and its deployment behavior, the structure within
apps may differ.
The logs directory may contain generated log files, if you configure it that way. Especially if
the application server does not unpack the .WAR files during deployment, we will need to
configure the application to write logs in that folder.
The application's file repository will be setup within repository; runtime files are located in
store.
For temporary installation purposes, files may be stored in temp.
Of course you may place these folders wherever you like, but please consider at least keep-
ing the document content within repository, separate from runtime files in store.
At last, we place the server license file and the application-config.properties directly in
$TTPS_HOME.
4.2.1.1 How should be the installation files be structured and provided?
In Weblogic, we follow the advised way of structuring the installation files. Within
$TTPS_HOME/apps, we create the following directories and files:
$TTPS_HOME/apps/publisher
$TTPS_HOME/apps/publisher/app
$TTPS_HOME/apps/publisher/plan
$TTPS_HOME/apps/publisher/plan/Plan.xml
$TTPS_HOME/apps/publisher/plan/WEB-INF
$TTPS_HOME/apps/publisher/plan/WEB-INF/weblogic.xml
$TTPS_HOME/apps/workbench
$TTPS_HOME/apps/workbench/app
$TTPS_HOME/apps/workbench/plan
$TTPS_HOME/apps/workbench/plan/Plan.xml
$TTPS_HOME/apps/workbench/plan/WEB-INF
$TTPS_HOME/apps/workbench/plan/WEB-INF/weblogic.xml
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
13
The provided installation files are copied to
$TTPS_HOME/apps/publisher/app/publisher.war
$TTPS_HOME/apps/workbench/app/workbench.war
4.2.1.2 What is Plan.xml?
The Plan.xml file is a deployment plan, defining the applications location, its name, and its
content.
To successfully deploy the application, copy the following content into the corresponding
Plan.xml. The only thing to edit is the location of the plan itself.
Plan.xml of TTS Server Workbench
workbench
workbench.war
war
weblogic-web-app
WEB-INF/weblogic.xml
1314197137989
web-app
WEB-INF/web.xml
c:/TTPS/apps/workbench/plan
Plan.xml of TTS Server Web Publisher
publisher
publisher.war
war
weblogic-web-app
WEB-INF/weblogic.xml
1314351049731
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
14
web-app
WEB-INF/web.xml
c:/TTPS/apps/publisher/plan
4.2.1.3 What is weblogic.xml?
Besides web.xml, weblogic.xml is a Weblogic-specific deployment descriptor, providing de-
ployment information for the application server during the installation. In addition to servlet
descriptors, we define bindings of JNDI-resources (data source) as well as parameters con-
cerning pre-compilation of JSPs and class loader hierarchies.
Actually, there is no need to edit this file, except you want to use another JNDI-name for the
data source.
weblogix.xml for TTS Server Workbench
jdbc/TTKFDS
jdbc/GTTKFDS
wm/TT_SCHEDULER
true
true
init
action
teamtrainer-connector
download
mimemapper
spring
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
15
weblogix.xml for TTS Server Web Publisher
jdbc/TTKFDS
jdbc/GTTKFDS
wm/TT_SCHEDULER
true
true
init
action
download
spring
4.2.2 Configure TTS Server with application-config.properties
4.2.2.1 What is application-config.properties?
The application-config.properties file is actually a simple text file with a .properties extension,
serving - among other things - especially as a configuration mechanism for Java applications.
Within this file, you can define application parameters using key-value-pairs separated by a
'='.
Defining parameters is subject to simple rules:
The file must have a .properties extension
Parameter and value are separated with an '=' on a single line
Parameter and value are valid
Parameters for TTS Server Workbench match the following syntax: ttkf.server.. or
ttkf.integrator..
Parameters for TTS Server Web Publisher match the following syntax: ttkf.server.. or
ttkf.accelerator..
File paths must be separated with a slash / instead of backslash \
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
16
The following example shows a snippet of an application-config.properties file:
# workbench database configuration
ttkf.server.data.hibernate.dialect = de.tts.bd.business.data.UnicodeOracle10gDialect
ttkf.server.data.hibernate.default_schema = TTS
# publisher database configuration
ttkf.accelerator.data.portal.hibernate.dialect = de.tts.bd.business.data.UnicodeOracle10gDialect
ttkf.accelerator.data.portal.hibernate.default_schema = TTS
# store directory
ttkf.server.store.store.base.directory = /TTPS/datastore
4.2.2.2 How to make application-config.properties accessible?
In order to optimize the installation and maintenance process, we strongly recommend to
keep the application's configuration separate from the application itself. For Weblogic, it is
recommended to set a JVM argument that defines the location of the application-
config.properties file.
It is a common way of applying arguments to Weblogic's JVM by copying the startWebLogic
batch file, adding arguments and options, and finally referring to the original startup script.
1. Copy the original startup script startWeblogic.cmd or startWeblogic.sh
You find it either in the default domain as $WEBLOGIC_HOME/samples/domain/wlserver
or directly in your domain $WEBLOGIC_HOME/$DOMAIN
2. Then, add the location of the application-config.properties by setting environment varia-
ble JAVA_OPTIONS
set JAVA_OPTIONS=-Dttkf.server.properties=C:/TTPS/application-config.properties
The resulting file may look like this:
SETLOCAL
set DOMAIN_HOME=U:\Weblogic_domains\manual
set JAVA_OPTIONS=-Dttkf.server.properties=C:\TTPS\application-config.properties -Xdebug
-Xnoagent -Xrunjdwp:transport=dt_socket,address=1044,server=y,suspend=n
call "%DOMAIN_HOME%\bin\startWebLogic.cmd" %*
ENDLOCAL
4.2.2.3 Example of a minimum application configuration
The following example illustrates the installation of TTS Server components using Oracle
database.
Database Connection
Initially, you configure the database connection. Since we want to use a data source, we just
need to set hibernate dialect and default schema. Internally the JNDI name we will bind the
data source which is called java:comp/env/jdbc/TTKFDS.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
17
ttkf.server.data.hibernate.dialect = de.tts.bd.business.data.UnicodeOracle10gDialect
ttkf.server.data.hibernate.default_schema = TTS
We define the connection properties for Web Publisher as well.
ttkf.accelerator.data.portal.hibernate.dialect =
de.tts.bd.business.data.UnicodeOracle10gDialect
ttkf.accelerator.data.hibernate.portal.default_schema = TTS
See the Database service chapter in the appendix for more details.
Application Properties
We begin by defining the context names of Workbench and Web Publisher. Since the context
names can be chosen freely, it is necessary for intercommunication of the applications to
know the context name of each other.
ttkf.server.properties.acceleratorContextPath = /publisher
ttkf.server.properties.integratorContextPath = /workbench
Next we set the location of license file, the directory of the application server's logs and the
super user IP's.
ttkf.server.properties.licenseFile=file:C:/TTPS/server.ttlk
ttkf.server.properties.applicationServerLogDirectory=U:\Weblogic_domains\manual\servers\
myserver\logs
ttkf.server.properties.superuserIPs=127.0.0.1,192.168.85.48
For Weblogic we also have to specify parameters xmlReaderClass and XercesXMLSerializ-
erFactory, to avoid XML-parsing issues.
ttkf.server.properties.xmlReaderClass=org.apache.xerces.parsers.SAXParser
ttkf.server.properties.XercesXMLSerializerFactory=org.exolab.castor.xml.XercesXMLSerializ
erFactory
Because only the Workbench can re/indexing entities with Solr, the Workbench have to know
the Publisher URL.
ttkf.server.properties.internal_acceleratorURL=http://192.168.86.44:9980/publisher
See the Properties service chapter in the appendix for details.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
18
Solr
The Workbench need to know the Solr-URL for re/indexing the entities.
ttkf.server.search.server.url=http://127.0.0.1:8983/solr/core
See the Search Service chapter in the appendix for more details.
See the Solr installation chapter in the Preparations for more details.
Data Store
Now we need to configure the base directory of the runtime files. So we just define the loca-
tion of our created folder $TTPS_HOME/store.
ttkf.server.store.store.base.directory = C:/TTPS/store
See the Store service chapter in the appendix for details.
Guide
To store Guides, a Guide-Repository is needed. So we just define the location of our created
folder $TTPS_HOME/repository/guide.
ttkf.server.guidebase.rootdir=C:/TTPS/repository/guide
See the Miscellaneous parameters chapter in the appendix for more details.
Distributed Cache
To get the distributed cache working properly, we need to configure several parameters. Be
sure to have information about the mode of the distributed cache (unicast/multicast) and the
corresponding IP-addresses and ports ready.
We will configure multicast, which is the default mode.
ttkf.server.cache.peers.multicastGroupPort=45637
ttkf.server.cache.peers.multicastGroupAddress=228.8.18.9
See the Cache service chapter in the appendix for details.
Logging
Finally, we direct the log output to the log directory we created. This is only necessary if the
application server does not unpack the .WAR files. If the application server unpacks the
.WAR file during deployment, the logs are written to $APPLICATION_HOME/WEB-INF/logs.
In this example, we assume that the application server does not unpack .WAR files.
ttkf.integrator.logging.log4j.appender.system.File=C:/TTPS/logs/workbench/system.xml
ttkf.accelerator.logging.log4j.appender.system.File=C:/TTPS/logs/publisher/system.xml
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
19
See the Logging service chapter in the appendix for more information.
4.2.2.4 How to escape special characters within the .properties file
The encoding of a .properties file is per definition ISO-8859-1, also known as Latin-1. All non-
Latin-1 characters must be entered using Unicode escape characters, e. g. \uHHHH, where
HHHH is a hexadecimal index of the character in the Unicode character set. A non-Latin-1
text file can be converted to a correct .properties file by using the native2ascii tool that ships
with the JDK.
4.3 Data source
4.3.1 Creating a data source with the Oracle Weblogic 10.3.5 Console
In Weblogic 10.3.5, you can create a data source in a very convenient way by using wizards
in the console. In the following step-by-step example, a data source pointing to an Oracle
10g database will be generated.
Click the Data Sources hyperlink.
Click the New button.
Click the Generic Data Source hyperlink.
http://en.wikipedia.org/wiki/ISO/IEC_8859-1http://en.wikipedia.org/wiki/Unicode
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
20
Enter the data source name GTTKFDS into the Name field.
Enter the JNDI Name jdbc/GTTKFDS into the JNDI Name field.
Click the Next button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
21
Click the Database Driver combobox.
Click the *Oracle's Driver (Thin) for Service connections; Versions:9.0.1 and later list item.
The application server provides several predefined jdbc providers (including the appro-
priate and supported jdbc drivers marked by *).
It is good practice to use these predefined jdbc providers if possible.
The given installation example makes use of the thin driver for service connections.
Click the Next button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
22
Click the Next button.
Enter the SID (XE in the example) into Database Name field.
Enter the host name (192.168.8.66 in the example) into the Host Name field.
Enter database user name (TTN in the example) into the Database User Name field.
Enter the password of the user into the Password field.
Enter the password of the user into the Confirm Password field.
Click the Next button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
23
Click the Test Configuration button.
Click the Next button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
24
Choose the server to which the data source is to be bound (myserver in the example).
Click the Finish button.
4.3.2 Configuring Connection pooling
In this step, the database connection pool will be increased to improve the database access
performance.
Click the GTTKFDS hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
25
Click the Connection Pool hyperlink.
Click the Maximum Capacity input field.
Enter 30 into the Maximum Capacity field.
Click the Save button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
26
4.3.3 Testing the database connection
Click the GTTKFDS hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
27
Click the Connection Pool tab.
Click the Advanced hyperlink.
Click the Test Connections On Reserve checkbox.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
28
Click the Save button.
Click the Monitoring tab.
Click the Select GTTKFDS radiobutton.
Click the Test Data Source button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
29
If everything was configured correctly, the connection test should finish successfully.
Should the connection test fail, you may want to verify that...
the database (to which the data source is pointing to) is running the connection
the database is not blocked by any software (e.g. a firewall)
the JDBC driver is configured correctly
the proper JDBC driver is placed in the defined directory
the user name and password of the database user(s) are correct
4.4 Application server settings
4.4.1 JVM-settings
The JVM of each server instance must meet at least the following memory settings:
Maximum PermGen space: 192 MB (-XX:MaxPermSize=192m)
Maximum Java heap size: 1024 MB (-Xmx1024m)
Initial Java heap size: 256 MB (-Xms256m)
Maximum thread stack size: (-Xss512k)
4.4.2 URL-encoding
To ensure parameters in URLs are interpreted correctly (as UTF-8), the charset-params
must be defined. This is done in the file weblogic.xml of the applications, by adding the tag
including the input-charset. This defines the character set that is used to
read GET and POST data for specific resources. In our case, we need to define that charac-
ter set to UTF-8.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
30
Example:
/*
UTF-8
For more information, please see:
http://docs.oracle.com/cd/E15051_01/wls/docs103/webapp/weblogic_xml.html
4.5 Deployment
For Oracle Weblogic, the deployment of the Workbench is described exemplarily step by
step. All steps must be carried out for Web Publisher instances as well. The data source that
has been created in the Data source chapter will be used here.
The example shows the deployment via a .WAR file. Usually, TTS provides pre-configured
.WAR files for both components, Workbench and Web Publisher.
Please do not forget to define the Weblogic-specific properties xmlReaderClass
and XMLSerializerFactory in the server properties.
Start the Weblogic administration console and log into it. Then go to Deployments.
Click the Install button.
Navigate to the folder where the installation files are located (in the example: C:\TTKF\apps).
http://docs.oracle.com/cd/E15051_01/wls/docs103/webapp/weblogic_xml.html
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
31
Click the localhost hyperlink.
Click the C:\ hyperlink.
Click the TTKF hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
32
Click the apps hyperlink.
Weblogic automatically recognizes the applications.
Click the workbench radiobutton.
Click the Next button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
33
Click the Next button.
Click the Next button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
34
Click the Finish button.
Click the Save button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
35
4.6 Deployment of the Solr core
We assume that you have installed the Solr Web application, and that you are running
a dedicated Solr instance for the TTS Server infrastructure.
In this step, you will install the prepared Solr core which is included in the TTS Server Com-
ponents distribution.
1. Stop the servlet container.
2. Make sure that you have defined a dedicated solr home directory, and remove all files
from that directory.
3. Unpack the file solr.zip to the solr home directory. After this step, the solr home directory
should contain the file solr.xml and the directory core.
4. Start the servlet container.
Visit http://please.insert.your.solr.url.and:port/solr/#/core to confirm that your Solr is running,
and that the required Solr core is present.
4.7 Post installation steps
4.7.1 Initialization of the database schema
If the steps described in the previous chapters have been carried out, the application should
now be properly configured and deployed, thus being ready to start. There are two different
procedures to start it: with Apache Tomcat, the server itself has to be started, whereas with
IBM WebSphere or Oracle Weblogic, TTS Server can be started through the administration
console.
http://please.insert.your.solr.url.and:port/solr/#/core
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
36
To initialize the database schema, a browser has to be started on the application serv-
er machine. If this is not possible and you thus have to use the browser on another
computer, the IP address of that machine must be declared as superuser IP (property
superuserIPs of Properties service).
The webpage for initializing the database is located at the following URL:
http://[server]:[port]/[contextWorkbench]/site/install/install.do
Start by entering the URL given above in the browser. A straightforward administration page
appears, offering to test the database connection, (re-)create or update the database sche-
ma, or to import/export the entire database content.
4.7.1.1 Test database connection
To ensure that the database connection is working properly and that the database user has
been granted all necessary permissions, the Workbench setup provides a database connec-
tion test:
Shortly after clicking the Test the connection link, the result of the test will be displayed,
representing successful tests in green, failed operations in red print.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
37
4.7.1.2 Initialize database
If you click the Initialize database link, the Workbench creates the database schema as well
as initial data. After a few moments, the login screen will then appear. A full restart of TTS
Server will be necessary to ensure that all services are running properly.
When (re-)creating the database schema or importing database content, the previous
data will be deleted completely. Please use this function very carefully!
Web Publisher does not require to initialize the database schema. It is therefore rec-
ommended to install and start up the Workbench standalone before installing (and
starting) the Web Publisher.
After initializing the database schema, the application should be restarted. Now
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
38
the Web Publisher may be started as well. For an easier analysis of possible
problems, the log file of the application server should be saved before restarting
the server or applications.
4.7.2 First login as administrator
During database schema creation, a few initial data have already been created, like the ad-
ministrator user:
User name: admin
Password: admin
The first login is done by calling http://[server]:[port]/[contextWorkbench]/ in the browser and
entering the administrator's user name and password.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
39
After logging in as administrator, the start page of the TTS Server Workbench will look like
the following screen by default (depending on the license):
TTS Server Web Publisher with login required:
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
40
TTS Server Web Publisher without login required:
For security reasons, change the administrator password upon first login.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
41
4.7.3 Next steps
The next steps for the administrator will usually encompass:
Defining repositories and document types
Assigning repositories to document types
Adding users and maintenance roles
Assigning authorizations to external users
Defining a process model
Managing custom properties
...
Please see the Administrator manual for more details on the steps outlined above.
4.8 Securing Solr
We strongly advise you to secure the Solr web application so that only the TTS
Server Components will be able to access it.
4.8.1 Securing Solr via Basic Authentication
A common approach to securing Solr is Basic Authentication. This method restricts access to
web applications based on users and roles. Users are usually required to authenticate them-
selves by a password.
In Oracle Weblogic, please follow these configuration steps:
4.8.1.1 Configure user and group
In Weblogic, navigate to Security Realms - myRealm.
Create the user "solradmin" and the group "solradmins".
Assign the user "solradmin" to the group "solradmins".
4.8.1.2 Adapt [solr]/WEB-INF/web.xml
Add the following xml fragment to the end of the file, directly before the closing tag :
SolrAccess
Solr
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
42
/*
DELETE
GET
POST
PUT
HEAD
TRACE
OPTIONS
SolrAccess
BASIC
myrealm
4.8.1.3 Adapt [solr]/WEB-INF/weblogic.xml
Replace everything inside the element by the following xml fragment:
SolrAccess
solradmin
true
false
4.8.1.4 Adapt application-config.properties
Add the user name and password to the application properties:
ttkf.server.search.server.user=solradmin
ttkf.server.search.server.password=[the password for solradmin]
If you experience any difficulties with the above approach, please enable logging. The
log may already point you to the problem.
4.8.1.5 Activate logging (optional)
Navigate to Security Realms - myRealm -Providers - Auditing and create a new AuditPro-
vider.
Check the logs at domain/servers/logs.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
43
4.8.2 Configure user and groups
Click the Security Realms hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
44
Click the myrealm hyperlink.
Click the Users and Groups hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
45
Click the New button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
46
Insert solradmin as name.
Click the OK button.
Click the Groups hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
47
Click the New button.
Insert solradmins as name.
Click the OK button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
48
Click the Users input field.
Click the solradmin hyperlink.
Click the Groups hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
49
Click the solradmins input field.
Click the Move selected items from Available list to Chosen list button.
Click the Save button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
50
4.8.3 Activate Logging
Click the Security Realms hyperlink.
Click the myrealm hyperlink.
Click the Providers hyperlink.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
51
Click the Auditing hyperlink.
Click the New button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
52
Enter logging into the *Name field.
Click the OK button.
4.9 Troubleshooting
The configuration and deployment of a complex application such as TTS Server sometimes
results in errors. In this chapter, the most common issues and their solutions will be dis-
cussed.
Before you contact TTS Support, you are encouraged to have a look at this chapter, as an
answer to the problem you are facing may be given here. In case the problem cannot be
solved, TTS Support will be glad to help you.
Please note, however, that support activities are not covered by the maintenance fee if the
problem results from a mistake the customer made during installation.
In order for TTS Support to be able to help you in the best possible way, please
attach log files and configuration files of the TTS Server to your support request.
If the TTS Server Workbench is up and running, the log and configuration files can be
downloaded from the Administration section (>Settings >Support >Server manage-
ment). Otherwise, the log files of the application server should be attached instead.
4.9.1 The server does not start up
Is the application server running correctly?
Is the context path, if configured, pointing to the right directory (Apache Tomcat)?
Is the license of TTS Server available and valid?
Is the application-config.properties file available and configured properly?
Is the data store defined in application-config.properties available?
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
53
4.9.2 Database is unavailable
Is the database up and running?
Can the database be accessed from the machine on which the application server is running?
Has the port been set correctly?
Is the specified data source available?
Is the appropriate JDBC driver properly defined/stored on the application server?
Is the data store defined in application-config.properties available?
4.9.3 Login fails
Has the correct user name and password been entered?
Is the user already logged in?
Has the maximum permissible number of logged-in users been reached?
Has the license expired?
Is this TTS Server addressing the right database (if pointing to a database initialized from another TTS Server Workbench, user logins might fail)?
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
54
4.10 Solr installation example (single Solr instance)
4.10.1 Solr installation example for Weblogic
Install:
Download and unpack the Solr distribution to a temporary location, e.g. C:\temp\solr-dist.
Create an empty directory for the Solr core and index data, e.g. C:\ttkf\solr. This di-rectory will be referred to as the solr home.
Unpack solr.zip to the solr home directory. The solr home should now contain the file solr.xml and the subdirectory core.
Add commons-logging-x.jar to C:\temp\solr-dist\solr.war\WEB-INF\lib folder. You can modify the solr.war with every desired zip-tool e.g. 7-zip. The common-logging-
x.jar can be found on http://commons.apache.org/proper/commons-
logging/download_logging.cgi.
Modify weblogic.xml in C:\temp\solr-dist\solr.war\WEB-INF\lib solr.war\WEB-INF\ and add the attribute prefer-web-inf-classes within the tag container-descriptor.
... true
....
Modify web.xml in C:\temp\solr-dist\solr.war\WEB-INF\lib solr.war\WEB-INF\web.xml. Remove comments from solr/home and put your solr home path in e.g. C:\ttkf\solr. (Chapter
Modify web-xml in Solr.war).
You might want to define solr home as JVM parameter in the JAVA_OPTIONS like this
-Dsolr.solr.home=C:\ttkf\solr
The order must be , , . Other-
wise, an exception will be thrown.
Deploy solr.war from C:\temp\solr-dist\dist as a new web application. (Chapter Solr.war deployment)
Change Deployment Order. Solr(80) starts first, then Worbench(90) and at least the Publisher(100). (Chapter Change Deployment Order)
http://commons.apache.org/proper/commons-logging/download_logging.cgihttp://commons.apache.org/proper/commons-logging/download_logging.cgi
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
55
Via Deployments -> Solr Deployment-> Testing -> The URL-Path from solr is visible. It is also possible to call the Solr Admin Console. (Chapter Connect to Solr admin
console)
For general installation instructions, please refer to the Solr documentation.
4.10.2 Solr.war deployment
Click the Deployments hyperlink.
Click the Install button.
Navigate to solr home directory and selector your solr.war.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
56
Click the Next button.
Choose Install this deployment as an application.
Click the Next button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
57
Click the Next button.
Click the Finish button.
Click the Deployment Order input field.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
58
Change the value to 80. (For more information see chapter Change Deployment Or-der)
Click the Save button.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
59
4.10.3 Change Deployment order
Click the Deployments hyperlink.
Select Deployment to change.
Type a value between 0 and 100. Units with lower values are deployed before those with higher values.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
60
4.10.4 Connect to Solr admin console
Click .
Click solr deployment.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
61
Click the Testing tab.
Click the Test Point next to admin.html.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
62
4.10.5 Modify web.xml in solr.war
Uncomment ...
... the item.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
63
Change the order (name,type,value) and adapt the path to your solr home.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
64
5 Migrating from previous versions
5.1 General remarks
This chapter provides a short summary of the most important changes that were introduced
in the major releases, focusing on installation and update routines as well as migration sce-
narios.
5.2 Updating from version 7.1 to 2012
Configuration
The content-based revision number, which could be combined with a storage pattern, has been removed. Please use the document type assigned versioning instead, which
provides a lot more possibilities.
The "showStatifyCertificateButton" parameter was added. For more details, see the Properties service chapter.
The default maintenance interval of the repository service was decreased to 5 seconds.
Detailed logging of LDAP connections has been introduced. See the Logging service chapter for more information.
5.3 Updating from version 2012 to 2012 R2
Configuration of Publisher
The template xml contains an additional filter configuration. The "roleAccessPredicateFilter" is now part of all filter chains by default.
This filter suppresses all entities that are not assigned to any role the current user is a
member of.
In earlier releases, the roleAccessPredicateFilter was applied implicitly to all filter
chains. Therefore, to maintain the default behavior, it is necessary to add the filter to all
existing filter chains. Take care to add it to existing customizings if it is needed. (it will
be needed in most cases.)
Example:
...
The template.xml contains an additional attribute in the filter chain configuration. All defined filter chains (including the nameless default filter chain) have to define an
additional mandatory "chain-elements-factory" attribute. The only valid value for that at-
tribute, at the current state, is "de.tts.bd.eud.filter.chain.DefaultChainElementFactory".
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
65
Example:
...
Configuration of Publisher
Until this version, the path of the feature.xml file could only be a path inside the applica-tion classpath. From now on, the path can also be an absolute path anywhere on the
system. The path has just to begin with the prefix "file:"
5.4 Updating from version 2012 R2 to 2013
Web Publisher with new design (hasFrameset)
If using the new design for the Publisher, there must be configured a new parameter within the file templates.xml, named hasFrameset.
< property name="hasFrameset" > true
Publisher designs prior 2013 need to set this value to true (default value), new designs must set this value to false, since the new portal design has no frames anymore.
Web Publisher offers image formats for user profiles
With TTKF 2013, a new design for the Web Publisher has been introduced, allowing users to upload profile images. Those images may be used for comments, newsfeeds,
or other resources.
To ensure a performant way of accessing content, you are advised to define image
formats, so a properly scaled image exists for each use case, reducing network traffic
and CPU usage.
Currently, we provide formats for
profile images
images for newsfeeds.
Configuration is done in the properties service following a specific syntax:
constant value: ttkf.server.properties.image.format
domain: either userprofile or newsfeedentry
format name: any name
value: width and height of the format in pixels; if both values are specified, the image will be scaled to match the longer side; if only one value is given, the other one must
be marked with "~"
Examples:
ttkf.server.properties.image.format.userprofile.passport = width:50;height:150
ttkf.server.properties.image.format.newsfeedentry.resource = width:500;height:~
Configure the productive image formats comma-separated via following parameter:
ttkf.server.properties.image.formats = userprofile.passport,newsfeedentry.resource
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
66
To limit the file size for profile images, use the following parameter:
constant value: ttkf.server.properties.image.upload
domain: userprofile
maxsize
value: any decimal number followed by unit kb or mb
Samples:
ttkf.server.properties.image.upload.userprofile.maxsize = 128kb
ttkf.server.properties.image.upload.userprofile.maxsize = 1.4mb
Web Publisher with more flexible Windows-based SSO configuration
Now it is possible to configure the authorities populator for the Windows-based SSO in a more flexible way. Instead of requesting user information and authorities from an
LDAP server (default behavior), you may now get those bits of information from the lo-
cal database.
Example for configuring local database authorities populator:
ttn.bd.login.sso.windows.authorization.WindowsSSODatabaseAuthoritiesPopulator
For more information, see User service for authentication and authorization in the ap-
pendix.
Workbench & Web Publisher: Combine multiple attributes in LDAP groupMembership
The definition of the groupMembership attribute now allows the combination of different attributes from LDAP.
Example:
ttkf.server.user.ldap.default.dialect.user.attr.groupMembership = #c#l
With the value c standing for country and l for location, the LDAP-interface now creates
entries like "c=DE,l=Heidelberg".
Workbench supports definition of more mime-types for zip archives
When uploading a zip file as document content, the archive is extracted and its content examined.
Files that match a set of pre-configured mime types will be considered to be different
publishing formats of the document and will be linked in the publisher automatically.
The files considered as published document formats are configured in a pair of mime
type / priority values.
A duplicate definition of a priority value will overwrite the previously defined mime type
value.
When extending the list of supported mime types with custom mime types, make sure
to respect priority values that are already used. This means that you should use incre-
mental values starting with the value 10.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
67
Preconfigured default values
The following values are preconfigured and therefore do not require explicit definition:
text/html=0
text/xml=1
text/rtf=2
application/msword=3
application/vnd.ms-word=4
application/mspowerpoint=5
application/vnd.ms-powerpoint=6
application/msexcel=7
application/vnd.ms-excel=8
application/pdf=9
Definition of custom mime-type support
The list of supported mime types can be extended using the application-config.properties file. The mime types have to be added in the format {pre-
fix}.{mimetype}={priority} where the prefix is
ttkf.integrator.collectionContentHandler.customSupportedTypes.
The following example shows how to add support for javascript (*.js), richtext (*.rtx)
and plain text (*.txt) files:
ttkf.integrator.collectionContentHandler.customSupportedTypes.text/javascript=10
ttkf.integrator.collectionContentHandler.customSupportedTypes.text/richtext=11
ttkf.integrator.collectionContentHandler.customSupportedTypes.text/plain=12
Adding the following lines will additionally add support for MS Help files (*.chm)
ttkf.integrator.collectionContentHandler.customSupportedTypes.application/mshelp=
13
ttkf.integrator.collectionContentHandler.customSupportedTypes.application/vnd.ms-
htmlhelp=14
5.5 Updating from version 2013 to 2013 R2
Workbench supports additional workflow functions
In 2013 R2, two new workflow functions were introduced to offer more flexibility within the workflow process: NotifyAssigneeOnlyFunction and NotifyOwnerOnlyFunction.
NotifyOwnerOnlyFunction: Sends an e-mail to the document's owner when the workflow status changes
NotifyAssigneeOnlyFunction: Sends an e-mail to the document's assignee when the workflow status changes
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
68
5.6 Updating from version 2013 R2 to 2014
5.6.1 Solr Search Engine
With the 2014 update, the Solr search server replaced the lucene search engine.
For a general Solr Installation Guide, see Solr Installation in the Preparations chapter.
On how the Solr server is linked with the tt server components, see the Solr installation ex-
ample in the Installation step-by-step chapter.
5.6.2 New mandatory application properties
5.6.2.1 Search service (Solr)
ttkf.server.search.server.url
This mandatory parameter defines how the Workbench and Publisher can reach the Solr
server.
ttkf.server.search.server.url={full context path to the solr instance}
Example:
ttkf.server.search.server.url=http://127.0.0.1:8983/solr/core
5.6.2.2 internal_acceleratorURL
Is now mandatory, because only the Workbench can re/indexing entities with Solr, the Work-
bench have to know the Accelerator URL.
ttkf.server.properties.internal_acceleratorURL={valid accelerator URL}
Example:
ttkf.server.properties.internal_acceleratorURL=http://192.168.86.44:9980/publisher
5.6.2.3 Guide
ttkf.server.guidebase.rootdir
To store Guides, a Guide-Repository is needed. Therefor a path is needed, where the
Guides can be stored:
ttkf.server.guidebase.rootdir={path with read/write access}
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
69
Example:
ttkf.server.guidebase.rootdir=C:/TTKF/repository/guide
5.6.3 New optional application properties
5.6.3.1 Search service (General parameter)
ttkf.server.search.max.result.size
This optional parameter defines the maximum number of unfiltered search results which
should be returned by a query.
By default, each search request will be limited to 10.000 results.
Default: 10.000
ttkf.server.search.max.result.size={Positive integer}
Example:
ttkf.server.search.max.result.size=5000
ttkf.server.search.disjunction.tie
This optional parameter specifies the tie breaker for the DisMax parser in the SolR search
engine.
When searching multiple fields, this factor defines the impact that additional matches will
have on the score of a result item. For example, when a query matches the title and the de-
scription of a document, with the best match found in the title, the score of the additional
match in the description will be multiplied by the tie factor and added to the score of the best
match in the title of the document.
With a tie factor of 0.0, additional matches will be ignored.
With a tie factor of 1.0, the overall score of a result item will be the sum of all field matches.
Usually, the tie factor should be much less than 1.0.
Default: 0.5
ttkf.server.search.disjunction.tie={Between 0 and 1}
Example:
ttkf.server.search.disjunction.tie=0.0
See http://docs.lucidworks.com/display/solr/The+DisMax+Query+Parser for more de-
tails.
http://docs.lucidworks.com/display/solr/The+DisMax+Query+Parser
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
70
5.6.3.2 Search service (Highlighting parameter)
The following configuration parameters for the highlighting of query results are optional.
Each highlighting parameter has a direct equivalent in the SolR syntax.
See: http://docs.lucidworks.com/display/solr/Highlighting for more details.
ttkf.server.search.highlighting.snippets
Maximum number of highlighted snippets per field.
Default:1
ttkf.server.search.highlighting.snippets={Positive integer}
Example:
ttkf.server.search.highlighting.snippets=2
ttkf.server.search.highlighting.fragsize
Size in characters for highlighted fragments.
Default: 256
ttkf.server.search.highlighting.fragsize={Positive integer}
Example:
ttkf.server.search.highlighting.fragsize=256
ttkf.server.search.highlighting.simple.pre
HTML markup to insert at the start of a match in the fragment.
Default:
ttkf.server.search.highlighting.simple.pre={HTML markup}
Example:
ttkf.server.search.highlighting.simple.pre=
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
71
ttkf.server.search.highlighting.simple.post
HTML markup to insert at the end of a match in a fragment.
Default:
ttkf.server.search.highlighting.simple.post={HTML markup}
Example:
ttkf.server.search.highlighting.simple.post=
5.6.3.3 Guide
ttkf.server.guidebase.paging.size
When the user scrolls in a category and reach the end of the list of currently visible Guides,
the next {ttkf.server.guidebase.paging.size} Guides will loaded.
Default: 20
ttkf.server.guidebase.paging.size={x>=20}
Example:
ttkf.server.guidebase.paging.size=100
5.6.3.4 LDAP
To consider nested groups for LDAP authentication define the following new optional param-
eters:
ttkf.server.user.ldap.default.recurseIntoGroups
Should parent groups be considered?
Default: false
ttkf.server.user.ldap.default.recurseIntoGroups={true|false}
Example:
ttkf.server.user.ldap.default.recurseIntoGroups=true
ttkf.server.user.ldap.default.group.base.dn
Base DN for group search.
Default: Value of parameter ttkf.server.user.ldap.default.base.dn
ttkf.server.user.ldap.default.group.base.dn={root domain for groups}
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
72
Example:
ttkf.server.user.ldap.default.group.base.dn = DC=teamtraining,DC=local
ttkf.server.user.ldap.default.dialect.group.filter
Filter query for group search. Template parameters can be used.
Default: (&(objectClass=group)(dn=${ttc:group}))
Example:
ttkf.server.user.ldap.default.dialect.group.filter=(&(objectClass=group)(dn=${ttc:group}))
ttkf.server.user.ldap.default.dialect.group.attr.groupMembership
Name of the group membership attribute.
Default: memberOf
Example:
ttkf.server.user.ldap.default.dialect.group.attr.groupMembership=memberOf
5.7 Updating from version 2014 to 2014 R2
5.7.1 Scheduler Service on Websphere
For 2014 R2 the parameters for the scheduler service on Websphere have changed.
Instead of org.quartz.threadPool.class and org.quartz.threadPool.workManager the parame-
ters org.quartz.threadExecutor.class and org.quartz.threadExecutor.workManagerName
must be set.
Old parameters which must be removed, otherwise errors might be occurr during runtime.
org.quartz.threadPool.class
org.quartz.threadPool.workManager
New parameters which must be set, when running on Websphere.
org.quartz.threadExecutor.class
org.quartz.threadExecutor.workManagerName
5.7.1.1 ttkf.server.scheduler.org.quartz.threadExecutor.class
Defines the thread executor used for Websphere.
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
73
Possible value:
ttkf.server.scheduler.org.quartz.threadExecutor.class =
org.quartz.custom.WorkManagerThreadExecutor
5.7.1.2 ttkf.server.scheduler.org.quartz.threadExecutor.workManagerName
Defines the name of the work manager, which shall be used.
Example:
ttkf.server.scheduler.org.quartz.threadExecutor.workManagerName =
ttkf.server.scheduler.org.quartz.threadPool.workManager
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
74
6 Appendix
6.1 Properties service
Workbench & Web Publisher
Application-wide settings are defined in the properties service.
Service name: properties
acceleratorContextPath (Workbench only)
Defines the site relative URL to the Web Publisher. In case several Web Publishers are installed, the one used for preview should be given here.
Possible value:
/publisher/
integratorContextPath (Web Publisher only)
Defines the site relative URL to the Workbench.
Possible value:
/workbench/
superuserIPs
A comma-separated list of IP addresses for which super user functions, like database initialization, are permitted. Do make sure that this property is not left blank (read: you should at least enter "127.0.0.1" here.)
Possible value:
127.0.0.1
allowLoginCookie
Allows remembering login data by means of a browser cookie.
Possible values:
yes (default) no
automanageDocumentLanguage
Automatically determines in which language multilingual meta data are saved (by using content language).
Possible values:
yes (default) no
xmlReaderClass
Defines an XML reader if the application server does not supply one.
Possible values:
Fully qualified Java class name. Example: org.apache.xerces.parsers.SAXParser
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
75
XercesXMLSerializerFactory (optional)
Defines an XML serializer factory used for content transport in case that the application server is not running on SUN JDK.
Possible values:
org.exolab.castor.xml.XercesXMLSerializerFactory
applicationServerLogDirectory
Defines a directory path for application server log files. If set, the administrative func-tion download logfiles includes the log files from the server.
Possible values:
Any valid path on a file system, e.g. c:/myAppServerDir/logs.
checkedOutLicenseValidity
Sets the number of days a checked-out license remains valid. Possible values:
Any positive integer value, e.g. 14.
qaIndexLength
Sets the maximum length of an index entry in the QuickAccess signature.
Possible values:
Any positive integer value, e.g. 64. 0 = no restriction
qaWildCardRestriction
Restricts level-wildcard assignments (generic signature).
Example:
GEN:1001;URL:1001;SAP:10001
1 = level is required and cannot be used as a wildcard 0 = level can be assigned as a wildcard by the user
serverUrl
Represents the URL and context path of the application used to backtrack imported ob-jects to their origin.
Possible values:
Any valid URL. Example: http://sampleServer:8080/workbench
external_integratorURL
Represents the URL to access the Workbench from external locations, for example in a reverse proxy scenario.
Possible values:
Any valid URL. Example: http://externalServer/workbench
external_acceleratorURL
Represents the URL to access the Web Publisher from external locations, for example in a reverse proxy scenario.
Possible values:
Any valid URL. Example: http://externalServer/publisher
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
76
internal_integratorURL
Represents the URL to access the Workbench in an internal way, mainly used for in-ternal server communication between the Workbench and the Web Publishers.
Possible values:
Any valid URL. Example: http://internalServer:8080/workbench
internal_acceleratorURL
Represents the URL to access the Web Publisher internally, mainly for internal server communication between the Workbench and the Web Publishers. This property is mandatory!
Possible values:
Any valid URL. Example: http://internalServer:8080/publisher
portalLoginRequired (Web Publisher only)
Defines whether Web Publisher requires login or not.
Possible values:
true (default) false
portalIgnoresMaintenanceRoles (Web Publisher only)
Defines whether the maintenance roles are ignored or not when it comes to filtering ob-jects visible to a user.
Possible values:
true false (default)
portalIgnoresMaintenanceRolesOnPreview (Web Publisher only)
Defines whether the maintenance roles are ignored on preview or not when it comes to filtering objects visible to a user.
Possible values:
true false (default)
qaSearchMode (Web Publisher only)
Defines the QuickAccess search mode.
Possible values:
"direct" searches only documents of the context specified by the QuickAccess appli-cation.
"cascade" uses multiple searches to allow more general results. E.g., if the specific context is "GEN;excel;cell formatting", the cascade mode will also search for the context "GEN;excel" if no documents were found for the specified context.
"all" uses multiple searches defined by searchlists "qaDirectSearchList" and "qaIndi-rectSearchList" (default).
"off" disables document search.
qaGlossarySearchMode (Web Publisher only)
Enables QuickAccess to search within glossary entries.
Possible values:
-
Server Installation Manual, Version 2014 R2 for Oracle Weblogic
77
on (default) off
qaDirectSearchList (Web Publisher only)
Sets a comma separated list of signature-level maps for a direct result list.
Example:
GEN:1110;URL:1110;SAP:11000
"1110" means the first three levels of a document's signature must be equal to the signature currently searched for.
qaIndirectSearchList (Web Publisher only)
A comma-separated list of signature-level maps for an indirect result list.
Example:
GEN:1100;URL:1100;SAP:00000
qaSortResult (Web Publisher only)
Sets sorting of the result list by ex