Alfresco Workdesk Installation Guide-4.1

Installation Guide
Alfresco Workdesk 4.1
Copyright 2013 by Alfresco and others. Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Alfresco. The trademarks, service marks, logos, or other intellectual property rights of Alfresco and others used in this documentation ("Trademarks") are the property of Alfresco and their respective owners. The furnishing of this document does not give you license to these patents, trademarks, copyrights, or other intellectual property except as expressly provided in any written agreement from Alfresco. The United States export control laws and regulations, including the Export Administration Regulations of the U.S. Department of Commerce, and other applicable laws and regulations apply to this documentation which prohibit the export or re-export of content, products, services, and technology to certain countries and persons. You agree to comply with all export laws, regulations, and restrictions of the United States and any foreign agency or authority and assume sole responsibility for any such unauthorized exportation. You may not use this documentation if you are a competitor of Alfresco, except with Alfresco's prior written consent. In addition, you may not use the documentation for purposes of evaluating its functionality or for any other competitive purposes. This copyright applies to the current version of the licensed program.
ii
Table of Contents
Introduction ...............................................................................................................................1
About this document .......................................................................................................................... 1 Intended audience .............................................................................................................................. 2 Typographical conventions used in this guide .................................................................................... 3 Abbreviations ..................................................................................................................................... 4 Checklist ............................................................................................................................................. 5
Prerequisites ..............................................................................................................................6
Server-side prerequisites .................................................................................................................... 6 Application server ........................................................................................................................... 6 Databases and JDBC drivers ............................................................................................................ 6 Back end ECM systems .................................................................................................................... 6 Client-side prerequisites ..................................................................................................................... 7
Recommendations......................................................................................................................8
Ports ................................................................................................................................................... 8 URL structure ...................................................................................................................................... 8
Preparation for installation ........................................................................................................9

Settings for application servers .......................................................................................................... 9 Settings in the ECM system................................................................................................................. 9 IBM FileNet P8 ................................................................................................................................ 9 Other ECM systems ....................................................................................................................... 12 Search templates .............................................................................................................................. 12 Required settings for IBM FileNet P8 ............................................................................................. 12 Required settings for other ECM systems ...................................................................................... 13
Deploying Alfresco Workdesk ..................................................................................................14

Initial deployment ............................................................................................................................ 14 Create an Alfresco Workdesk Web Archive.................................................................................... 14 Application servers........................................................................................................................ 14 Verify the initial Alfresco Workdesk deployment ........................................................................... 16 ECM adapter activation .................................................................................................................... 18 Provide native ECM system API libraries ........................................................................................ 18 Update Alfresco Workdesk configuration ...................................................................................... 21 Redeploy and verify ...................................................................................................................... 26 Native viewer integration ................................................................................................................. 26 Provide native viewer libraries ...................................................................................................... 26 Redeploy and verify ...................................................................................................................... 26 Database connection ........................................................................................................................ 27 Configure database ....................................................................................................................... 27 Configure Application Server ......................................................................................................... 30 Redeploy and Verify ...................................................................................................................... 34 Access control and security .............................................................................................................. 34 Authentication .............................................................................................................................. 34 Authorization ................................................................................................................................ 37
iii
Auditing ........................................................................................................................................ 38
Basic configuration ...................................................................................................................39

Design ............................................................................................................................................... 39 Role Manager ................................................................................................................................... 39 Simple Role Manager .................................................................................................................... 39 DB Role Manager .......................................................................................................................... 40 History Manager ............................................................................................................................... 42 DB History Manager ...................................................................................................................... 42 Case History (only for IBM FileNet P8 BPM) ................................................................................... 42 MIME Types ...................................................................................................................................... 43 Drag and Drop applet (DND) ............................................................................................................. 43 Drag and Drop activation .............................................................................................................. 43 Drag and Drop configuration ......................................................................................................... 44 Temporary files................................................................................................................................. 44 Language support ............................................................................................................................. 45
Hints and troubleshooting ........................................................................................................46

Log files............................................................................................................................................. 46 Log4j configuration file.................................................................................................................. 46 Log4j and JBoss ............................................................................................................................. 47 Reload configuration files ................................................................................................................. 48 Servlets ............................................................................................................................................. 48 Deploying on Unix/Linux systems ..................................................................................................... 49
Installing the AWD Configurator ..............................................................................................50

Create new project ........................................................................................................................... 50 Import deployment folder structure ................................................................................................. 52 How to use the AWD Configurator ................................................................................................... 54 owplugins.xml ............................................................................................................................... 55 owmimetables.xml........................................................................................................................ 57 How to handle your configuration files ............................................................................................ 58
Updating Alfresco Workdesk ....................................................................................................60 Upgrading the ECM back end system .......................................................................................62 Appendix ..................................................................................................................................63
Daeja Viewer configuration in web.xml ............................................................................................ 63 Example for Log4J configuration ....................................................................................................... 64 A4: Background about Log4J............................................................................................................. 65 A5: Example for changing Java user in DB2....................................................................................... 67
iv
Introduction
Introduction
Alfresco Workdesk is the leading solution for content-centric business applications, running onpremise, as well as in the cloud. Alfresco Workdesk is recommended for Enterprise customers, requiring high levels of functionality, versatility, security, and performance. It is licensed using a subscription model based on the number of processors used in the application server. The yearly subscription price is accounted as operating expenses rather than capital expenses. Besides the CMIS adapter, for example, for connecting to Alfresco Enterprise, it provides an additional native adapter for IBM FileNet Content Manager. Alfresco Workdesk enables users to work seamlessly across the boundaries of different ECM systems without compromising the look and feel. Also, it includes many enterprise features such as multi-tenancy, federation of different systems, and audit trail. Alfresco Office Workdesk and Mobile Workdesk are available add-ons. Alfresco Workdesk is recommended for maximizing the use of your ECM platform whilst supporting a large number of users. Alfresco Workdesk Community is recommended for developers and technology fans dealing with non-critical information. It provides user-friendly applications for eFile management and retrieval and supports all CMIS compliant ECM systems. It can be downloaded for free and is licensed under the GNU Public License. The early availability of Community Edition releases allows using the latest features very fast. Customers can use the Community Edition to develop their own solutions.
About this document

This guide explains how to deploy the Alfresco Workdesk and how to configure the supported ECM infrastructure. It also contains information about how to install the AWD Configurator. Here is the brief overview of the different sections in this installation manual. The Prerequisites section describes the prerequisites for installing Alfresco Workdesk. The Recommendations section recommends the ports and URL structure for Alfresco Workdesk deployment. The Preparation for installation section describes each step of the installation process, including the settings for application servers, ECM systems, search templates, and so on. The Deploying Alfresco Workdesk section describes Alfresco Workdesk deployment, starting from deploying a dummy ECM adapter, and then followed by the deployment of the real ECM adapter. It lists the corresponding library files required for each ECM system, and describes the source and destination locations of these libraries during the deployment. The Basic configuration section includes the most common problems that can occur during deployment, and provides possible solutions. When you have finished installing Alfresco Workdesk with a real ECM adapter, you can configure different Alfresco Workdesk components, for example, Role Manager, History Manager, MIME Type Manager, drag and drop, and so on, by following the instructions in Hints and troubleshooting. To facilitate the configuration of plugins and MIME types, Alfresco Workdesk is delivered with a helper tool called AWD Configurator. The Installing the AWD Configurator section describes how you can install and use this tool and then be able to configure the Alfresco Workdesk plugins and MIME types.
Introduction
The Updating Alfresco Workdesk section describes how to update an existing Alfresco Workdesk deployment with a newer updated version, or fix pack, for the existing version.
Intended audience
This document is intended for software professionals who are installing Alfresco Workdesk. Depending on the ECM and the Alfresco Workdesk edition you are using, you need basic skills to manage the underlying ECM systems. Alfresco Workdesk provides adapters for the following list of ECM systems. The adaptors make use of the native Java APIs: CMIS-compliant ECM systems, for example, Alfresco IBM FileNet P8 Note: Only CMIS-compliant ECM systems are available with Alfresco Workdesk Community. It is recommended that you are a system administrator and have experience with: Application servers: o Deploying web applications (on IBM WebSphere, JBoss, Oracle WebLogic, Apache Tomcat) o classpath configurations o Configuration of the libraries used by your web application o log4j configuration, reading of log files o xml JDBC connections Database knowledge (running DB scripts) Web applications
You must have the authorization to modify and create resources.
Introduction
Typographical conventions used in this guide

Convention
Important terms Classes Methods
Source Code Comments in Source Code //
Example Alfresco OwAppContext getName() public void myMethod(){}

simple source code comment
Java Package Plugins
com.wewebu.server.app com.wewebu.ow.server.plug.owdemo.owmain com/wewebu/ow/server/ <node> value Add Document
Path
XML Attribute XML value
Product-specific terms
Formatting legend for brackets in Source Code, Paths, File Names, and so on:
Ellipsis (...): Parameter the user must supply Between brackets []: Optional items Between braces {}, choices separated by pipe |, example: {even|odd}: Set of choices from which the user must choose only one
The following placeholders are used in this document:
(workdesk) - root directory of AWD deployment (Workplace) - root directory of IBM FileNet P8Workplace deployment (WebSphere) - installation root of WebSphere application server (Tomcat) - installation root of Tomcat application server (JBoss) - installation root of JBoss application server
Introduction
Abbreviations
AE AMP AWD AOWD AMWD BPM CE CMIS ECM FNCM IE MS MS Word Office P8 SSO WAR IBM FileNet Application Engine Alfresco Module Package Alfresco Workdesk Alfresco Office Workdesk Alfresco Mobile Workdesk Business Process Management IBM FileNet Content Engine Content Management Interoperability Services Enterprise Content Management IBM FileNet P8 Content Manager Internet Explorer Microsoft Microsoft Word Microsoft Office IBM FileNet P8 Single Sign-On Web Archive
All trademarks, trade names, registered trademarks, or registered trade names are property of their respective holders.
Introduction
Checklist
1. Before starting [Prerequisites] Prerequisites? [Recommendations] Checked recommendations? [Settings for application servers] Checked settings for application server? [Settings in the ECM system] Checked settings for ECM system? 2. Deployment [Initial deployment] Dummy ECM adapter deployment up and running? [ECM adapter activation] Client libraries installed? [Update Alfresco Workdesk configuration] Alfresco Workdesk configured? [Native viewer integration] Viewer configured? * [Database connection] Database configured? 3. Basic configuration [DB Role Manager] DB Role Manager configured? * [DB History Manager] DB History Manager configured? * [MIME Types] MIME types configured? [Drag and Drop applet (DND)] Drag and Drop applet configured? * 4. Installing AWD Configurator [Installing the AWD Configurator] New project created and deployment structure imported? * These features are not available in Alfresco Workdesk Community.
Prerequisites
Prerequisites
Before deploying the Alfresco Workdesk application, your infrastructure should meet the following prerequisites on both the server-side and the client-side.
Server-side prerequisites
Before starting the Alfresco Workdesk installation, check the server-side prerequisites.
Application server
Alfresco Workdesk runs within a web application. You can test the Alfresco Workdesk deployment on the application server without an underlying back end ECM system by using the dummy ECM adapter (see Initial deployment for more information). Alfresco Workdesk has been successfully tested on several application servers. The following list shows the recommended application servers: JBoss Oracle WebLogic IBM WebSphere Apache Tomcat Note: Only Apache Tomcat is available in Alfresco Workdesk Community.
Databases and JDBC drivers

Alfresco Workdesk is able to store persistent information in a database. Communication with that database is done using JDBC and datasources handled by the application server. In case there is no eligible JDBC driver installed on the Alfresco Workdesk application server, you need the corresponding JDBC libraries from your database vendor. For further details, see Database connection. Alfresco Workdesk has been successfully tested with several databases. The following list shows the recommended databases: IBM DB2 Microsoft SQL Oracle Database MySQL PostgreSQL Note: Only MySQL and PostgreSQL are available in Alfresco Workdesk Community.
Back end ECM systems

The underlying ECM back end system must meet the prerequisites described in the following sections. Note: only CMIS-compliant ECM systems are available with Alfresco Workdesk Community.
See the Alfresco Workdesk Release Notes for supported ECM system versions.
Prerequisites
IBM FileNet P8
Make sure that your Alfresco Workplace deployment is running and you have made a backup. When using IBM FileNet P8, we recommend deploying Alfresco Workdesk on the same application server that hosts the IBM FileNet Application Engine. In some cases, this is mandatory.
CMIS-compliant ECM systems

No additional prerequisites are required to connect Alfresco Workdesk to an ECM back end system using the Content Management Interoperability Services (CMIS) adapter.
Client-side prerequisites
To access the Alfresco Workdesk application on the client-side, use any of the popular web browsers.
See the Alfresco Workdesk Release Notes to find a list of supported browsers.
In addition to an installed web browser, the following criteria must be met: The web browser must be connected to the network for accessing the application server JavaScript must be enabled in the web browser To use some features of Alfresco Workdesk (for example, drag and drop functionality, viewers), Java applets must be allowed in the web browser To use Alfresco Workdesk features/plugins, like Send as email link or Send as email attachment, install an email client, for example, Microsoft Office Outlook or Lotus Notes, on the client-side. Select one of these email clients as the default email client for both the client-side operating system and the client-side web browser.
Even if you are using any other browser than Internet Explorer, make sure that you set the default email program in the Internet Explorer settings. This is because the email plugins of Alfresco Workdesk might use the Internet Explorer API to specify the default email program.
Recommendations
Recommendations
The following sections outline the recommendations for deploying Alfresco Workdesk.
Ports
Alfresco Workdesk does not require any special port or port settings. It can also use Secure Sockets Layer (SSL) to provide secure communication. By default, no additional communication channel mechanism is needed by the applets used in Alfresco Workdesk (for example, the Daeja Viewer applet, the Workflow Designer applet, or the drag and drop applet).
You must install a security certificate on your application server. For more information, see your application server help.
URL structure
In this document, the base URL of the installed Alfresco Workdesk application is referred as (Workdesk Base URL). It is composed of (Protocol)://(Server name)[:(Port)]/(Context path)
The :(Port) in the URL is required only for non-standard ports and even forbidden for the default ports 80 (HTTP) and 443 (HTTPS).
Preparation for installation

Alfresco Workdesk may require additional settings on the application server and the underlying ECM system.
Settings for application servers

The following settings are mandatory for the Oracle WebLogic application server:
Oracle WebLogic: When using Oracle WebLogic, you cannot work with relative file paths in your configuration files. You must use absolute file paths. The option deploy# is not available. For Oracle WebLogic version 10 and higher: Alfresco Workdesk uses the
getRealPath()
method to read some configuration from the deployment file structure.
Therefore set the WebLogic parameter <show-archived-real-path-enabled> in WebLogics config.xml to true, for example:
<web-app-container> <show-archived-real-path-enabled>true </show-archived-real-path-enabled> </web-app-container>
Apache Tomcat: There are no further settings necessary. IBM WebSphere: There are no further settings necessary. JBoss: There are no further settings necessary.
Settings in the ECM system

When using an IBM FileNet P8 ECM system, Alfresco Workdesk must save its search templates and user settings somewhere in the ECM system. To store this information, create folders such as owsearchtemplates and owpreferences 1. In the following sections, these folder structures are described.
IBM FileNet P8
Note: This feature is not available in Alfresco Workdesk Community. To operate correctly, Alfresco Workdesk needs a predefined folder structure in an IBM FileNet P8 Object Store, where user specific persistent information is stored. You may either use an existing Object Store, that also holds business information, or you may create a new Object Store solely for Alfresco Workdesks persistent information. In a later step, you must tell Alfresco Workdesk in which Object Store the folder structure can be found, by setting a parameter in (workdesk)\WEB-INF\conf\fncm5\owbootstap.xml.
Often, an Alfresco Workdesk deployment and an Alfresco Office Workdesk deployment share the same configuration folder structure. In this way both have access to the same resources, like search templates. However, each deployment must have its own location for storing persistent information. A different folder name for owpreferences can be defined in owboostrap.xml using the <UserDefinedPreferencesFolder> configuration node.
See Configure ECM adapter. To create the folder structure, you may either use a provided script (see section Create required folder structure via script) or add the required folders manually (see Create required folder structure manually).
Create required folder structure via script

In the default Alfresco Workdesk installation, you can find a directory \db\fncm. In this directory, you will find a P8 export script with the file name P8ObjectStoreInitial.xml. Import this XML file into the root directory of your Object Store and use the FileNet Enterprise Manager (FEM) to create the initial folder structure. Also, you must adjust the security preferences for these folders. The created folder owpreferences must have "write permissions" for everyone.
Create required folder structure manually

Create a folder /ow_app and a subfolder /owpreferences in your Object Stores root folder if they do not already exist. The folder /owpreferences is necessary for saving any changes in the Alfresco Workdesk settings.
Note: Make sure that all users have write access rights to the /owpreferences folder.
Additionally, further folders must be created. Your subfolder structure under the folder /ow_app may have the following structure:
10 Alfresco Workdesk 4.1
/other folders and eFiles /owpreferences /owsearchtemplates /recordtemplates /owbpmviewtemplates
contains templates defining hierarchies of (semi-)virtual all users must have "write access" for this folder contains search templates contains templates for physical eFiles contains definitions for virtual queues/inboxes
11
Import test data

To test virtual folders, you may import the \db\fncm\testvirtualfolder.xml file into /ow_app/other. In this virtual folder template, you must ensure that the IBM FileNet P8 Object Store is set correctly in your configuration:
<objectstores mergeoption="union"> <objectstore name="DemoStore1" /> </objectstores>
An example virtual view for BPM can be found in \db\fncm\bpmtestcrossview.xml. Import it to /ow_app/owbpmviewtemplates.
Other ECM systems

For underlying ECM systems other than IBM FileNet P8, the Alfresco Workdesk configuration information is not stored in the repository, but in the file system of the application server. Per default, the required folder structure is stored within the Alfresco Workdesk deployment at (workdesk)\WEB-INF\(Adapter)\*.*. Inside owbootstrap.xml (located in the corresponding adapters configuration directory in (workdesk)\WEB-INF\conf\(Adapter), for example cmis), this location can be changed using the <OwApplicationObjectBaseDir> node. If you change the <OwApplicationObjectBaseDir> node, you should move the whole content and folder structure of (workdesk)\WEB-INF\(Adapter)\*.* to this new location. By default this folder contains the directories other, owpreferences and owsearchtemplates.
Search templates
The necessary preparations for using search templates in Alfresco Workdesk are described in accordance to the corresponding ECM repository in the following section.
Required settings for IBM FileNet P8

Note: This feature is not available in Alfresco Workdesk Community. Alfresco Workdesk offers the possibility to search in your repository by using standard IBM FileNet P8 search templates. These search templates are special XML documents created with the IBM FileNet P8 Search Designer and described in detail in the Alfresco Workdesk Configuration and Planning Guide . Alfresco Workdesk is looking for search template documents by default in the folder /ow_app/owsearchtemplates of the default IBM FileNet P8 Object Store. The name of the default IBM FileNet P8 Object Store is configured in owbootstrap.xml.
12
You can make existing search templates available to Alfresco Workdesk by adding a reference to the owsearchtemplates folder. You can make these search templates available on a per user base by setting appropriate permissions for each search template.
Required settings for other ECM systems

Copy search template files to the following location in the file system: Default folder: (workdesk)\WEB-INF\(Adapter)\owsearchtemplates or The folder owsearchtemplates within the folder configured using the node <OwApplicationObjectBaseDir> in owbootstrap.xml.
13
Deploying Alfresco Workdesk

The following sections describe how to deploy Alfresco Workdesk. The first section describes how to deploy Alfresco Workdesk with its out-of-the-box configuration (that is, using the dummy ECM adapter). The dummy ECM adapter allows you to test your Alfresco Workdesk deployment without using a real underlying back end ECM system. For the deployment procedure, several supported application servers are covered and a short verification mechanism is provided to ensure that your first deployment step is successful. Later sections cover the deployment procedures, when it comes to redeploy Alfresco Workdesk in advanced configurations, for example, switching from dummy ECM adapter to a real ECM adapter. This step also includes a verification mechanism. A third section is about creating a datasource at the application server side. Alfresco Workdesk must have a datasource to store persistent information in a database. This step also includes the redeploying and verification procedure.
Initial deployment
This section describes how to create a valid Alfresco Workdesk web archive (WAR) file and how to deploy this archive in its initial configuration on several application servers. We strongly recommend deploying Alfresco Workdesk initially without any modifications to how it was delivered by default. Later sections then refer to modifying Alfresco Workdesks configuration and redeploying Alfresco Workdesk with this changed advanced configuration.
Create an Alfresco Workdesk Web Archive

Extract the delivery zip file sent to you by Alfresco to a temporary location. Depending on the deployment procedure of your application server, the web archive is needed in one of the following modes: Packed Mode: To create a packed web archive file, a Java Development Kit (JDK) has to be installed on your system. For Microsoft Windows operating systems, we provide a batch script called create_workdesk_war.bat in the \bin directory of the Alfresco Workdesk delivery. Read create_war_readme.txt in the same directory for further information. On other operating systems than Microsoft Windows, you may want to create the web archive file manually by executing a command similar to jar cf workdesk.war *. Exploded Mode: The \bin\workdesk folder in the unpacked delivery is an already exploded web archive. For deploying Alfresco Workdesk, proceed with the section for your application server.
Application servers
This section describes the most important steps of the Alfresco Workdesk deployment procedure on different supported application servers.
IBM WebSphere
Note: This feature is not available in Alfresco Workdesk Community.
14
On IBM WebSphere, Alfresco Workdesk has to be deployed as packed web archive ( *.war file). Use the WebSphere server administration console to deploy this file. You do not need to change the default settings during the deployment process of WebSphere. After having deployed Alfresco Workdesk, check that all classes are loaded with the application class loader. Normally you can find this option in the menu Shared library references > JSP reload options for web modules by navigating in WebSpheres server administration console through step 1 to 3 as shown in the following screenshot:
Select Classes loaded with application class loader first .
Oracle WebLogic
Note: This feature is not available in Alfresco Workdesk Community. On Oracle WebLogic, Alfresco Workdesk has to be deployed as packed web archive ( *.war file). Use the WebLogic server administration console to deploy this file.
WebLogic only supports absolute file paths in the Alfresco Workdesk configuration files like web.xml. Placeholders like deploy# are not supported.
15
For Oracle WebLogic version 10 and higher: Alfresco Workdesk uses the
getRealPath()
method to read some configuration from the Alfresco Workdesk
deployment file structure. Therefore set the WebLogic parameter <show-archivedreal-path-enabled> in WebLogics config.xml to true: <web-app-container> <show-archived-real-path-enabled>true </show-archived-real-path-enabled> </web-app-container>
JBoss
Note: This feature is not available in Alfresco Workdesk Community. On JBoss, Alfresco Workdesk has to be deployed as exploded web archive. After copying the \bin\workdesk folder from the Alfresco Workdesk delivery to (JBoss)\server\default\deploy, you may rename the folder to your application context. Do not forget to append the .war extension to the folder name. An example would be (JBoss)\server\default\deploy\workdesk.war.
JBoss and log4j*.jar: Do not deploy log4j*.jar when using JBoss. See Log4j and JBoss for further information.
Apache Tomcat
On Apache Tomcat, Alfresco Workdesk has to be deployed as exploded web archive. After copying the \bin\workdesk folder from the Alfresco Workdesk delivery to (Tomcat)\webapps, you may rename the folder to your application context. An example would be (Tomcat)\webapps\workdesk.
If you are using Alfresco as ECM Repository, Alfresco Workdesk may not be deployed in the same Apache Tomcat as Alfresco is deployed. Use a separate Apache Tomcat instance.
Verify the initial Alfresco Workdesk deployment

To check if your initial Alfresco Workdesk deployment is up and running, open any supported web browser and navigate to http://(servername)[:(port)]/(context path) . The default value for (context path) is workdesk. If your initial deployment was successful, the following login page should be displayed:
16
Log in with the names Guest, A, B, or Admin (as described on the welcome screen). After logging in with name B and without any password, see the following screen:
17
Log out and log in once more with user name Admin and without any password. You will see the following screen:
If you see an error message similar to Error 500: com.wewebu.ow.server.log. OwLogCoreBase (initialization failure) when calling the Alfresco Workdesk URL,
log4j-x.x.x.jar is missing on your application server. Follow the instructions in

section Log files to install the missing library.
Verification of different Alfresco Workdesk deployments will produce different welcome screens (for example, configuring a real ECM adapter in later sections). We strongly recommend that you verify the Alfresco Workdesk deployment again after each deployment step.
ECM adapter activation

The Alfresco Workdesk deployment can be switched from a dummy ECM adapter to a real ECM back end adapter in just two steps. First, Alfresco Workdesk needs to know where to find the native Java API libraries of the respective ECM back end system. Afterwards, the ECM adapter must be switched in the Alfresco Workdesk web application web.xml configuration file.
Provide native ECM system API libraries

Copy the libraries into the Alfresco Workdesk web application deployment, that is, (workdesk)\WEB-INF\lib and make them available to the Alfresco Workdesk web application.
Whenever the original libraries change (new patch/fix pack version), you must update the copies here also.
18
IBM FileNet P8 5.x API libraries

Note: This feature is not available in Alfresco Workdesk Community. For IBM FileNet P8 5.x, there are two tasks to complete (with additional tasks depending on the situation). 1. Provide required libraries: Alfresco Workdesk needs the IBM FileNet P8 5.x Client API to connect to the IBM FileNet P8 5.x Content Engine. The structure and archive names of the IBM FileNet P8 Client API might change from version to version. For IBM FileNet P8 5.x, the Client APIs are contained in the following libraries: jace.jar pe.jar * pe3pt.jar * peResources.jar * stax-api.jar xlxpScanner.jar xlxpScannerUtil.jar Only required when using IBM FileNet P8 BPM / Process Engine The IBM FileNet P8 5.x Client API itself additionally requires the log4j-1.2.10.jar library. This library might already be provided by the application server.
All required IBM FileNet P8 Client API libraries can be found in an IBM FileNet P8 deployment directory in ../FileNetEngine.ear/APP-INF/lib.
Either copy the required libraries into the WEB-INF\lib folder of the Alfresco Workdesk deployment or use the referencing mechanisms provided by the application server to make them available for the web application. 2. Configure the connection to the IBM FileNet Content/Process Engine: Next, you need to tell Workdesk how to connect to the IBM FileNet P8 Content/Process Engine. Modify the corresponding configuration nodes in (workdesk)\WEBINF\conf\fncm5\owbootstrap.xml. This file contains, among other configuration parameters, the server name or IP address of your IBM FileNet P8 Content Engine and the connection point for your IBM FileNet P8 Process Engine located under the main adapter configuration node <EcmAdapter>:
<ConnectionUrl> <jaasContext> <BPM>/<ConnectionPointName>
sets the URL for the IBM FileNet P8 Content Engine sets the authentication mechanism sets the P8 Process Engine Connection Point
19
Content Management Interoperability Services API libraries

Alfresco Workdesk needs the CMIS APIs to connect to any CMIS compliant ECM repository with the CMIS adapter. For CMIS 1.0, the CMIS APIs are contained within the libraries alfrescocmis.jar (only needed when running Alfresco Workdesk on top of Alfresco 3.4 or later) cmis.jar json-simple.jar webservices-api.jar webservices-extra.jar webservices-extra-api.jar webservices-rt.jar The CMIS API libraries can be found in the Alfresco Workdesk delivery under (Delivery)\libs\cmis.
Required libraries for Alfresco BPM
If you want to use Alfresco Workdesk BPM functionalities with Alfresco, there are further libraries required which can be found under (Delivery)\libs\alfrescobpm: apache-mime*.jar httpclient*.jar httpcore*.jar httpmime*.jar 20ptione-core-asl*.jar 20ptione-mapper-asl*.jar jcip-annotations*.jar org.osgi.core*.jar org.restlet.ext.httpcllient*.jar org.restlet.ext.jackson*.jar org.restlet.ext.json.jar org.restlet.lib.org.json*.jar org.restlet*.jar
Cross-adapter scenario
Note: This feature is not available in Alfresco Workdesk Community. If you want to use Alfresco Workdesk against one ECM system crossed with another ECM system (see Configure ECM cross adapter), you must ensure that the corresponding libraries for both ECM systems are made available for the Alfresco Workdesk deployment.
20
Update Alfresco Workdesk configuration

Before Alfresco Workdesk is able to access the underlying ECM system(s), its configuration has to be adapted in several locations. The necessary switches are described in the following sections.
Switch ECM adapter

Alfresco Workdesk is able to maintain and switch between multiple configurations. Each configuration corresponds to a different ECM back end system and consists of a set of xml files. Each set of xml files is stored in its own descriptive folder. Switching different ECM back end system configurations means switching to a different configuration folder. You can do so by changing the path to the currently active configuration in the (workdesk)/WEB-INF/web.xml file. Alfresco Workdesk provides configuration folders for all supported ECM back end systems: Content Management Interoperability Services (CMIS) for Alfresco Workdesk Community: (workdesk)\WEB-INF\conf\cmis Content Management Interoperability Services (CMIS): (workdesk)\WEB-INF\conf\cmis_prof IBM FileNet P8 5.x: (workdesk)\WEB-INF\conf\fncm5 Switch between the ECM back end system configurations by removing and adding XML comment tags. Example: Switch from dummy ECM adapter to the IBM FileNet P8 5.x adapter. Before switching (dummy ECM adapter is set):
<context-param id=OwResourceFilePath> <param-value>deploy#WEB-INF/conf/dummy</param-value>  <propertymap name=D:owd:hrdocument.owd:documentPersonnelNumber > HrDocument.DocumentPersonnelNumber </propertymap> </propertymappings> <classmappings> <classmap name="D:owd:hrdocument">HrDocument</classmap> </classmappings> </Xmapping> <XecmAdapter> <ClassName>com.wewebu.ow.server.ecmimpl.cmis.OwCMISNetwork </ClassName> <Version>4.1.0</Version> <IDDMSIDConverterClass> com.wewebu.ow.server.ecmimpl.cmis.p8.OwP8CMISIDDMSIDConverter </IDDMSIDConverterClass>  <WSDLRepository>http://192.168.1.254:9080/fncmis/wsdl </WSDLRepository> <WSDLNavigation>http://192.168.1.254:9080/fncmis/wsdl </WSDLNavigation> <WSDLObject>http://192.168.1.254:9080/fncmis/wsdl </WSDLObject> <WSDLMultifiling>http://192.168.1.254:9080/fncmis/wsdl</WSDLMultifiling> <WSDLDiscovery>http://192.168.1.254:9080/fncmis/wsdl</WSDLDiscovery> <WSDLVersioning>http://192.168.1.254:9080/fncmis/wsdl </WSDLVersioning> <WSDLRelationship>http://192.168.1.254:9080/fncmis/wsdl </WSDLRelationship> <WSDLPolicy>http://192.168.1.254:9080/fncmis/wsdl </WSDLPolicy> <WSDLACL>http://192.168.1.254:9080/fncmis/wsdl </WSDLACL> <Authentication mode="NONE"/> </XecmAdapter> </ExternalCrossAdapter>
25
Configure the logging mechanism

Configure log4j to make Alfresco Workdesk write logs into a separate log file. See Log files for details about configuring log4j.
Redeploy and verify

To finalize the ECM adapter activation, Alfresco Workdesk has to be redeployed. See Initial deployment.
Before deploying Alfresco Workdesk in its new configuration you must undeploy Alfresco Workdesk first.
Native viewer integration

Note: This feature is not available in Alfresco Workdesk Community. The next section describes how to deploy and configure the native viewer for IBM FileNet P8 (Daeja) ECM systems. If you have purchased the Alfresco Workdesk Advanced Document Viewing package, see the Advanced Document Viewing Installation Guide.
After integrating the native ECM system viewer, Alfresco Workdesk has to be redeployed. Afterwards, the viewer integration should be verified, for example, by opening image files with the native viewer out of Alfresco Workdesk.
Provide native viewer libraries

Use the following steps to make the necessary native viewer libraries available to the Alfresco Workdesk web application.
IBM FileNet P8 Daeja viewer libraries

You can choose between two options if you want to install the Daeja viewer. First option is to install it as a separate application with its own WAR-file. The second option is to copy the entire FnJavaV1Files directory, that is, including its contents, from (Workplace) to (workdesk). Also, you must copy Annot.xsl from (Workplace)\WEB-INF\xsl to (workdesk)\viewer\fncm5. You must also configure the CODEBASE parameter in (workdesk)/ viewer/fncm5/FNCM5ImageViewer.jsp to point to a valid Daeja viewer installation (For example: codebase="<%=strBaseURL%>/FnJavaV1Files" ).
Make sure that the Daeja viewer related servlets and servlet-mappings in
(workdesk)\WEB-INF\web.xml are active. For details on how web.xml must be

adapted, refer to Daeja Viewer configuration in web.xml.
Redeploy and verify

To finish the native viewer integration, Alfresco Workdesk has to be redeployed. See Initial deployment. Verify the correct native viewer integration by opening some image files from Alfresco Workdesk afterwards.
26
Database connection
Alfresco Workdesk uses database connections to store persistent data for: DB Role Manager DB History Manager Other Alfresco Workdesk related data (attribute bag, user settings, bookmarks/favorites, search queries) This section explains how to create the required database tables, how to create the corresponding datasources in your application server and how to make the created datasources available to the Alfresco Workdesk web application.
Configure database
By default, Alfresco Workdesk writes persistent data into the database tables OW_ATTRIBUTE_BAG, OW_HISTORY and OW_ROLE. If you want to use custom database tables with custom table names, you can configure these table names in the owbootstrap.xml file (see Configure ECM adapter and Role Manager for configuration examples). We recommend creating a new database for Alfresco Workdesk with the scripts (adapt the scripts if you want to change database table names) delivered with Alfresco Workdesk and configure the database with read/write privileges.
IBM DB2
Note: This feature is not available in Alfresco Workdesk Community. Create a new database for Alfresco Workdesk using the delivered script (Delivery)\db\scripts\create_db2_databases\win\workdesk\create_OWDDB.b at from the DB2 Command Window: Use the following delivered scripts to create the default database tables: (Delivery)\db\scripts\OwDB2_CreateAttributeBagTable.sql
Note: The Attribute Bag table script provided with an Alfresco Workdesk delivery contains a default column length of 1024 bytes for the attribute value. We recommend to set this column length to an upper limit as per own needs.
(Delivery)\db\scripts\OwDB2_CreateDBHistoryManagerTable.sql (Delivery)\db\scripts\OwDB2_CreateDBRoleManagerTable_Scheme2.sql You can run the scripts by using the DB2 Control Center. Note that the schema user of the tables will be the same user that established a database connection while creating the tables. This user has to be configured in the datasource at the application server later on. The following screenshot gives an example of this connection in case of IBM WebSphere 6.1 and IBM DB2 9.1:
Note: In case of Windows 2003 Server, the currently logged in user will be the owner of the new database. The user you specify in the fourth argument will be granted the rights Connect to and Create Table and is called the Schema user.
27
Note: When creating the database manually, make sure to use a page size of at least 8 KB. The provided script create_OWDDB.bat automatically takes care of this issue.
Changing the Java Connector user: It is not enough only to change the database owner to the Java Connector user, because the schema user would not be changed. To achieve this, connect as the appropriate user to the database. See A5: Example for changing Java user in DB2 for examples.
Microsoft SQL Server

Note: This feature is not available in Alfresco Workdesk Community.
Create a new database and then use the scripts provided with the Alfresco Workdesk delivery to create the database tables. (Delivery)\db\scripts\OwMSSQL_CreateAttributeBagTable.sql (Delivery)\db\scripts\OwMSSQL_CreateDBHistoryManagerTable.sql (Delivery)\db\scripts\OwMSSQL_CreateDBRoleManagerTable_Scheme2.sql Create a new user account for the Alfresco Workdesk web application with read and write privileges to the created tables.
Oracle 9i
Note: This feature is not available in Alfresco Workdesk Community. Create a new database and then use the scripts provided with the Alfresco Workdesk delivery (Delivery)\db\scripts\OwOracle_CreateAttributeBagTable.sql (Delivery)\db\scripts\OwOracle_CreateDBHistoryManagerTable.sql (Delivery)\db\scripts\OwOracle_CreateDBRoleManagerTable_Scheme2.sql Create a new user account for Alfresco Workdesk with read/write privileges to these tables.
Note: When using a command line tool like Sql-Plus to import the SQL statements, every file has to end with a / , otherwise the last SQL statement will not be executed.
Example:
CREATE TABLE OW_ATTRIBUTE_BAG ( UserName BagName AttributeName varchar2(128) varchar2(128) varchar2(128) NOT NULL, NOT NULL, NOT NULL,
AttributeValue varchar2(1024) NOT NULL, CONSTRAINT OW_ATTRIBUTE_BAG_PK PRIMARY KEY (UserName, BagName, AttributeName) );/
MySQL
Use the supplied batch file to create the Alfresco Workdesk database and all database tables: (Delivery)\db\scripts\create_mysql_databases\create_OWDDB.bat Alternatively, use the following script to create the Alfresco Workdesk database: (Delivery)\db\scripts\create_mysql_databases\Create_MySQL_Database.sql Use the following scripts to create every Alfresco Workdesk table manually: (Delivery)\db\scripts\OwMySQL_CreateAttributeBagTable.sql (Delivery)\db\scripts\OwMySQL_CreateDBHistoryManagerTable.sql * (Delivery)\db\scripts\OwMySQL_CreateDBRoleManagerTable.sql * * Not needed/used by Alfresco Workdesk Community
29
PostgreSQL
Use the supplied batch file to create the Alfresco Workdesk database and all database tables: (Delivery)\db\scripts\create_postgres_databases\create_OWDDB.bat Alternatively, use the following script to create the Alfresco Workdesk database: (Delivery)\db\scripts\create_postgres_databases\Create_PostgreSQL_Data base.sql Use the following scripts to create every Alfresco Workdesk table manually: (Delivery)\db\scripts\OwPostgreSQL_CreateAttributeBagTable.sql (Delivery)\db\scripts\OwPostgreSQL_CreateDBHistoryManagerTable.sql * (Delivery)\db\scripts\OwPostgreSQL_CreateDBRoleManagerTable.sql * * Not needed/used by Alfresco Workdesk Community
Configure Application Server

You must configure a new datasource at the application server, which makes the created database tables available to the Alfresco Workdesk web application. The following section briefly describes how to establish a JDBC connection between the application server and the DBMS. The first part explains how to create a JDBC provider at the application server. The latter part covers the configuration of a related datasource for that JDBC provider.
JDBC Libraries: Make sure you have the correct versions of the required JDBC driver libraries for connecting to your database. You can download the libraries from the corresponding database vendor.
Here are some JDBC libraries that you might need; their names may be different from database version to database version. MSSQL: sqljdbc-3.0.1301.101.jar Oracle: ojdbc14-10.2.0.5.jar
30
IBM DB2: db2jcc.jar (JDBC driver type 4) db2jcc_license_cu.jar (JDBC driver type 4) db2jcc_license_cisuz.jar (JDBC driver type 4 for z/OS) db2java.zip (db2java.jar) (JDBC driver type 2) MySQL: mysql-connector-java-5.1.14-bin.jar PostgreSQL: postgresql-9.1-902.jdbc4.jar (JDBC driver type 4) The following list provides the JDBC driver library destination folder for the corresponding application server, to make the JDBC driver available to a web application running on that application server: Apache Tomcat 5.x: (Tomcat)\common\lib Apache Tomcat 6.x onwards: (Tomcat)\lib JBoss: (JBoss)\server\default\lib Oracle WebLogic: Contact your Oracle WebLogic and/or database administrator for further Information IBM WebSphere: Contact your WebSphere and/or database administrator for further information
IBM WebSphere
Note: This feature is not available in Alfresco Workdesk Community. In IBM WebSphere you must configure a new datasource. For IBM WebSphere 6.1 the steps are: Configure a JDBC Provider: o For Alfresco Workdesk, a non-XA JDBC Provider is sufficient. If appropriate, you may use an already existing provider. Otherwise, create a new one at Resources -> JDBC -> JDBC Providers -> New Configure a J2C Authentication Alias: o Make sure that there is an authentication alias configured defining appropriate database access credentials. To create a new one, go to Secure administration, applications, and infrastructure -> Authentication -> Java Authentication and Authorization Service -> J2C authentication data -> New. Create a new datasource o This is done at Resources -> JDBC -> Data sources -> New o Choose an appropriate Datasource name and JNDI name.
31
Important: make sure you enter the same value for <JNDIName> of
<DefaultDataSource> section in the
owbootstrap.xml as defined in the
WebSphere datasource. It may not start with a java:/ prefix. Here is an example of how it is supposed to look, both in WAS as well as in owbootstrap.xml:
<DefaultDataSource> <JNDIName>WorkdeskDefaultDS</JNDIName> </DefaultDataSource>
For other IBM WebSphere versions, the setup should be similar, but some menu entry names might have changed. Contact your IBM WebSphere administrator for details.
Apache Tomcat
Copy the JDBC driver files from \db\lib to (Tomcat)\common\lib. Configure the Resource Adapter for Tomcat: 1. Edit the configuration template \db\tomcat\META-INF\context.xml according to your database installation by uncommenting the correct XML example block for your database (DB2, Oracle, MSSQL, Access, MySQL, PostgreSQL) . 2. Adopt the path value in the <Context> element to the value of the web application context root of your Alfresco Workdesk deployment, that is, (workdesk). 3. Adopt the values for the parameters username, password and url in the configuration file to the values of your database server. 4. Create a new folder META-INF in your Alfresco Workdesk deployment, that is, (workdesk)\META-INF. 5. Copy the edited configuration template (Delivery)\db\tomcat\METAINF\context.xml to (workdesk)\META-INF. Create the required database tables if they dont exist already. The corresponding SQL scripts can be found in db/scripts (see Configure database). Depending on your type of Alfresco Workdesk configuration, all three tables may be required ( ow_attribute_bag, ow_history, ow_role). Alfresco Workdesk needs the OW_ATTRIBUTE_BAG table. Make sure you entered the correct value for <JNDIName> in owbootstrap.xml, section <DefaultDataSource>. It has to be exactly the value of the name parameter from the <Resource name=java:/JNDIName> tag of the copied context.xml configuration file.
32
The following shows an example of the owbootstrap.xml entry:

<DefaultDataSource> <JNDIName>java:/JNDI_Name</JNDIName> </DefaultDataSource>
JBoss
Note: This feature is not available in Alfresco Workdesk Community. Copy the file from the Alfresco Workdesk delivery: (Delivery)\db\jboss\mssql-ds.xml for MS-SQL (Delivery)\db\jboss\db2-ds.xml for DB2 (Delivery)\db\jboss\oracle-ds.xml for Oracle (Delivery)\db\jboss\mysql-ds.xml for MySQL or (Delivery)\db\jboss\postgresql-ds.xml for PostgreSQL Copy the file to the directory (JBoss)\server\default\deploy and adapt all settings (server-name, database-name, user-name and password) to your environment. You could change the JNDI name MSSQLDS, OracleDS, DB2DS, MySQLDS or PostgreSQL to a name of your choice, but you must remember that the name must correspond to the default name (<JNDIName> of <DefaultDataSource> section) specified in owbootstrap.xml.
Oracle WebLogic with Connection Pooling

Note: This feature is not available in Alfresco Workdesk Community. In the Server Console, create a new connection pool. When selecting the type of the pool, select "other". Input values in the same way as when creating the datasource in Tomcat. The major problem should be to make the JDBC driver libs (for example, the sqljdbc.jar file) available to WebLogic. Modify the CLASSPATH variable in the "startWebLogic.cmd" by adding the JDBC driver path, for example, ";(path to sqljdbc.jar)" or copy the JDBC driver libraries (jar files) to the ...\server\lib folder. Restart the application server. Create a new datasource using the Server Console. Then select the connection pool that was created using the previous instructions.
Important: The JNDI name has to be "MSSQLDS" for Microsoft for example. No java:/ or anything on both sides - neither the datasource configuration side on WebLogic nor the owbootstrap.xml side on Alfresco Workdesk. Then, restart the application server.
When the datasource has been created correctly, it should be visible in the JNDI tree view at Server Console -> Server -> Logging -> JDBC -> View JNDI tree.
33
Redeploy and Verify

To finish the setup of the database connection, Alfresco Workdesk has to be redeployed. Follow Initial deployment to do so. A correct database connection can be verified by starting up the Alfresco Workdesk deployment and checking the corresponding LOG file. If you see some lines similar to the following in the LOG file, whereas the entry with the <DefaultDataSource> element is the most important line, everything seems to work fine and a database connection should be established by Alfresco Workdesk:
[main] DEBUG owd.core [] - OwConfiguration.applicationInitalize: start reading the bootstrap configuration data... [main] DEBUG owd.core [] - OwConfiguration.createJdbcDataSource: Initializing datasource successfully. [main] DEBUG owd.core [] - OwConfiguration.createJdbcDataSource: Initializing Spring Jdbc template successfully done. [main] DEBUG owd.core [] - OwConfiguration.applicationInitalize: DB <DefaultDataSource> of owbootstrap.xml, JNDIName = java:/MSSQLDS [main] DEBUG owd.core [] - OwConfiguration.applicationInitalize: ...reading the bootstrap configuration data finished.
Access control and security

For access control, the following three levels are differentiated: Authentication Identification and verification of users Authorization Controlling access to resources Auditing Monitoring and logging access to the system
Authentication
To understand authentication with Alfresco Workdesk, note the following: Alfresco Workdesk never authenticates a user or verifies user credentials. Authentication is usually performed by the ECM repository (as it contains the objects for which access control is required). For CMIS-compliant repositories connected with the Alfresco Workdesk CMIS adapter, you must authenticate users against an ECM system connected to a LDAP system (see LDAP authentication). Alfresco Workdesk can only support what the back end provides, so you must set up the back end and authentication infrastructure as a prerequisite. Only a user who is authenticated by the ECM repository can access content using Alfresco Workdesk. Alfresco Workdesk passes user credentials to the ECM back end system in one of two possible ways: o Username and password from a user login form are passed to the ECM back end. o Alfresco Workdesk delegates authentication to the JEE (formerly J2EE) application server container. This is commonly called Single Sign-On (SSO), since it does not require username and password to be provided to Alfresco Workdesk. This is always
specific to the content repository and the provided API for authenticating users. The JEE container uses the Java Authentication and Authorization Service (JAAS) to verify the user's credentials by making the necessary LDAP calls to whatever directory service is configured on the application server level. Once a user is successfully authenticated against the back end, Alfresco Workdesk uses this identity for authorization. Authentication is always specific to the content repository. SSO has to be configured for the ECM repository and on the application server. This is a task of the system administrator and/or service provider, which is out of the Alfresco Workdesk scope. Alfresco Workdesk can be configured to support SSO for IBM FileNet P8. Technically, Alfresco Workdesk is calling a logon() or connect() method with or without username and password. Setting up the prerequisites and performing integration tests typically requires far more effort and planning.
LDAP authentication
As it is not possible to request user or group information with CMIS, it is necessary to have a LDAP connection configured for Alfresco Workdesk to be able to use the DB Role Manager (see DB Role Manager) in combination with CMIS compliant repositories. In those cases, the CMIS compliant repository itself also needs to be connected to the same LDAP system and needs to share the same users and groups. LDAP authentication for Alfresco Workdesk is configured in the configuration node <authentication> in owbootstrap.xml. By configuring mode="LDAP" Alfresco Workdesk authentication is no longer performed against the pure ECM system, but against an ECM system connected to the same LDAP system as configured in this node. Example LDAP authentication configurations can be found as commented parts of every default owbootstrap.xml file. The available LDAP configuration nodes are standard LDAP configuration nodes.
Enabling of SSO for Alfresco Workdesk

To enable Single Sign-On for Alfresco Workdesk, enable security in the application server and the Alfresco Workdesk deployed module. Activate container-managed security for Alfresco Workdesk by adding these lines to the web.xml file of Alfresco Workdesk:
<security-constraint> <web-resource-collection> <web-resource-name>AWD</web-resource-name> <description>Alfresco Workdesk</description> <url-pattern>/</url-pattern> <url-pattern>/default41.jsp</url-pattern> </web-resource-collection> <auth-constraint> <role-name>All Authenticated</role-name> </auth-constraint> <user-data-constraint> <description>User data constraints</description> <transport-guarantee>NONE</transport-guarantee> </user-data-constraint>
35
Deploying Alfresco Workdesk </security-constraint> <login-config> <auth-method>BASIC</auth-method> <realm-name>Workdesk</realm-name> </login-config> <security-role> <description>All Authenticated</description> <role-name>All Authenticated</role-name> </security-role>
Configure security roles in the application.xml deployment descriptor:

<application> <display-name>AWD</display-name> <module> <web> <web-uri>workdesk.war</web-uri> <context-root>/workdesk</context-root> </web> </module> <security-role> <role-name>All Authenticated</role-name> </security-role> </application>
Users or groups must be assigned in the application server role configuration (for example, when using IBM WebSphere, go to the Integrated Solutions Console > Enterprise Applications > Alfresco workdesk > Security role to user/group mapping ).
SSO configuration for IBM FileNet P8 5.x

As a prerequisite for using SSO with Alfresco Workdesk and IBM FileNet P8 5.x, IBM FileNet P8 WorkplaceXT has to be configured for SSO. If SSO is working correctly with IBM FileNet P8 WorkplaceXT, you must configure owbootstrap.xml located in (workdesk)/WEBINF/conf/fncm5 as shown in the following example to use SSO also for your Alfresco Workdesk deployment:
<EcmAdapter> <ClassName>com.wewebu.ow.server.ecmimpl.fncm5.OwFNCM5Network</ClassName> <Version>4.1.0</Version> <ConnectionURL>iiop://localhost:2809/FileNet/Engine </ConnectionURL> <jaasContext>FileNetP8Server</jaasContext>
36
To get more information about SSO for IBM FileNet P8 5.x, visit the IBM Information Center: IBM FileNet P8 Version 5.0 Information Center: http://publib.boulder.ibm.com/infocenter/p8docs/v5r0m0/index.jsp?topic=%2Fcom.ibm.p8.ce.de v.ce.doc%2Fgs_concepts.htm
SSO for other ECM systems

Contact Alfresco Support if you want to use SSO for Alfresco Workdesk in combination with other ECM systems than the ones mentioned above.
Authorization
Authorization is handled at two different levels, at object and document level (see Object and document-level security) as well as at business roles and UI level (see Business roles and UI level security).
Object and document-level security

Alfresco Workdesk strictly complies with the security of the underlying repository. This security can never be bypassed. The back end repository provides security on an object-level, typically documents and folders but also choicelists, workitems and other custom objects or item types depending on the back end System.
Business roles and UI level security

Alfresco Workdesk extends the above basic object level security by a functional, role-based security at front end level. This is incorporated by the DB Role Manager. The DB Role Manager assigns a set of functionality to a group by calling getGroupMemberships() against an LDAP Directory for the current user, retrieved during authentication process. Permissions can be assigned to a group or role for the following items: UI Design Definitions (corporate or departmental design) Master Plugins Document Plugins eFile Plugins Document classes User-defined items
37
Auditing
There are three levels of auditing and logging: Back end history maintained by the ECM repository: Logging is completely transparent to Alfresco Workdesk. It has to be decided if back end logging or front-end logging (by Alfresco Workdesk) is used (or both). Alfresco Workdesk uses a History Manager (see History Manager) to display whatever history is used in a table, back end history can only be displayed. Application history by incorporating the Alfresco Workdesk DB History Manager: If front-end logging has to be used, any major DB (Oracle, DB2, MS SQL, MySQL, PostgreSQL) can be used to log whichever action was executed in the front end. Therefore the DB History Manager (see DB History Manager) is required. Any event can be logged which is triggered in the fronted, so typically a click on a component, plugin, button. For example a click on the checkout menu item, which is an Alfresco Workdesk plugin. Often front-end history is used if back end events are not meaningful and/or must be combined to be meaningful from a business perspective. So front-end history is used as a kind of storytelling from the business perspective. Technical logging for Alfresco Workdesk is done using log4j (see Log files)
38
Basic configuration
Basic configuration
After Alfresco Workdesk is configured to run with a supported ECM system, you can start modifying some basic configurations.
Design
The design definition, which should be invoked by Alfresco Workdesk, can be specified with the element <DesignName> (within the <RoleManager> element in owbootstrap.xml). In a standard Alfresco Workdesk delivery the design default41 is available. When left empty, the default design default41 will be chosen. Additional designs can be created by customization. For additional information refer to Developer Guide: Customizing Layout and Designs section.
Role Manager
Alfresco Workdesk offers two variants of its Role Manager: the Simple Role Manager (<ClassName> element ends with OwSimpleRoleManager) and the DB Role Manager (ends with OwDBRoleManager). The Role Manager is configured in the file owbootstrap.xml and the corresponding configuration element is called <RoleManager>. Since only one instance of the <RoleManager> is allowed to be present, use XML comments (<!and -->) to hide the instance which should not be taken into account:
 <RoleManager> <ClassName>com.wewebu.ow.server.roleimpl.dbrole.OwDBRoleManager </ClassName> </RoleManager>
Simple Role Manager

When enabling the Simple Role Manager, you may only restrict access to the Site Settings by defining the tag <SiteAdmins> and to specify which design (element <DesignName>) should be used. In the following example, the user Administrator is set as the site administrator.
39
Basic configuration
<RoleManager> <ClassName>com.wewebu.ow.server.roleimpl.simplerole.OwSimpleRoleManager </ClassName> <SiteAdmins> <user>Administrator</user> </SiteAdmins> <DesignName>default41</DesignName> </RoleManager>
DB Role Manager
Note: This feature is not available in Alfresco Workdesk Community. By using the DB Role Manager, persistent user/role data is saved to a database table (see Configure database). The table name (default: OW_ROLE) can be configured in the <DbTableName/> element:
<RoleManager> <ClassName>com.wewebu.ow.server.roleimpl.dbrole.OwDBRoleManager</ClassName> <DbTableName>OW_ROLE</DbTableName> </RoleManager>
When using the DB Role Manager, you can define role profiles with the Administration master plugin. The element <SecurityAdmin> allows specifying the name(s) of the user(s) and group(s) who may act as role administrator(s):
<SecurityAdmin pluginid="[id of plugin to enable for Security Admin]"> <User>[user1]</User> <User>[user2]</User> ... <Group>[group1]</Group> <Group>[group2]</Group> ... </SecurityAdmin>
40
Basic configuration
Beware of case sensitivity: The user names must be spelled exactly as defined in the user and group directory (for example, in LDAP). As it is not possible to request user or group information with CMIS directly, it is required to have LDAP authentication (see LDAP authentication) configured to be able to use the DB Role Manager in combination with CMIS compliant repositories.
In addition to the default design, you can set up a list of additional designs available for the role configuration with the element <AvailableDesigns>. Remember that the default design defined in element <DesignName> is only used as long as you are not logged in. Once logged in, the design corresponding to an assigned role is applied. The element <SchemeVersion> defines the version of the database scheme, which must be set to 3. This option is used for backwards compatibility. The element <MasterRoles> is explained in the Configuration and Planning Guide: Master Roles section. With the <ConfigCategories/> element, a list of categories is specified that appear in the Administration master plugin, separated by comma. For categories that are not specified in the list, the access is allowed to all resources. The following XML code fragment from owbootstrap.xml shows a sample configuration for the DB Role Manager:
<RoleManager> <ClassName>com.wewebu.ow.server.roleimpl.dbrole.OwDBRoleManager </ClassName> ... <SecurityAdmin pluginid="com.wewebu.ow.Admin"> <User>Administrator</User> </SecurityAdmin> <DesignName></DesignName> <AvailableDesigns> <Design displayName="Alfresco Workdesk 4.1 Design">default41</Design> </AvailableDesigns> <SchemeVersion>3</SchemeVersion> <MasterRoles enable="true"> <MasterRoleGroup name="Manager" memberOfAll="true"> <Role>HR Manager</Role> <Role>Office Manager</Role> </MasterRoleGroup> </MasterRoles> <ConfigCategories>ROLE_CATEGORY_PLUGIN,ROLE_CATEGORY_SEARCH_TEMPLATE</ConfigCategories> </RoleManager>
Indexfields are different to other categories. An implicit Allow is set for all groups. For indexfields, there are three types of contexts:
CREATE.Document/FolderClass.PropertyName for example, AddDocument Plugin
41
Basic configuration
CHECKIN.Document/FolderClass.PropertyName for example, Checkin-Plugin VIEW.Document/FolderClass.PropertyName for example, EditProperties-Plugin
The following values can be set: Allow/Deny: Implicitly all values for all roles are set to Allow. Whenever a user is member of more than one group and the access rights for one of these groups is denied then the user wont see the properties in this certain context. Modify/View: You can define whether the property is displayed as readonly or editable for a user. The values of all groups where the user is a member are interpreted with an OR operator. This means that if one property for a certain user (group) is displayed as readonly, each of the groups must have the access right set to readonly. If only one group has the value modify, then it is displayed as editable in the application.
It is not recommended in Alfresco Workdesk to set properties as readonly with the DB Role Manager indexfields category. Configure a second instance of an EditPropertiesSimple-Plugin to display certain properties readonly.
History Manager
In owbootstrap.xml, you can configure which History Manager is invoked. Use XML comments to enable or disable the corresponding <HistoryManager> elements.
DB History Manager
Note: This feature is not available in Alfresco Workdesk Community. By using the DB History Manager, configurable audit data is saved to a database table (see Configure database). The table name (default: OW_HISTORY) can be configured in the <DbTableName/> element:
<HistoryManager> <ClassName>com.wewebu.ow.server.historyimpl.dbhistory.OwDBHistoryManager</ClassName> <DbTableName>OW_HISTORY</DbTableName> </HistoryManager>
Case History (only for IBM FileNet P8 BPM)

When dealing with situations where documents appear as workflow attachments, it is often preferable to be able to not only access the audit information directly related to the document but also to retrieve the audit information related to the workflow instance(s) the document was involved in. To provide this functionality, your system must be configured in the following way: Create a property in the IBM FileNet P8 Content Engine. This property will contain the reference to the Workflow instance
42
Basic configuration
o Create a property of type String, add it to the document classes for which this functionality should be available; this property can be either single or multivalue, depending on whether you plan to establish relationships to just one or multiple workflow instances. o Set its symbolic name as value for element <CaseObjectRefPropertyName> (within <EcmAdapter>) in owbootstrap.xml. Set the value for referencing in the workflow. In the workflow, the property defined above is set for the attached document. o Add a component step to your workflow design(s) with a call of setStringProperty. o Parameters are: destDocument: name of attachment field symbolicPropName: name of property in Content Engine value: F_WobNum+","+F_Subject
MIME Types
Most ECM systems determine the file type due to MIME type definitions, whereas Microsoft Office or Microsoft Windows ignore MIME types and use a filename extension like .doc or .xls instead. Alfresco Workdesk performs the MIME type and filename extensi on mapping in both directions. Existing documents in the repository always keep their filename and MIME type while being edited with Alfresco Workdesk. For detailed information about configuring MIME types for usage in Alfresco Workdesk, follow the instructions given in owmimetables.xml.
Drag and Drop applet (DND)

Note: This feature is not available in Alfresco Workdesk Community. The drag and drop applet can rapidly import multiple documents into your ECM repository. By default, this functionality is activated for the default Alfresco Workdesk configuration. In this default configuration, it is part of the eFile plugin named Add documents and is included in the class:
com.wewebu.ow.server.plug.owaddmultidocuments.OwAddMultipleDocumentsRecordFun ction
Drag and Drop activation

The drag and drop applet can be enabled/disabled in the configuration for the Add documents eFile function by changing the following tag in owplugins.xml:
<DragDropTarget multifile="truefalse">truefalse</DragDropTarget>
Setting multifile=true will enable multifile upload and setting false inside the <DragDropTarget> tag will disable the drag and drop applet for the Add documents eFile plugin. If you are using the AWD Configurator helper tool, then you can enable/disable the function DragDropTarget in all plugins from the plugin class
43
Basic configuration
com.wewebu.ow.server.plug.owaddmultidocuments.OwAddMultipleDocumentsRecordFuncti on.
The servlet that is actually responsible for drag and drop functionality can be activated/deactivated in the following sections in the web.xml file:
<servlet id="Servlet_5"> <servlet-name>dragdropcontent</servlet-name> <servlet-class>com.wewebu.ow.server.servlets.OwDragDropContent</servlet-class> </servlet> <servlet-mapping id="ServletMapping_5"> <servlet-name>dragdropcontent</servlet-name> <url-pattern>/dragdropcontent/*</url-pattern> </servlet-mapping>
If you have set the value to "true" inside the <DragDropTarget> tag and the corresponding drag and drop servlet in the web.xml is commented out, then upon drag and drop you will see the Add New Document dialog without any file content.
Drag and Drop configuration

You can configure various parameters of the drag and drop applet by editing the appropriate cfg.properties file located at (workdesk)\applets\dndupload. The properties file lets you customize the upload behavior of the drag and drop applet. You can define the maximum upload size, allowed file extensions or the maximum number of uploaded files. The properties file has the following important parameters that can be changed according to your needs: max_batch_upload_size max_upload_count file_ext_filter accept_insecure_certificates Maximum upload size limit of file(s) in Kilobytes Maximum number of uploaded files File extensions allowed for upload Allow self-signed or expired certificates
Temporary files
When using document upload, you must define a folder for temporary files in the <TempDir> configuration node of owbootstrap.xml. You can define the path of this temporary folder as absolute path or as a path relative to the Alfresco Workdesk deployment. Make sure that the value is set to a directory/path, on which the Alfresco Workdesk application has reading and
Basic configuration
writing access. If the temporary folder does not exist in the defined location, the Alfresco Workdesk application will try to create and use it. Example for an absolute path definition: Windows server operating system: Unix server operating system: Windows/Unix server operating system:
<TempDir>C:/Temp/</TempDir> <TempDir>/usr/tmp</TempDir>
Example for a path definition relative to the Alfresco Workdesk deployment:

<TempDir>../../Temp/</TempDir>
If no value is set, the Alfresco Workdesk application uses the environment information/properties (java.io.tmpdir) to get the location of the application server or the temporary folder of the server operating system. If this variable is not available to the process, the deployment location will be used as temporary folder.
Language support
The Alfresco Workdesk user interface is available in different languages. In a default Alfresco Workdesk delivery, English (en), French (fr) and German (de) are supported. You can setup your preferred language support in owbootstrap.xml. Set a specific language as default:
<defaultlocal>en</defaultlocal>
Make a series of languages available for selection by Alfresco Workdesk users:

<availablelocals> <lang displayname="Deutsch">de</lang> <lang displayname="English">en</lang> <lang displayname="French">fr</lang> </availablelocals>
All configured languages must be part of the deployment.

Instead of clicking on the respective link, the user can also save the link to a preferred language as a personal browser favorite and therefore always start with the correct language.
45
Hints and troubleshooting

This section lists the most frequently asked questions (FAQ) and answers about installing Alfresco Workdesk.
Log files
Alfresco Workdesk uses log4j for error reporting. By default, only errors are logged to the console. You can modify the reporting/logging level from error to debug and/or send the log to a file by changing the log4j.properties file. If you want to log during the startup/initialization phase of Alfresco Workdesk, you must copy the log4j.properties file, for example, from (workdesk)/WEB-INF/conf/fncm5 to the (workdesk)/WEB-INF/classes/ directory. This is very important, because of errors caused by incorrect configuration of Alfresco Workdesk (for example, syntax errors in owplugins.xml), misconfigured datasource, missing libraries and so on.
Multiple log4j.jar libraries: Make sure that you do not have multiple log4j-
x.y.z.jar files installed on your application server and in the Alfresco Workdesk
deployment. Sometimes the ECM back end API libraries also provide some log4j libraries that can be in conflict with the log4j libraries provided by Alfresco Workdesk.
Log4j configuration file

A configuration file for log4j (log4j.properties) is shown in the following example:
# Set root logger level to DEBUG and its only appender to A1. log4j.rootLogger=DEBUG,A1 # A1 is set to be a ConsoleAppender. log4j.appender.A1=org.apache.log4j.ConsoleAppender # A1 uses PatternLayout. log4j.appender.A1.layout=org.apache.log4j.PatternLayout # %x inserts the user id to the log file log4j.appender.A1.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c [%x] - %m%n # log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c - %m%n # FileNet P8 log4j.category.com.filenet=WARN log4j.category.com.filenet.wcm.api.impl.RemoteCommand=ERROR # FileNet P8 5.0 log4j.category.filenet_tracing=WARN # Apache log4j.category.org.apache=WARN
46
# Spring log4j.category.org.springframework=WARN
You can log into a separate log file with the following example of a log4j configuration. In this case, an appender called workdesk_file was defined, which logs into a file workdesk.log in the root directory of drive c:
# file appender for workdesk #log4j.appender.workdesk_file=org.apache.log4j.DailyRollingFileAppender #log4j.appender.workdesk_file.DatePattern='.'yyyy-MM-dd log4j.appender.workdesk_file=org.apache.log4j.FileAppender log4j.appender.workdesk_file.file=${catalina.home}/logs/workdesk.log log4j.appender.workdesk_file.layout=org.apache.log4j.PatternLayout #log4j.appender.workdesk_file.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n log4j.appender.workdesk_file.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c [%x] - %m%n log4j.appender.workdesk_file.append=true
You can use this appender with the following command line:
log4j.rootLogger=DEBUG, workdesk_file
Suppress ECM system logs: If you want to suppress logs that have not been written by Alfresco Workdesk (for example, from IBM FileNet P8 or Apache Tomcat), your log4j.properties must be similar to the following example:
# FileNet P8 log4j.category.com.filenet=WARN log4j.category.com.filenet.wcm.api.impl.RemoteCommand=ERROR
For further technical background information about log4j see A4: Background about Log4J.
Log4j and JBoss

JBoss assigns a separate classloader for each deployed application, so that different versions of common libraries do not interfere with each other. But JBoss also uses log4j and has its own version of a log4j library. Therefore, do not deploy an additional log4j-xxx.jar and do not create an additional appender in the log4j configuration file. It is highly recommended to use only the appender that is already present in the global JBoss log4j configuration.
47
Reload configuration files

Alfresco Workdesk offers the possibility of reloading configuration files after changing them. Therefore, you can activate changes during runtime. You can reload the configuration for plugins, MIME types and boot settings separately. Only an Alfresco Workdesk administrator can reload configuration files see owbootstrap.xml Role Manager SiteAdmins. Also, it is possible to reload the class descriptions of your DMS, so that the Alfresco Workdesk application must not be restarted after adding class descriptions to the DMS. Reloading the configuration files effects the visibility of new data after a user is logging in again. The following screen shows the configuration reloading section in the Alfresco Workdesk settings:
Servlets
The Alfresco Workdesk application is using several servlets, such as the standard application servlets and specific servlets for different ECM back end systems. Ensure that, at minimum, you enable the standard application servlets by activating (uncommenting) them in the web.xml file. Standard application servlets are the following: getContent (/getContent/*) Gets the application content stream dragdropcontent (/dragdropcontent/*) Receives the content from the client multifileDownload (/multifileDownload/*) Enables downloading multiple files as one single zip file.
The encoding of the file names in the zip file (default set to UTF-8) can be set with the <init-param> parameter file_name_encoding.
getPropertyContent (/getPropertyContent/*) Get a stream request from a property ECM back end specific servlets are the following: setFNCMDaejaViewerAnnotation (/setFNCMDaejaViewerAnnotation/*) Saves an annotation in the IBM FileNet P8 using Daeja Viewer or ADV getFNCMDaejaAnnotationSecurity (/getFNCMDaejaAnnotationSecurity /*) Opens an annotation in the IBM FileNet P8 using Daeja Viewer
48
Daeja Viewer configuration in web.xml describes how to integrate the DaejaViewer for IBM FileNet P8 by enabling the corresponding servlets in the web.xml file.
Deploying on Unix/Linux systems

When using a Unix/Linux system for the Alfresco Workdesk deployment, make sure that the access rights (owner) of the deployment files are the same as the access rights of the application engine. This is especially important for an IBM WebSphere application server. When the access rights (owner) for the application engine is set to root, there should not be any problems.
49
Installing the AWD Configurator

The configuration helper tool AWD Configurator is located in the directory (Delivery)\bin\configurator. There is one directory alfresco-workdesk-configurator_x.y.z_linux.gtk that includes the launchable version for the Linux operating systems and one directory alfrescoworkdesk-configurator_x.y.z_win32 including the launchable version for Microsoft Windows operating systems. Depending on your operating system, copy the corresponding directory to an appropriate location, for example, /etc/opt/Alfresco for Linux or C:\Program Files\Alfresco\ for Microsoft Windows and start the AWD Configurator by launching launcher for Linux (you must launch AWD Configurator as administrator and with the execution flag set) or eclipse.exe for Microsoft Windows. When first starting the AWD Configurator, you must create a new project for your Alfresco Workdesk deployment. In this project, you can read in all required configuration files by linking the corresponding configuration directories. This procedure is described in the following sections.
Create new project

Create a project for your Alfresco Workdesk deployment configuration (for example, myConfiguration). Create a subfolder in this project, which is linked to the Alfresco Workdesk deployment directory, which you wish to configure. To create projects use the context menu: New Project type project. Now, choose a name for your new configuration. In this example, we have chosen Workdesk Configuration.
50
Note: do not use the _xsd project for referencing to the configuration files. This project is for XML schema files, which are used to validate the created *.xml configuration files.
51
Import deployment folder structure

Use the context menu on the recently created project to link to your configuration source files: New Others New Dialog: type Folder.
52
After selecting the sub item Other, select File System and then activate the <<Advanced option. You must select the option Link to alternate location (Linked Folder) and browse to the root directory of your Alfresco Workdesk deployment containing all its configuration files.
You can either use a temporary directory for configuration or link directly to the directory of the Alfresco Workdesk deployment if your application server supports this behavior.
After linking configuration files, the AWD Configurator will be similar to the following example:
53
How to use the AWD Configurator

After you have installed Alfresco Workdesk, and after basic configuration, you can start customizing by editing the owplugins.xml file of your ECM adapter (for example, fncm5) configuration. The default owplugins.xml of your ECM adapter shows a basic configuration of most common functions and is a good starting point for your project. By editing owplugins.xml, you define menus and functions implemented as Alfresco Workdesk plugins. There are four types of Alfresco Workdesk plugins: ow_app: The application itself. Configure this plugin for a base setup of your Alfresco Workdesk deployment. ow_master: By defining master plugins, you create the main menu navigation. Create a new master plugin to add a new menu item. You can change the order of these menu items by ordering the corresponding master plugins. ow_recordfunction: eFile plugins offer a range of functions for eFiles/folders. ow_docfunction: Document plugins are used when working with documents. They appear as options of actions to perform on a document, for example appearing in the context menu of an item in a result list. You can change the order of these document functions by ordering the corresponding plugins. The following sections describe the AWD Configurator features.
54
owplugins.xml
Navigate to a ECM adapter configuration folder (for example, (workdesk)\WEBINF\conf\fncm5\) and double-click on one of the configuration files (owplugins.xml or owmimetable.xml) to open the plugins editor.
You can now edit the various plugin instances, add new ones (
) or modify the order in which ),
they are listed (sort plugins ; change grouping of plugins ). By using the arrows ( you can define in which order they appear in the deployed application.
Note: The move plugin up and move plugin down buttons ( grouping is disabled. ) only work if
55
When selecting a plugin instance (only the plugin, not a class or any grouping criteria), you can open the context help with detailed parameter description by pressing F1. To delete, copy, and modify plugin instances, the editor has a tree for selection. The selected plugin is displayed on the Details editor where the configuration parameter can be changed. The Details editor always displays only configuration elements, which have simple content. This means that if an element or a subnode of a plugin has a complex structure, then it is displayed in the tree view as a selectable tree node. You can add elements to a plugin instance that are not present in owplugins.xml yet (this includes the situation when an element became available only with an upgrade to a newer Alfresco Workdesk version), you can add these new elements to the plugin by right-clicking at the appropriate position within the tree, selecting Add subnode and selecting the element.
56
owmimetables.xml
Besides editing the owplugins.xml configuration file, you can also use the AWD Configurator to configure the behavior of Alfresco Workdesk-handled MIME types (owmimetable.xml configuration file) and add new ones. See the online help for detailed information by pressing F1 when selecting a MIME type.
57
How to handle your configuration files

The AWD Configurator does not support any versioning or automatically created backups of your configuration files. This offers you the possibility to edit the deployed Alfresco Workdesk application directly instead of having to redeploy the entire directory. The proceeding of linking to this directory is described in the previous sections. Depending on your application server, you must restart the application or the entire server when making changes to the configuration files. We recommend making a backup of at least your owplugins.xml file when starting to make changes to your configuration. You can save the configuration files directly in your deployment. This does not have an effect on your application. Your deployment directory in (workdesk)\WEB-INF\conf\(Adapter) may contain the following structure: log4j.properties owbootstrap.xml owmimetable.xml owplugins.xml owplugins.backup09-01-03.xml owplugins.backup09-01-02.xml owplugins.backup09-01-01.xml WcmApiConfig.properties
58
Backup: When making a backup, we recommend not only backing up the configuration files, but the entire deployment. Keep in mind that there might be various changes to different files (for example, JSP files) in the deployment that need to be backed up.
You can also use the AWD Configurator functions Copy and Paste to make backups of your existing configuration files.
59
Updating Alfresco Workdesk

The following guide gives a brief overview of the tasks to be done when updating to a newer version of Alfresco Workdesk: See the Release Notes for the new Alfresco Workdesk version to see whats changed with the new release. Analyze your existing JSP files. If there are any changes, backup those changed files separately and migrate them separately so that you do not loose any client-specific customizations. Analyze your existing CSS files. If there are any changes, backup those changed files separately and migrate them separately so that you do not loose any client-specific customizations. Back up your current Alfresco Workdesk deployment. Copy the new JAR files to (workdesk)\WEB-INF\lib. Afterwards, delete the corresponding old JAR files, so that only the new library versions will be deployed.
Alfresco Workdesk libraries are located in the (Delivery)/lib folder of the delivery, additional libraries (third party libraries like Spring, log4j, Apache Commons) used by Alfresco Workdesk are placed in the (Delivery)/lib.ext/ folder.
Copy/Upgrade customer-specific Java classes. Copy your web resource (everything except the folder WEB-INF) into your deployment. Upgrade every saved JSP file separately. Upgrade every saved CSS file separately. Update your configuration: o Take the old owbootstrap.xml and transfer the configuration to the new one. You can do this quite easy by comparing the old file with the new file and by checking for new parameters or nodes. o Take the old owplugins.xml and transfer the configuration to the new one. You can do this quite easy by comparing the old file with the new file and by checking for new parameters or nodes. o Take the old owmimetable.xml and transfer the configuration to the new one. You can do this quite easy by comparing the old file with the new file and by checking for new parameters or nodes.
Alfresco Workdesk is downwards compatible. You can use your old configuration to run a newer version of Alfresco Workdesk. If you are using your old configuration files, you may miss new features introduced with a new Alfresco Workdesk release (see Release Notes for more information).
60
If the database schema has changed: o Upgrade the database Alfresco Workdesk tables (for example, ow_attribute_bag, ow_history, ow_role) with provided upgrade scripts. o Pay attention when using an Oracle database: If you use Oracle as database and you want to use the old TB_ROLE DB-scheme of Alfresco Workdesk 2.0, upgrade your databases with a new trigger (OwOracle_CreateDBRoleManagerTable_Scheme1Trigger.sql ). The Alfresco Workdesk DB Role Manager doesnt create the TB_ROLE.ID value automatically; it uses the trigger for inserting the new created ROLE.
61
Upgrading the ECM back end system
Upgrading the ECM back end system

When upgrading the ECM back end system, you must do the following tasks on an existing Alfresco Workdesk installation: Back up your actual deployment so that you can revert the following steps every time. Replace the native API libraries/configuration files of the ECM back end system in the existing Alfresco Workdesk installation with the API libraries/configuration files from the upgraded ECM back end system. You can achieve this by following the steps in Provide native ECM system API libraries. If the upgraded ECM back end system comes with an upgraded viewer, which you might want to integrate in Alfresco Workdesk, you must upgrade the files for the viewer in the Alfresco Workdesk deployment. Follow the steps in Native viewer integration.
62
Appendix
Appendix
Daeja Viewer configuration in web.xml
Note: This feature is not available in Alfresco Workdesk Community. The following extract shows the corresponding entries in web.xml for the servlets used in combination with Daeja Viewer and IBM FileNet P8 5.x:
<!-.............................................................................. Servlets ............................................................................... -->  <servlet id="Servlet_2"> <servlet-name>setFNCMDaejaViewerAnnotation</servlet-name> <servlet-class> com.wewebu.ow.server.ecmimpl.fncm5.viewer.OwFNCM5DaejaAnnotServlet </servlet-class> </servlet>  <servlet id="Servlet_3"> <servlet-name>getFNCMDaejaAnnotationSecurity</servlet-name> <servlet-class> com.wewebu.ow.server.ecmimpl.fncm5.viewer.OwFNCM5AnnotSecurityServlet </servlet-class> </servlet>  <servlet-mapping id="ServletMapping_2"> <servlet-name>setFNCMDaejaViewerAnnotation</servlet-name> <url-pattern>/setFNCMDaejaViewerAnnotation/*</url-pattern> </servlet-mapping>  <servlet-mapping id="ServletMapping_3"> <servlet-name>getFNCMDaejaAnnotationSecurity</servlet-name> <url-pattern>/getFNCMDaejaAnnotationSecurity/*</url-pattern> </servlet-mapping>
63
Appendix
Example for Log4J configuration

The following text shows a typical log4j configuration file, which has to be put in the root directory of the directory where your classes are located. The value ../YourLogFileFolder/YourLogFile.log represents the location for saving your logs.
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  <!-<!-<!-<!-deployed application --> Log4j Configuration --> --> On WebSphere this file must be placed in the "web-inf/classes" folder of the On JBOSS, the .xml-file should be in the following folder: "jboss-
3.2.7\server\default\conf" -->   <!-| For more configuration information and examples see the Jakarta Log4j | website: http://jakarta.apache.org/log4j --> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <appender name="FILE" class="org.apache.log4j.DailyRollingFileAppender"> <param name="File" value="../YourLogFileFolder/YourLogFile.log"/> <!- True adds entries to an existing log file when starting <!- False deletes the existing log file when starting <param name="Append" value="false"/>  <param name="DatePattern" value="'.'yyyy-ww"/> <layout class="org.apache.log4j.PatternLayout">  <param name="ConversionPattern" value="%d %-5p [%c] %m%n"/  </layout> </appender>  <category name="org.apache"> <priority value="error"/> </category> --> -->
64
Appendix

<category name="com.filenet.wcm.api.impl.RemoteCommand"> <priority value="ERROR"/> </category> <category name="com.wewebu.ow"> <priority value="WARN"/> </category> <root> <appender-ref ref="FILE"/> </root> </log4j:configuration>
A4: Background about Log4J

There are three main aspects that cause massive problems with log4j on an application server: A java ClassLoader is responsible for loading Classes from their corresponding .class or .jar file. For security reasons, classes with the same name but loaded by different ClassLoaders are treated as different classes. Example:
class Foo { private static Bar x; public setX(newX : Bar); { x = newX; } } class Bar {} class BarChild extends Bar {}
Imagine some code loaded by ClassLoader1 creates an object of class Foo. So, this class Foo is loaded by ClassLoader1. This ClassLoader will also load the class Bar since it is used by Foo. Then some other code loaded by ClassLoader2 creates an object of class BarChild. So, BarChild and Bar will be loaded by ClassLoader2. When this other code tries to call setX(), a ClassMismatchException is thrown. Why? BarChild extends Bar and so you can call setX() with an object of class BarChild, but Bar@ClassLoader1 is different from Bar@ClassLoader2.
Alfresco Workdesk 4.1 65
Appendix
An application server uses a couple of different ClassLoaders. There is the default Java System Loader, responsible for loading all Classes of the JRE. Next, an application server has some root ClassLoader responsible for loading all classes in the shared libraries folders of the application server (tomcat: common/lib). And there is an extra ClassLoader for each application. This is also done for security reasons. With this design, no class of ApplicationA can be loaded or used by code from ApplicationB. Log4j creates a static logging object used by all applications. Due to 1 and 2, you can get lots of problems depending on where your log4j archives are located. Due to the third point, problems are depending on your application server. If you are only using one log4j instance, you can get into conflict with log4j of your application server. If you have problems with log4j, contact Alfresco Support for assistance.
66
Appendix
A5: Example for changing Java user in DB2

Note: This feature is not available in Alfresco Workdesk Community. The following screenshots show the steps necessary to connect to the database as user DB2ADMIN and transmit a query to the database.
67
Appendix
68

Alfresco Workdesk Installation Guide-4.1

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Alfresco Workdesk Installation Guide-4.1

Hochgeladen von

Copyright:

Verfügbare Formate

Installation Guide

Alfresco Workdesk 4.1

Preparation for installation ........................................................................................................9

Deploying Alfresco Workdesk ..................................................................................................14

Basic configuration ...................................................................................................................39

Hints and troubleshooting ........................................................................................................46

Installing the AWD Configurator ..............................................................................................50

About this document

Alfresco Workdesk 4.1

You must have the authorization to modify and create resources.

Alfresco Workdesk 4.1

Typographical conventions used in this guide

Example Alfresco OwAppContext getName() public void myMethod(){}

Java Package Plugins

com.wewebu.server.app com.wewebu.ow.server.plug.owdemo.owmain com/wewebu/ow/server/ <node> value Add Document

Alfresco Workdesk 4.1

Alfresco Workdesk 4.1

Alfresco Workdesk 4.1

Databases and JDBC drivers

Back end ECM systems

Alfresco Workdesk 4.1

CMIS-compliant ECM systems

Alfresco Workdesk 4.1

Alfresco Workdesk 4.1

Preparation for installation

Preparation for installation

Settings for application servers

method to read some configuration from the deployment file structure.

Settings in the ECM system

Alfresco Workdesk 4.1

Preparation for installation

Create required folder structure via script

Create required folder structure manually

Preparation for installation

/other folders and eFiles /owpreferences /owsearchtemplates /recordtemplates /owbpmviewtemplates

Alfresco Workdesk 4.1

Preparation for installation

Import test data

Other ECM systems

Required settings for IBM FileNet P8

Alfresco Workdesk 4.1

Preparation for installation

Required settings for other ECM systems

Alfresco Workdesk 4.1

Deploying Alfresco Workdesk

Deploying Alfresco Workdesk

Create an Alfresco Workdesk Web Archive

Alfresco Workdesk 4.1

Deploying Alfresco Workdesk

Select Classes loaded with application class loader first .

Alfresco Workdesk 4.1

Deploying Alfresco Workdesk

method to read some configuration from the Alfresco Workdesk

Verify the initial Alfresco Workdesk deployment

Alfresco Workdesk 4.1

Deploying Alfresco Workdesk

Alfresco Workdesk 4.1

Deploying Alfresco Workdesk

log4j-x.x.x.jar is missing on your application server. Follow the instructions in

ECM adapter activation

Provide native ECM system API libraries

Alfresco Workdesk 4.1

Deploying Alfresco Workdesk