Configure xPression Server

Transcription

EMC ® Document Sciences ®
xPression ©
Version 4.6
Installation Guide
EMC Corporation
Corporate Headquarters
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Legal Notice
Copyright © 2003 — 2016 EMC Corporation. All Rights Reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS
OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF
Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks
used herein are the property of their respective owners.
Documentation Feedback
Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback
about how we can make our documentation better or easier to use, please send us your feedback directly at
[email protected]
Table of Contents
Revision History
Chapter 1
.................................................................................................................. 13
Before You Install
........................................................................................ 15
xPressionHome ................................................................................................
15
Documentum Edition and Enterprise Edition .....................................................
15
xPublish or CompuSet Scenarios .......................................................................
15
Disk Space Requirements ..................................................................................
16
Requirements for Windows ...............................................................................
UAC Settings on Windows ............................................................................
Non-English Windows Versions on Client Computers ....................................
16
16
16
Requirements for UNIX Platforms .....................................................................
User Validation ............................................................................................
User Profiles.................................................................................................
The User to Install xPression .........................................................................
Verify Environment Settings ..........................................................................
Using xWindows ..........................................................................................
Authentication on the xPression Server ..............................................................
Local User Authentication .............................................................................
LDAPUser Authentication ............................................................................
LDAP Settings from the xPression Installer ................................................
LDAPUser Parameters ..............................................................................
LDAP_NAME_ATTRIBUTE ..................................................................
LDAP_ADMIN_PWD ...........................................................................
LDAP_ADMIN_DN .............................................................................
LDAP_USER_FILTER ...........................................................................
LDAP_USER_MODE ............................................................................
LDAP_MEMBER_ATTRIBUTE ..............................................................
LDAP_GROUP_FILTER ........................................................................
LDAP_SERVER_URL............................................................................
LDAP_NAME_CONTEXT ....................................................................
LDAP_GROUP_CONTEXT ...................................................................
LDAP_INITIAL CONTEXT FACTORY ..................................................
USE_START_TLS..................................................................................
LDAPS Configuration ...............................................................................
Start TLS Configuration ............................................................................
Multi-Domain LDAP Configuration...........................................................
LDAP_DOMAIN_NAME.DOMAIN[x] ..................................................
LDAP_SERVER_URL.DOMAIN[x] ........................................................
LDAP_DOMAIN_CONTEXT.DOMAIN[x] ............................................
LDAP_ADMIN_USER.DOMAIN[x].......................................................
LDAP_ADMIN_PASSWORD.DOMAIN[x] ............................................
LDAP_USER_FILTER.DOMAIN[x]........................................................
LDAP_GROUP_FILTER.DOMAIN[x] ....................................................
LDAP_INITIAL_CONTEXT_FACTORY.DOMAIN[x] .............................
LDAP_DISPLAY_ATTRIBUTE.DOMAIN[x] ...........................................
LDAP_AUTH_ATTRIBUTE.DOMAIN[x] ...............................................
17
17
18
18
18
18
18
19
19
20
20
21
21
21
22
22
22
22
22
23
23
23
23
23
23
24
25
25
25
25
25
25
26
26
26
26
3
Table of Contents
Chapter 2
4
LDAP_MEMBER_ATTRIBUTE.DOMAIN[x] ..........................................
LDAP_QUERY_USERS_FOR_PICK_LIST.DOMAIN[x] ...........................
LDAP_QUERY_GROUPS_FOR_PICK_LIST.DOMAIN[x] .......................
Switching from ADUser to LDAPUser .......................................................
SiteMinder Authentication ............................................................................
Access Through FastPath ..........................................................................
Access Through Direct Login ....................................................................
User Exit Authentication ...............................................................................
26
26
27
27
30
31
31
31
Clustering ........................................................................................................
xPression Groups Messages ..........................................................................
Unicast ....................................................................................................
Multicast ..................................................................................................
Local Cast ................................................................................................
Horizontal Cluster Requirement ....................................................................
Vertical Clusters ...........................................................................................
31
32
32
32
32
33
33
SAP System Landscape .....................................................................................
33
Requirements, Recommendations, and Limitations .............................................
xPression Requires Exclusive Environment ....................................................
JBoss and WebLogic Installation Paths ...........................................................
Multiple Instances of xPression .....................................................................
Installing Multiple xPression Servers on the Same Machine .........................
Databases That Require a Database Client ......................................................
Removing Existing xPression Server ..............................................................
Installing the xAdapter .................................................................................
Database Issues ............................................................................................
Copying an xPression Database .................................................................
Migration Limitation for Oracle Databases .................................................
License Validation with Linux .......................................................................
Autograph and xPression on the Same Server .................................................
34
34
35
35
35
35
36
36
36
36
36
37
37
............................................................
About the xPression Database ...........................................................................
DB2 on Linux ...............................................................................................
Step One: Start the Database Manager ...............................................................
Start the Database Manager Service with Windows Services ............................
Start the Database Manager from the Command Line .....................................
Start the Database Manager on UNIX and Linux .............................................
Step Two: Create a New DB2 Database ..............................................................
Create the Database from the Command Line .................................................
DB2: Create the Database with IBM DB2 Control Center .................................
Step Three: Create a New Database User............................................................
Creating the User from the DB2 Command Line Processor ..............................
Creating the User from DB2 Control Center ...................................................
Step Four: Create Buffer Pool and Tablespaces....................................................
Creating an 8K Buffer Pool and Table Spaces With the Command Line .............
39
Step One: Configure DB2 Database
39
39
40
40
40
40
41
41
41
43
43
44
44
44
Creating an 8K Buffer Pool and Table Spaces With the DB2 Control
Center..........................................................................................................
45
Step Five: Run xPression Database Scripts ..........................................................
Step Six: Test the xPression Database .................................................................
47
48
Step Seven: Modify Database Configuration .......................................................
Modifying a DB2 Database Configuration ......................................................
49
49
Step Eight: Back Up Your Database ....................................................................
49
Step Nine: Enable Full-Text Searching ................................................................
Create DB2DBDFT Environment Variable ......................................................
50
50
Table of Contents
Chapter 3
Chapter 4
Create DB2DBDFT Variable on Windows ...................................................
Create DB2DBDFT on UNIX and Linux......................................................
Enable Full-Text Search .................................................................................
Automatically Updating Your Index ..............................................................
50
50
50
51
Auditing Your xPression Database .....................................................................
52
DB2 Stopwords ................................................................................................
52
DB2 Limitations ...............................................................................................
52
........................................................
Important Information About Oracle Databases..............................................
Using Oracle with Other Databases ...........................................................
The Oracle Client Application ...................................................................
Oracle Requirement ..................................................................................
Migration Limitation ................................................................................
Step One: Create a New Database ......................................................................
Step Two: Create a New Database User ..............................................................
Creating the User with SQL Plus ...................................................................
53
Step One: Configure Oracle Database
53
53
54
54
54
54
54
55
55
Creating the User from the Oracle Enterprise Manager Database
Express ........................................................................................................
Step Three: Run xPression Database Scripts .......................................................
56
57
Step Four: Test the xPression Database...............................................................
57
Step Five: Back Up Your Database .....................................................................
58
Step Six: Configure Full-Text Searching ..............................................................
For Windows Installations.................................................................................
58
59
59
Oracle Stopwords .............................................................................................
60
.................................................
The SQL Server Client Application ....................................................................
Database Authentication ...................................................................................
Configuring Windows Authentication ...........................................................
SQL Limitations and Known Issues ...................................................................
Full-Text Search Limitation ...........................................................................
Merant Drivers for SQL Server ......................................................................
Step One: Create a New Database ......................................................................
Create a New Database on SQL Server ...........................................................
Step Two: Create a New Database User ..............................................................
Step Three: Run xPression Database Scripts .......................................................
Step Four: Test the xPression Database...............................................................
Test Your xPression Database on SQL Server 2008 R2/2012 ..............................
Step Five: Installing Microsoft JDBC Driver ........................................................
Microsoft SQL Server JDBC Driver 4.0 ...........................................................
Step Six: Final Configuration Tasks ....................................................................
Determine Port Number................................................................................
Back Up Your Database .............................................................................
List of Stopwords .............................................................................................
61
Step One: Configure SQL Server Database
61
61
62
62
62
62
63
63
63
64
65
65
66
66
66
66
67
68
68
69
5
Table of Contents
Chapter 5
Chapter 6
6
.......................
Configuring WebSphere ....................................................................................
WebSphere Paths ..........................................................................................
Your WebSphere Installation Location ............................................................
Create an xPression Profile ............................................................................
Create Profile with the manageprofiles Command ......................................
Setting Up a Profile as a Windows Service ..............................................
Deleting a Profile from the Command Line ............................................
Deleting a Window Service ...................................................................
Creating a Profile with the Profile Management Tool ..................................
Configure the Application Server...................................................................
Start Your Server ......................................................................................
Start the WebSphere Administrative Console..............................................
Configure WebSphere Variables.................................................................
USER_INSTALL_ROOT Variable ...........................................................
JAVA_HOME Variable ..........................................................................
XPRESSIONHOME Variable .................................................................
XPRESSION_EAR Variable ...................................................................
Database Driver Variable.......................................................................
Set Class Loading Mode ............................................................................
Set Transaction Timeout ............................................................................
Enable Pass By Reference ..........................................................................
Set Host Alias ...........................................................................................
Add Image to MIME Type on WebSphere ..................................................
Configure JVM Settings.............................................................................
Configure Data Sources.............................................................................
Create an Authentication Alias ..............................................................
Creating a DB2 Data Source ..................................................................
Creating an Oracle Data Source .............................................................
Creating a SQL Server Data Source ........................................................
Relational Customer Data Sources .........................................................
Setting resultSetHoldability attribute for DB2 .........................................
Deploy the xPression Enterprise Archive File .............................................
Pre-Deployment Configurations ............................................................
Deploying the xPression Enterprise Archive File.....................................
Deploying the JMS-Enabled xPression Adapter ......................................
Import LDAP Server Certificate to Truststore .............................................
Configure Cookies Settings .......................................................................
Set Transport Option for CSIv2 ..................................................................
WebSphere Users and Permissions.................................................................
Configuring WebLogic ......................................................................................
Understanding Your Server Paths ..................................................................
Understanding User Names ..........................................................................
Create a New WebLogic Configuration ..........................................................
Extract the xPression Enterprise Archive Files ................................................
Configuring JBoss .............................................................................................
Add Environment Variables ..........................................................................
Determine Your HTTP Server Port .................................................................
Prepare Your JBoss Environment for Installation.............................................
71
Step Three: Install xPression Server ...........................................................
About the Installer ............................................................................................
97
97
Running the xPression Installer .........................................................................
The “Choose xPression Edition” Page ............................................................
The “Choose Installer Type” Page ..................................................................
The “xPression Installation Folder” Page........................................................
The “Select Application Server Type” Page .....................................................
98
98
99
99
99
Step Two: Configure Application Server Before Installation
71
71
72
72
72
73
74
74
74
75
76
77
77
78
78
78
78
79
80
80
80
81
81
81
83
83
84
85
87
88
89
89
89
90
91
91
92
92
92
93
93
94
94
94
95
95
95
96
Table of Contents
Selecting Application Server Installation Directory .........................................
Selecting Application Server Home Directory .................................................
The “Select JDK Installation Folder” Page ......................................................
The “Select EAR Folder” Page .....................................................................
The “Application Server Information” Page ..................................................
The “HTTP Server Connection” Page ...........................................................
The “Select Driver” Page .............................................................................
The "Database URL Settings" Page ...............................................................
The “E-Mail Server” Page............................................................................
The “User Authentication Security Settings” Page.........................................
The “LDAP Authentication” Page ................................................................
The “Documentum Settings” Page ...............................................................
The “Cluster Settings” Page .........................................................................
The “Performance Settings” Page .................................................................
The “User Selection Summary” Page ............................................................
The “Pre-Installation Summary” Page ..........................................................
Restart Your Server .....................................................................................
Chapter 7
99
99
99
100
100
101
101
101
102
102
102
103
104
104
105
105
105
Installing the Server in Silent Mode..................................................................
Creating the xPression Server Silent Mode Response File ..............................
Running the xPression Server in Silent Mode................................................
105
106
106
....................................................
Additional Steps for Linux and UNIX ..............................................................
Configuring Local Authentication for Non-Root Users ..................................
Configurations for Using the xPression Documentum Repository ..................
Editing bash_profile for JBoss on Linux ........................................................
Additional Configurations for WebSphere ........................................................
Increasing Application Server Memory ........................................................
Library File Usage ......................................................................................
Configurations for CompuSet Jobs in RMI Mode ..........................................
Additional Configurations for WebLogic ..........................................................
Setting Java Options for UNIX Systems ........................................................
Defining Path for xPression Logging ............................................................
Starting the xPression Server .......................................................................
Configuring xPression on WebLogic ............................................................
Configure Data Sources...........................................................................
DB2 JDBC Driver ................................................................................
Oracle JDBC Driver ............................................................................
Microsoft SQL Server Driver ...............................................................
109
109
109
110
110
110
111
111
111
112
112
112
113
113
113
114
116
117
Configuring WebLogic When Publishing xPresso for Word
Documents from xBatch ..........................................................................
Manually Deploy the Enterprise Archive File ...........................................
Configure JTA ........................................................................................
Starting the Enterprise Archive Files ............................................................
Increasing Memory Size ..............................................................................
Increasing Maximum Message Size ..........................................................
119
119
120
120
120
120
Additional Configurations for JBoss .................................................................
Increasing Memory Settings ........................................................................
Configuring Data Sources on JBoss ..............................................................
Windows Authentication with Microsoft SQL Server ................................
Using a Relational Database with JBoss ....................................................
Using a Non-Default Data Source with JBoss ............................................
Configuring Additional Components ...........................................................
Define Path for xPression Logging ...........................................................
Filenet Configuration ..............................................................................
Starting and Stopping the Server .................................................................
121
121
121
122
122
122
125
125
125
126
Step Four: Configure xPression Server
7
Table of Contents
Chapter 8
8
Installing an xPresso Client on the Same Machine as the xPression
Server ........................................................................................................
126
Configuring the xPression Diagnostic Utility ....................................................
126
Oracle Database Settings for BatchRunner ........................................................
127
Configuring User Access for xAdmin and xDashboard .....................................
Resetting the Super Administrator User Password ........................................
128
128
Connecting CompuSet Bridge to the Server ......................................................
128
..........................................
xDesign .........................................................................................................
Chinese Language Paths .............................................................................
Requirement for Windows ..........................................................................
Exporting Searchable Document Lists ..........................................................
Installing xDesign .......................................................................................
Installing xDesign in Silent Mode ................................................................
Changing Log Location for Silent Mode Installer ......................................
Creating the xDesign Silent Installer Response File ...................................
Running the xDesign Silent Installation ....................................................
Update LAN Settings ..................................................................................
xPresso for Word ............................................................................................
Before You Install .......................................................................................
Directory for Temporary Files ..................................................................
Supported Data Types.............................................................................
Installing xPresso for Word .........................................................................
Registering Your Software ...........................................................................
xPresso for Adobe InDesign ............................................................................
Requirements for Windows Users ............................................................
About InDesign Versions ........................................................................
Installing the xPresso Plug-ins into the Extension Manager ...........................
Installing on Windows ................................................................................
Installing on Macintosh ...............................................................................
About the Java Environment ...................................................................
Performing a Macintosh Installation ........................................................
Multiple User Access to InDesign on Macintosh .......................................
xPresso for Dreamweaver ...............................................................................
Requirement for Windows Users .............................................................
About Dreamweaver Versions .................................................................
Supported Data Types.............................................................................
Installing on Windows ................................................................................
Installing on Macintosh ...............................................................................
Managing Certificates of HTTPS Servers ..........................................................
Configuring xResponse ...................................................................................
Internet Explorer Settings ............................................................................
xResponse User Access ...............................................................................
Installing VBA ............................................................................................
eCor.properties Configuration .....................................................................
Configuring xRevise .......................................................................................
xRevise User Access....................................................................................
Running xRevise on a non-xDesign Machine ................................................
131
Installing and Configuring Client Applications
131
132
132
132
132
133
134
134
135
136
136
136
137
137
137
138
139
140
140
140
141
141
142
142
142
143
144
144
145
146
146
147
147
147
147
148
149
150
151
151
152
152
152
152
153
153
Table of Contents
Chapter 9
Chapter 10
Configuring Application Startup Order ........................................................
153
xEditor...........................................................................................................
About Smart Client Installation ...................................................................
Access Rights to Install xEditor ....................................................................
Preparing Your Environment.......................................................................
Java Runtime Environment .....................................................................
Microsoft .NET Framework .....................................................................
Install VBA ............................................................................................
Internet Explorer Settings ........................................................................
Adobe PDFMaker ...................................................................................
Installing xEditor ........................................................................................
Pushing the xEditor Installation From the Server ..........................................
Verifying the Installation .............................................................................
153
154
154
155
155
155
155
156
156
156
157
157
About Deploying xPressForms ........................................................................
Validating Properties Files...........................................................................
Deploying xPressForms Environment ..........................................................
158
158
158
About xPression Adapter ................................................................................
Configuring WebSphere MQ .......................................................................
Add Queues to WebSphere MQ 5.3 ..........................................................
Configure the JMS Provider ....................................................................
Configuring xPression Adapter for WebLogic ...............................................
159
159
159
160
165
Using XQuery Outside of xPression .................................................................
XQuery Command Line Utility....................................................................
XML Converter Command Line Utility ........................................................
Installing the Command Line Utilities ..........................................................
Sample Commands .....................................................................................
165
165
165
166
166
.........................................................................
Step One: Check Basic Connectivity .................................................................
Examine Server Logs ..................................................................................
Access xAdmin ..........................................................................................
Supply Your License ...................................................................................
Access Locales ............................................................................................
Step Two: Import Sample Test Data .................................................................
Step Three: Configure Access Rights ................................................................
Step Four: Test Assembly in xDesign ...............................................................
169
Verifying Your Installation
Integrating with Third-Party Software ........................................................
Integrating with Documentum ........................................................................
Step One: Configure Documentum System User Name .................................
Step Two: Install Documentum Foundation Classes ......................................
Step Three: Configure Application Server ....................................................
Adding Paths to Support xPression Batch.................................................
Configuration Steps for WebSphere .........................................................
Configuration Steps for WebLogic ...........................................................
Configuration Steps for JBoss ..................................................................
Configuration Steps for Process Builder Users ..........................................
Step Four: Create an ECM Configuration .....................................................
Setting DFC Registry Mode for xPression Documentum Repository ...............
Installing the Sample Workflow ...................................................................
Deploying the Sample Application ..........................................................
Configuring the Sample Workflow ...........................................................
Run the Sample Workflow.......................................................................
After Updating an Activity Template ...........................................................
Adding Formats for Archiving ....................................................................
169
169
169
170
170
171
171
172
173
173
174
174
174
175
175
176
177
179
180
180
180
180
181
183
183
184
9
Table of Contents
Chapter 11
Chapter 12
Upgrading the Sample Workflow ................................................................
184
Integrating with FileNet ..................................................................................
Implementing FileNet .................................................................................
Configurations for JBoss..........................................................................
Configurations for WebLogic ...................................................................
Configurations for WebSphere .................................................................
Configuring FileNet in xAdmin ...................................................................
Setting Up the FileNet ECM Server ..........................................................
Setting Up the Filenet ECM Configuation .................................................
185
185
185
186
187
187
188
188
Installing Language Packs
189
189
190
Installing a Language Pack for xDesign ............................................................
191
Installing a Language Pack for xPresso for Word ..............................................
191
Installing a Language Pack for xPresso for Adobe InDesign ...............................
192
Installing a Language Pack for xPresso for Dreamweaver ..................................
193
Setting the Internet Explorer Language for xPresso Clients ................................
195
.................................
Uninstall, Reinstall, and Remove .....................................................................
Uninstalling xPression Server ..........................................................................
Preparations for Uninstalling xPression Server on Windows..........................
Undeploy Enterprise Archive Files ..............................................................
Uninstall the Server ....................................................................................
Uninstalling xPresso Client Applications..........................................................
Modifying, Repairing, or Removing xDesign ....................................................
Reinstalling xPression Server ...........................................................................
Removing xPression Completely .....................................................................
197
Uninstalling, Reinstalling, and Removing xPression
Chapter 13
Upgrading xPression
Chapter 14
Troubleshooting
10
........................................................................ 189
Installing a Language Pack for the Server .........................................................
On the Server .............................................................................................
On the Client ..............................................................................................
197
197
198
198
198
199
199
200
200
................................................................................. 203
........................................................................................
xPression Server .............................................................................................
Errors During Start Up ................................................................................
The Installer Cannot Access JVM .................................................................
Cannot Start the Server on JBoss ..................................................................
xDashboard Log On Page Not Displayed .....................................................
Error While Attempting to Connect to xAdmin ............................................
xResponse xPression Database Error with DB2 .............................................
DB2 Error When Deleting or Updating Very Large Document .......................
xDesign .........................................................................................................
Enabling Access Keys .................................................................................
5981 Error ..................................................................................................
xPresso for Word ............................................................................................
Enabling the xPresso COM Add-in ..............................................................
Current Installation No Longer Functions ....................................................
Substituting Font Not Found .......................................................................
Corda Builder Not Launching .....................................................................
Presso for Adobe InDesign ..............................................................................
Valid License Being Called Invalid ...............................................................
205
205
205
206
206
207
207
207
208
208
208
209
209
209
210
210
210
211
211
Table of Contents
Chapter 15
Current Installation No Longer Functions ....................................................
Corda Builder Not Launching .....................................................................
211
211
xEditor...........................................................................................................
Unable to Reinstall xEditor ..........................................................................
212
212
..............................................................
Configure xPression for Documentum .............................................................
Deploy Documentum Edition DAR File ...........................................................
Create ECM Configuration ..............................................................................
Define Documentum Users and Roles ..............................................................
213
Deprecated Documentum Edition
213
214
214
215
11
Table of Contents
12
Revision History
Revision Date
Description
August 2016
Added section Configuring WebLogic When
Publishing xPresso for Word Documents from
xBatch, page 119
July 2016
Updated sections Configure Cookies Settings,
page 92, Switching from ADUser to LDAPUser,
page 27 and Microsoft SQL Server Driver, page
117.
November 2015
Initial publication
13
Revision History
14
Chapter 1
Before You Install
Before installation, ensure that your system meets the requirements. The xPression Release Notes
contains the system requirements for this release.
Note: To avoid security issues, refer to the security guides of your application server, database server
and operating system to configure them properly.
xPressionHome
The term "xPressionHome” refers to the location where xPression is installed on your server. The
default location on Windows servers is C:\xPression
Documentum Edition and Enterprise Edition
xPression Documentum Edition is deprecated in this release. EMC recommends that you upgrade
to xPression Enterprise Edition, which contains all the functionality of the Documentum Edition.
If you are currently using the Documentum Edition, contact EMC Document Sciences Support for
additional information.
Documentum Edition can be acquired as a separate add-on to the standard Enterprise Edition server,
or as a separate installation that installs the server, but not the Enterprise Edition applications. When
installing Documentum Edition, the steps are similar with the standard Enterprise Edition steps.
Differences are noted in this guide where they occur. See Chapter 15, Deprecated Documentum
Edition for configuration steps for Documentum Edition.
xPublish or CompuSet Scenarios
xDesign and the xPression Server must both have CompuSet functionality activated to ensure that
CompuSet functions properly. If the server has CompuSet enabled, but xDesign does not, the user
will not be able to open or edit CompuSet documents in xDesign. If xDesign has CompuSet enabled,
but the xPression server does not, the xDesign user will not be able to access or publish CompuSet
documents. Ensure that your xDesign and xPression Server environments are both enabled or both
disabled.
15
Before You Install
You can select whether to install CompuSet in the installation wizard that is described in Running
the xPression Installer, page 98. For descriptions and instructions for all CompuSet features, see
the xPression CompuSet User Guide.
Disk Space Requirements
The xPression installation program requires approximately 520 MB to run. The Disk Space
Information page in the installer shows that you need 174 MB to install the xPression Server.
However, this refers only to the size of the files being copied to your system. The installer itself
requires the remaining space. Ensure that your server has the required disk space allotment of a
minimum of 520 MB.
Requirements for Windows
Review the following requirements for Windows platforms:
• UAC Settings on Windows, page 16
• Non-English Windows Versions on Client Computers, page 16
UAC Settings on Windows
To install xPression Server on Windows system, ensure that your installing account is Administrator
or in the Administrators group, and check the following User Account Control (UAC) settings:
• If UAC is set to Default, the installing account for xPression Server must be the built-in
Administrator.
• If the installing account is not the built-in Administrator but a member of the Administrators
group, set UAC to Never notify.
Non-English Windows Versions on Client Computers
When logging on to client applications in the xPression suite (xDesign, xResponse, and xRevise)
xPression uses LDAP to verify credentials. On client machines using non-English versions of
Windows, it is necessary to set the HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet
\Control\Lsa\ForceGuest key in the registry to 0. By default, this value is 1.
Refer to your operating system documentation for instructions on editing the registry. This is an
advanced procedure that should be attempted by qualified personnel only.
16
Before You Install
This setting and the status of the Guest account has the following impact: on security:
• If the ForceGuest key is set to 1 and the guest account (invite in <language>) is enabled, then
anyone can log in.
• If the ForceGuest key is set to 1 and the guest account is disabled, then no logons will succeed.
• If the ForceGuest key is set to 0, then authorized users can log in regardless of the guest account
setting.
For full security, the recommended settings are ForceGuest = 0 and guest account disabled.
Requirements for UNIX Platforms
Review the following UNIX requirements and recommendations.
• User Validation, page 17
• User Profiles, page 18
• The User to Install xPression, page 18
• Verify Environment Settings, page 18
• Using xWindows, page 18
User Validation
User validation has been enhanced to enable the use of a shadow password file. When using a
shadow password file, a binary executable is run as root to allow the shadow password file to be
read and users authenticated. xPression now supports this authentication scheme. If you use a
non-root-level user to install xPression and intend on using local authentication, you must complete
the following configuration changes. If you fail to make these changes, xRevise and xResponse
authentication will fail.
To Configure User Validation
1.
Navigate to the following directory:
xPressionHome/Drivers
2.
Locate the *AuthUser file for your version of UNIX: SolarisAuthUser, AIXAuthUser, or
LinuxAuthUser.
3.
Change the owner of this file for the root user. For example:
chown root:root SolarisAuthUser
chmod 4655 SolarisAuthUser
17
Before You Install
User Profiles
The xPression Server installation program automatically writes the xPression environment variables
to the local user profile of the user that ran the installation program.
After running the installation program, you must log off and log back onto the server so that the
current user profile can be updated with the environment changes.
The User to Install xPression
The user who installs xPression Server should be the same user who installed the application server.
Verify Environment Settings
Ensure that your environment settings contain the correct database path for your database.
Using xWindows
If you install through xWindows, set up the display environment to view the installation screens
by typing:
DISPLAY=computer_name:0.0;export DISPLAY
Make sure the DB2 database on the client computer can connect to the DB2 server if the server
is installed on a different computer.
Authentication on the xPression Server
xPression operates in a client/server environment where the xPression client user must log on
to the xPression Server to gain access to the system. You can authenticate users for this system
using one of two modes of authentication: Local User and LDAPUser authentication. Select your
authentication mode in the xPression Server installation wizard. The selection you make is reflected
in the dscsecurity.properties file in your xPressionHome directory.
See the following topics:
• Local User Authentication, page 19
• LDAPUser Authentication, page 19
• SiteMinder Authentication, page 30
• User Exit Authentication, page 31
18
Before You Install
Local User Authentication
This option enables user authentication on the local machine. Users with access to the local machine
that hosts the xPression Server will also have access to xPression. You authenticate users for xPression
by adding them to the local users list on your server.
On a Windows system, when you select Local User authentication, the dscsecurity.properties
file records the following information and comments out all Active Directory settings.
IMPL_CLASS=com.dsc.uniarch.security.user.NTUser
NT_AUTH=SERVERNAME
The following example shows the IMPL_CLASS property for Linux users:
IMPL_CLASS=com.dsc.uniarch.security.user.LinuxUser
Note: If you are using local NTUser authentication, you cannot use the umlaut character (ä) in
the user name.
LDAPUser Authentication
Lightweight Directory Access Protocol (LDAP) is a protocol for accessing information
directories. When you select LDAP as your authentication method in the xPression Server
installation wizard, you must supply a set of LDAP authentication settings. These settings are
reflected in the ldapcfg.properties file. The path to ldapcfg.properties is stored in
dscsecurity.properties, which is located in your xPressionHome directory.
xPression supports the following facets of LDAP:
• Using LDAP as a user registry to authenticate user names and passwords.
• Retrieving a list of users or groups from an LDAP server. You can also set up a filter to narrow the
number of users or groups you are retrieving.
• Determining which groups a user is a member of. With xPression, you can retrieve (but cannot
change) the associations between users and groups.
• Enabling you to configure the group name values for your LDAP implementation.
• Both single domain LDAP and multi-domain LDAP configurations. Multi-domain LDAP
configuration must be done after running the server installer.
• LDAPS and the Start TLS extension in LDAP V3.
• Using Active Directory through the LDAPUser interface. If you were previously using ADUser
authentication, switch to use LDAPUser authentication. ADUser authentication is no longer
supported.
Note: LDAPUser authentication is non case-sensitive. If you have used case-sensitive authentication
settings with “common name” (cn) and want to upgrade your xPression, see the xPression Upgrade
Guide.
This section contains the following topics:
• LDAP Settings from the xPression Installer, page 20
• LDAPUser Parameters, page 20
19
Before You Install
• LDAPS Configuration, page 23
• Start TLS Configuration, page 23
• Multi-Domain LDAP Configuration, page 24
• Switching from ADUser to LDAPUser, page 27
LDAP Settings from the xPression Installer
The xPression installer requires you to specify your authentication method, and then requests
details about your LDAP configuration. The setting you configure in the installer are saved to two
configuration files that can be manually updated.
Your authentication method and the location of your LDAP configuration file are stored in the
dscsecurity.properties file located in your xPressionHome directory.
IMPL_CLASS=com.dsc.uniarch.security.user.LDAPUser
LDAP_CFG_PATH=C:\\xPression\\ldapcfg.properties
The LDAP configuration settings you define in the xPression installer are saved in the
ldapcfg.properties file. By default, this file resides in the xPressionHome directory. If you move this
file to a different location, update the LDAP_CFG_PATH property in the dscsecurity.properties file.
This property controls where xPression looks for this information.
LDAP_NAME_ATTRIBUTE=<uid>, <cn>, <custom_name>
LDAP_ADMIN_PWD=<PASSWORD>\=\r\n
LDAP_ADMIN_DN=uid=admin,ou=administrators,ou=topologymanagement,o=netscaperoot
LDAP_USER_FILTER=(objectclass\=person)
LDAP_MEMBER_ATTRIBUTE=uniqueMember
LDAP_GROUP_FILTER=(objectclass=groupOfUniqueNames)
LDAP_SERVER_URL=ldap://localhost:389
LDAP_NAME_CONTEXT=\cn=<commonName>,ou\=<organizationalUnit>, dc=<DomainName>,
dc=com
LDAP_INITIAL_CONTEXT_FACTORY=com.sun.jndi.ldap.LdapCtxFactory
LDAP_GROUP_CONTEXT=\cn=<commonName>,ou\=<organizationalUnit>, dc=<DomainName>,
dc=com
LDAP_USER_MODE=<FILTER OR FILTERANDGROUP>
USE_START_TLS=false
xPression encrypts your LDAP password when writing it into the ldapcfg.properties file. You will
find the password string in the file similar to the following one:
LDAP_ADMIN_PWD=<PASSWORD>\=\r\n
where PASSWORD is your password and \=\r\n is part of the encryption string.
LDAPUser Parameters
The following list contains descriptions of the LDAPUser parameters:
• LDAP_NAME_ATTRIBUTE, page 21
• LDAP_ADMIN_PWD, page 21
• LDAP_ADMIN_DN, page 21
• LDAP_USER_FILTER, page 22
20
Before You Install
• LDAP_USER_MODE, page 22
• LDAP_MEMBER_ATTRIBUTE, page 22
• LDAP_GROUP_FILTER, page 22
• LDAP_SERVER_URL, page 22
• LDAP_NAME_CONTEXT, page 23
• LDAP_GROUP_CONTEXT, page 23
• LDAP_INITIAL CONTEXT FACTORY, page 23
• USE_START_TLS, page 23
LDAP_NAME_ATTRIBUTE
By default, xPression provides supports UID (user ID; first initial and last name) or CN (common
name; first name followed by last name). CN is selected by default. But xPression also supports any
customized name for LDAP_NAME_ATTRIBUTE.
For customized LDAP name attributes, you must manually configure the ldapcfg.properties file.
For example:
LDAP_NAME_ATTRIBUTE=sAMAccountName
You can also authenticate groups of LDAP users for access to xPression.
If you are using common name (cn) for the LDAP_NAME_ATTRIBUTE, you must ensure that
all common names are unique. If your common names are not unique, you should set your
LDAP_NAME_ATTRIBUTE to UserID (uid).
This parameter is defined by your selection for LDAP Name Attribute in the xPression Server
installation program.
LDAP_ADMIN_PWD
This parameter is the password for the LDAP_ADMIN_DN user or the directory object. Your plain
text password entry will be encrypted once the xPression application is started.
This parameter is defined by your input in the Bind Credential field in the xPression Server
installation program.
LDAP_ADMIN_DN
LDAP_ADMIN_DN is a special user who has access to a designated sub tree for interested users and
groups. Note that this user is not necessarily the LDAP server administrator. You can modify this
entry to retrieve different users and groups from different LDAP directory levels.
21
Before You Install
LDAP_USER_FILTER
This parameter is the filter used to query for users associated with the object class. NOTE: If you do
not want to pull individual user components from the group, set up the LDAP_USER_FILTER with a
false condition. For example, 1=2. This parameter is defined by your input in the User SearchScope
field in the xPression Server installation program.
LDAP_USER_MODE
Controls the way xPression retrieves users. This parameter has two modes:
FILTER - xPression uses only LDAP_USER_FILTER to limit the users retrieved. FILTER is the default
value.
When using this value, xPression returns all users that are members of the organizational unit defined
by LDAP_NAME_CONTEXT and meet the criteria in LDAP_USER_FILTER.
FILTERANDGROUP - When using this value, xPression returns only the users that meet the
following criteria at the same time:
• The users are members of the organizational unit defined in LDAP_NAME_CONTEXT;
• The users meet the criteria in LDAP_USER_FILTER;
• The users are members of the groups that:
— are members of the organizational unit defined in LDAP_GROUP_CONTEXT, and
— meet the criteria in LDAP_GROUP_FILTER.
This parameter is defined by your selection for User Mode in the xPression Server installation
program.
LDAP_MEMBER_ATTRIBUTE
This parameter is the name of the group’s member attribute. The group instance should contain
an attribute for recording its members. This attribute is uniqueMember if the group’s object class
is groupOfUniqueNames. The resulting list displays all the users within each unique group. This
parameter is defined by your input in the Member Attribute field in the xPression Server installation
program.
LDAP_GROUP_FILTER
This parameter is the filter used to query for groups associated with the object class. This parameter
is defined by your input in the Group Filter field in the xPression Server installation program.
LDAP_SERVER_URL
This parameter is the LDAP server URL. The port number must be provided in the URL if the
LDAP server is not using the default port. A fully qualified name should be provided, for example:
22
Before You Install
servername.docscience.com. This parameter is defined by your input in the Provider URL field
in the xPression Server installation program.
LDAP_NAME_CONTEXT
Use as the root context to retrieve users. It is the search base for the entire LDAP directory tree. The
search will remain in scope for this branch. If another branch in the tree also contains the interested
users and groups, then the parent of the two branches should be configured as the search base. This is
the distinguished name where the search will begin. This parameter is defined by your input in the
User Context field in the xPression Server installation program.
LDAP_GROUP_CONTEXT
Use as the root context to retrieve groups. By default, this is set to match the LDAP_NAME_CONTEXT
value. This parameter is only active when LDAP_USER_MODE=FILTERANDGROUP. or
LDAP_USER_MODE=FILTER. This parameter is defined by your input in the Group Context field
in the xPression Server installation program.
LDAP_INITIAL CONTEXT FACTORY
This parameter is the initial context factory for LDAP access. This value can be changed if you
use a vendor other than Sun.
USE_START_TLS
This property enables Start TLS on your server. By default it is set to false. Manually set this property
to true if you want to enable Start TLS. See Start TLS Configuration, page 23 for more information.
LDAPS Configuration
Before you begin, ensure your LDAP server supports LDAPS. Next, open ldapcfg.properties and
set the LDAP_SERVER_URL property for your LDAP server. Ensure the server URL uses the
LDAPS protocol.
Start TLS Configuration
Before you begin, ensure your LDAP server supports Start TLS. Next, open ldapcfg.properties and set
the LDAP_SERVER_URL property for your LDAP server. Ensure the server URL uses the LDAP
protocol (not LDAPS). Also, ensure the USE_START_TLS property is set to “True”.
23
Before You Install
Multi-Domain LDAP Configuration
The xPression Server installer enables you to set up single domain LDAP. To configure multi-domain
LDAP, you must manually configure dscsecurity.properties after the installation is complete. Keep
in mind the following items when planning your configuration:
• Domain names crossing the multiple forests will never be duplicated. They are globally unique.
• The filters of users and groups must be surrounded by parentheses.
• The xPression configuration will only retrieve the users who are specified by the user filter in
the configuration file. It does not support retrieving the users based on the groups, which is
supported by the single domain LDAP solution.
• xPression only provides weak encryption of the administrator passwords in the configuration file.
To configure multi-domain LDAP, specify your LDAP details in the dscsecurity.properties file
that is located in the xPressionHome directory on your server.
1.
Open dscsecurity.properties for editing.
2.
Locate the IMPL_CLASS property. To enable multi-domain LDAP, change the value of this
property to: com.dsc.uniarch.security.user.MultiDomainLDAPUser.
3.
Locate the MULTI_LDAP_CFG_PATH property. Set the value of this property to the location of
your Multildapcfg.properties file. This file can reside anywhere on your file system as
long as the path is defined in this property. However, EMC Document Sciences recommends
storing this file in your xPressionHome directory for ease of maintenance. For example:
MULTI_LDAP_CFG_PATH=C:\\xPression\\Multildapcfg.properties
Caution: The Multildapcfg.properties file must use .properties as its extension.
Errors may occur if it uses other file extensions such as .txt.
4.
Save and close dscsecurity.properties.
5.
Open Multildapcfg.properties to configure your LDAP settings. The configuration file
must contain the following parameters:
• LDAP_DOMAIN_NAME.DOMAIN[x], page 25
• LDAP_SERVER_URL.DOMAIN[x], page 25
• LDAP_DOMAIN_CONTEXT.DOMAIN[x], page 25
• LDAP_ADMIN_USER.DOMAIN[x], page 25
• LDAP_ADMIN_PASSWORD.DOMAIN[x], page 25
• LDAP_USER_FILTER.DOMAIN[x], page 25
• LDAP_GROUP_FILTER.DOMAIN[x], page 26
The following properties are optional:
• LDAP_INITIAL_CONTEXT_FACTORY.DOMAIN[x], page 26
• LDAP_DISPLAY_ATTRIBUTE.DOMAIN[x], page 26
• LDAP_AUTH_ATTRIBUTE.DOMAIN[x], page 26
24
Before You Install
• LDAP_MEMBER_ATTRIBUTE.DOMAIN[x], page 26
• LDAP_QUERY_USERS_FOR_PICK_LIST.DOMAIN[x], page 26
• LDAP_QUERY_GROUPS_FOR_PICK_LIST.DOMAIN[x], page 27
The “x” inside of [] represents the sequence number of each domains. It must start at 0, and be
increased by 1 for the next domain. Any increase greater than 1 will cause the loss of domains.
6.
Save and close Multildapcfg.properties.
LDAP_DOMAIN_NAME.DOMAIN[x]
This is the name of the domain in LDAP. EMC Document Sciences recommends that you use the
real domain name as the value for this parameter. For example:
LDAP_DOMAIN_NAME.DOMAIN[0]=Domain1
LDAP_SERVER_URL.DOMAIN[x]
The LDAP domain server URL including the protocol. For example:
LDAP_SERVER_URL.DOMAIN[0]=ldap\://192.168.1.8
LDAP_DOMAIN_CONTEXT.DOMAIN[x]
The LDAP domain context. For example:
LDAP_DOMAIN_CONTEXT.DOMAIN[0]=dc\=EMC,dc\=DocScience,dc\=Domain1
LDAP_ADMIN_USER.DOMAIN[x]
This is the username of a user who has access to bind to the LDAP server and read the domain
specified in the properties file. This user is not necessarily the LDAP server administrator. xPression
will only read the directory, it will not write to it. A dedicated service account can be used for this
task. In most cases, the value of this parameter is a DN or UPN. For example:
LDAP_ADMIN_USER.DOMAIN[0]=uid\=admin,ou\=administrators,ou\=topologymanagement,
o\=netscaperoot
LDAP_ADMIN_PASSWORD.DOMAIN[x]
The password for the LDAP_ADMIN_USER. When the xPression application starts, the plain text
password entry will be weak encrypted.
LDAP_USER_FILTER.DOMAIN[x]
The filter used to query for users associated with the objectclass. For example:
25
Before You Install
LDAP_USER_FILTER.DOMAIN[0]=(&(objectclass\=person)(cn\=a*))
LDAP_GROUP_FILTER.DOMAIN[x]
The filter used to query for groups associated with the objectclass. For example:
LDAP_GROUP_FILTER.DOMAIN[0]=(&(objectclass\=groupofuniquenames)(cn\=xpr*))
LDAP_INITIAL_CONTEXT_FACTORY.DOMAIN[x]
The implementation class of context factory. The default value is com.sun.jndi.ldap
.LdapCtxFactory.
LDAP_DISPLAY_ATTRIBUTE.DOMAIN[x]
The attribute used for displaying when configuring the access of xPression resources, which is also
the expected attribute of the user name for users logging in. The value of this parameter also could
be uid, cn, etc. For example:
LDAP_DISPLAY_ATTRIBUTE.DOMAIN[0]=cn
LDAP_AUTH_ATTRIBUTE.DOMAIN[x]
The attribute used for authentication. Authentication will be applied against the pair of the value
of this attribute and password the users provided. The value of this parameter also could be
DistinguishedName, etc. The default value is userPrincipalName. If this optional parameter is not
added to the Multildapcfg.properties, xPression will use the default value: userPrincipalName.
The value you specify for this parameter must be unique in all domains. For example:
LDAP_AUTH_ATTRIBUTE.DOMAIN[0]=entrydn
LDAP_MEMBER_ATTRIBUTE.DOMAIN[x]
The attribute used for checking whether the groups contain the particular user. For example:
LDAP_MEMBER_ATTRIBUTE.DOMAIN[0]=uniquemember
LDAP_QUERY_USERS_FOR_PICK_LIST.DOMAIN[x]
If this attribute is not specified, the default value is True. When set to True, xPression will query users
from this domain and add them to the pick list used in xAdmin. If set to False, xPression skips this
domain when querying for users for the return list. For example:
LDAP_QUERY_USERS_FOR_PICK_LIST.Domain[0]=false
26
Before You Install
LDAP_QUERY_GROUPS_FOR_PICK_LIST.DOMAIN[x]
If this attribute is not specified, the default value is True. When set to True, xPression will query
groups from this domain and add them to the pick list in xAdmin. If set to False, xPression skips this
domain when querying for groups for the return list. For example:
LDAP_QUERY_GROUPS_FOR_PICK_LIST.Domain[0]=true
The following sample shows a Multildapcfg.properties with two domains.
# 1st Domain
LDAP_SERVER_URL.DOMAIN[0]=ldap\://192.168.0.10:392
LDAP_ADMIN_USER.DOMAIN[0]=uid\=admin,ou\=administrators,
ou\=topologymanagement,o\=netscaperoot
LDAP_ADMIN_PASSWORD.DOMAIN[0]=2L4uf+2MmW3p/TU=
LDAP_USER_FILTER.DOMAIN[0]=(&(objectclass\=person)(cn\=a*))
LDAP_GROUP_FILTER.DOMAIN[0]=(&(objectclass\=groupofuniquenames)(cn\=xpr*))
LDAP_DISTINGUISHED_NAME_ATTRIBUTE.DOMAIN[0]=entrydn
# 2nd Domain
LDAP_SERVER_URL.DOMAIN[1]=ldap\://192.168.0.11:393
LDAP_ADMIN_USER.DOMAIN[1]=uid\=admin,ou\=administrators,ou\=topologymanagement,
o\=netscaperoot
LDAP_ADMIN_PASSWORD.DOMAIN[1]=2L4uf+2MmW3p/TU=
LDAP_USER_FILTER.DOMAIN[1]=(objectclass=person)
LDAP_GROUP_FILTER.DOMAIN[1]=(&(objectclass\=groupofuniquenames)(cn\=a*))
Switching from ADUser to LDAPUser
This section will demonstrate how to reconfigure your authentication for LDAP user. For this
demonstration, we will use a typical scenario where the goal is to pull users from two groups
(cgroup1 and cgroup2). The ADUser method, which is no longer supported, pulls all users and
groups that reside under the TestingAD OU. The LDAP method allows more focused approach, and
only pulls users from the two groups that are found under the LDAP_NAME_CONTEXT defined in
the ldapcfg.properties file.
To Determine Whether You Are Using the ADUser Security Interface
1.
Locate the dscsecurity.properties file in the xPressionHome directory on the xPression server.
2.
Locate the IMPL_CLASS property in the properties file.
27
Before You Install
3.
If the property is set to com.dsc.uniarch.security.ADUser, you are using the ADUser Security
interface.
If you are using ADUser, your dscsecuritiy.properties file should resemble the following example.
Each line that requires modification is highlighted in red.
# File currently configured for Local authentication.
# Use this file to change/modify your method of authentication.
#IMPL_CLASS=com.dsc.uniarch.security.user.LDAPUser
IMPL_CLASS=com.dsc.uniarch.security.user.ADUser
#IMPL_CLASS=com.dsc.uniarch.security.user.NTUser
#IMPL_CLASS=com.dsc.uniarch.security.user.MultiLDAPUser
#NT_AUTH=xpro-vm4
#The following settings is for Active Directory
AD_AUTH=LDAP://AD_Server/OU=TestingAD,DC=docscience,DC=com
AD_USERS=LDAP://CN=Users,OU=TestingAD,DC=docscience,DC=com
AD_GROUPS=LDAP://OU=TestingAD,DC=docscience,DC=com
#SiteMinder = on
#SSO_USER_HEADERS=SM_USER
#SSO_GROUPS_HEADERS=SM_GROUPS,SM_USERGROUPS,SM_USERNESTEDGROUPS
#SSO_GROUP_DELIMITER=^
#SSO_GROUP_FORMAT=LDAP
#for User cache, the unit is second
UserCredentialCacheTimeout=1800
#LDAP_CFG_PATH=c:/xPression/ldapcfg.properties
To move from ADUser to LDAPUser, modify your dscsecurity.properties file as in the
following steps:
1.
Change the implementation class from ADuser to LDAPuser. This is done by "commenting out”
the ADuser line and removing the comment designation from the LDAPuser line. Using the
sample dscsecurity.properties file as an example, remove the pound sign (#) from the beginning
of the LDAPuser line and place it in front of the ADuser line as shown below.
#IMPL_CLASS=com.dsc.uniarch.security.user.ADUser
2.
In the Active Directory section, “comment out” the AD_AUTH, AD_USERS, and AD_GROUPS
lines. Using the sample dscsecurity.properties file as an example, place a pound sign (#) in
front of each line as shown below.
#AD_AUTH=LDAP://AD_Server/OU=TestingAD,DC=docscience,DC=com
#AD_USERS=LDAP://CN=Users,OU=TestingAD,DC=docscience,DC=com
#AD_GROUPS=LDAP://OU=TestingAD,DC=docscience,DC=com
3.
Remove the comment designation from the LDAP_CFG_PATH line. Using the sample
dscsecurity.properties file as an example, remove the pound sign (#) from the line as shown below.
LDAP_CFG_PATH=c:/xPression/ldapcfg.properties
4.
Save the dscsecurity.properties file. The resulting dscsecurity.properties file should resemble the
following example. Each line that has been modified is highlighted in red.
28
Before You Install
#IMPL_CLASS=com.dsc.uniarch.security.user.NTUser
#NT_AUTH=xpro-vm4
#AD_AUTH=LDAP://AD_Server/OU=TestingAD,DC=docscience,DC=com
#AD_USERS=LDAP://CN=Users,OU=TestingAD,DC=docscience,DC=com
#AD_GROUPS=LDAP://OU=TestingAD,DC=docscience,DC=com
#SiteMinder = on
#SSO_USER_HEADERS=SM_USER
#SSO_GROUPS_HEADERS=SM_GROUPS,SM_USERGROUPS,SM_USERNESTEDGROUPS
#SSO_GROUP_DELIMITER=^
#SSO_GROUP_FORMAT=LDAP
#for User cache, the unit is second
UserCredentialCacheTimeout=1800
LDAP_CFG_PATH=c:/xPression/ldapcfg.properties
5.
Add your information from the AD_AUTH, AD_USERS, and AD_GROUPS lines to the
ldapcfg.properties file. Using the sample dscsecurity.properties file as an example, you must
copy the following information to the ldapcfg.properties file:
OU=TestingAD,DC=docscience,DC=com
6.
Open the ldapcfg.properties file. This file is located at the path defined in your
dscsecurity.properties file under the LDAP_CFG_PATH property.
7.
Locate the LDAP_ADMIN_DN line. In this line, add the information from the
dscsecurity.properties file. Using the sample dscsecurity.properties file as an example, copy the
following information to the LDAP_ADMIN_DN in the ldapcfg.properties file:
The LDAP_ADMIN_DN line should look like the following code:
LDAP_ADMIN_DN=cn\=user1,ou\=testingad,dc\=docscience,dc\=com
8.
Locate the LDAP_ADMIN_PWD line. This parameter is the password for the LDAP_ADMIN_DN
user or the directory object. Your plain text password entry will be encrypted once the xPression
application is started. Supply the password for the LDAP_ADMIN_DN user.
9.
Locate the LDAP_GROUP_CONTEXT line. In this line, add the information from the
following information to the LDAP_GROUP_CONTEXT in the ldapcfg.properties file:
The LDAP_GROUP_CONTEXT line should look like the following code:
LDAP_GROUP_CONTEXT=cn\=user1,ou\=testingad,dc\=docscience,dc\=com
10. Locate the LDAP_NAME_CONTEXT line. In this line, add the information from the
following information to the LDAP_NAME_CONTEXT in the ldapcfg.properties file:
The LDAP_NAME_CONTEXT line should now look like the following code:
LDAP_NAME_CONTEXT=cn\=user1,ou\=testingad,dc\=docscience,dc\=com
11. Locate the LDAP_SERVER_URL line. In this line, add the information from the beginning of the
AD_AUTH property in the dscsecurity.properties file. At the end of the line, supply the correct
29
Before You Install
port number for the server. Using the sample dscsecurity.properties file as an example, supply
this value in the LDAP_SERVER_URL line as shown below.
LDAP_SERVER_URL=ldap\://AD_Server\:389
12. Using the sample dscsecurity.properties file as an example, the resulting ldapcfg.properties file
should look like this. Each line that has been modified is highlighted in red.
#Fri Oct 07 16:57:53 PDT 2005
LDAP_NAME_ATTRIBUTE=cn
LDAP_ADMIN_PWD=2L4uf+2MjXrh5mo\=\r\n
LDAP_ADMIN_DN=cn\=user1,ou\=testingad,dc\=docscience,dc\=com
LDAP_USER_FILTER=(objectclass\=person)
LDAP_MEMBER_ATTRIBUTE=member
LDAP_GROUP_FILTER=(&(objectclass\=group)(|(cn\=cgroup1)(cn\=cgroup2)))
LDAP_SERVER_URL=ldap\://AD_Server\:389
LDAP_NAME_CONTEXT=ou\=testingad,dc\=docscience,dc\=com
LDAP_GROUP_CONTEXT=ou\=Groups,ou\=TestingAD,dc\=docscience,dc\=com
LDAP_USER_MODE=FILTERANDGROUP
LDAP_INITIAL_CONTEXT_FACTORY=com.sun.jndi.ldap.LdapCtxFactory
13. Save and close the ldapcfg.properties file.
SiteMinder Authentication
SiteMinder is a third-party application that enforces single sign-on authentication on web servers.
xPression supports the use of SiteMinder for xRevise and xResponse, though some SiteMinder
configuration is required.
Currently, xPression must be configured manually for SiteMinder. After installing xPression, alter the
dscsecurity.properties file by adding the property SiteMinder=on.
IMPL_CLASS=com.dsc.uniarch.security.user.NTUser
NT_AUTH=<SERVERNAME>
SiteMinder=on
SSO_USER_HEADERS=SM_USER
SSO_GROUPS_HEADERS=SM_GROUPS, SM_USERGROUPS,SM_USERNESTEDGROUPS
SSO_GROUP_DELIMITER=^
SSO_GROUP_FORMAT=LDAP
#AD_AUTH=LDAP://<domain_ip_address>/DC=<domain_name>
#AD_USERS=LDAP://CN=Users,DC=<domain_name>
#AD_GROUPS=LDAP://DC=<domain_name>
In addition to setting SiteMinder=on in dscsecurity.properties, create the following unprotected
realms within the SiteMinder configuration to support xEditor for xRevise.
• xRevise/xEditor
• xRevise/services
30
Before You Install
To support xEditor for xResponse create the following two unprotected realms within the SiteMinder
configuration
• xResponse/xEditor
• xResponse/services
In either case, ensure that no rules are associated with the realms.
When SiteMinder support is activated, the xResponse and xRevise login pages will automatically
begin posting data to SiteMinder instead of xPression. Additionally, SiteMinder will be able to access
xRevise and xResponse using either of the following two methods:
• A FastPath login (forwarding the SiteMinder headings from the current application)
• A direct login to either xResponse or xRevise through the login page for either application
Access Through FastPath
To access xResponse or xRevise through FastPath, SiteMinder must pass the required fastpath
User Name and Groups values through the SiteMinder http headers named "SM_USER" and
"SM_GROUP".
If the SiteMinder property is "on" and valid values are passed through the SiteMinder HTTP headers,
xRevise and xResponse will bypass normal password authentication, deferring to SiteMinder
authentication. All current options of FastPath will be available to SiteMinder.
For more information on FastPath, see the xResponse User Guide and xRevise User Guide.
Access Through Direct Login
xResponse and xRevise will still be accessible through SiteMinder for independent login, however,
xResponse and xRevise will not be able to communicate authentication to one another.
This means that SiteMinder will provide authentication for independent login to xResponse or
xRevise, but will not be able to provide Single Sign-On services.
User Exit Authentication
You can implement a Java user exit to provide authentication. This process involves modifying the
dscsecurity.properties file, creating some new properties files, and compiling the Java code that you
have created. See xPression Server Integration Guide for more information.
Clustering
xPression can be deployed to a clustered environment. Refer to the your application server
documentation for instructions on how to enable and support clustering in your environment.
31
Before You Install
xPression Groups Messages
In clustered environments, multiple xPression servers access the same xPression database. xPression
uses caches to ensure optimal performance by avoiding the need to access the database continuously
while processing document publishing requests. However, since the database can be updated at
any time by any server, it is important that all of the servers are made aware of any changes to the
database so that they can update their respective caches. Whenever an application server instance
updates the database and determines that the update is eligible for caching, xPression must send a
message to every application server instance.
xPression uses xPression Groups (based on jGroups) to send these messages for local cast, unicast,
and multicast broadcast message types. The xPression Server installer enables you to configure
xPression Groups as Unicast, page 32, Multicast, page 32, or Local Cast, page 32.
If you want to make adjustments to the xPression Groups configuration, you can edit your settings in
the xPressionCache.properties file located in the xPressionHome directory.
Unicast
This method should be used when IP Multicast is disabled by your network administrator. xPression
Groups supports Unicast messages through TCP protocol. Configure Unicast for your server while
installing the xPression Server. You will need to know your cluster membership IP address, cluster
membership port, local xPression Server IP address, and the local xPression Server port.
Multicast
This method should be used when you want to use IP Multicast. Ensure that IP Multicast is available
in your network environment. Configure Multicast for your server while installing the xPression
Server. You will need to have an available IP multicast address.
Ensure that each multicast address used in your enterprise is unique. Coordinate with your network
management team to ensure that no other hardware or software is using that same multicast address.
Request that the network management team assign a unique multicast IP address for each xPression
database in your enterprise.
Local Cast
xPression is configured to use Local cast by default. Use Local cast when xPression is used in a
single-server environment. xPression will only send messages to the local machine.
32
Before You Install
Horizontal Cluster Requirement
Each server in a horizontal cluster must have a distribution service running on their system. If
a server in a horizontal cluster does not have a distribution service running, some archive, e-mail,
and print documents may not get processed.
The Distribution service can be enabled on all servers in a Horizontal cluster.
Vertical Clusters
Vertical clusters are still limited to a single distribution service in the cluster.
SAP System Landscape
xPression can be integrated into the SAP System Landscape. To use xPression in the SAP System
Landscape, it is necessary to register xPression.
To register xPression in the SAP System Landscape:
1.
Locate the easySolManReady.zip file in the xPression home directory.
2.
Extract the contents of easySolManReady.zip to <drive>\SolManReady. Create the folder if
necessary.
3.
Locate the ThirdPartySystem.txt file in the SolManReady folder created in step 2 and set the
following.
Setting
Value
LocalSystemName
The name of your environment. For example: EMCTest
or EMCProd.
ComputerName
The name of the server where xPression is installed.
ProductID
0120061532090000440
ProductName
EMC xPression
ProductVendor
sap.com
ProductVersion
4.6
SoftwareComponentID
01200615320200015844
SoftwareComponentName
EMC_xPression
SoftwareComponentVendor
sap.com
SoftwareComponentVersion
4.6
4.
Save ThirdPartySystem.txt.
5.
On the xPression server, open a command line and navigate to the folder created in step 2.
33
Before You Install
6.
From the command line execute the following:
java ThirdPartySystemXMLGenerator . ThirdPartySystem.txt ThirdPartySystem.template
. ThirdPartySystem.xml
This action updates ThirdPartySystem.xml.
7.
From the command line execute the following:
java ThirdPartyPassToSLD <sld_host> <sld_http_port> <sld_user>3rd_ <sld_pwd>
ThirdPartySystem.xml
The following information can be retrieved from the SAP environment:
• <sld_host>
• <sld_http_port>
• <sld_user>
• <sld_pwd>
The actual command would resemble this:
java ThirdPartyPassToSLD iccsolman40.sap.com 55500 3rd_party isvconnect08
ThirdPartySystem.xml
Requirements, Recommendations, and
Limitations
The following section lists special requirements for particular platforms and applications.
• xPression Requires Exclusive Environment, page 34
• JBoss and WebLogic Installation Paths, page 35
• Multiple Instances of xPression, page 35
• Databases That Require a Database Client, page 35
• Removing Existing xPression Server, page 36
• Installing the xAdapter, page 36
• Database Issues, page 36
• License Validation with Linux, page 37
• Autograph and xPression on the Same Server, page 37
xPression Requires Exclusive Environment
The Application Server environment where the EAR file is deployed must be exclusive to xPression
unless non-xPression components rely on the xPression server/database to function, such as custom
code developed by EMC Document Sciences. Under those circumstances, such non-xPression
components may be deployed alongside the xPression applications.
34
Before You Install
JBoss and WebLogic Installation Paths
xPression does not support JBoss and WebLogic servers installed to paths using non-Latin characters.
Multiple Instances of xPression
xPression provides limited support for deploying multiple instances of xPression on the same
machine. Depending on the operating system, application server, and application server startup
method, multiple instances of xPression Server may or may not be run on the same operating system
instance. xPression has several operating requirements that must be fulfilled in order to function
properly, most notably the requirement to maintain a separate native code execution path.
Each operating system and application server vendor has different mechanisms to configure and
start its application server JVMs, making it difficult or impossible to document all the different
combinations in the installation guide. This installation guide documents the simplest xPression
installations for each supported operating system and application server only. Consult the EMC
Document Sciences Professional Services team for more advanced installations, particularly
implementations involving multiple instances and clusters. EMC Document Sciences will support
xPression environments under these circumstances only when all xPression operating requirements,
including native code designation, are correctly configured for each instance.
Installing Multiple xPression Servers on the Same Machine
In most situations, you can install multiple xPression Servers on the same machine.
To install multiple xPression Servers on the same machine, you must install all xPression Servers
to different locations. If you attempt to install the xPression Server in a location where an existing
xPression Server resides, the installation program will revert to Reinstallation mode, which enables
to you completely or partially reinstall the existing server. For more information, see Reinstalling
xPression Server, page 200.
Additionally, the xPression installer updates the “xPressionHome” operating system environment
variable each time xPression is installed. Therefore, if you have multiple xPression installations
on the same system, the variable will contain the path for the latest installation only. All other
xPressionHome paths should be manually added to the application server classpath.
Databases That Require a Database Client
For DB2 databases, xPression requires that you install a database client application on all xPression
Servers. This database client application enables the connection between the server and the xPression
database.
EMC Document Sciences also recommends that you also install database client applications if you
are using SQL Server or Oracle. Installing the client application on the server generally simplifies
the configuration process by installing needed files (for example, the database drivers), and helps
with debugging.
35
Before You Install
Removing Existing xPression Server
EMC Document Sciences recommends that you remove any existing xPression Server that resides
on the application server where you will install xPression. Remove the xPression Server before
starting the xPression installation steps. See Removing xPression Completely, page 200 for detailed
information.
Installing the xAdapter
The xAdapter uses any combination of real-time integration, near-time integration, or batch
integration models to collect and merge XML files for later processing by the Batch capabilities
of xPression. The xPression installation program enables you to deploy the xAdapter EAR file.
Configuration steps for the xAdapter application are integrated into the configuration steps for
your application server.
EMC Document Sciences provides two versions of the xAdapter application: one with a JMS listener
and one without. The JMS functionality is used specifically for companies that use JMS/MQ to send
messages, and is the only difference between the standard Adapter (non-JMS) and the JMS Adapter.
Select either of the following files to install xAdapter:
• If you need the JMS functionality, use the xPRS_EE4.6.0_JMS_your_server.ear file.
• If you do NOT need the JMS functionality and would like to use xAdapter, use the
xPRS_EE4.6.0_your_server.ear file.
Database Issues
Review the following general database issues.
Copying an xPression Database
If you copy an xPression database to a new environment and that database contains xPression
documents, you must clear the t_cruuid table in the xPression database before using that environment.
Migration Limitation for Oracle Databases
When using the xPression Utilities in xAdmin to migration a document from a non-Oracle database
to an Oracle database, ensure you perform the following steps.
In the Oracle database, adjust the max length of fields value to ensure that the database can store
multi-byte characters. Multibyte (non-ASCII) characters in Oracle are handled as three-byte
characters. Therefore, when migrating from other databases, it is necessary to adjust max length and
column length for fields containing multi-byte characters accordingly.
36
Before You Install
License Validation with Linux
For xPression license to successfully validate, you must provide the server entry in the .etc/hosts
file. If there is no value, the loopback address (127.0.0.1) is used. For example:
10.0.4.194
myserver.mydoman
myserver
The NETWORK and BROADCAST parameters in the /etc/sysconfig/network-scripts
/ifcfg-eth0 file must be set appropriately.
Autograph and xPression on the Same Server
If you are running a version of the Autograph software suite from EMC Document Sciences, you
can install xPression on the same server that hosts Autograph. However, if the server is a Windows
server, you must ensure that the xPressionHome\Drivers path appears in your Windows
environment variable list first. This is not an issue for UNIX servers.
To Add the Path to System Variables
1.
From the Windows Start Menu, select Settings, Control Panel, and System.
2.
In the System properties, select the Advanced tab and click Environment Variables.
3.
In the System variables list, select Path and click Edit.
4.
Ensure that the path to your xPressionHome\Drivers directory appears first in this list.
By default, the path is C:\xPression\Drivers.
5.
Click OK to save your changes.
37
Before You Install
38
Chapter 2
This chapter contains configuration instructions for installing the xPression database on a DB2
database.
At this point in the installation, you should have:
• Reviewed the System Requirements chapter of the xPression Release Notes available on
https://support.emc.com or in your downloaded documentation package.
• Reviewed the issues listed in Chapter 1, Before You Install.
About the xPression Database
The xPression database is the center of the xPression system and must be installed first. It is the
centralized location for all your content, images, and xPression data. The xPression database is
a relational database that stores all the data needed for assembling, formatting and publishing
personalized documents. The xPression database is a fully indexed database that holds all the
content, images, document templates, rules, profiles, and internal data that xPression uses to create,
manage, and publish your documents.
In an unclustered environment, there is one xPression database in each xPression installation. For a
clustered environment, one xPression database is used by the computers participating in the cluster.
The xPression database holds different types of information: xPression data objects, rules, text objects
(documents), and binary objects (images). The xPression database is hosted in a relational database.
Caution: EMC Document Sciences strongly recommends that you create a new database for
xPression database. During the setup process, you will be modifying the database configuration
file. These modifications impact the entire database and could adversely effect any existing
objects.
DB2 on Linux
For all DB2 users on Linux, make the following change to the .profile file. Locate the
LD_LIBRARY_PATH. Add the path to the lib64 directory:
<db2_install_home>/lib64
39
Step One: Start the Database Manager
Before you can create a database or perform any tasks on a database, you must start the DB2 database
manager. The database manager may be configured to start automatically when your server starts,
but perform this to ensure that it is started.
If you are using a Windows machine for your database server platform, you can start the database
manager service from the Windows Services as shown in Start the Database Manager Service with
Windows Services, page 40. For both Windows and UNIX based systems, you can Start the Database
Manager from the Command Line, page 40.
Start the Database Manager Service with Windows
Services
Start Services from the Administrative Tools section of the Windows Control Panel.
Locate the following two services:
• DB2DAS – DB2DAS00
• DB2-DB2-0
Right-click each service and select Start.
These services must be started before performing any operations on a database. After both services
have started, close the Services window.
Start the Database Manager from the Command Line
You can perform this step on Windows systems. Start the IBM DB2 Command Line Processor (CLP)
by executing the following command from a command prompt: db2cmd.
In the DB2 CLP command window, execute the following two commands:
db2start
db2admin start
These commands are necessary before performing any operations on a database.
Start the Database Manager on UNIX and Linux
If you are logged on to your workstation using either the DB2 UDB Administration Server user ID or
the DB2 UDB instance user ID, you can issue DB2 UDB commands and SQL statements from the
command line.
Type the following command from the terminal command line window:
db2start
40
Step Two: Create a New DB2 Database
The xPression database must support Universal Transport Format 8 (UTF-8).
When creating a new database, keep in mind the following DB2 database naming conventions:
• A database name or alias must be a unique character string consisting of one to eight characters.
Supported characters are A-Z, 0-9, @, #, $.
• You can type the database name or alias using lowercase letters, but the database manager
processes them as if they were uppercase.
• The first character of the database name or alias cannot be a number.
• The database name or alias cannot begin with the following sequences: SYS, DBM, IBM.
You can use one of two methods to create the new database:
• Create the Database from the Command Line, page 41
• DB2: Create the Database with IBM DB2 Control Center, page 41
Create the Database from the Command Line
To create the database from the command line:
1.
Start the IBM DB2 Command Line Processor by executing the following command from a
command prompt: db2cmd. Linux and AIX users can skip this step and enter the DB2 command
directly from the command line.
2.
In the DB2 CLP command window, execute the Create Database command:
db2 CREATE DATABASE <XPRESSION_DATABASE_NAME> ON <DRIVE_LETTER> USING
CODESET UTF-8 TERRITORY US COLLATE USING SYSTEM
The following sample shows a complete Create Database command:
db2 CREATE DATABASE XPRESSCR ON D: USING CODESET UTF-8 TERRITORY US COLLATE USING
SYSTEM
In this example, <XPRESSION_DATABASE_NAME> is the name you want to provide for the new
database and <DRIVE_LETTER> is letter of the hard drive where you are creating the database.
For Linux or AIX, do not specify a drive letter. For example:
db2 CREATE DATABASE XPRESSCR USING CODESET UTF-8 TERRITORY US COLLATE USING SYSTEM
3.
When finished, proceed to Step Three: Create a New Database User, page 43.
Note: If you are running the Command Line Processor in Interactive mode, you do not have to
preface every command with "db2". In Interactive mode, your command prompt will appear as
follows: db2 => The examples in this chapter assume you are not using Interactive mode.
DB2: Create the Database with IBM DB2 Control Center
For Windows systems, select IBM DB2 Control Center from the Windows Start Menu. For UNIX
and Linux systems, start the IBM DB2Control Center by typing the following command from the
terminal command line window: db2cc
41
When the IBM DB2 Control Center appears, complete the following steps to create your database.
If you are given a choice of how you want to view the DB2 Control Center, you must choose the
Advanced View, not the Basic View.
1.
In the object tree, expand the All Databases item. Right-click All Databases, select Create
Database, and click Standard.
2.
If you have more than one DB2 database instance, the Instance Selection box appears. Select the
database instance for your xPression database and click OK.
3.
The Create Database Wizard appears. On the Name page, define the following settings and leave
all other settings empty or at their default value:
• Database Name — Type a one-to-eight character name for the database using the naming
conventions discussed on Step Two: Create a New DB2 Database, page 41.
• Default Path — Select the drive where you want to place the xPression database.
• Alias — This is an optional setting. If no alias is provided, the specified database name is
used. A database alias uses the same naming conventions as the database name. These are
discussed on Step Two: Create a New DB2 Database, page 41.
• Let DB2 manage my storage/I want to manage my storage manually — Select I want to
manage my storage manually.
• Default bufferpool and table space page size — Select 8k.
Click Next.
4.
The next three wizard pages refer to the USER, CATALOG, and TEMPORARY tablespaces.
Each of these tablespaces is created with the new database. You must decide how you want the
tablespaces created.
You can select either Low Maintenance or High Performance. The Low Maintenance method
creates the tablespace as a System Managed Space (SMS), and the High Performance method
creates the tablespace as a Database Managed Space (DMS).
Your Database Administrator should choose one of these methods based on the type of device,
your needs, and your performance requirements. Make your selection and click Next.
5.
For "Specify how and where to store the system catalog tables” , refer to the instructions for
step 4. Make your selection and click Next.
6.
For "Specify how and where to store system temporary tables” , refer to the instructions for
step 4. Make your selection and click Next.
7.
You are not required to make any changes on the "Tune the performance of the darabase” page.
Click Next.
8.
On the "Specify the locale for this database” page, define your region and territory, select UTF-8
as the Code Set, and select System as the Collating Sequence.
9.
On the Summary page, review your choices and click Finish. DB2 Control Center creates the
xPression database. When finished, proceed to Step Three: Create a New Database User, page 43.
42
Step Three: Create a New Database User
Create a user account on DB2 for xPression. This user must be authenticated on the local operating
system. This user enables the xPression application to access the xPression database DB2 database.
If you need to perform maintenance on the xPression database, use the database administrator
user that you created when you installed DB2.
There are two methods for creating a new DB2 user:
• Creating the User from the DB2 Command Line Processor, page 43
• Creating the User from DB2 Control Center, page 44
Creating the User from the DB2 Command Line
Processor
DB2 does not validate if the user you create is authenticated on the local operating system, you must
validate this on your own. To create the user from the command line, complete the following steps:
1.
Ensure you have created a user account on your local operating system to use as the database
user. In the following steps you will assign DB2 authorities to this user.
2.
Log on to the xPression database you created in Step Two: Create a New DB2 Database, page 41
as an Administrative User:
db2 connect to <XPRESSION DATABASE NAME> user <ADMIN USER> using
<PASSWORD>
The <XPRESSION DATABASE NAME> is the name of the database you created in Step Two:
Create a New DB2 Database, page 41.
For example: db2 connect to xpresscr user db2admin using db2admin
3.
Use the ’grant’ command to grant the following authorities to the database user:
Create Table Connect Implicit Schema Load Bind new package (BINDADD)
db2 grant CREATETAB, BINDADD, CONNECT, IMPLICIT_SCHEMA, LOAD ON
DATABASE to user <XPRESSION DATABASE USER NAME>
In this example, the <XPRESSION DATABASE USER NAME> is the name you are giving to the
new user. For example, if you are giving your new user the name "xpress”, you would type
the following:
db2 grant createtab, connect, bindadd, implicit_schema, load on
database to user xpress
4.
Terminate the connection:
db2 terminate
When finished, proceed to Step Five: Run xPression Database Scripts, page 47.
43
Creating the User from DB2 Control Center
To create a user from the DB2 Control Center, start the Control Center and complete
the following steps:
1.
Ensure you have created a user account on your local operating system to use as the database
user. In the following steps you will assign DB2 authorities to this user.
2.
Expand the All Databases folder.
3.
In the All Databases folder you should see your xPression database. Expand the xPression
database item.
4.
Expand the Users and Groups Objects folder and select the DB Users folder.
5.
Right-click DB Users and select Add.
6.
The Add User page appears.
Select the user name from the User list. This list contains users from the from the local operating
system. Only users already authenticated on the local operating system are eligible for inclusion
on this list.
Select the Connect database, Create tables, Create Packages, Create schemas implicitly, Access
to the load utility authorities.
7.
Click OK to complete the process.
When finished, proceed to Step Four: Create Buffer Pool and Tablespaces, page 44.
Step Four: Create Buffer Pool and Tablespaces
You must create an 8K buffer pool and two 8K table spaces. These steps must be done under the
database administrator username, not the xPression database user you created in Step Three: Create a
New Database User, page 43.
Creating an 8K Buffer Pool and Table Spaces With the
Command Line
1.
Start the IBM DB2 Command Line Processor by running the following command from a
command prompt: db2cmd. Linux and AIX users can skip this step and enter the DB2 command
directly from the command line.
2.
Log on to the xPression database you created in Step Two: Create a New DB2 Database, page 41
as an Administrative User:
db2 connect to <XPRESSION DATABASE NAME> user <ADMIN USER> using <PASSWORD>
The <XPRESSION DATABASE NAME> is the name of the database you created in Step Two:
For example:
db2 connect to xpresscr user db2admin using db2admin
44
3.
Next, create an 8k buffer pool with the following command:
db2 CREATE Bufferpool BP8 IMMEDIATE SIZE 250 PAGESIZE 8 K
4.
Next, create and 8k regular tablespace with the following command:
db2 CREATE REGULAR TABLESPACE TS8 PAGESIZE 8 K MANAGED BY SYSTEM
USING (’<CONTAINER_PATH>\<CONTAINER_NAME>’ ) EXTENTSIZE 8 OVERHEAD 10.5
PREFETCHSIZE 8 TRANSFERRATE 0.14 BUFFERPOOL BP8 DROPPED TABLE RECOVERY ON
<CONTAINER_PATH> is a real path to a DB2 sub-directory. For example:
C:\DB2\NODE0000\SQL00001\
<CONTAINER_NAME> is the name you give to your new tablespace container.
For example, CON8. Add this name to the end of your path, for example:
(’C:\DB2\NODE0000\SQL00001\CON8’)
5.
Next, type the following command:
db2 COMMENT ON TABLESPACE TS8 IS ’table space with page size 8192’
6.
Next, create and 8k system tablespace with the following command:
db2 CREATE SYSTEM TEMPORARY TABLESPACE TS8sys PAGESIZE 8 K MANAGED BY
SYSTEM USING (’<CONTAINER_PATH>\<CONTAINER_NAME>’ ) EXTENTSIZE 8 OVERHEAD
10.5 PREFETCHSIZE 8 TRANSFERRATE 0.14 BUFFERPOOL BP8
<CONTAINER_PATH> is a real path to a DB2 sub-directory. For example:
C:\DB2\NODE0000\SQL00001\
<CONTAINER_NAME> is the name you give to your new tablespace container. Tablespaces
cannot share containers. Ensure you give the container for the system tablespace a different name
than the container for the regular tablespace. At the end of the path, type the name for your new
tablespace. For example, CON8sys: (’C:\DB2\NODE0000\SQL00001\CON8sys’)
7.
Next, grant ’use’ privileges to the xPression database user: db2 grant use of tablespace
<TABLESPACE_NAME> to user <XPRESSION_DATABASE_USERNAME>; where
<TABLESPACE_NAME> is the name of the regular tablespace you created above and
<XPRESSION_DATABASE_USERNAME> is the xPression database user name. For example: db2
grant use of tablespace TS8 to user xpress
8.
For these changes to take effect, you must disconnect from the database:
db2 terminate
Creating an 8K Buffer Pool and Table Spaces With the
DB2 Control Center
In the left pane of the Control Center, expand the item for your xPression database and locate the
folder named Buffer Pools. Right-click the folder and select Create. The Create Buffer Pool dialog
box appears, set the following options and click OK.
• Buffer Pool Name — BP8
• Page Size — 8
• Size in 8 KB Pages — 250
45
• Non-blocked/blocked — Leave at default value
• Enable self tuning — Leave unchecked
• Use default buffer pool size — Leave unchecked
• Create Bufferpool Immediately / Create bufferpool on database restart — Select Create
Bufferpool Immediately
Next create an 8k regular tablespace. Before creating the tablespace in the DB2 Control Center, Create
two sub-directories in your DB2 directory as follows:
For Windows, navigate to your DB2 directory and create two directories named CON8 and CON8sys.
For example:
C:\DB2\NODE0000\CON8 C:\DB2\NODE0000\CON8sys
For UNIX and Linux, navigate to your DB2 directory and create two directories named CON8 and
CON8sys. For example:
/opt/IBM/db2/v9.5/containers/CON8 /opt/IBM/db2/v9.5/containers/CON8sys
In the left pane of the Control Center, locate the folder named Table Spaces. Right-click the folder
and select Create. The Create Table Space Wizard appears. To create the table spaces, complete the
following steps.
1.
In the "Specify a Name for Your New Table Space” page, type TS8 and selct I want to manage
my store manually; then click Next.
2.
In the "Specify the Type of Table You Want to Create” page, select Regular and click Next.
3.
In the "Specify a Buffer Pool for Your New Table Space” page, select BP8 and click Next.
4.
In the "Select the Space Management System You Want to Use” page, select System-managed
space (low maintenance) and click Next.
5.
In the "Define Containers for this Table Space” page, Click Add.
6.
Navigate to the DB2 sub-directory where you created the CON8 and CON8sys directories.
For Windows: C:\DB2\NODE0000\
For UNIX and Linux: /opt/IBM/db2/v9.5/containers/
Select the CON8 directory and click OK. Click Next.
7.
In the "Specify the Extent and Prefetch Sizes for this Table Space” page, select Less than 50 MB
in the Determining Recommended Settings section. This should result in an Extent size of 8
and a Prefetch size of 8. Click Next.
8.
In the "Describe Hard Drive Specifications” page, Even if the High-Performance Server is
selected, click this option again. This should result in an Overhead setting up 10.5 and a Transfer
setting of 0.14. Click Next.
9.
In the "Specify the Dropped Table Recovery Option for Your New Table Space” page, select
Enable dropped table recovery. Click Next.
10. When the summary page appears, review your selections and click Finish.
11. Next, create an 8k system table space. In the left pane of the Control Center, right-click Table
Spaces and select Create. The Create Table Space Wizard appears. To create the table spaces,
complete the following steps.
46
12. In the "Specify a Name for Your New Table Space” page, type TS8sys in the Table space name
box. In the Comment box, type system temp tablespace and click Next.
13. In the "Specify the Type of Table You Want to Create” page, select System Temporary and click
Next.
14. In the "Specify a Buffer Pool for Your New Table Space” page, select BP8 and click Next.
15. In the "Select the Space Management System You Want to Use” page, select System-managed
space (low maintenance) and click Next.
16. In the "Define Containers for this Table Space” page, Click Add.
17. Navigate to the DB2 sub-directory where you created the CON8 and CON8sys directories.
For Windows: C:\DB2\NODE0000\
For UNIX and Linux: /opt/IBM/db2/v9.5/containers/
Select the CON8sys directory and click OK. Click Next.
18. In the "Specify the Extent and Prefetch Sizes for this Table Space” page, select Less than 50 MB
in the Determining Recommended Settings section. This should result in an Extent size of 8
and a Prefetch size of 8. Click Next.
19. In the "Describe Hard Drive Specifications” page, Even if the High-Performance Server is selected,
click this option again. This should result in an Overhead setting up 10.5 and a Transfer setting of
0.14. Click Next. When the summary page appears, review your selections and click Finish.
20. Finally grant ’use’ privileges to the xPression database user. Select Table Spaces from the left
console pane. Select the TS8 table in the list of table spaces. Right-click TS8 and select Privileges.
21. Click Add User and select your xPression database user from the list. Click OK. The xPression
database user name should appear in the list.
22. Select the xPression database user name and click Grant All.
23. In the "Select Grant Option” box, select With Grant option and click OK.
24. From the "Privileges: USE” drop-down box, select Grant. Notice that two check marks now
appear behind the xPression database user name in the list.
25. Click OK.
Step Five: Run xPression Database Scripts
In this step you will execute two scripts from the Windows command line. The first script creates all
the xPression database tables. The second script supplies a set of base data for the xPression database.
Do not run these scripts in Interactive mode. These scripts are located in your software installation or
upgrade package. They are not available for download on Support Zone.
1.
Start the IBM DB2 Command Line Processor by running the following command from a
command prompt: db2cmd. Linux users can skip this step and enter the DB2 commands directly
from the command line.
2.
Log on using the new user name you created in Step Three: Create a New Database User, page
43. For this example we will call this the <XPRESSION DATABASE USER NAME>.
47
If you do not log on to db2 as the xPression database user, the xPression database tables will be
created under the wrong schema and xPression will fail to run.
db2 connect to <XPRESSION DATABASE NAME> user <XPRESSION DATABASE USER
NAME> using <PASSWORD>
For example:
db2 connect to xpresscr user xpress using xpress
3.
Run the following xPression database scripts in order:
• <xPression CD>\Cr_Scripts\DB2_install.ddl
• <xPression CD>\Cr_Scripts\DB2_basicdata.ddl
EMC Document Sciences supplies these scripts for you. Ensure you are using the DB2 version of
the scripts. If you are running the installation from a network location, supply the path to the
network location where you copied the files from your xPression installation CD.
To run the scripts, use the following command:
db2 -vtf <PATH>/<SQL Script Name>
For example: db2 -vtf D:\Cr_Scripts\DB2_install.ddl
For UNIX, AIX, or Linux, use the following paths and substitute the specific mount point for
your UNIX CD drive.
db2 -vtf /xPressionCD/Cr_Scripts/DB2_install.ddl
You can send the screen display to a log file for review. Simply add the following text to the
paths shown in step 2.
-z C:\CRInstall.log
For example:
db2 -vtf D:\Cr_Scripts\DB2_install.ddl -z C:\CRInstall.log
The -z parameter will create the log file if it does not exist. If it does exist, it will append the
log to the end of the existing file.
4.
If you are using Satori Software’s Bulk Mailer volume mailing preparation software with
xPression and need support for Canada or the United Kingdom, you must run the following
scripts to add new fields to your data source:
• DB2_Satori_Fields_CA.ddl
• DB2_Satori_Fields_UK.ddl
5.
When finished, proceed to Step Six: Test the xPression Database, page 48.
Step Six: Test the xPression Database
To ensure that your xPression database was created correctly, validate that you are able to successfully
query data from a xPression database table.
1.
Query a table from the xPression database. For this test we will query a table named t_locale.
Type:
db2 select * from t_locale
48
2.
If the query returns data from the t_locale table, then the xPression database was installed
correctly. The query results should look similar to the following example.
LOCALECODE DESCRIPTION ISSYSTEMDEFAULT
en_US
English
1
de_DE
German
fr_FG
French
es_ES
Spanish
3.
When finished, proceed to Step Seven: Modify Database Configuration, page 49.
Step Seven: Modify Database Configuration
Some of the default settings for your new database are not sufficient for xPression’s needs. You
need to increase the size of the following parameters located in the database configuration file. You
can increase these parameters to a higher level than we are recommending if the complexity of
your applications warrants such an increase.
• Modifying a DB2 Database Configuration, page 49
• Setting resultSetHoldability attribute for DB2, page 89
Modifying a DB2 Database Configuration
To modify the database configuration using the command line, complete the following steps:
1.
If it is not already running, start the IBM DB2 Command Line Processor and log on to the
xPression database as the user you created in Step Three: Create a New Database User, page 43.
2.
Change the values of these parameters with the following command:
db2 update database configuration for <XPRESSION DATABASE NAME> using logfilsiz 2000
In this example, <XPRESSION DATABASE NAME> is the name of the database you created in
Step Two: Create a New DB2 Database, page 41.
3.
For this change to become effective, you must disconnect from the database:
db2 terminate
4.
When finished, proceed to the Post-Installation Tasks.
Step Eight: Back Up Your Database
While this step is optional, EMC Document Sciences recommends that you back up your database at
this time. The best time to back up your new xPression database is immediately after completing your
database installation. Contact your database administrator for assistance in backing up your database.
49
Step Nine: Enable Full-Text Searching
You must configure full-text searching on your database to enable text searching in xPression.
Full-text searching requires that you install the DB2 Text Search component. DB2 Text Search is an
optional component included with the installation of all DB2 database server products.
Create DB2DBDFT Environment Variable
db2text.exe requires that you create the DB2DBDFT environment variable on your system.
Create DB2DBDFT Variable on Windows
To create the variable for Windows:
1.
Right-click My Computer and select Properties.
2.
Select the Advanced tab and click the Environment Variables button.
3.
Click New in the System Variable section.
4.
In the Variable name box, type: DB2DBDFT
The variable name is case-sensitive.
5.
In the Variable value box, type: <XPRESSION_DATABASE_NAME>where <XPRESSION
_DATABASE_NAME> is the name of the xPression database you created in Step Two: Create a
New DB2 Database, page 41.
6.
Click OK.
Create DB2DBDFT on UNIX and Linux
For UNIX and Linux systems:
Set the following environment variable:
$ DB2DBDFT = <XPRESSION_DATABASE_NAME>
$ export DB2DBDFT
Where <XPRESSION_DATABASE_NAME> is the name of the xPression database you created in Step
Two: Create a New DB2 Database, page 41. The variable name is case-sensitive.
Enable Full-Text Search
Before performing this step, ensure you are logged in as the database administrator.
To enable full-text searching:
1.
50
After creating the environment variable, type the following command from the command
line:db2text start
2.
From the command line, type:
db2text enable database for text
3.
db2text create index <xPression database User Name>.text_index on
<xPression database User Name>.t_textdata(data) for text
Replace <xPression database User Name> with the name of your xPression database. For example:
db2text create index xpress.text_index on xpress.t_textdata(data) for
text
4.
db2text create index <xPression database User Name>.text_index2 on
<xPression database User Name>.t_ruleelement(detail) for text
Replace <XPRESSION_DATABASE_USERNAME> with the name of your xPression database. For
example:
db2text create index xpress.text_index2 on xpress.t_ruleelement(detail)
for text
5.
db2text update index <XPRESSION_DATABASE_USERNAME>.text_index for text
6.
db2text update index xpress.text_index2 for text
xPression requires that you set up the indexing engine to run automatically on the server that hosts
your DB2 xPression database. The indexing engine should always be running. To start the index
server on the DB2 computer, use the db2text start command.
The update index commands used in steps five and six above enable you to search your content for
specific words. The content search function will only find words that existed in your content at the
time of your last update. For this reason, you should update the indexes frequently or set up your
database to automatically update your indexes.
Automatically Updating Your Index
By default, the full-text search index does not automatically update itself. You need to either perform
manual updates frequently, or you can set up an automatic update for your text search index using
the Alter Index command. For example, to update the index Monday through Friday at noon and
again at 5:00pm, you would type:
DB2TEXT ALTER INDEX XPRESSION.text_index FOR TEXT UPDATE FREQUENCY
D(1,2,3,4,5) H(12,17) M(00)
Caution: Be aware that automatic updates can adversely impact database performance.
Automatic updates should only be set up by database administrators. EMC Document Sciences
recommends that you consult your DB2 documentation for more information about indexing.
51
Auditing Your xPression Database
You can set up triggers in your xPression database to audit tables and extract information. You can
set up triggers to capture any information you want to gather. For example, you can set up triggers
to capture information about which user last changed a work item. This information would assist
in debugging by identifying who made the changes, and would also enable you to verify proposed
changes with the previous user.
Your database administrator can set up the triggers to gather the desired information.
DB2 Stopwords
Stopwords are common words that are not indexed by the database and therefore cannot be searched
for through a full-text search. This list is controlled by your database vendor. For the purposes of
full-text searching, xPression ignores all stopwords. To view the list of stopwords for DB2, see the
stopword list <LANGUAGE>.tsw in ..sqllib/db2ext/resources
where <LANGUAGE> is the LANGUAGE value from the CREATE INDEX command. We don’t set
this parameter while creating the index, so it follows the default value. The default value is from the
DB2EXT.DBDEFAULTS view where DEFAULTNAME=’LANGUAGE’.
DB2 Limitations
Be aware of the following DB2 limitation. Because DB2 does not support the use of dashes in database
names, ensure you do not use dashes when naming your xPression database.
52
Chapter 3
This chapter contains complete installation and configuration instructions for installing the xPression
database on an Oracle database. At this point in the installation, you should have:
• Reviewed the System Requirements chapter of the xPression Release Notes.
In an non-clustered environment, each xPression installation has an xPression database. For a
clustered environment, a same xPression database is used by the computers participating in the
cluster.
Overview of xPression Database Installation
1.
Create a new database for the xPression database.
2.
Create an xPression user for the xPression database and run the provided xPression database
SQL installation scripts.
3.
Validate that the xPression database is installed properly by querying data from a table.
4.
You can optionally modify the database configuration file parameters based on the needs of
your system and documents.
Important Information About Oracle Databases
This section contains important information about the use of Oracle with xPression.
53
Using Oracle with Other Databases
If you use Oracle as your xPression database, ensure that you avoid using DB2 relational databases to
supply customer data to the xPression Server. You may encounter an issue where you are unable to
retrieve customer data. EMC Document Sciences recommends against using this configuration.
The Oracle Client Application
EMC Document Sciences recommends that you install your Oracle database client application on
your xPression Server. Installing the client on your server generally simplifies the configuration
process by installing needed files (for example, the Oracle drivers), and helps with debugging.
Oracle Requirement
If you are installing Oracle on a computer that uses Dynamic Host Configuration Protocol (DHCP), or
on an offline computer that you plan to connect to a network after the installation, Oracle requires
that you install a loopback adapter.
Ensure that your environment meets this requirement before beginning the xPression database
installation.
For more information, see the Oracle Database Installation Guide.
Migration Limitation
Multi-byte (non-ASCII) characters in Oracle are handled as three-byte characters. Therefore, when
migrating content from other databases, adjust the Oracle maximum length for fields containing
multi-byte characters accordingly.
Step One: Create a New Database
The xPression database must support Universal Transport Format 8 (UTF-8).
The only requirement xPression places on a default Oracle database is that, you must use AL32UTF8
– Unicode UTF-8 Universal character set as the database character set. Ensure that your database
conforms to this requirement.
xPression supports container databases (CDB), non-container databases (non-CDB), and pluggable
databases (PDB). However, EMC Document Sciences recommends you to use PDB as xPression
database.
54
Step Two: Create a New Database User
You can create either a common user or a local user. Ensure that the users have the following
privileges and roles to the database that you use as xPression database:
• CONNECT
• RESOURCE
• CREATE VIEW
• UNLIMITED ON <tablespace>
The user name should meet the following requirements:
• In a non-CDB, a user name must NOT begin with “C##” or “c##”.
• In a CDB of Oracle Database 12c Release 1 (12.1.0.1), a common user name must begin with “C##”
or “c##”, while a local user name must NOT.
• In a CDB version higher than Oracle Database 12c Release 1 (12.1.0.1), a common user
name must begin with case-insensitive characters that match the prefix specified by the
COMMON_USER_PREFIX initialization parameter. By default, the prefix is “C##”. A local user
name must NOT begin with “C##” or “c##”.
You can use either of the following methods to create a new Oracle user:
• Creating the User with SQL Plus, page 55
• Creating the User from the Oracle Enterprise Manager Database Express, page 56
Creating the User with SQL Plus
To create a user with SQL Plus, complete the following steps:
1.
Start SQL Plus with sqlplus \nolog.
2.
Log on to the database you created in as a System user.
3.
Update the container to a PDB if you want to connect to the PDB:
SQL> alter session set container=ServiceNameForPDB;
4.
To create a new user, use the "create user" command as follows:
SQL> create user New_User identified by PASSWORD default tablespace
USERS temporary tablespace TEMP;
For example, if the new user name is XPRESS, you would type the following commands:
SQL> create user XPRESS identified by XPRESS default tablespace USERS
temporary tablespace TEMP;
5.
Grant roles and permissions to the new user:
• SQL> grant connect to New_User;
• SQL> grant resource to New_User;
55
• SQL> grant create view to New_User;
• SQL> ALTER USER New_User QUOTA UNLIMITED ON default_tablespace;
where New_User is the user you created in step 4, and default_tablespace is the default tablespace
that you want to use.
6.
Exit from SQL Plus:
SQL> exit
Creating the User from the Oracle Enterprise Manager
Database Express
Oracle Enterprise Manager Database Express (EM Express) is a web-based database management
tool that is built inside the Oracle Database. Refer to the Oracle Online Help for how to configure
it if you do not have access.
To Create the User from Oracle EM Express
1.
Log on to Oracle Enterprise Manager Database Express.
2.
Locate the Security tab and click Users.
3.
On the Users page, click Create User.
4.
Supply the following settings on the User Account tab.
• Name—Supply the user name from the local operating system that you want to use for the
xPression database.
• Authentication—Select Password, unless another selection is required in this installation.
• Enter Password—Type the password for your xPression database user.
• Confirm Password—Confirm the password of your xPression database user.
• Profile—Select DEFAULT, unless another selection is required in this installation.
5.
Supply the following settings on the Tablespaces tab.
• Default Tablespace—Select USERS from the list.
• Temporary Tablespace—Select TEMP from the list.
6.
On the Privilege tab, all the existing roles are listed on the left area of the page. Add CONNECT,
RESOURCE and CREATE VIEW to right area of the page.
7.
Click OK to create the user.
8.
Switch to the Quotas tab and select the default tablespace. Specify the Quota field as Unlimited.
When completed, proceed to Step Three: Run xPression Database Scripts, page 57.
56
Step Three: Run xPression Database Scripts
In this step you will run two scripts from SQL Plus. The first script creates all the xPression database
tables. The second script supplies a set of base data for the xPression database. These scripts are
located in your software installation or upgrade package.
To Run the Scripts
1.
If necessary, start SQL Plus and log on to the database you created in Step One: Create a New
Database, page 54 as the xPression database user you created in Step Two: Create a New
Database User, page 55.
2.
Run these xPression database scripts in the following order.
• Ora_install.sql
• Ora_basicdata.sql
Ensure you are using the Oracle version of the scripts. Supply the full path and file name for
each script as follows:
SQL> @<PATH>\<Script Name>
For example:
SQL> @D:\Cr_Scripts\Ora_install.sql
For UNIX or Linux, use the following path and substitute the specific mount point for your
CD drive:
SQL> @/xPressionCD/Cr_Scripts/Ora_install.sql
3.
• ORA_Satori_Fields_CA.sql
• ORA_Satori_Fields_UK.sql
4.
Exit from SQL Plus: SQL> exit
Caution: If you do not log on as the xPression database user, the xPression database tables will
be created under the wrong schema and xPression will fail to run.
When finished, proceed to Step Four: Test the xPression Database, page 57.
Step Four: Test the xPression Database
To ensure that your xPression database was created correctly, validate that you can successfully query
data from a xPression database table by using the following procedure:
1.
If necessary, start SQL Plus and log on to the database you created in Step One: Create a New
Database, page 54 as the xPression user you created in Step Two: Create a New Database User,
page 55.
57
2.
Query a table from the xPression database. For this test we will query a table named t_locale.
SQL> select * from t_locale;
3.
The query should return a list of locales. If the query returns data from the t_locale table, then the
xPression database was installed correctly.
LOCALECODE
------------------------------------------------------------DESCRIPTION
------------------------------------------------------------ISSYSTEMDEFAULT
--------------en_US
English
1
de_DE
German
LOCALECODE
-----------------------------------------------------------DESCRIPTION
------------------------------------------------------------ISSYSTEMDEFAULT
--------------fr_FR
French
es_ES
Spanish
Your list of locales may be different than the locales displayed in this sample.
4.
Exit from SQL Plus:
SQL> exit
When finished, proceed to Step Five: Back Up Your Database, page 58.
Step Five: Back Up Your Database
The best time to back up your new xPression database is immediately after completing Step Four
above. Contact your database administrator for assistance in backing up your database.
Step Six: Configure Full-Text Searching
To Configure Full-Text Searching with Oracle
1.
After installing Oracle, the CTXSYS user is locked by default. Ensure this user is unlocked before
configuring full-text searching.
2.
If necessary, start SQL Plus and log on to the database you created in as the CTXSYS user. The
password for the CTXSYS user is CTXSYS.
3.
Grant the object privilege to the xPression database user.
grant EXECUTE on CTXSYS.CTX_DDL to XPRESSION_DATABASE_USER;
58
where XPRESSION_DATABASE_USER is the user you created in
4.
Log out of SQL Plus.
5.
Restart SQL Plus and log in as the xPression database user. This is the user you created in
6.
Create a reference for WORLD_LEXER by typing the following command.
exec CTX_DDL.CREATE_PREFERENCE('my_lexer', 'WORLD_LEXER');
The WORLD_LEXER lexer type includes automatic language detection in documents, enabling
you to index multilingual documents without having to include a language column in a base table.
7.
Create a full-text index on XPRESSION_DATABASE_USER.T_TEXTDATA(data) by typing the
following command:
create index text_index on t_textdata(data) indextype is CTXSYS.CONTEXT
PARAMETERS('LEXER my_lexer SYNC(ON COMMIT)')PARALLEL num_of_CPUs;
where PARALLEL num_of_CPUs is performance enhancing parameter that should only be used
if your database resides on a server with more than one CPU. If your database server does contain
more than one CPU, type the PARALLEL parameter followed by the number of CPU.
8.
Create a full-text index on XPRESSION_DATABASE_USER.T_RULEELEMENT(detail) by
typing the following command:
create index text_index2 on t_ruleelement(detail) indextype is CTXSYS.CONTEXT
PARAMETERS('LEXER my_lexer SYNC(ON COMMIT)')PARALLEL num_of_CPUs;
where PARALLEL num_of_CPUs is performance enhancing parameter that should only be used
if your database resides on a server with more than one CPU. If your database server does contain
more than one CPU, type the PARALLEL parameter followed by the number of CPU.
9.
Exit from SQL Plus:
SQL> exit
For Windows Installations
Ensure that your registry setting for ORACLE_HOME is set to the correct location used by Oracle. If
these directories are not synchronized, the xPression database installation will fail to create tables for
the xPression database user.
The following registry setting should point to the same directory Oracle uses on your file system:
HKEY_LOCAL_MACHINE > SOFTWARE > ORACLE > KEY_oracleKey>ORACLE_HOME
59
Oracle Stopwords
full-text searching, xPression ignores all stopwords. See your Oracle documentation for a full list of
stopwords for each supported language.
60
Chapter 4
Step One: Configure SQL Server
Database
This chapter contains complete installation and configuration instructions for installing the xPression
database on a SQL Server database. At this point in the installation, you should have:
• Reviewed the System Requirements chapter of the xPression Release Notes available on
https://support.emc.com.
In an non-clustered environment, each xPression installation has an xPression database. For a
clustered environment, one xPression database is used by the computers participating in the cluster.
Note: SQL Server Express Edition does not support full-text searching and is not recommended
for use with xPression.
The SQL Server Client Application
EMC Document Sciences recommends that you install your SQL Server database client application
on your xPression Server. Installing the client on your server generally simplifies the configuration
process by installing needed files (for example, the SQL Server drivers), and helps with debugging.
61
Database Authentication
xPression supports SQL Server authentication for all application servers. Windows authentication is
supported for JBoss application servers installed on a supported Windows operating system. Also,
the user ID that logs into the system must contain a password.
Configuring Windows Authentication
Windows authentication is supported for JBoss application servers installed on a supported Windows
operating system. If you want to use Windows authentication, you must make some manual changes
to your configuration.
1.
Locate sqljdbc_auth.dll in your JDBC driver directory. Copy this file to C:\Windows\System32.
2.
Select “Windows authentication” when creating your database user logins. This step is performed
in Step Two: Create a New Database User, page 64. The user must be authenticated on the
Windows machine.
3.
You must make a manual change to your JBoss datasource configuration file. This step is
performed after installing the xPression Server. See Windows Authentication with Microsoft
SQL Server, page 122 for full details.
SQL Limitations and Known Issues
Review the following list of SQL Server limitation and known issues.
Full-Text Search Limitation
When you run SQL Server full-text searches, the search may not return the correct results if there is
no blank space between a word and its HTML tag.
Use the following sample T_TEXTDATA as an example.
 Type: Web Page Title: Microsoft Security Bulletin (MS01-060)
 Author: Microsoft ; Type: Web Page Title:
Microsoft Security Bulletin (MS01-060) Author: Microsoft ;
 Title: Microsoft Security Bulletin (MS01-060) Author: Microsoft ;
Title: Microsoft Security Bulletin (MS01-060) Author: Microsoft
If you run the following query after the full-text index is created and populated, the query only
returns rows with row_num 2 and 4:
select * from T_TEXTDATA where contains(DATA, ’MS01-060’)
Row_Num=2 is returned because there is a blank space between the parenthesis and the HTML
( ) tag.
Row_Num=4 is returned because it does not contain any HTML tags.
62
This happens because the English word breaker does not perform HTML filtering. Instead, it looks at
the text and applies the rules of the English language.
Merant Drivers for SQL Server
The Merant Sequelink JDBC drivers are not certified for xPression. EMC Document Sciences
recommends using the Microsoft JDBC SQL Server drivers.
Step One: Create a New Database
You must create a new database for the xPression database. EMC Document Sciences strongly
recommends that you create a new database for xPression database. During the setup process, you
will modify the database configuration file. These modifications impact the entire database and could
adversely affect any existing objects.
Create a New Database on SQL Server
To create the xPression database, start the Microsoft SQL Server Management Studio and complete
1.
Log in as the database system administrator.
2.
Expand the server instance where you want to create your new database, right-click the
Databases folder and select New Database.
3.
The New Database page appears.
In the Select a page panel you can see the General, Options, and Filegroups pages listed. The
General page appears by default.
On the General page, supply the following information.
4.
Option
Definition
Database name
Supply a name for your database. In this document we will use
the name xpresscr.
Owner
Leave at the default setting.
Use full-text indexing
Select this option.
Database files list
By default you should see a Data and Log file entry in this list.
SQL Server Management Studio will prepend these file names
with the data base name you provided. You can accept these file
names or change them.
In the Select a page panel, click Options. The Options page appears. On the Options page,
supply the following information.
63
Option
Definition
Collation
The collation you select must be case insensitive. Document
Sciences recommends SQL_Latin1_General_CP1_CI_AS.
If you are using xPressForms or xPression Catalog and also want
to use non-English text in the xPressForms and xPression Catalog
application, you must ensure the Collation setting specifies a
collation that can process the non-English characters. For more
information about SQL Server collations, see the Microsoft MSDN
Library
Recovery model
Full
Compatibility level
Leave this setting at the default value.
Other options
In the Other options section, locate the Miscellaneous section.
Locate the item for ANSI NULL DEFAULT.
Change this value from False to True.
Click OK. The new database should now appear under the Databases folder in the Microsoft SQL
Server Management Studio.
Step Two: Create a New Database User
From the SQL Server Management Studio, expand the instance where your new xPression database
resides and complete the following steps:
1.
Expand the Security folder.
2.
Right-click Logins and select New Login.
3.
The New Login page appears.
From the Select a page panel you can select General, Server Roles, User Mapping. Securables,
and Status to view different options. The General page displays by default.
On the General page, supply the following options.
• Login name — Supply a login name for your new user. For this document, we will use the
name xpression.
• Windows authentication or SQL Server authentication:
— If you select SQL Server authentication, supply a password for your user name. You can
also set the following options based on your needs: Enforce password policy, Enforce
password expiration, or User must change password at next login. Consult your SQL
Server documentation for information about these settings.
— If you select Windows authentication, you will need to perform some additional steps. See
Configuring Windows Authentication, page 62 for full details.
• Default database — From the drop-down list, select the new xPression database you created
in Step One: Create a New Database, page 63.
• Default language — Leave at the default setting.
64
4.
Click User Mapping from the Select a page panel. In the top list box, select your xPression
database. In the lower list box, select the db_owner database role.
5.
Click OK.
When finished, proceed to Step Three: Run xPression Database Scripts, page 65.
Step Three: Run xPression Database Scripts
In this step you will execute two SQL scripts that will create all the xPression database tables and
supply the base data for the xPression database. These scripts are located in your software installation
or upgrade package. They are not available for download on Support Zone.
To run the xPression database scripts for xPression, complete the following steps:
1.
If the Microsoft SQL Server Management Studio is still open from the last step, close it. Re-login
to the Microsoft SQL Server Management Studio using the database user name you created in
Step Two: Create a New Database User, page 64.
2.
Expand the Databases folder and right-click the xPression database you created in Step One:
Create a New Database, page 63. Select New Query. The New Query page appears.
Notice the query tool bar at the top of the window and the connection information located on
the right side. Ensure that the Microsoft SQL Server Management Studio is connected to your
xPression database using the database username you created.
3.
To install the xPression database, you will need to run the following SQL scripts:
<xPression CD>\Cr_Scripts\SQL_install.sql
<xPression CD>\Cr_Scripts\SQL_basicdata.sql
4.
Open SQL_install.sql in a text editing program like Notepad and copy the contents into the
blank query window.
Click Execute.
5.
Open SQL_basicdata.sql in a text editing program like Notepad and copy the contents into a
new, blank query window.
Click Execute.
6.
• SQL_Satori_Fields_CA.sql
• SQL_Satori_Fields_UK.sql
7.
When finished, proceed to Step Four: Test the xPression Database, page 65.
Step Four: Test the xPression Database
To ensure that your xPression database was created correctly, validate that you are able to successfully
query data from a xPression database table.
65
Test Your xPression Database on SQL Server 2008
R2/2012
Start the Microsoft SQL Server Management Studio and log on to the new xPression database as the
user you created in Step Two: Create a New Database User, page 64. Complete the following steps.
1.
Ensure you are connected to the xPression database using your database user name.
2.
Expand the Databases folder, right-click your xPression database and select New Query.
3.
Type the following text into the query window:
select * from t_locale
4.
To execute the Query, click Execute.
5.
If the xPression database installation was successful, the query will return data. The exact data
returned may be different on your system.
When finished, proceed to Step Five: Installing Microsoft JDBC Driver, page 66.
Step Five: Installing Microsoft JDBC Driver
If you plan on using Microsoft SQL Server JDBC Driver 4.0 as recommended in this document, you
must download the driver from the Microsoft website.
Microsoft SQL Server JDBC Driver 4.0
This Type 4 driver provides database connectivity through the standard JDBC application program
interfaces (APIs) available in J2EE (Java2 Enterprise Edition). Microsoft SQL Server JDBC Driver
4.0 is a Java Database Connectivity (JDBC) 4.0 compliant driver and runs on Java Development
Kit (JDK) version 1.6.
First, download Microsoft SQL Server JDBC Driver 4.0 to your application server machines. The
driver is available from the Microsoft website.
Next, install the driver on your application server machines.
Note: If you use an early version of Microsoft SQL Server JDBC Driver, documents in languages other
than English are not displayed correctly when the xPression server is installed on WebSphere.
Step Six: Final Configuration Tasks
Complete the final configuration tasks for your database version.
• Determine Port Number, page 67
• Back Up Your Database, page 68
66
Determine Port Number
Some editions of SQL Server 2008 R2/2012 (for example, SQL Server 2012 Express Edition) use a
dynamic port number that is different from the SQL Server default port number 1433. For this reason,
you should always check your database port number for SQL Server 2008 R2/2012.
To determine your port number, complete the following steps:
1.
Start the SQL Server Configuration Manager.
2.
Expand the network configuration item.
3.
Click Protocols for MSSQLSERVER.
4.
In the right pane, ensure that TCP/IP is enabled.
5.
Right-click TCP/IP and select Properties.
6.
Click the IP Addresses tab.
7.
In the IPALL section, look up the value for TCP Port. This is your database port number. Record
this value for use later in the installation process.
Full-Text searching in SQL server requires MS Search Service, which is installed by default. To
enable full-text searching in SQL 2008 R2/2012:
1.
Open Microsoft SQL Server Management Studio.
2.
Expand the SQL Server Group, the element for your database server, the databases folder, and the
xPression database element.
3.
Expand the xPression database element and then Tables.
4.
Locate the T_TEXTDATA table, right-click T_TEXTDATA, point to Full-Text Index, and then
click Define Full-Text Indexing on a table.
5.
Click Next on the opening page of the Full-Text Indexing Wizard.
6.
On the Select an Index page, select PK_T_TEXTDATA_DATA_ID from the Unique index list.
7.
Click Next.
8.
On the Select Table Columns page, select Data.
9.
Click Next.
10. On the Select Change Tracking page, ensure that Automatically is selected.
11. Click Next.
12. On the Select a Catalog page, if a usable catalog is not defined, select Create a new catalog and
then click Next. If one is defined that can be used, click Next and skip the following step.
13. This step applies if creating a new catalog only. On the Define Population Schedules page,
leave all default settings and then click Next.
14. Click Finish.
15. Click Close when wizard reports that the indexing succeeded.
67
16. Locate the T_RULEELEMENT table, right-click T_RULEELEMENT, point to Full-Text Index, and
then click Define Full-Text Indexing on a table.
17. Click Next on the opening page of the Full-Text Indexing Wizard.
18. On the Select an Index page, select PK_ELEMENT_ID from the Unique index list.
19. Click Next.
20. On the Select Table Columns page, select Detail.
21. Click Next.
22. On the Select Change Tracking page, ensure that Automatically is selected.
23. Click Next.
24. On the Select a Catalog page, if a usable catalog is not defined, select Create a new catalog and
then click Next. If one is defined that can be used, click Next and skip the following step.
25. This step applies if creating a new catalog only. On the Define Population Schedules page,
leave all default settings and then click Next.
26. Click Finish.
27. Click Close when wizard reports that the indexing succeeded.
Verify that full-text searching has been enabled by viewing the DATA field in the T_TEXTDATA table
and the DATA field in the T_RULEELEMENT table. The value for Full Text should be TRUE.
Back Up Your Database
The best time to back up your new xPression database is immediately after completing Step Six
above. Contact your database administrator for assistance in backing up your database.
List of Stopwords
full-text searching, xPression ignores all stopwords. Your SQL Server documentation refers to these
words as "noise words".
For a full list of noise words for your database version, see the correct file from the following location:
.../Mssql/Ftdata/Sqlserver/Config.
Noise-word file
Language
Noise.chs
Simplified Chinese
Noise.cht
Traditional Chinese
Noise.dat
Language Neutral
Noise.deu
German
Noise.eng
English UK
68
Noise-word file
Language
Noise.enu
English US
Noise.esn
Spanish
Noise.fra
French
Noise.ita
Italian
Noise.jpn
Japanese
Noise.kor
Korean
Noise.nld
Dutch
Noise.sve
Swedish
69
70
Chapter 5
Step Two: Configure Application
Server Before Installation
You must configure your application servers before you install the xPression server. See the following
topics:
• Configuring WebSphere, page 71
• Configuring WebLogic, page 93
• Configuring JBoss, page 95
Configuring WebSphere
Before you can deploy and configure the xPression Server, you must create a new application server
in your environment. You may also use an existing application server, but the existing server’s
settings must comply with settings described in the following sections.
Note: Your WebSphere Application Server user (the WebSphere service account) must belong to the
administrator group.
• WebSphere Paths, page 71
• Your WebSphere Installation Location, page 72
• Create an xPression Profile, page 72
• Configure the Application Server, page 75
• WebSphere Users and Permissions, page 92
WebSphere Paths
This document makes reference to a number of directories in the WebSphere installation directory.
Because you could have installed WebSphere to a non-default location, this document will use the
WebSphere_install_root variable to represent the WebSphere installation directory. The installation
directory is the path to your AppServer folder.
71
For example, the full path to your ProfileManagement directory may be: C:\IBM\WebSphere
\AppServer\bin\ProfileManagement
This path will be represented as WebSphere_install_root\bin\ProfileManagement in
this guide.
Your WebSphere Installation Location
By default, the WebSphere directory structure is very deep. Consequently, many of the xPression
application files must be placed in a deep WebSphere sub-directory. We must pass the location of
these files to the application server at startup. If the path to these files is too long, the Classpath value
will surpass the Line Length setting (2048) for the CRLINK code. This can cause failures while trying
to assemble or publish xPression documents.
If you are a Windows user and you have not yet installed WebSphere, you can help alleviate the
problem by installing WebSphere to a shorter path. For example, instead of installing WebSphere to
C:\Program Files\IBM\WebSphere, use the following shorter path: C:\WebSphere
If you have already installed WebSphere to a longer path, proceed with the installation.
In Chapter 9, Verifying Your Installation, you will validate your installation. If you receive errors
pertaining to the long WebSphere file paths, this step will provide you with instructions on how
to solve the problem.
Create an xPression Profile
In WebSphere, each server is installed in its own profile. Before you can create a new xPression
server, you must create a profile for that server. If you are using a 32-bit version of WebSphere, use
the Profile Management Tool to create your profile. If you are using a 64-bit version of WebSphere,
use the manageprofiles command.
• Create Profile with the manageprofiles Command, page 72
• Creating a Profile with the Profile Management Tool, page 74
Create Profile with the manageprofiles Command
See the IBM documentation for full information about the manageprofiles command. The following
instructions describe how to create a profile for the xPression Server.
1.
Open a command prompt and navigate to the following directory:
WebSphere_install_root\bin
2.
Run the manageprofiles.bat or manageprofiles.sh command using the following parameters:
• create—Creates a profile. This parameter requires no value.
• templatePath—Specifies where the templates are located. Supply the path to the template file
for this parameter.
72
• profileName—Specifies the name for your new profile.
• profilePath—The path to the desired location for your new profile.
For example:
manageprofiles.bat -create -templatePath "WebSphere_install_root\
profileTemplates\default" -profileName profile_name -profilePath
"WebSphere_install_root\profiles\profile_name"
where profile_name is the name you chose for the profile.
Type the command, including all parameters, and press Enter.
3.
If the command was successful, you should receive the following message:
INSTCONFSUCCESS: Success: Profile profile_name now exists.
To delete a profile from the command line, see Deleting a Profile from the Command Line,
page 74.
4.
If you are a Windows user, continue to set up the profile as a Windows service.
Setting Up a Profile as a Windows Service
To create a Windows service to run the profile manually, complete the following steps:
1.
Open a command window, and navigate to the following location:
2.
Type the following command:
WASService.exe -add profile_name -servername server1 -profilePath
"WebSphere_install_root\profiles\profile_name" -wasHome "WebSphere_install
_root" -logFile "WebSphere_install_root\profiles\
profile_name\logs\WS_startServer.log" -logRoot "WebSphere_install_root
\profiles\profile_name\logs\server1" -restart true
3.
Press Enter.
4.
If successful, you will see the following message:
Adding Service:profile_name
Config Root:WebSphere_install_root\profiles\profile_name\config
Server Name: server1
Profile Path: WebSphere_install_root\profiles\profile_name
Was Home: WebSphere_install_root\
Start Args:
Restart: 1
5.
Open Windows Services, and locate the IBM Windows service named IBM WebSphere
Application Server V8.5 – profile_name.
6.
Right-click the service and select Properties. Ensure the Startup type is set to Automatic.
7.
Click the Log On tab, and select the option to log on as a specific account. Use the username and
password for the account that installed WebSphere.
8.
Click OK, and start the server.
73
Deleting a Profile from the Command Line
To delete a profile by using the command line, complete the following steps:
1.
Open a command prompt and navigate to WebSphere_install_root\bin
2.
Run the following command:
manageprofiles.bat -delete -profileName profile_name.
3.
If the profile is successfully deleted, you will receive the following message:
INSTCONFSUCCESS: Success: Profile profile_name no longer exists.
4.
Delete the profile home directory.
Deleting a Window Service
To delete a Windows service, complete the following steps:
1.
Navigate to the following location:
2.
WASService.exe -remove profile_name
3.
If successful, you will see the following message:
Remove Service: profile_name Successfully removed service
Creating a Profile with the Profile Management Tool
To create a WebSphere Profile by using the Profile Management Tool, complete the following steps:
1.
Select IBM WebSphere > IBM WebSphere Application Server > Tools > Profile Management
Tool from Windows Start menu. The Profiles page appears, showing all existing profiles.
2.
Click Create. The Environment Selection page appears.
3.
Ensure Application Server is selected and click Next. The Profile Creation Options page appears.
4.
Select Advanced profile creation and click Next. The Optional Application Deployment page
appears.
5.
Clear the Deploy the default application check box and click Next. The Profile Name and
Location page appears.
6.
Type a name for your profile in the Profile Name box. Unless you have a need to move the profile
directory to a different location, use the default path. Record this path for future reference. You
will need this information later in the installation process.
Note: When you change the profile name, WebSphere does not automatically update the default
profile directory path. You will need to change the name of the last subdirectory in the profile
directory path. For example: C:\WebSphere\AppServer\profiles\xPressionProfile
74
7.
Click Next. The Node and Host Names page appears. Supply a name for the Node. You can use
any name, for example, xPressionNode. Leave the default value for Host name, and click Next.
8.
If you want to enable administrative security, ensure that Enable Administrative Security is
selected. Define the username and password, and click Next. The Security Certificate (Part
1) page appears.
9.
Leave all options at their default value and click Next. The Security Certificate (Part 2) page
appears.
10. Type a new Keystore password, and click Next. The Port Values Assignment page appears. This
page displays port value assignments for the profile. WebSphere ensures that these ports do not
conflict with other WebSphere profiles, but it does not ensure that the ports do not conflict with
other applications or another WebSphere installation.
11. Verify that ports selected for you are unique. If the selected value is not unique or if you prefer to
use a different port, you can change the port value assignments from this page.
Record the following port numbers for future reference and click Next. You will need this
information later in the installation process: Administrative Console Port, Administrative
Console Secure Port, HTTP Transport Port, and Bootstrap Port.
12. The Windows Service Definition page appears. Leave all values at their default level and click
Next.
13. The Web Server Definition page appears. Leave all values at their default level and click Next.
14. The Profile Creation Summary page appears. Click Create.
The Profile creation wizard will begin creating and configuring your profile. When the Profile
creation wizard completes, select the Launch the First steps console option, and click Finish.
On the First steps page, EMC Document Sciences recommends running the Installation Verification
feature to ensure that your profile is set up correctly. Then, proceed to Configure the Application
Server, page 75.
Configure the Application Server
This section contains the following instructions for configuring the application server:
• Start Your Server, page 76
• Start the WebSphere Administrative Console, page 77
• Configure WebSphere Variables, page 77
• Set Class Loading Mode, page 80
• Set Transaction Timeout, page 80
• Enable Pass By Reference, page 80
• Set Host Alias, page 81
• Add Image to MIME Type on WebSphere, page 81
• Configure JVM Settings, page 81
75
• Configure Data Sources, page 83
• Deploy the xPression Enterprise Archive File, page 89
Start Your Server
To install the xPression managed server, you must first start the administrative server. If you ran the
installation verification and it was successful, the server will already be started. Click the Start the
server link on the First Steps page to start the administrative server for the xPression profile. You can
also use any of the following methods to start the server.
For Windows, use either of the following ways:
• Click Start the Server from the WebSphere program group in the Windows Start Menu.
• Open a command prompt and navigate to the following folder:
WebSphere_install_root\profiles\xPressionProfile\bin
Type the following command using the name of your administrative server:
startserver.bat server1
where server1 is the default name of the administrative server.
For Linux
1.
Navigate to the following folder:
WebSphere_install_root/profiles/xPressionProfile/bin/
2.
nohup ./startServer.sh server1 &
The nohup statement prevents the process from being shut down when you exit your shell.
server1 is the default name of the administrative server.
The ampersand (&) enables the script to be executed in the background, returning access to
your shell.
For UNIX
1.
Navigate to the following folder:
WebSphere_install_root/profiles/xPressionProfile/bin/
2.
Assuming that your UNIX administrator made arrangements for non root users to start the
server, you can use the following command:
nohup ./startServer.sh server1 &
The nohup statement prevents the process from being shut down when you exit your shell.
server1 is the default name of the administrative server.
The ampersand (&) enables the script to be executed in the background, returning access to
your shell.
76
Start the WebSphere Administrative Console
After the server has started, click the Administrative console link from the First Steps page. When
you start the administrative console, you will be asked to provide a user ID. This ID only persists
for the duration of the session in which it is being used. Server configuration changes are saved to
the user ID.
If you need to start the administrative console at a later time, use any of the following methods:
Operating System
Instructions
Windows
On Windows machines, you can start the console by clicking the
Administrative Console shortcut in the Start Menu program
group for your WebSphere profile.
Linux and UNIX
You can start the console opening a web browser and typing
the following URL:
http://<fully_qualified_server_name>:<administrative_port>/ibm
/console
where <fully_qualified_server_name> is the fully qualified host
name for the machine that contains the administrative server,
and <administrative_port> is the port number WebSphere assigned
for your administrative console.
When the administrative console is on the local machine, you can
use localhost unless security is enabled.
Configure WebSphere Variables
To simplify the configuration and future maintenance of xPression, you can use WebSphere Variables
to represent several network paths.
In the left console pane, expand Environment and click WebSphere Variables. Ensure that the node
you defined for xPression is selected in the Scope section. If you are using WebSphere ND (Network
Deployment), select Server instead of Node.
Define the following variables:
• USER_INSTALL_ROOT Variable, page 78
• JAVA_HOME Variable, page 78
• XPRESSIONHOME Variable, page 78
• XPRESSION_EAR Variable, page 78
• Database Driver Variable, page 79
77
USER_INSTALL_ROOT Variable
Navigate the variable list to locate USER_INSTALL_ROOT. Ensure that the value for this variable
coincides with the path to your xPressionProfile directory. For example, on Windows:
WebSphere_install_root\profiles\xPressionProfile
For UNIX or Linux systems:
WebSphere_install_root/profiles/xPressionProfile
JAVA_HOME Variable
Locate the JAVA_HOME variable and ensure that the value coincides with the path to the WebSphere
Java directory.
This WebSphere Java directory is a sub-directory of your WebSphere AppServer directory. For
example, on Windows:
${WAS_INSTALL_ROOT}/java
XPRESSIONHOME Variable
In the variable list table, click New to create an XPRESSIONHOME variable. Define the following
settings:
Setting
Definition
Name
XPRESSIONHOME
Value
Type the path where you intend to install the xPression Server. You
can install xPression in any directory, but EMC Document Sciences
recommends the following default locations.
For Windows: C:\xPression
For UNIX and Linux: /xPression/
Description
xPression Home Directory
XPRESSION_EAR Variable
Create a variable for the location where you will place the xPression enterprise archive file. This path
does not yet exist on your system. Click New and define the following settings.
Setting
Definition
Name
XPRESSION_EAR
78
Setting
Definition
Value
Type the path of the directory where WebSphere deploys the enterprise
archive file for your profile and add xPression.ear to the end of the
path. For example:
For Windows:
xPression_profile_directory\installedApps\{CELL}
\xPression.ear
For UNIX and Linux:
xPression_profile_directory/installedApps/{CELL}
/xPression.ear
Replace {CELL} with the name of the cell in which the server is running.
Description
xPression EAR location
Database Driver Variable
You must configure a variable for the path to your xPression database driver. The path to your
database drivers will differ depending on where you installed your database client or driver package.
The examples shown in this section use the default driver locations and may be different than the
actual locations on your system.
Consult the following table to determine which name you should use for your variable. All of these
variable names should exist in the variable list. If the variable for your database does not exist,
create it.
Driver
Variable
DB2
DB2_JDBC_DRIVER_PATH
Oracle
ORACLE_JDBC_DRIVER_PATH
SQL Server
MICROSOFT_JDBC_DRIVER_PATH
In the Value box for your database driver variable, supply the path to the database driver you want
to use. The following tables shows examples.
Note: Ensure that you only supply the path to the database drivers. Do not include the actual driver
filenames.
Database Driver Path
Path
DB2
Supply the path to the directory where you installed your DB2 drivers.
For Windows:
C:\Program Files\ibm\SQLLIB\java\
For UNIX or Linux:
/ibm/SQLLIB/java
79
Database Driver Path
Path
Oracle
Supply the path to the directory where you installed your Oracle
drivers.
For example:
Oracle_Install_Root\jdbc\lib
SQLServer
Specify the directory where the driver file is located. For example:
SQLServerDriver_installation_dir\driver_version\enu\
Set Class Loading Mode
To configure your new xPression server, expand Servers in the left pane of the administrative console
and select Server Types > WebSphere application servers. By default, your xPression profile will
contain a server named server1. This server will appear in the Application servers list. Click the
server1 link to edit the configuration of the server. The Configuration page appears.
To set the class loading mode:
1.
Locate the General Properties > Server-specific Application Settings section.
2.
Select Single from the Classloader policy list, and ensure the Class loading mode is Classes
loaded with parent class loader first.
Note: If you are using xPression Web Services, set the Classloader policy to Multiple.
3.
Click Apply.
Set Transaction Timeout
To set the transaction timeout:
1.
With the server configuration page still open, locate the Container Settings section.
2.
Expand Container Services and click Transaction Service.
3.
On the Transaction Service page, set Total transaction lifetime timeout to 3600.
4.
Set Maximum transaction timeout to a value greater than or equal to the Total transaction
lifetime timeout, and save your changes.
Enable Pass By Reference
In many cases, xPression performance is improved when WebSphere Pass By Reference setting is
enabled. Refer to http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/topic/com.ibm.websphere
.base.doc/info/aes/ae/uorb_rsetg.html for detailed information about the Pass By Reference option.
80
To Set Pass By Reference on WebSphere:
1.
From the server configuration page, open Container Services > ORB Service page.
2.
Select the Pass by reference option and save your changes.
This setting takes effect after the application server has been restarted. Continue with the
configuration as required, but ensure that the application server is restarted after setting this option.
Set Host Alias
This step identifies the port number for HTTP Transport and a matching host alias.
To identify the transport chain and set the host alias:
1.
With the server configuration page still open, locate the Container Settings > Web Container
Settings section.
2.
Click Web Container Transport Chains. The transport chains list appears.
3.
Locate WCInboundDefault and make a notation of the port number assigned to it. This port
number must be identified as a Host Alias.
4.
In the left console pane, expand Environment and click Virtual hosts.
5.
In the list on the Virtual Hosts page, click default_host.
6.
In the Additional Properties section, click Host Aliases. The Host Aliases page appears.
7.
Ensure that the port number assigned to WCInboundDefault also appears in the Host Aliases
list. If the port number does not appear in the Host Aliases list, click New to add the port number.
Add Image to MIME Type on WebSphere
To ensure that icons of xPression user interface are displayed on a WebSphere server, complete the
following steps:
1.
From the left pane of the administrative console, select Environment > Virtual hosts, and select
the virtual host where IBM Rational Asset Manager is installed.
2.
Click the MIME Types link in the Additional Properties section.
3.
Click New to add a new MIME Type. Specify image/png as the MIME type and png as the
extension.
4.
Save your changes and restart the server.
Configure JVM Settings
To Configure JVM Settings
1.
In the Server Infrastructure section of the server configuration page, expand Java and Process
Management and click Process definition. The Process definition page appears.
81
2.
Locate the Executable name field and supply the file name of the Java process. This file is located
in your WebSphere Java bin directory. You have already configured a variable for the path to
this directory:
• For Windows:
${JAVA_HOME}\bin\java.exe
• For UNIX and Linux:
${JAVA_HOME}/bin/java
3.
Leave all the other settings at their default values, and click Apply.
4.
On the Process definition page, click Java Virtual Machine in the Additional Properties section.
The Java Virtual Machine page appears. Supply the following settings on this page.
Setting
Definition
Classpath
Type the following value:
${XPRESSIONHOME}
Boot Classpath
Leave this field empty.
Verbose class loading
Leave this box unchecked.
Verbose garbage collection
Verbose JNI
Initial Heap Size
512
Maximum Heap Size
1024
Run HProf
HProf Arguments
Debug Mode
Debug arguments
Do not alter the default value.
Generic JVM arguments
To avoid input errors, add the following argument for Windows
system:
-Dcom.ibm.IgnoreMalformedInput=true
Each argument should be separated by a single space.
For AIX system, add the following argument to ensure the usage of
Compuset:
-Dcom.ibm.IgnoreMalformedInput=true -Xmso1m
For UNIX and Linux systems, add the following two arguments:
-Djava.awt.headless=true -Djava.net.preferIPv4Stack
=true
For Documentum users:
-Dlog4j.configuration=file:///xPressionHome
/LogConfiguration
Executable JAR file name
82
5.
Setting
Definition
Disable JIT
Operating system name
Leave this field at the default value.
Save your changes to the master configuration.
Configure Data Sources
This section contains the steps to set up the JDBC providers and data sources for your xPression
database.
See the following steps:
• Create an Authentication Alias, page 83
• Creating a DB2 Data Source, page 84
• Creating an Oracle Data Source, page 85
• Creating a SQL Server Data Source, page 87
• Relational Customer Data Sources, page 88
• Setting resultSetHoldability attribute for DB2, page 89
Create an Authentication Alias
The data source needs an authentication alias in order to access the xPression database. You must
create a J2C authentication alias containing the user ID and password that is required to access the
database.
To Create a J2C Authentication Alias
1.
Launch the WebSphere administrative console.
2.
In the left pane, expand Security, and click Global security.
3.
In the Authentication section, expand Java Authentication and Authorization Service, and
click J2C authentication data.
4.
Click New, and supply the following values:
Setting
Definition
Alias
Enter a name for the authentication alias. For example,
xPressionCR_Alias. The alias name will be used later when you
create a resource to identify this as the authentication alias to use.
83
5.
Setting
Definition
User ID
Type the user name that you created for your xPression database.
Password
Type the password of the xPression database ID. This is the
password for the userID listed above.
Save your changes.
Creating a DB2 Data Source
To create a new DB2 data source, complete the following steps:
1.
From the administrative console, expand Resources in the left pane, and select JDBC > JDBC
Providers. The JDBC Providers page appears. Ensure that your node is displayed.
2.
On the JDBC Providers page, click New. The Create a new JDBC Provider wizard appears.
3.
On the Step 1: Create new JDBC provider page, set the following options:
a.
In the Database type list, select DB2, and click Apply.
b. In the Provider type list, select DB2 Universal JDBC Driver Provider, and click Apply.
c.
4.
In the Implementation type list, select Connection pool data source, and click Apply.
On the Step 2: Enter database class path information page, set the following options:
• In the Class path box, ensure that the correct class path for your JDBC driver is included. If
you change the value, click Apply to effectuate your changes.
• In the Directory location box, use complete directory paths. For example:
C:/jdbcdriver/db2jcc.jar
where C:/jdbcdriver may be the value that you set for the ${DB2UNIVERSAL_JDBC
_DRIVER_PATH} WebSphere variable.
5.
Leave all the options at their default value to complete the wizard.
6.
On the JDBC Providers page, click DB2 Universal JDBC Driver Provider from the list.
7.
Click Data Sources in the Additional Properties section on the right side of the page. The Data
Sources page appears.
8.
Click New. The Create a data source wizard appears. Supply the following values, and leave the
other options at their default values.
84
Setting
Definition
Data source name
xPression_CR
JNDI Name
jdbc/xPression_CR
Setting
Definition
Driver type
The type of JDBC Driver (2 or 4) used to access the database.
To determine the best type of driver to use for your
circumstances, consult the documentation for the specific driver
that you use.
In general, use type 2 for databases on the same system as the
application server and type 4 for remote databases.
Database Name
Type the name of your xPression database. This is the name
assigned in Step Two: Create a New DB2 Database, page 41
Server name
Enter the host name of the DB2 Server.
Port number
Enter the port number the database server listens on.
xiuy
9.
On the Step 3: Setup security aliases page, select the authentication alias you created in Create
an Authentication Alias, page 83 from both the Component-managed authentication alias list
and the Container-managed authentication alias list.
10. Review the your selections on the summary page, and click Finish. When the data source creation
is complete, save the configuration and synchronize the changes with the nodes.
11. On the JDBC Providers page, click the xPression_CR link from the list. The Configuration
page appears.
12. In the Additional Properties section, click Connection pool properties, and supply the following
values:
Setting
Definition
Scope
Ensure that this value correctly identifies the
cell and node for your xPression server.
Connection timeout
1000
Maximum connections
20
Minimum connections
5
Reap time
180
Unused timeout
1800
Aged timeout
0
Purge policy
EntirePool
13. Save your configurations.
Creating an Oracle Data Source
To create a new Oracle data source, complete the following steps:
85
1.
From the administrative console, expand Resources in the left pane, and select JDBC > JDBC
Providers. The JDBC Providers page appears. Ensure that your node is displayed.
2.
On the JDBC Providers page, click New. The Create a new JDBC Provider wizard appears.
3.
On the Step 1: Create new JDBC provider page, set the following options:
a.
In the Database type list, select Oracle, and click Apply.
b. In the Provider type list, select Oracle JDBC Driver, and click Apply.
c.
4.
In the Implementation type list, select Connection pool data source, and click Apply.
On the Step 2: Enter database class path information page, set the following options:
• In the Class path box, ensure that the correct class path for your JDBC driver is included. If
you change the value, click Apply to effectuate your changes.
• In the Directory location box, use complete directory paths. For example:
C:/jdbcdriver/ojdbc6.jar
where C:/jdbcdriver may be the value that you set for the ${ORACLE_JDBC_DRIVER
_PATH} WebSphere variable.
5.
Complete the wizard and save your changes. The JDBC Providers page appears.
6.
On the JDBC Providers page, click Oracle JDBC Driver from the list.
7.
In the Additional Properties section on the Configuration page, click Data Sources.
8.
On the Data Sources page, click New. The Create a data source wizard appears.
9.
Define the following settings, and leave the other settings at their default values.
Setting
Definition
Data Source Name
xPression_CR
JNDI Name
jdbc/xPression_CR
URL
The URL for the connection to the Oracle database, in the following
format:
jdbc:oracle:thin:@//host_name:port/databaseName
where the parameters have the following meanings:
• host_name is the name of the server where the Oracle database
resides.
• port the port number for your database (the default value is
1521).
• databaseName is the name of the database you created in Step
One: Create a New Database, page 54.
10. On the Step 3: Setup security aliases page, select the authentication alias you created in Create
an Authentication Alias, page 83 from both the Component-managed authentication alias and
Container-managed authentication alias lists.
11. Review the your selections on the summary page, and click Finish. When the data source creation
is complete, save the configuration and synchronize the changes with the nodes.
86
12. On the Data sources page, click xPression_CR in the list. The Configuration page appears.
13. In the Additional Properties section, click Connection pool properties, and supply the following
values:
Setting
Definition
Scope
Ensure this value correctly identifies the cell and
node for your xPression server.
Connection timeout
1000
Maximum connections
20
Minimum connections
5
Reap time
180
Unused timeout
1800
Aged timeout
0
Purge policy
EntirePool
14. Save your configurations.
Creating a SQL Server Data Source
To create a new SQL Server data source, complete the following steps:
1.
In the JDBC Providers page, click New. The JDBC providers configuration page appears.
2.
In the Database type drop-down box, select SQL Server.
3.
In the Provider type drop-down box, select Microsoft SQL Server JDBC Driver.
4.
In the Implementation type drop-down box, select Connection Pool Data Source.
5.
Click Next. WebSphere displays the properties for the new JDBC Provider. In the
class path box, WebSphere displays the variable for the driver. In the Directory
location box, specify the directory where the driver file is located. For example:
<SQLServerDriver_installation_dir>\<driver_version>\enu\. Leave other options at their default
value.
6.
Click Next and then click Finish.
7.
Click Save.
8.
Click Microsoft SQL Server JDBC Driver.
9.
Ensure sqljdbc4.jar is defined.
10. Locate the Additional Properties section on the right side of the page. In the Additional Properties
section, click the Data Sources link. When the Data Sources page appears, click New to display
the New Data Source page.
11. Define the following settings. Leave the other settings at their default values
87
Setting
Definition
Data Source Name
xPression_CR
JNDI Name
jdbc/xPression_CR
Database name
Type the name of your xPression database you created in Step One:
Create a New Database, page 63.
Port number
Enter the port number the database server listens on.
Server name
Enter the host name of the SQL Server installation.
12. Click Next.
13. Select the authentication alias you created in Create an Authentication Alias, page 83 from both
the Component-managed authentication alias list and the Container-managed authentication
alias list.
14. Click Next.
15. Review the summary of your selections, and click Finish.
16. When the data source creation is complete, save the configuration and synchronize the changes
with the nodes.
17. Test the SQL Server connection.
18. Click the xPression_CR link in the path at the top of the page and scroll down to the Additional
Properties section.
19. Click Connection Pools and define the following settings.
Locate the Additional Properties section on the right side of the page. In the Additional Properties
section, click Connection pool properties. Supply the following values.
Setting
Definition
Scope
Ensure this value correctly identifies the cell and
node for your xPression server.
Connection timeout
1000
Maximum connections
20
Minimum connections
5
Reap time
180
Unused timeout
1800
Aged timeout
0
Purge policy
EntirePool
20. Save your changes.
Relational Customer Data Sources
If you are using a relational database for your customer data source, do the following configuration:
88
1.
Launch the WebSphere administrative console.
2.
Click the Resources item in the left console pane to expand it, click JDBC, and then click Data
Sources.
3.
Click the name of your customer data source.
4.
Click WebSphere Application Server data source properties.
5.
Select Non-transactional data source, click OK, and save your changes to the master
configuration.
Setting resultSetHoldability attribute for DB2
If you are using DB2 for a customer data source, you must set the resultSetHoldability attribute.
To set the resultSetHoldability attribute:
1.
Open the WebSphere administrative console.
2.
Expand Resources, then select JDBC providers, DB2 Universal JDBC Driver Provider, and
Data Sources.
3.
Click the data source name that you created for use with xPression.
4.
Locate the Additional Properties section, then click Custom Properties.
5.
Select resultSetHoldability and set the value to 1.
6.
Click Apply, then click Save.
Deploy the xPression Enterprise Archive File
This step deploys the xPression EAR file on your system by using the WebSphere administrative
console. You can deploy only one enterprise archive file depending on the xPression components you
are licensed to use. These instructions assume that you use the Prompt me only when additional
information is needed option on the page where you specify the path of the EAR file. If you select
the Show me all installation options and parameters option, the procedure will be different.
• Pre-Deployment Configurations, page 89
• Deploying the xPression Enterprise Archive File, page 90
• Deploying the JMS-Enabled xPression Adapter, page 91
Pre-Deployment Configurations
Before deploying the xPression EAR file, increase the memory for the WebSphere deploy tool by
doing the following steps:
1.
Open the following file for editing:
Websphere_install_root\deploytool\itp\ejbdeploy.bat
For UNIX users, the file is ejbdeploy.sh
89
2.
Locate the following settings:
-Xms256M -Xmx256M
3.
Change the settings to the following values:
-Xms1024M -Xmx1024M
4.
Save and close the file.
Deploying the xPression Enterprise Archive File
To deploy the xPression enterprise archive file, complete the following steps:
1.
From the administrative console, expand Applications in the left console pane and click New
Application.
2.
On the New Application page, click New Enterprise Application. The Preparing for the
application installation page appears.
3.
Supply the directory where you store the xPression Enterprise Archive file.
4.
In the How do you want to install the application? section, ensure that Fast Path - Prompt
only when additional information is required. is selected, and click Next. The Install New
Application wizard appears.
5.
On the Step 1: Select installation options page, ensure that the Deploy enterprise beans option
is NOT selected, and leave the other options at the default value.
6.
On the Step 2: Map modules to servers page, ensure the following settings:
a.
Click the Select All Items button to select all of the modules on the page.
b. Select the target for your xPression server in the Clusters and servers list. If you are using IIS
6.0 as your web server, you must select both the xPression Server and the IIS Web Server.
c.
Click Apply. You can view that the Server column is updated.
7.
On the Step 3: Map virtual hosts for Web modules page, ensure that the Virtual host for each
Web module is default_host.
8.
On the Step 4: Metadata for modules page, leave the options at their default values.
9.
Review your settings on the Summary page, and complete the wizard.
When the installation process begins, WebSphere displays the Installing page. This page provides
information about the installation and eventually displays a message indicating that application
installed successfully.
10. When the installation completes, save your changes to master configuration.
11. Expand Applications in the left console pane, and select Application Types > WebSphere
enterprise applications. The Enterprise Applications page appears. You can view that xPression
appears in the application list.
12. Click xPression. The Configuration page appears.
13. In the Detail Properties section, click Class loading and update detection.
14. On the Class loader page, ensure that Class loader order is set to Classes loaded with parent
class loader first, and click OK.
90
15. In the Modules section, click Manage Modules.
16. For the following modules, click each of them to open the module Configuration page, and select
Classes loaded with local class loader first (parent last) as the Class loader order:
• UniArch_WebService
• xPRS_xFramework
• ecor2
• xPression_Revise
• xDevKit
17. Save your changes to the master configuration.
Deploying the JMS-Enabled xPression Adapter
Refer to the deploying xPression Enterprise Archive file procedure to deploy the JMS-enabled
xPression adapter. Note the following difference:
• Ensure that you supply the directory of the correct JMS-enabled EAR file in Step 2.
• On the Step 2: Map modules to servers page, ensure that your list of modules contains the
following modules:
— xPressionAdapterEJB
— xPressionAdapterWeb
Import LDAP Server Certificate to Truststore
If you use Secure LDAP as your authentication method for xPression, import the certificate of the
LDAP server through the WebSphere administrative console.
To import the certificate of the LDAP server:
1.
Expand Security in the left console pane and click SSL certificate and key management.
2.
In the Related items section, click Key stores and certificates.
3.
Click the NodeDefaultTrustStore link or the trust store you are using.
4.
On the NodeDefaultTrustStore page, click Signer certificates in the Additional Properties
section.
5.
Click Add, and supply the alias name and full path to the certificate file.
6.
In the Data type list, select Binary DER data.
7.
Click OK. The certificate appears in the list of signer certificates.
91
Configure Cookies Settings
You must enable cookies for the xPression server. Otherwise, xDesign is unable to connect to the
server.
To configure Cookies settings:
1.
From Websphere administrative console, expand Servers, and select Server Types > WebSphere
application servers.
2.
Click your xPression server link. The configuration page appears.
3.
In the Container Settings section, click Session management.
4.
From the Session tracking mechanism: section, click Enable cookies.
5.
On the cookies configuration page, ensure that the Set session cookies to HTTPOnly to help
prevent cross-site scripting attacks option is NOT selected.
Set Transport Option for CSIv2
You must set the Transport option for the CSIv2 transport layer to TCP/IP; otherwise, errors will occur
when you migrate documents from the command line.
To set the Transport option for the CSIv2 transport layer:
1.
On the left side the WebSphere Administrative Console, expand Security and click Global
security.
2.
In the Administrative security section, select Enable administrative security.
3.
In the Authentication section on the right side, click CSIv2 Inbound Communications.
4.
Select TCP/IP from the Transport drop-down list.
5.
Click Apply.
WebSphere Users and Permissions
The WebSphere users and their permissions must be set up correctly. Check your WebSphere
configuration to make sure that you have:
• Created the appropriate groups and users on the WebSphere server. You should create a Windows
user under which the WebSphere service will run and define that user locally and as a member of
the Administrators group.
• Assigned the appropriate rights and permissions to the user. Set this user up to act as part of
the operating system, and log on as a service.
See WebSphere documentation for complete instructions.
92
Configuring WebLogic
Before you can deploy and configure the xPression Server, you must create a new configuration in
your WebLogic environment. If you are planning on using an Admin server or an Admin server
with a Managed server, you should deploy the xPression application to the Managed server. See
the following topics:
• Understanding Your Server Paths, page 93
• Understanding User Names, page 94
• Create a New WebLogic Configuration, page 94
• Extract the xPression Enterprise Archive Files, page 94
Understanding Your Server Paths
You will be creating several server directories throughout the installation and configuration process.
It is important to know the purpose and location of these directories.
Directory
Location and Purpose
WebLogic Configuration/Domain
This directory contains the WebLogic configuration/domain
you create in Create a New WebLogic Configuration, page
94.
By default, WebLogic places all configurations in the
following directory: <WebLogic_Home>\user_projects
\domains\
xPression Applications
The xPression enterprise archive file contains all of the
components needed to run xPression, xResponse, and
xRevise.
The enterprise archive file is delivered together with
the installation package. You must extract the file to the
xPression "applications" directory.
The applications directory is a sub-directory of your
xPression configuration/domain, and it is created when you
install the WebLogic configuration. For example:
WebLogic_Home\user_projects\domains
\xPressionDomain\applications
xPression Server
This directory is created when you install the xPression
server. You can install the server to any directory. The
default location for the xPression Server is:
• On Windows: C:\xPression
• On UNIX: /$HOME/xPression/
93
Understanding User Names
You are asked to supply a user name at various places throughout the process of installing and
using the software.
First, you are asked to create an Administrative user name in the WebLogic Configuration wizard. This
user name enables you to start the WebLogic administrative server and to log on to the WebLogic
Admin Console.
If you want to authenticate additional users for xPression Admin, see after you complete your
installation.
Create a New WebLogic Configuration
To create a new configuration for xPression, start the WebLogic Configuration Wizard.
For Windows, you can start the program by clicking WebLogic Configuration Wizard from the
Windows Start menu.
For UNIX systems, you can locate the config.sh file located in the WebLogicHome/oracle_common
/common/bin directory and type the following command from the terminal window:
sh config.sh
Follow the instructions and supply required information in the wizard. You can click the Help button
on the lower-left corner of the wizard for detailed instructions.
EMC Document Sciences recommends that you make the following configurations for xPression:
• On the Create Domain page, select Create a new domain, and supply a name and location for
the domain. You can use any server location for the domain directory. The configuration wizard
appends the domain name to the path you specify in Domain Location.
• On the Administrator Account page, create an administrative user as the default administrator to
start the xPression Server and log on to the WebLogic Admin Console. Do NOT use weblogic
as the user name in a production environment. EMC Document Sciences recommends using
xpression as the username.
• On the Domain Mode and JDK page, select Development mode. This mode enables you to
auto-deploy applications.
Extract the xPression Enterprise Archive Files
Select an EAR file according to your system requirements. If you want to use JMS with xAdapter, use
xPRS_EE4.6.0_JMS_WebLogic.ear. Otherwise, use xPRS_EE4.6.0_WebLogic.ear.
To Extract the EAR File
1.
Create a subdirectory named applications under the WebLogicHome\user_projects
\domains\xpression directory.
2.
Create a new folder in the applications subdirectory. The folder must use the following name:
94
xPression.ear
3.
Locate the xPression EAR file in your installation package.
4.
For UNIX, copy the EAR file to your desired folder. If you use FTP to move the EAR file to your
server, ensure you use BIN and not ASCII to preserve binary properties.
5.
Extract the EAR file to the folder you created in Step 2. For UNIX, you can use the Unzip utility
(http://www.info-zip.org/pub/infozip/UnZip.html), or a jar utility. Ensure that you use the -a
parameter to preserve BINARY and ASCII properties.
• If you are using the unzip utility, type:
unzip -a xPression.ear
• If you are using the jar utility, type:
jar -xvf xPression.ear
Configuring JBoss
Complete the following steps:
• Add Environment Variables, page 95
• Determine Your HTTP Server Port, page 95
• Prepare Your JBoss Environment for Installation, page 96
Add Environment Variables
Ensure that the JAVA_HOME environment variable is set to point to your JDK installation.
For Windows systems, check your environment variables by opening the System Properties from the
Windows Control Panel. Click the Advanced tab and click Environment Variables.
For Linux systems, ensure the JAVA_HOME environment variable appears in your .bash_profile file
located in your root directory. This file is hidden by default. If the JAVA_HOME variable does not
appear in this file, add the JAVA_HOME variable and ensure it points to the directory where your
Java JDK is installed. For example:
JAVA_HOME="<path>" export JAVA_HOME
Determine Your HTTP Server Port
To determine your HTTP server port number, complete the following steps:
1.
In the Jboss_Installation_Directory\standalone\configuration folder, open one
of the following files to edit:
• If you have not installed xPression Server, open standalone.xml.
• If you have already installed xPression Server, open xPression-standalone.xml.
95
2.
The HTTP port is defined in the following property:
<socket-binding name="http" port="8080"/>
Prepare Your JBoss Environment for Installation
To prepare your environment for installation, complete the following steps:
1.
Locate the Server_Installer directory in your installation package and locate the xPression
Server installer.
2.
Locate the xPression EAR file for your JBoss version and copy it to same directory as the
xPression Server installer.
3.
Rename the xPression EAR file as xPression.ear. xPression will deploy your EAR file
automatically.
96
Chapter 6
Step Three: Install xPression Server
You must have JRE 1.6 or higher versions to run the installer. You can run the installer in two modes:
GUI-enabled mode for Windows, UNIX, and Linux, or command line mode for UNIX and Linux.
Locate the appropriate installer from the installation package according to your platform. For
CompuSet installation, you can select whether to install CompuSet in the installation wizard.
• About the Installer, page 97
• Running the xPression Installer, page 98
• Installing the Server in Silent Mode, page 105
About the Installer
Before running the installer, be aware of the following issues:
• This installer does not work with Windows Add/Remove programs. For steps to uninstall the
xPression Server, see Uninstalling xPression Server, page 197.
• To prevent potential xPression production errors, verify that your system clock is set accurately
before installing xPression. If your system clock is incorrect at installation time and is corrected at
a later time, the inconsistencies with the last usage date can cause xPression to fail.
• The xPression installation program requires approximately 520 MB to run. The Disk Space
Information page in the installer shows that you need 174 MB to install the xPression Server.
However, this refers only to the size of the files being copied to your system. The installer itself
requires the remaining space. Ensure your system has the required disk space allotment of a
minimum of 520 MB.
• If you encounter a JAVA JVM error while trying to uninstall the xPression Server, the program
may be having trouble recognizing your JVM. You can force the program to recognize your JVM
as long as the JVM is version 1.6. To accomplish this, you must append the JVM path to the end
of the command when starting the installer.
• If you are using the GUI installer on Linux or UNIX, see the following recommendations:
— To use the GUI-based installation wizard on UNIX, log in to your UNIX server as an
administrative user and ensure that xWindows is running on your system. If you are using
telnet to remotely access and execute the installation program, ensure that you set your
DISPLAY property as follows:
97
DISPLAY=<IP Address>:0 export DISPLAY
— EMC Document Sciences recommends that you install xPression with a root-level user account.
If you use a non-root-level user to install xPression and intend on using local authentication,
you must complete the configuration changes identified in Configuring Local Authentication
for Non-Root Users, page 109. If you fail to make these changes, xRevise and xResponse
authentication will fail.
— The GUI-based installation wizard requires xWindows and contains the same installer screens
as the Windows version.
• WebSphere Users — When configuring your WebSphere application server, you created a
WebSphere variable named XPRESSIONHOME. If you install xPression to a directory that is
different than the directory identified in the variable, you must change the WebSphere variable.
• xPressionVersion.properties — The xPressionVersion.properties file located in your xPression
EAR directory is only used as the base template to generate the xPressionVersion.properties
file in your xPressionHome directory during installation. The xPressionVersion.properties file
located in your xPression EAR directory is not updated and might be different from the one
in your xPressionHome directory.
• Some startup log information may not be displayed on the JBOSS Console. You can always check
xPression.log for all xPression log messages.
Running the xPression Installer
Locate the Server_Installer directory in your installation package.
For Windows, run xPression_Server_Installer_Windows.exe.
For Linux, AIX, or Solaris, complete the following procedure:
1.
Locate xPression_Server_Installer_your_server.bin in the package, where
your_system refers to the operation system on which to install xPression Server.
2.
Start the command line interface and run the corresponding command. For example, on Linux,
start the command line Terminal, and run one of the following commands to start the installation
wizard:
• For the GUI installer, use the following command:
sh xPression_Server_Installer_your_server.bin
• For the command line installer, use the following command:
sh xPression_Server_Installer_your_server.bin –i console
Follow the instructions in the installation wizard, and supply necessary information on each page.
The “Choose xPression Edition” Page
Select the version of xPression that you want to install.
98
The “Choose Installer Type” Page
If you want to install CompuSet with xPression, select the Compuset option.
The “xPression Installation Folder” Page
Define the directory where you want to install xPression. Your installation path cannot contains
non-English characters.
In this document, this directory will be referred to as the xPressionHome directory.
The “Select Application Server Type” Page
Select your application server type and version.
Selecting Application Server Installation Directory
If you are using WebSphere, the Select WebSphere Installation Folder page appears. Supply the
path to your WebSphere\AppServer directory. For example: C:\WebSphere\AppServer
If you are using WebLogic, the Select WebLogic Home page appears. Supply the
directory where Oracle WebLogic is installed. By default, the WebLogic Home directory is
C:\Oracle\Middleware\Oracle_Home
If you are using JBoss, the Select JBoss Installation Folder page appears. Supply the path to the
directory where JBoss is installed.
Selecting Application Server Home Directory
If you are using WebSphere, the Select WebSphere Profile Home Directory page appears. Provide
the full path of your WebSphere profile. For example:
C:\WebSphere\AppServer\profiles\xPressionProfile
If you are using WebLogic, the Select Oracle WebLogic Domain Directory page appears. Supply
your WebLogic domain folder. This directory should be:
WebLogic_Home\user_projects\domains\xpression\
The “Select JDK Installation Folder” Page
If you are using JBoss, this page appears. Supply the path to the JDK installation directory.
99
The “Select EAR Folder” Page
Supply the path to the directory where you want to deploy xPression.ear. This file should reside
in the same directory as the xPression Server Installer. When completed, proceed to the next step.
This applies to WebSphere, WebLogic, and JBoss.
The “Application Server Information” Page
For WebSphere, define the following options:
• http or https—Sets up an HTTP server or a secure HTTPS server.
• HTTP Server Port—The port number of your HTTP Server. You should have written down this
port number when configuring your application server.
• RMI Port—Your RMI port number. The RMI port number is the same as the bootstrap port
number.
• Protocol—Select corbaloc or iiop. Both protocols works with xPression, but EMC Document
Sciences recommends using CORBALOC for most environments. Consult your system
administrator to determine which protocol to use.
• HTTPS Server Port — The port number of your HTTPS server. You should have written down this
port number when configuring your application server.
For WebLogic, the port number you supply here should be the same as the WebLogic Server Listener
Port in the WebLogic Configuration Wizard. You can also look up the port number by locating the
following code in the config.xml file in your xPression domain directory:
<Server ListenAddress="" ListenPort="7001" Name="xPression" ...
For JBoss, define the following options:
• HTTP or HTTPS — You can choose to set up an HTTP server or a secure HTTPS server. Previously
the server was non-secure by default and using a secure server required manual configuration. To
set up an HTTPS server, select HTTPS.
• HTTP Server Port — The port number of your HTTP Server. By default, this port is 8080.
• RMI Port — Set the RMI port number. Ensure the port you choose is not in use by another
application. To see a list of JBoss ports, check your standalone.xml file.
100
The “HTTP Server Connection” Page
Supply the following information:
• Descriptive name of the server connection — Supply a descriptive server name for application
server that will host xPression.
• Server Name or IP Address — Supply the actual server name for the application server that
will host xPression or supply the IP address.
• HTTP Proxy — An HTTP Proxy server enables you to route your users requests through a proxy
server instead of allowing them to directly connect to the xPression Server. If you want to use an
HTTP Proxy server, select the checkbox and supply the HTTP Proxy server name or IP address.
The “Select Driver” Page
Select your xPression database type, and then supply the path to your database driver.
For DB2 driver, db2jcc.jar and db2jcc_license_cu.jar are required.
The "Database URL Settings" Page
If you are using JBoss, this page appears. Supply the following information according to your
database type.
For DB2, supply the following settings to configure the database URL:
• Database Name — The name of your xPression database. You created this database in Step Two:
• User Name — Your xPression database user name. You created this user name in Step Three:
Create a New Database User, page 43.
• User Password — The password for your xPression database user name.
For Oracle, supply the following settings to configure the database URL:
• Server Name — The name of the server that hosts your database.
• Port Number — Your database port number.
• Database Name — The name of your xPression database. You created this database in Step One:
• User Name — Your xPression database user name. You created this user in Step Two: Create a
New Database User, page 55.
For SQL Server, supply the following settings to configure the database URL:
• Server Name — The name of the server that hosts your database.
• Port Number — Your database port number. See Determine Port Number, page 67.
101
• Database Name — The name of your xPression database. You created this database in Step One:
• User Name — Your xPression database user name.
The “E-Mail Server” Page
To use e-mail as a distribution method, type the name or IP address of the e-mail server used to
distribute xPression documents. When finished, proceed to the next step.
The “User Authentication Security Settings” Page
On this page you will set up your user authentication method. You can select Local or LDAP. Click
Next.
• Local Security — Select this option to enable user authentication on the local machine. Users with
access to the local machine will also have access to xPression.
• LDAP — Lightweight Directory Access Protocol (LDAP) is a set of protocols for accessing
information directories. Select this option to set up LDAP authentication. When you select LDAP,
you must supply LDAP authentication settings on the next page.
When finished, proceed to the next step.
The “LDAP Authentication” Page
This page only appears if you selected LDAP authentication on the previous page. Non-LDAP users
proceed to the next step. The LDAP Authentication page appears. Supply your LDAP authentication
information here. Supply the following settings. These settings can be altered after installation by
altering these settings in the ldapcfg.properties file.
• Provider URL — The URL of the LDAP server. For example:
ldap://localhost:389
• Name Attribute — Select one of the following:
— cn — This is the common name attribute, which is the first name followed by last name. CN is
selected by default. But xPression also supports any customized name. Use this option if your
user objects appear in the following format: First Name Last Name. For example: Jimmy Johnson
— uid — this is the user ID attribut, which is the first initial and last name. Use this option if your
user objects appear as a username. For example: jjohnson
— sAMAccountName — A common name attribute to identify the Distinguished Name (DN). It
is also used as the value for LDAP_NAME_ATTRIBUTE in ldapcfg.properties.
For customized LDAP name attributes, you must manually configure the ldapcfg.properties file as
shown in LDAPUser Authentication, page 19.
102
• Bind DN — The DN used to connect to the LDAP server when xPression performs searches against
the LDAP server. It is also the used as the value of LDAP_ADMIN_DN in ldapcfg.properties
• Bind Credential — The password for the Bind DN. It is also the used as the value of
LDAP_ADMIN_PWD in ldapcfg.properties
• User Mode — Controls the way xPression retrieves users. Select one of the following:
— FILTERANDGROUP - When using this value, xPression returns only those users that are
members of the organizational unit defined in LDAP_NAME_CONTEXT and only those
groups that are members of the organizational unit defined in LDAP_GROUP_CONTEXT.
— FILTER - xPression uses only LDAP_USER_FILTER to limit the users retrieved. FILTER is the
default value.
When using this value, xPression returns all users and groups that are members of the
organizational unit defined by LDAP_NAME_CONTEXT.
— GROUP — When using this value, xPression returns all users and groups that are members of
the organizational unit defined by LDAP_GROUP_CONTEXT.
• User Context — This identifies the starting point within the LDAP directory hierarchy for
performing user and group searches. It is the search base for the entire LDAP directory tree.
The search will remain in scope for this branch. If another branch in the tree also contains the
interested users and groups, then the parent of the two branches should be configured as the
search base. This is the distinguished name where the search will begin.
• User Filter — This is the search filter that should be used to display a list of individual group
objects. For example: "(objectclass=person)"
• Group Context — Use as the root context to retrieve groups. By default, this is
set to match the LDAP_NAME_CONTEXT value. This parameter is active when
LDAP_USER_MODE=FILTERANDGROUP. or LDAP_USER_MODE=FILTER
• Group Filter — This is the search filter that should be used to display a list of individual group
objects.
• Member Attribute — This attribute determines which groups the user belongs to. For example:
uniquemember
Note: If you use Secure LDAP as your authentication method and use self-signed certificates or
server certificates that are not pre-installed, you must import the certificates into the truststore used
by your application server. For instructions on how to import certificates refer to your application
server documentation.
The “Documentum Settings” Page
If you are integrating with a Documentum repository, configure the following settings:
• Specify the location of the Documentum /config directory
• Specify the location where Documentum DFC is installed
103
The “Cluster Settings” Page
If you are installing an xPression cluster node, configure the settings on this page. If you are not
installing an xPression cluster node, you can skip this page. See xPression Groups Messages, page 32
for more information.
Select one of the following:
• Local — xPression is configured to use Local cast by default. Use Local cast when xPression is
used in a single-server environment. xPression will only send messages to the local machine. To
configure xPression for Local cast, you don’t have to do anything, xPression will be configured
upon installation.
• Mulitcast — This method should be used when you want to use IP Multicast. Please ensure that
IP Multicast is available in your network environment.
Define the following:
— Cluster Name — The unique name for a group of cluster nodes. This name will be used as the
value of xPressionGroupsName in xPressionCache.properties.
— Current Node Name — This value is only for OnDemand implementations. On premise
installations should ignore this setting.
— Multicast Address — the Multicast address. The default value is 239.192.11.11.
— Mulitcast Port — the Multicast port number.
• Unicast — This method should be used when IP Multicast is disabled by your network
administrator. xPression Groups supports Unicast messages through TCP protocol.
Define the following:
— Cluster Name — The unique name for a group of cluster nodes. This name will be used as the
value of xPressionGroupsName in xPressionCache.properties.
— Current Node Name — This value is only for OnDemand implementations. On premise
installations should ignore this setting.
— Unicast Port — the port number of the local xPression Server.
— Unicast Members — list all of the servers in the cluster by IP address and port number using
the following syntax:
ip_address[port],ip_address[port],
The “Performance Settings” Page
Define the following performance settings according to your business requirements. Select Medium,
Large, or Custom. If you select Medium, the initial memory will be set to 128 and the maximum
memory will be set to 512. If you select Large, the initial memory will be set to 512 and the maximum
memory will be set to 1024. If you select Custom, you can supply your own values.
104
The “User Selection Summary” Page
This page shows a list of the options you selected during the install.
The “Pre-Installation Summary” Page
This page shows the installer disk space requirements.
For the GUI installer, click Install.
For the command line installer, press Enter.
The installation program begins copying files to the server. A status bar measures the progress of
the installation.
Restart Your Server
The xPression server installation makes registry and environment changes to your system that will
only take effect when the server is restarted. Restart your server.
Installing the Server in Silent Mode
This feature enables you to capture your installation selections in an installation response file,
then use that file to perform additional installations without the need to remake your installation
selections. First, you must run the xPression Server installer in order to capture your installation
selections in a response file. After the response file is created, you can use it to automatically supply
the installation selections to the xPression Server installer for additional installations.
Silent mode means that no errors or warnings are reported while the installation is running. Besides,
there is no notification that the installation is complete. To verify that the installation is complete,
check the xPression_Server_InstallLog.log in the USER_INSTALL_DIR directory. You can also get
installation messages in a console on Windows by holding down the CTRL key immediately after
launching the installer. This action activates DEBUG mode. Hold down the CTRL key until the
console appears.
• Creating the xPression Server Silent Mode Response File, page 106
• Running the xPression Server in Silent Mode, page 106
105
Creating the xPression Server Silent Mode Response
File
By default, the xPression Server installer creates a Silent Mode response file each time the installer
is run. Your installation selections are captured in the installer.properties file that is stored in your
xPressionHome\UninstallerData directory. The response file is created automatically for both
the GUI and console mode installers.
Running the xPression Server in Silent Mode
Once you have a response file, you must supply it to the xPression Server installer for any installation
you want to perform in Silent Mode. By default, a Silent Mode installation will look in the directory
in which it resides for installer.properties response file, but you can also specify a different location
for the file. Use the following switches when running the xPression Server installer in Silent Mode.
• -i silent—Activates Silent Mode.
— On Windows platforms:
xPression_Server_with_CompuSet_Installer_Windows.exe -i silent
— On Linux or UNIX platforms:
xPression_Server_with_CompuSet_Installer_platform.bin -i silent
• -f—Enables you to supply a path to an installer.properties file that does not reside in the same
directory as the xPression Server installer. For example:
— On Windows platforms:
xPression_Server_with_CompuSet_Installer_Windows.exe -i silent
-f "C:\installer.properties"
— On Linux or UNIX platforms:
xPression_Server_with_CompuSet_Installer_platform.bin -i silent
-f "C:\installer.properties"
where platform should be replaced with your specific platform.
To Run the xPression Server Installer in Silent Mode
1.
Open a command window.
2.
Navigate to the directory that contains your xPression Server installer.
3.
Type the command above according to your platform. If your installer.properties file is not
stored in the same directory as the xPression Server installer, use the -f switch to supply the
path to the file.
106
4.
The installer will run in the background until completion.
107
108
Chapter 7
After you have installed the xPression server, configure the server as necessary. See the following
steps:
• Additional Steps for Linux and UNIX, page 109
• Additional Configurations for WebSphere, page 110
• Additional Configurations for WebLogic, page 112
• Additional Configurations for JBoss, page 121
• Configuring the xPression Diagnostic Utility, page 126
• Oracle Database Settings for BatchRunner, page 127
• Configuring User Access for xAdmin and xDashboard, page 128
• Connecting CompuSet Bridge to the Server, page 128
Additional Steps for Linux and UNIX
Complete the following additional configuration steps if you are using Linux or UNIX platforms:
• Configuring Local Authentication for Non-Root Users, page 109
• Configurations for Using the xPression Documentum Repository, page 110
• Editing bash_profile for JBoss on Linux, page 110
Configuring Local Authentication for Non-Root Users
If you use a non-root-level user to install xPression on a WebSphere or WebLogic server, and intend
on using local authentication, you must complete the following configuration changes.
Note: Without these changes, xRevise and xResponse authentication will fail.
1.
Navigate to the following directory: xPressionHome/Drivers.
2.
Locate the LinuxAuthUser (for Linux), SolarisAuthUser (for Solaris), or the AIXAuthUser (for
AIX) file.
109
3.
Change the owner of this file for the root user as follows.
• For Linux:
chown root LinuxAuthUser
chmod 4655 LinuxAuthUser
• For AIX:
chown root: root AIXAuthUser
chmod 4655 AIXAuthUser
• For Solaris:
chown root: root SolarisAuthUser
chmod 4655 SolarisAuthUser
Configurations for Using the xPression Documentum
Repository
If you are a Documentum user and are using the xPression Documentum Repository, you must make
the following changes to your Java Security file.
1.
On the server, navigate to the JavaHome directory used by your applications server.
2.
Open the security folder.
JavaHome/JDK_version/lib/security/
3.
Open the java.security file for editing.
4.
Locate and comment out the following statement:
securerandom.source=file:/dev/urandom
5.
Add the following statement to the file:
securerandom.source=file:/dev/random
6.
Editing bash_profile for JBoss on Linux
Open .bash_profile, and add JBoss_installation_directory/bin to $PATH.
Additional Configurations for WebSphere
Complete the following configurations if you are using WebSphere:
• Increasing Application Server Memory, page 111
• Library File Usage, page 111
• Configurations for CompuSet Jobs in RMI Mode, page 111
110
Increasing Application Server Memory
The xPression server sometimes requires more memory than has been set in WebSphere to perform
import and export functions. To optimize system performance, you can increase the Java Heap
Size for your xPression Server via the JVM (Java Virtual Machine) settings page of WebSphere
administrative console.
Library File Usage
xPression Batch may be unable to publish HTML documents if the library files used by WebSphere
are not the ones most compatible with xPression.
Configurations for CompuSet Jobs in RMI Mode
You must do the following configurations for CompuSet jobs in RMI mode. The configurations
are optional for xPublish jobs. xPublish jobs will still run successfully with a warning or an error
message at the beginning of jobs.
1.
Copy WebSphere_Profile_directory/properties/sas.client.props, for example, C:
\IBM\WebSphere\AppServer\profiles\AppSrv01\properties\sas.client.props,
to the xPression Server and all hosts that run batch jobs. The paths of this file on the Server and
hosts are referenced as SASClientPropsServer and SASClientPropsHost in the following steps.
2.
Set the following properties in SASClientPropsServer/sas.client.props and
SASClientPropsHost/sas.client.props:
com.ibm.CSI.performTransportAssocSSLTLSRequired=false
com.ibm.CSI.performClientAuthenticationSupported=false
3.
Open xPressionHome/batchrunner.properties on the server, and add the following
configuration to the Java_Option property:
-Dcom.ibm.CORBA.ConfigURL=file:///SASClientPropsServer/sas.client.props
4.
Open xPressionHome/BatchRunner.bat or xPressionHome/BatchRunner.sh on the
batch job hosts, and add the following configuration to the Java command line:
-Dcom.ibm.CORBA.ConfigURL=file:///SASClientPropsHost/sas.client.props
5.
Add the following configuration in the com2ejbbridge.properties files:
com.ibm.CORBA.ConfigURL=file:///SASClientPropsServer/sas.client.props
on the server, and
com.ibm.CORBA.ConfigURL=file:///SASClientPropsHost/sas.client.props
on the batch job hosts.
111
Additional Configurations for WebLogic
Complete the following configurations if you are using WebLogic:
• Setting Java Options for UNIX Systems, page 112
• Defining Path for xPression Logging, page 112
• Starting the xPression Server, page 113
• Configuring xPression on WebLogic, page 113
• Starting the Enterprise Archive Files, page 120
• Increasing Memory Size, page 120
Setting Java Options for UNIX Systems
If you are using a UNIX system, complete the following steps:
1.
Open startxPressionServer.sh with a text editor.
2.
Near the bottom of the file, location the following section of text:
%JAVA_HOME%/bin/java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS%
3.
After %JAVA_OPTIONS%, add the following parameter:
-Djava.awt.headless=true
For example:
%JAVA_HOME%/bin/java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS%
-Djava.awt.headless=true
Defining Path for xPression Logging
This step is for Documentum users only. If you are using Documentum, you must make the following
configuration change to ensure that xPression events are written to the xPression log. Without this
configuration step, the events will be written to the Documentum log.
To ensure that xPression sends logging information to the correct location, add the following
parameter to the xPression start script. The start script is located in your xPression domain directory:
startxPressionServer.cmd for Windows or startxPressionServer.sh for UNIX.
1.
Locate your xPression start script.
2.
Open the start script for editing.
3.
Locate the variable JAVA_OPTIONS.
4.
Add the following parameter to the end of the JAVA_OPTIONS statement
-Dlog4j.configuration="xPressionHome\LogConfiguration"
112
Starting the xPression Server
The xPression Server installation program delivers a startup script for starting the new xPression
Server: startxPressionServer.cmd for Windows and startxPressionServer.sh for UNIX.
This file is located in the xPression domain directory. For example:
WebLogic_Home/user_projects/domains/xpression/bin
For Windows, double-click the startxPressionServer.cmd file to start the xPression Server.
For UNIX, if your administrator made arrangements for non-root users to start the server, you can
use the following command:
nohup ./startxPressionServer.sh &
The ampersand (&) enables the script to be executed in the background, returning access to your
shell. The nohup statement prevents the process from being shut down when you exit your shell.
When prompted, supply the username and password that you defined when creating the xPression
domain and server in the WebLogic Configuration Wizard.
Configuring xPression on WebLogic
To configure your new xPression server, launch the WebLogic Admin Console by starting the Admin
Console shortcut in the WebLogicHome/wlserver/server directory.
When prompted, supply the administrative username and password you created in Create a New
WebLogic Configuration, page 94.
To configure the application server, complete the following steps:
• Configure Data Sources, page 113
• Configuring WebLogic When Publishing xPresso for Word Documents from xBatch, page 119
• Manually Deploy the Enterprise Archive File, page 119
• Configure JTA, page 120
Configure Data Sources
To configure your data sources for xPression, you must create a new JDBC data source.
1.
If you are using the Production Mode, click Lock & Edit from the Change Center on the upper-left
corner of the Admin Console. The Lock & Edit button is not displayed for Development Mode. If
you are using the Development Mode, ignore this step.
2.
From the Domain Structure section, select Services > Data Sources. The Summary of JDBC
Data Sources page appears.
3.
Select New > Generic Data Source. The Create a New JDBC Data Source page appears.
113
4.
From the Database Type list, select your database type. For instructions for specific database
drivers, see the following topics:
• DB2 JDBC Driver, page 114
• Oracle JDBC Driver, page 116
• Microsoft SQL Server Driver, page 117
DB2 JDBC Driver
To define the DB2 JDBC driver:
1.
Supply the following values for your DB2 database.
Setting
Definition
Name
DB2 JDBC xPression Connection Pool
JNDI Name
jdbc/xPression_CR
Database Type
Select DB2.
Database Driver
Select IBM’s DB2 Driver (Type 4) for JDBC and SQL Versions: 8.X
and later.
2.
Click Next.
3.
The Transaction Options page appears. Ensure Supports Global Transactions is selected and
click Next.
4.
The Connection Properties page appears. Supply the following values.
Settings
Definition
Database Name
Supply the name of the database you created in Step Two: Create a New
DB2 Database, page 41.
Host Name
Supply the name or IP address of the database server.
Port
Supply the port number for the database you created in Step Two:
Database User Name
Supply the user name for the database user you created to connect to
the xPression database. You created this user in
Password/Confirm
Password
Supply the password for the user you created to connect to the xPression
database.
5.
Click Next.
6.
The Test Database Connection page appears. Ensure that the following values are defined.
114
Setting
Value
Driver ClassName
com.ibm.db2.jcc.DB2Driver
Setting
Value
URL
Ensure that the value you defined for the Database Name is
reflected in the URL path.
jdbc:db2:IP_address:Port/databaseName
For example, jdbc:db2://10.32.229.33:50001/xprv45
Database User Name
Ensure the database username you supplied correctly appears
in this box.
Database Password/Confirm
Password
Type your database password.
Properties
The following values should appear in the Properties box:
user=<your database user name>
DatabaseName=<your database name>
Where <your database user name> is the user name you created
in Step Three: Create a New Database User, page 43.
and <your database name> is the name of the database you
created Step Two: Create a New DB2 Database, page 41.
7.
The following values should appear in the Properties box:
user=<your database user name> DatabaseName=<your database name>
Where <your database user name> is user name you created in Step Three: Create a New
Database User, page 43 and <your database name> is the name of the database you created in
Step Two: Create a New DB2 Database, page 41.
8.
Click Test Driver Configuration to ensure that WebLogic can connect to the database using the
information you provided.
9.
When completed, click Finish to create the new data source.
10. The new database should appear in your Data Sources table. Click the database name to view
the Settings for DB2 JDBC xPression Connection Pool page. On the General page, select Row
Prefetch Enabled and click Save.
11. Click Connection Pools and supply the following values.
Setting
Definition
Initial Capacity
5
Maximum Capacity
20
You may need to increase this value if you have
trouble importing large PDP files.
12. Click the Advanced link to display the advanced options.
13. Select Test Connections on Reserve.
115
14. In the Test Table Name box, ensure the value is SQL SELECT COUNT(*) FROM
SYSIBM.SYSTABLES.
15. Click Save.
16. Click the Targets tab and select all servers that you want to target. Click Save.
17. From the Change Center section, click Activate Changes.
Oracle JDBC Driver
To define the Oracle JDBC driver, complete the following steps:
1.
Supply the following values for your Oracle database, and click Next.
Setting
Definition
Name
Oracle JDBC xPression Connection Pool
JNDI Name
The path where the data source is bound. By default, the JNDI
name is the data source name. For example:
jdbc/xPression_CR
Database Type
Select Oracle
2.
In the Database Driver list, select: Oracle’s Driver (Thin) for Service connections; Versions:Any,
and click Next.
3.
On the Transactions Options page, leave the settings at their default value, and click Next.
4.
On the Connection Properties page, supply the Oracle database information that you configured
in Step One: Create a New Database, page 54 and Step Two: Create a New Database User, page 55.
5.
On the Test Database Connection page, review the following configurations, and click Next.
Setting
Value
Driver ClassName
oracle.jdbc.OracleDriver
URL
Ensure that the values you defined for the Port and Database
Name are reflected in the URL path.
The syntax for the URL is:
jdbc:oracle:thin:@//server:port/databaseName
Database User Name
in this box.
Password/Confirm Password
Ensure the correct password is used.
Properties
user=database_username
where database_username is the username of your xPression
database.
6.
116
Select all of the servers that you want to target and click Finish.
7.
On the Summary of JDBC Data Sources page, click your data source from the Data Sources table
to open the settings page.
8.
On the General tab, select Row Prefetch Enabled and click Save.
9.
On the Connection Pool tab, configure the following options, and click Save.
Setting
Definition
Initial Capacity
5
Maximum Capacity
20
Note: You may need to increase this value if you
have trouble importing large PDP files.
10. Click the Advanced link to display the advanced options, and ensure that the Test Connections
On Reserve option is selected.
11. In the Test Table Name box, ensure that the value is SQL SELECT 1 FROM DUAL, and click
Save.
12. From the Change Center section, click View changes and restarts. The Changes and Restarts
page appears.
13. You can view that your data source is listed on the Restart Checklist tab. Select the data source
and click Restart.
Microsoft SQL Server Driver
To define the Microsoft SQL Server JDBC driver, complete the following steps:
1.
Supply the following values for your SQL Server database.
Setting
Definition
Name
MSSQL JDBC xPression Connection Pool
JNDI Name
The path where the data source is bound. By default, the JNDI name is
the data source name. For example:
jdbc/xPression_CR
Database Type
2.
Select MS SQL Server
Click Next and supply the following values:
Setting
Definition
Database Type
MS SQL Server
Database Driver
Select Other
3.
The Transactions Options page appears. Leave the settings at their default value and click Next.
4.
The Connection Properties page appears. Supply the following values and click Next.
117
5.
Setting
Definition
Database User Name
Supply the user name for the database user you created to
connect to the xPression database. You created this user in .
Supply the password for the user you created to connect to the
xPression database.
The Test database connection page appears. Ensure that the following values are defined.
Setting
Value
Driver ClassName
com.microsoft.sqlserver.jdbc.SQLServerDriver
URL
Ensure that the value you defined for the Port is reflected in the
URL path.
For SQL Server 2008 R2/2012:
jdbc:sqlserver://<serverName>:<portnumber>;
databaseName=<databaseName>
Database User Name
in this box.
Ensure the database password is defined in these boxes.
Properties
Ensure the following values are defined in the properties box
for SQL Server 2008 R2/2012:
user=<xPression_Database_User_Name> databaseName
=<databaseName> selectMethod=cursor
6.
Click Test Configuration to ensure that WebLogic can connect to the database using the
information you provided. The test should be successful.
7.
When completed, click Finish.
8.
The new data source appears in the data source table. Click your data source name from the
table to view the data source settings.
9.
On the General page, select Row Prefetch Enabled and click Save.
10. Click Connection Pool and configure the following options.
Setting
Definition
Initial Capacity
5
Maximum Capacity
20
You may need to increase this value if you have
trouble importing large PDP files.
11. Click the Advanced link to display the advanced options.
12. Select Test Connections on Reserve.
13. In the Test Table Name box, ensure the value is SQL SELECT 1.
118
14. Click Save.
15. Click the Targets tab and select all servers that you want to target. Click Save.
16. From the Change Center section, click Activate Changes.
Note: If you select non-English language for an SQL account, issues can take place during the
migration phase. Thus, we urge you to make sure that English is used with select name ,
language from master..syslogins where name = ’XPRESS_46’ (where ’XPRESS_46’ is
SQL xPression user). If required, modify it the following way:ALTER LOGIN XPRESS_46 WITH
DEFAULT_LANGUAGE = English
Configuring WebLogic When Publishing xPresso for Word
Documents from xBatch
When publishing xPresso for Word documents from xBatch on WebLogic 12C and the
UseAssemblyServiceEJB=false, following JVM parameters should be appended for
Java_Option of the BatchRunner files located in xPression Home:
-Dcom.sun.xml.ws.spi.db.BindingContextFactory=com.sun.xml.ws.db.glassfish.JAXBRIContextFactory
-Djavax.xml.bind.JAXBContext=com.sun.xml.bind.v2.ContextFactory
Manually Deploy the Enterprise Archive File
To manually deploy your enterprise archive file, complete the following steps:
1.
From the Domain Structure section on the left side of the Admin Console main page, click
Deployments. The Summary of Deployments page appears.
2.
Click Install. The Install Application Assistant appears.
3.
Navigate to the \xPression.ear directory you created in Extract the xPression Enterprise
Archive Files, page 94, and ensure that the \xPression.ear folder is specified in the Path field.
4.
On the Choose targeting style page, select Install this deployment as an application, and click
Next. The Optional Settings page appears.
5.
Leave the options at their default selections and click Finish. The deployment will take a few
seconds. When the application deployment completes, the Summary of Deployments page
appears.
6.
Click your application name in the Deployments list. The Settings for YourApplication page
appears.
7.
On the Targets tab, ensure that the application is targeted to your server.
Caution: Be aware that the enterprise archive file must be Started manually when your
configuration is complete.
119
Configure JTA
To modify the Java Transaction API (JTA) configuration for your xPression Server domain, complete
1.
In the Change Center section of the Admin Console, click Lock & Edit if you see this option.
Otherwise, ignore this step.
2.
From the Domain Structure section, select Services > JTA.
3.
Set the value of Timeout Seconds to 3600 and click Save.
Starting the Enterprise Archive Files
To start your enterprise archive file, complete the following steps:
1.
In the Change Center section of the Admin Console, click Lock & Edit if you see this option.
Otherwise, ignore this step.
2.
From the Domain Structure section, click Deployments.
3.
Select the xPression enterprise archive file to start, and select Start > Servicing all requests.
Starting the enterprise archive file will take a few seconds. After the start completes, you can
view the status in the State column.
Increasing Memory Size
To perform import and export functions, the xPression server sometimes requires more memory
than has been set. To optimize system performance, you may want to increase the Java Heap Size
for your xPression Server.
The minimum and maximum memory sizes for WebLogic are passed from the xPression
server at the time the server is started. For UNIX systems, these values are stored in
the StartxPressionServer.sh file; for Windows operating systems, they are in the
WebLogicHome\user_projects\domains\xpression\bin\StartxPressionServer.cmd
file. Your System Administrator will help you find or modify these files.
To change the memory defaults, locate the line that looks similar to the following example and
make the desired changes.
MEM_ARGS=”-Xms256m -Xmx1024m -Xss1m”
Increasing Maximum Message Size
If you encounter MaxMessageSizeExceededException errors, you can increase the Maximum
Message Size in the WebLogic Admin Console by completing the following steps:
120
1.
Log on to the Admin Console. From the Domain Structure section, select Environment > Servers,
and click your admin server name in the list. The Settings for YourServer page appears.
2.
On the Protocols > General tab, set the value of Maximum Message Size to 50000000, and
click Save.
Additional Configurations for JBoss
Complete the following configurations if you are using JBoss:
• Increasing Memory Settings, page 121
• Configuring Data Sources on JBoss, page 121
• Configuring Additional Components, page 125
• Starting and Stopping the Server, page 126
• Installing an xPresso Client on the Same Machine as the xPression Server, page 126
• Increasing Memory Size, page 120
Increasing Memory Settings
You can increase the Java memory settings via the following steps:
1.
Locate standalone.conf.bat in the following directory:
JBoss_install_dir\bin\
2.
Open the file for editing.
3.
Locate the following statement (your parameter values may be different than shown):
SET "JAVA_OPTS=%JAVA_OPTS% -Xms128M -Xmx512M -XX:MaxPermSize=512M"
4.
Increase the Xmx and MaxPermSize values to 1024M or higher.
5.
Configuring Data Sources on JBoss
The xPression installation program places a data source configuration information in a file on your
server. This information is automatically configured by the xPression installation program based on
the settings you provided during installation. You can update this information to add additional
settings or to correct configuration errors.
You can find this information in the xPression-standalone.xml file located in the following
directory:
JBoss_installation_directory\standalone\configuration
121
Perform the following database configuration steps if necessary:
• Windows Authentication with Microsoft SQL Server, page 122
• Using a Relational Database with JBoss, page 122
• Using a Non-Default Data Source with JBoss, page 122
Windows Authentication with Microsoft SQL Server
If you are using Windows authentication with Microsoft SQL Server, add integratedSecurity
=true to the connections string in the JBoss datasource configuration.
Open xPression-standalone.xml from the JBoss \standalone\configuration directory,
and locate the <connection-url> element. Add integratedSecurity=true to the connection
string. For example:
<connection-url>jdbc:sqlserver://localhost:1433;selectMethod=cursor;
databaseName=xpression;integratedSecurity=true</connection-url>
Using a Relational Database with JBoss
When setting up an RDB data source in xAdmin, the JNDI name syntax should be:
java:/jdbc/xPression_Database_Name
For example: java:/jdbc/xPression_CR
Using a Non-Default Data Source with JBoss
A non-default data source is a data source from a database not configured for the xPression
application during installation. To use a data source that is a non-default data source for JBoss, you
must make a few configuration changes. The following procedure shows how to configure JBoss to
use an Oracle data source with an xPression MS SQL database:
1.
Acquire the Oracle thin application client driver, class12.zip, from Oracle website:
http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html
2.
Place the driver in a location on the local machine, and point to it within the JBoss startup script
classpath:
SET JBOSS_CLASSPATH=
...:$ORACLE_DRIVER_DIRECTORY\class12.zip
3.
Copy the oracle-ds.xml file located in the $JBOSS_INSTALL_HOME\docs\examples\jca
directory, and paste in the $JBOSS_INSTALL_HOME\server\default\deploy\ directory.
4.
Modify the following lines as follows:
• Specify the name of the JNDI connection:
122
<jndi-name>OracleDS</jndi-name>
• Update the line <connection-url>jdbc:oracle:thin:@your_oracle_host:port:your_sid<
/connection-url> as below:
— your_oracle_host: The IP address or host name of the Oracle database you wish to connect to.
— port: The port the Oracle listener is configured to listen for remote connections.
— your_sid: The database SID.
The value of each of these components can be determined from the TNSNAMES.ora file,
located in $ORACLE_HOME\db_1\NETWORK.
• Specify the username and password to log onto the Oracle database:
<user-name>name</user-name>
<password>password</password>
5.
Copy the following code into a file called oracleConnectionTest.jsp and place it in the
$JBOSS_INSTALL_HOME\server\default\deploy\jmx-console.war directory:
<%@page contentType="text/html"
import="java.net.*.java.util.*,org.jboss.jmx.adapter.model.*,java.sql.*,
javax.sql.*,javax.naming.*"%>
<html>
<head>
<title>JBoss->Oracle Connection Text</title>
<link rel="stylesheet" href="style_master.css" type="text/css">
<meta http-equiv="cache-control" content="no-cache">
</head>
<body>
<%
InitialContext ctx = new InitialContext();
DatabaseMetaData dm = null;
DataSource ds = (DataSource)
ctx.lookup("java:/jdbc/OracleDS");
Connection conn = null;
Statement stmt = null;
try {
conn = ds.getConnection();
dm =conn.getMetaData();
out.println("Connected to-> database version
"+dm.getDatabaseProductVersion());
} catch (Exception sqlex) {
out.println(sqlex.getMessage());
} finally{
conn.close();
}
%>
</body>
<html>
This will test if the connection to the Oracle database was successfully set up.
6.
Start the xPression Server.
7.
Test the connection by going to http://Your_Hostname:8080/jmx-console/oracleConnnectionTest
.jsp. You should see a message that indicates the successful connection.
8.
Launch xAdmin and create a new data source group using the settings in the following table.
Element
Setting
Name
The user-specified name of data source group.
123
Element
Setting
Schema Source Type
Relational Database.
Qualifier
Leave blank.
You do not need a Qualifier unless the data source group is attached
to a specific schema outside the one the data source user login is
associated with. For example, the user is in the HR schema, and the
data source is in the EXAMPLES schema.
If, for some reason, you can’t retrieve the relational database tables
or date, try adding a Qualifier.
JNDI name
java:/JNDI_Name_From_DS_File
Make sure that the JNDI name is prefixed with "java:/”.
Get Schema/
Get Tables
Click to get the necessary tables.
• Set the desired table to the primary table.
• Set the pk value for the primary table.
Make sure all DATE data types have no values under the LENGTH
column, such as, LENGTH=Unlimited. Otherwise, xDesign will be
unable to pull data from the tables.
9.
Create a new data source using the settings in the following table.
Element
Setting
Name
The user-specified name of data source group.
Schema Source Type
Relational Database.
Qualifier
Leave blank.
You do not need a Qualifier unless the data source group is attached
to a specific schema outside the one the data source user login is
associated with. For example, the user is in the HR schema, and the
data source is in the EXAMPLES schema.
If, for some reason, you can’t retrieve the relational database tables
or date, try adding a Qualifier.
JNDI name
java:/JNDI_Name_From_DS_File
Make sure that the JNDI name is prefixed with "java:/”.
10. Once the data source has been created, you can then use it in a category and create documents
as normal.
124
Configuring Additional Components
Configure the following additional components if necessary:
• Define Path for xPression Logging, page 125
• Filenet Configuration, page 125
Define Path for xPression Logging
This step is for Documentum users only. If you are using Documentum, you must make the following
configuration change to ensure that xPression events are written to the xPression log. Without this
configuration step, the events will be written to the Documentum log. To ensure that xPression sends
logging information to the correct location, add the following parameter to the xPression start script.
This parameter will tell xPression where the default log configuration file resides.
1.
Locate your xPression start script. See Starting and Stopping the Server, page 126 to find the
location of the script.
2.
Open the start script for editing.
3.
Locate the variable JAVA_OPTS=.
4.
Add the following parameter to the end of the JAVA_OPTS statement:
-Dlog4j.configuration="xPressionHome\LogConfiguration"
Filenet Configuration
Filenet integration is not supported for JBoss. If you are integrating with Filenet, you must add these
Filenet paths to your JBoss application server classpath and set the JVM Generic Argument:
1.
Navigate to the JBoss bin directory.
2.
Locate the run.conf.bat file, and open it with a text editor.
3.
Locate the SET JAVA_OPTS= statement near the beginning of the file and add the following
argument:
-Xss1m
The complete line will resemble this:
Set JAVA_OPTS=%JAVA_OPTS% -xms128m -xmx512m -XX:MaxNewSize=256m
-XX:MaxPermSize=256m -Xss1m
This establishes the JVM Generic Argument. You may need to adjust these values for your
environment.
4.
From the same directory, open startxPressionServer.bat for editing.
5.
In this file, locate the SET JBOSS_CLASSPATH= statement. This statement will contain a list of
classpaths separated by a semi-colon(;).
125
In this statement, enter the paths to the Filenet jar files for your Filenet version. Append the paths
to the end of the statement. Separate each path with a semi-colon(;). For example:
C:\FilenetLib\jace.jar;C:\FilenetLib\soap.jar;
For UNIX systems:
/FilenetLib/jace.jar;/FilenetLib/soap.jar;
Before setting these paths, ensure that both paths exist on your server.
Starting and Stopping the Server
To start the server, run either of the following scripts:
• For Windows: JBoss_installation_directory\bin\StartxPressionServer.bat
• For Linux: JBoss_installation_directory/bin/StartxPressionServer.sh
When you run the script, JBoss will display numerous log messages from all of the JBoss components
as they are deployed and started. The final message will indicate that the server has been started.
To stop the server, run either of the following scripts:
• For Windows: JBoss_installation_directory\bin\shutdownxPressionServer.bat
• For Linux: JBoss_installation_directory/bin/shutdownxPressionServer.sh
Installing an xPresso Client on the Same Machine as
the xPression Server
If you are installing xPresso for InDesign or xPresso for Dreamweaver on the same
machine that hosts the xPression server, add a line to the Run.sh file located in the
JBoss_installation_directory\bin folder. In the Run.sh file, locate the following line:
-Djava.endorsed.dirs="$JBOSS_ENDORSED_DIRS" \
After this line, add the following text to ensure that all the components of the xPression Server
are started correctly:
-Djava.awt.headless=true \
Configuring the xPression Diagnostic Utility
The xPression diagnostic utility should only be used under the direction of EMC Document Sciences
Support personnel. The diagnostic data produced by the utility is likely only useful to EMC
Document Sciences developers.
This utility captures dumps of the inputs and outputs that certain programs generate during
assembly. This information can help Document Sciences Support personnel trace and resolve
problems with your xPression implementation.
126
You can capture assembly diagnostic data for a specific user from xDesign or for a specific batch
run by using xPression Batch.
The output created by this utility is stored on your xPression Server. If you are running this utility
from an xDesign client, you may need assistance from your IT department to retrieve the output.
Before you can use the utility, you must complete the following configuration steps:
1.
Open the AssemblyEngine.properties file located in the xPressionHome directory.
2.
Add the following parameter:
DiagnosticDirectory=desired_server_path
where desired_server_path is a path on your xPression Server where utility output should be
stored. This directory must already exist on your server, the utility will not create it for you.
For example:
DiagnosticDirectory=C:\xPression\diagnosticfiles\
If the diagnostic utility output cannot be written to the directory you specify, the assembly process
will continue, but a warning message will be written to your xPression.log file.
See the xPression Server Administration Guide for more information about the xPression Diagnostic
Utility.
Oracle Database Settings for BatchRunner
If your customer data is in an Oracle database, and large batch jobs fail with a message in
xPression.log indicating that xPression BatchRunner can’t find a record set, it is likely that the
connection to the database has timed out and been dropped. The timeout occurs intermittently when
parameter settings in the init.ora file are not high enough to enable BatchRunner to continue
processing with the database connection.
EMC Document Sciences recommends changing the init.ora parameters to at least the values
shown in the parameter list if your system can accommodate them. When choosing the parameter
values, consider the RAM capacity in your server and how your organization is using the system.
Higher settings optimize BatchRunner’s performance if your system can handle them. The
recommended Oracle init.ora parameter settings are:
DB_BLOCKS_BUFFERS = 3540 (or more)
LOG_BUFFER = 786432
OPEN_CURSORS = 500
SESSION_CACHED_CURSORS = 500
CURSOR_SHARING = FORCE
SHARED_POOL_SIZE = 54525952 (or more)
processes = 250
sessions = 280
always_anti_join = HASH
always_semi_join = HASH
star_transformation_enabled = TRUE
To apply the new settings, always restart your database after modifying the init.ora file.
Note: If you are using an Oracle-controlled data warehouse, set the star_transformation_enabled
parameter to TRUE.
127
Configuring User Access for xAdmin and
xDashboard
User access to xAdmin and xDashboard is no longer configured through your application server.
xAdmin enables administrators to configure access based on roles. Your xPression installation comes
with a pre-configured super administrative user named xpressionsa. Use this user account to gain
initial access to xAdmin and set up access for your users based on their role. The password for
the super administrative user is xpressionsa but you can change it through the User Management
section of xAdmin. If you forget the changed password for the super administrator, see Resetting the
Super Administrator User Password, page 128.
Upgrading customers should ensure that any xAdmin users previously configured through your
application server are now available to xAdmin through the mode of authentication you have chosen
for xPression users (LDAP or local operating system authentication). To learn more about assigning
roles for your users, see the xAdmin User Guide.
Resetting the Super Administrator User Password
The super administrator username and password are the same upon installation
(xpressionsa/xpressionsa). You can always change the password of the xpressionsa user through
xAdmin. If you forget your chosen password, you can reset the password to the default value
(xpressionsa/xpressionsa) through a SQL script provided with your installation files. There is a
script for each database supported by xPression:
• DB2 databases — DB2_Super_User_Password_Reset.ddl
• Oracle databases — Ora_Super_User_Password_Reset.sql
• Microsoft SQL Server databases — SQL_Super_User_Password_Reset.sql
Run the script against your xPression database to reset the password. Use the same procedure you
used to install your xPression database tables.
Connecting CompuSet Bridge to the Server
To connect CompuSet Bridge/Autograph 64-bit modules to the xPression Server in Servlet mode,
apply the following registry changes:
Windows Registry Editor Version 5.00
[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{7154F305-383F-426B-9987-9E1ED0C993C6}]
"AppID"="{7154F305-383F-426B-9987-9E1ED0C993C6}"
[HKEY_CLASSES_ROOT\Wow6432Node\AppID\{7154F305-383F-426B-9987-9E1ED0C993C6}]
"DllSurrogate"=""
[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\AppID\{7154F305-383F-426B-9987-9E1ED0C993C6}]
128
"DllSurrogate"=""
129
130
Chapter 8
Installing and Configuring Client
Applications
xPression Enterprise Edition users (including Enterprise Edition users who have purchased
Documentum Edition as an add-on) need to install xDesign and can configure any other application if
licensed to do so. Documentum Edition-only users cannot install xDesign or configure xResponse
and xRevise. Documentum Edition-only users must install one of the xPresso client applications.
See the installation and configurations for each client application:
• xDesign, page 131
• xPresso for Word, page 136
• xPresso for Adobe InDesign, page 139
• xPresso for Dreamweaver, page 145
• Managing Certificates of HTTPS Servers, page 150
• Configuring xResponse, page 151
• Configuring xRevise, page 152
• xEditor, page 153
• About Deploying xPressForms, page 158
• About xPression Adapter, page 159
• Using XQuery Outside of xPression, page 165
xDesign
The xPression Client installation makes use of the Windows Installer engine introduced with
Windows 2000. If the installation program cannot find the Windows installer software on your
target system, you will be prompted to install it. At the beginning of the installation process, the
installation program loads the Windows installer. This portion of the installation cannot be cancelled
by clicking the Cancel button. You must wait for the Windows installer to finish loading, then cancel
the installation.
You can find more information about Windows Installer at http://www.microsoft.com/windows2000
/docs/wininstaller.doc
131
The installation program begins by attempting to detect a previously installed version of xPression
client. If xPression does not detect a previously installed version, it follows the installation path
described in Installing xDesign, page 132.
Chinese Language Paths
Installing xDesign to a path that contains Chinese characters is not supported; xDesign must be
installed to an English character path.
Requirement for Windows
When installing xDesign on Windows, the default installation directory is C:\xPression Design. If
you change this default location to a sub-folder of the Program Files directory, you will need to use
"run as administrator” to run xDesign.exe and winword.exe. To avoid this limitation, install xDesign
to a location outside of the Program Files directory.
Before installing xDesign on Windows 2008 R2, you must use System Manager to install .NET
Framework 3.5.1-Features;otherwise, you will encounter errors when launching xDesign.
Exporting Searchable Document Lists
If you have created searchable document lists while using xDesign previously, and you want to install
xDesign on another computer, you can export the searchable document lists to the target computer.
The searchable document lists are saved in the registry of your computer at HKEY_CURRENT
_USER\Software\Document Sciences Corporation\xPression\xPression
Design\Preferences\Stored Search Product Lists. To move the searchable document
lists to another computer, use registry tools to export the key/value pairs from that registry location,
and then import them to the target computer.
Installing xDesign
The installation of xDesign uses a step-to-step wizard. Open the xDesign.net_Installer
directory and double-click setup.exe to start the installation wizard. Follow the instructions on the
wizard and provide necessary information on each step.
You may encounter the following options during your installation:
• On the Setup Type page, select a installation method. A Typical installation installs xDesign and
the xPression Help files, and a Custom installation enables you to install or exclude the xPression
Help files and CompuSet.
• The Client Connectivity page defines how the client communicates with the xPression Server.
Provide the following information:
132
Field/Option
Definition
Application server platform
Select your application server type from the
drop-down list.
Connection method
Select RMI or Servlet. Select the correct method for
your system configuration.
xPression
Server
Descriptive server name
Type a descriptive name for the server. This name
will appear in the server name box when selecting a
server to log on to.
Server name or IP
address
The name or IP address of the xPression Server.
Port Number
The port number of the xPression Server.
xPressForms
Select this option if you are using xPressForms and
supply the server information in the provided boxes.
This feature enables xDesign to access fxPressForms
to perform an xPressForms Search.
xPression Catalog
Select this option if you are using Catalog and supply
the server information in the provided boxes. This
feature enables xDesign to access Catalog to perform
an Catalog Search.
• When the installation program completes, you are prompted to restart your system. You can
select to restart your system immediately or at a later time. Because the installation continues after
restarting the computer, you must log on as an administrator during the restart.
Installing xDesign in Silent Mode
This feature enables you to capture your installation selections in an installation response file,
then use that file to perform additional installations without the need to remake your installation
selections. First, you must run the xDesign installation wizard in order to capture your installation
selections in a response file. After the response file is created, you can use it to automatically supply
the installation selections to the xDesign installer for additional installations.
This section contains the following topics:
• Changing Log Location for Silent Mode Installer, page 134
• Creating the xDesign Silent Installer Response File, page 134
• Running the xDesign Silent Installation, page 135
If your xPression server is using the HTTPS protocol, the certificates of used HTTPS servers must be
imported. See Managing Certificates of HTTPS Servers, page 150 for detailed steps.
133
Changing Log Location for Silent Mode Installer
The Silent Mode installer log file provides result codes that indicate success or error in the installation
process. By default, the name of the file is setup.log and it is created in the same directory as the
xDesign installer (setup.exe). You can change the name and location of this log file with the f2 switch.
Use the following syntax:
setup.exe /s /f2"C:\silentmodelog.log"
Ensure you place the path and file name in quotes. Do not place a space between the switch and the
path.
The log returns the following result codes:
• –0 — Success
• –1— General error
• –2 — Invalid mode
• –3 — Required data not found in the Setup.iss file.
• –4 — Not enough memory available.
• –5 — File does not exist.
• –6 — Cannot write to the response file.
• –7 — Unable to write to the log file.
• –8 — Invalid path to the InstallShield Silent response (.iss) file.
• –9 — Not a valid list type (string or number).
• –10 — Data type is invalid.
• –11 — Unknown error during setup.
• –12 — Dialog boxes are out of order.
• –51 — Cannot create the specified folder.
• –52 — Cannot access the specified file or folder.
• –53 — Invalid option selected.
Creating the xDesign Silent Installer Response File
By default, the Silent Mode installer response file is named setup.iss and stored in your Windows or
WINNT directory, but you can change the name and location of this file. Use the following switches
when creating the response file:
• /r — Creates a response file to capture all of your installation selections. Use the following syntax:
setup.exe /r
• /f1 — Enables you to change the location and name of the response file. By default the response
file is named setup.iss and stored in the Windows or WINNT directory. To change the name
and/or location, use the following syntax:
setup.exe /r /f1"C:\responsefile.iss"
134
The switch uses the number "one”, do not confuse it with a lowercase "L” or a capital "I”. Ensure
you place the path and file name in quotes. Do not place a space between the switch and the path.
To create the Silent Mode installer response file complete the following steps:
1.
2.
Navigate to the directory that contains the xDesign installer (setup.exe).
3.
setup.exe /r
Use the f1 switch if you want to change the name or location of the response file.
4.
The installer will start, follow the wizard prompts to define all of your installation settings.
When the installer finishes, restart the computer.
5.
Unless you changed the name and location, the setup.iss response file now resides in your
Windows or WINNT folder.
Running the xDesign Silent Installation
To run the Silent Mode installer, you must provide the installer with the location of your response file.
You can either copy the response file to the directory that contains the xDesign installer (setup.exe),
or use a switch to specify different location and/or filename. By default, the installer will create a
Silent Mode log file named setup.log in the same directory as the xDesign installer (setup.exe). To
change the location and/or name of the log file, use the f2 switch. For more information, see Changing
Log Location for Silent Mode Installer, page 134. Use the following switches when running the
Silent Mode installer:
• /s — Activates Silent Mode. The installer will look for the setup.iss response file in the same
directory unless you specify a different filename or location with the f1 switch.
• /f1 — Enables you to specify a different location and/or filename for the response file. Use the
following syntax:
setup.exe /s /f1"C:\responsefile.iss"
The switch uses the number "one”, do not confuse it with a lowercase "L” or a capital "I”. Ensure
you place the path and file name in quotes. Do not place a space between the switch and the path.
To Run the Silent Mode Installer
1.
2.
Navigate to the directory that contains the xDesign installer (setup.exe).
3.
setup.exe /s
This command expects the setup.iss file to reside in the same directory as setup.exe. To change
the location and/or filename, use the f1 switch.
4.
The installer will install xDesign in the background. Restart the computer after the installation
completes.
135
Update LAN Settings
Verify the LAN settings on each computer that will serve as an xPression client.
1.
From your Internet Explorer, select Tools > Internet Options.
2.
Click the Connections tab.
3.
Click LAN Settings, and ensure that the Automatically detect settings box is cleared. If this box
is checked, xPression applications that access the xPression database through servlet mode may
experience a 60-second delay when exiting.
xPresso for Word
xPresso for Word has specific requirements for operation. For a list of hardware and software
requirements, see the System Requirements chapter of the xPression Release Notes.
Note: If you have xPresso clients deployed on the same Windows workstation and you want to
uninstall the plug-ins for one of the xPresso clients, do not select the remove all common files option
during the uninstallation; otherwise, the other xPresso clients might encounter error.
• Before You Install, page 136
• Installing xPresso for Word, page 137
• Registering Your Software, page 138
Before You Install
Before you install xPresso for Word, ensure that you have obtained the following information:
• Serial Number—The serial number is specific to your company and the xPresso client applications
purchased, specifying a certain number of licenses for each application. EMC provides the serial
number to your company or administrator along with the installation files.
• Request Code—The request code is specific to the machine upon which you run the xPresso
client. This request code secures the software from being copied to other machines.
• License Key—The license key is granted to you from the EMC Document Sciences self-service
activation application or manually from EMC Licensing ([email protected]). The license key’s
term of validity is set by the serial number and the master agreement with your company.
Note: Ensure that you have administrative privileges to install xPresso client applications.
136
If you are installing xPresso for Word for the first time on a computer, ensure that the following
components are installed:
• Microsoft Office
• Microsoft .NET Framework
• Visual Studio Tools
• Microsoft Office Primary interop Assemblies (PIA)
See the xPression Release Notes for the supported versions of the software. You can go to the
Microsoft Website to obtain the installation programs and install the components as instructed
in the installation wizards.
If you have installed xPresso for Word 4.2, and want to work with both 4.2 and 4.6 on your computer,
you do not need to uninstall xPresso for Word 4.2. For any other versions, you must uninstall xPresso
for Word before installing the latest version. See Uninstalling xPresso Client Applications, page 199
for how to remove xPresso.
Ensure that all Microsoft Word and Outlook applications are closed before the installation.
Directory for Temporary Files
During the installation process, the installer uses the system default temporary directory
(%TMP%($TMP)) to store temporary files. The installer doesn’t support non-English characters in
this path. If your default temp directory contains unsupported characters, you must change the
path to one that contains only English characters before installation. You can reset the path after
the installation completes.
The directory that the software is installed to must consist of standard English letters (A-Z, upper
or lower case), digits (0–9), the underscore, hyphen, or parentheses characters. Internationalization
characters are not supported.
Supported Data Types
xPresso for Word and the xPression Server support industry standard XML data sources and data
schema files for your variable data input. Your variable records can all be contained in a single XML
file or broken out into separate XML files. If you have multiple XML files, store them all in the same
directory, and in a location that xPresso for Word can access. Each of your XML files for a particular
document must be compatible with the schema used to create the document.
xPresso for Word supports the following data types: String, Boolean (true/false), DateTime, Date
(format: YYYY-MM-DD), Time, Integer, Double, and Float.
Installing xPresso for Word
Installing xPresso for Word is guided by a step-by-step installation wizard. If you are installing a
non-English version of xPresso for Word, use the steps in this section to install the English version,
137
and then follow the steps in Installing a Language Pack for xPresso for Word, page 191 to install
the correct language pack.
Note: If you are installing on a system using Chinese language settings, you may see a question mark
(?) within the Chinese text. This is an issue with the InstallAnywhere software that is used to create
the installation program, and not an issue with the installation program itself.
Run the xPresso_for_Word_Install_Windows.exe file from your installation package, and
follow the instructions in the step-by-step wizard.
Note the following issues:
• On the xPresso for Word Installation Folder page, the directory path must consist of standard
English letters (A-Z, upper or lower case), digits (0–9), the underscore, hyphen, or parentheses
characters. Internationalization characters are not supported.
In the Installation Types section, select the user to use xPresso for Word.
— Current User—Enables only the current user logged on to this machine during installation to
use the software. If any other users require the use of the software on this machine, xPresso for
Word must be installed again for those users.
Be aware that if you select Current User, any user logged in as a different user will not be able
to use this installation of xPresso for Word. Also, if a different user has already installed
xPresso for Word on this machine, and you select the same installation directory, you will
be prompted with a message that xPresso is already installed. If you choose to overwrite
the other installation, the other user will no longer be able to use xPresso for Word on this
machine. If you choose a different directory, both users will be able to use their installation
of xPresso for Word.
— All Users—Enables any user logged in to this machine to use the software, without installing
xPresso for Word again.
• If you select to install the Corda Builder, ensure that the installation path for the xPresso Charts
application does not have spaces in it.
Registering Your Software
Before the xPresso for Word software can be used, it needs to be registered. Registration can be done
while running the installer, or after the installation process is complete. If you completed registration
while running the installer, you can skip this section.
The registration process requires that you launch xPresso for Word, obtain the request code, submit
the request code, receive your license key, and then apply your license key. Obtaining your license
key is done through an easy-to-use Web interface.
To register your software:
1.
Launch xPresso for Word. The xPresso Register dialog box appears automatically at start-up.
If the dialog box doesn’t appear automatically, click the xPresso tab on the Word Ribbon and then
click Register (with the gold key icon). If you don’t see the xPresso tab, you may need to enable
the xPresso COM add-in. For more information, see Enabling the xPresso COM Add-in, page 209.
2.
138
In the Register dialog box, select and copy the entire contents of the Request Code field. The
Request Code is unique to the machine the software is running on.
3.
Open a Web browser and navigate to http://www.docscience.com/xpressoregister3. The EMC
Document Sciences xPresso Product Activation page appears. The xPresso Product Activation
page enables you to submit your request code and receive your license key in an e-mail response.
4.
Paste the entire Request Code into the Request Code field on the web page.
5.
Type your first and last name, telephone number and e-mail address. Your e-mail address
must match the domain addresses registered for your company. For example, a license key for
Document Sciences Corporation may be sent to [email protected] but not [email protected].
6.
Click Get License. Your license key will be sent from [email protected] to the e-mail address
specified - if you use spam filtering, add this to your e-mail address book to ensure prompt
delivery. If your request was processed successfully, you will see a confirmation message.
7.
Copy the license key from the e-mail into the Register dialog box License Key field within xPresso
for Word. Ensure that you copy the entire license key.
8.
Click OK. You will see a confirmation message that the license has been accepted.
9.
Click OK. The Register dialog box closes and your xPresso for Word software is now ready for use.
Now that you have installed and registered xPresso for Word, you should perform an end-to-end
verification test to ensure that your installation is configured and working correctly.
xPresso for Adobe InDesign
xPresso for Adobe InDesign has specific requirements for each supported platform. For a list of
hardware and software requirements, see the xPression Release Notes.
• Installing the xPresso Plug-ins into the Extension Manager, page 141
• Installing on Windows, page 142
• Installing on Macintosh, page 142
139
Before You Install
Before you install xPresso for Adobe InDesign, ensure that you have done the following things:
• Obtained the following information for xPresso for Adobe InDesign:
— Serial Number—The serial number is specific to your company and the xPresso client
applications purchased, specifying a certain number of licenses for each application. EMC
provides the serial number to your company or administrator along with the installation files.
— Request Code—The request code is specific to the machine upon which you run the xPresso
— License Key—The license key is granted to you from the EMC Document Sciences self-service
activation application or manually from EMC Licensing ([email protected]). The license
key’s term of validity is set by the serial number and the master agreement with your company.
• Uninstalled any existing version of xPresso. See Uninstalling xPresso Client Applications, page
199 for how to remove xPresso.
• Installed Adobe InDesign on your computer.
Requirements for Windows Users
Before you attempt to install the software, ensure that the installing user account is configured
to notify you when software attempts to make changes to your computer. To verify this setting,
complete the following steps:
1.
Open the Control Panel and click the User Accounts link.
2.
Click Change User Account Control Settings.
3.
Ensure that this setting is not set to “Never notify”. The setting must be set to allow notification.
Choose Notify me only when programs try to make changes to my computer
(do not dim my desktop), Default — Notify me only when programs try to
make changes to my computer, or Always notify me.
4.
Click OK when finished.
About InDesign Versions
Refer to xPression Release Notes for the supported Adobe InDesign versions. Installing xPresso for
multiple versions of InDesign on the same computer is not supported.
If you want to install xPresso for Adobe InDesign CC, be aware that xPression supports only the
32-bit version of Adobe InDesign CC on Windows platforms. To install Adobe InDesign CC on a
64-bit Windows system, you must download the installer from the Adobe website manually. Adobe
Creative Cloud does not support installing the 32-bit version on a 64-bit Windows system.
To install Adobe InDesign CC on a Macintosh, you can either use Adobe Creative Cloud or download
the installer from Adobe website.
140
Adobe InDesign CS 6 is supported only on Windows systems.
(%TMP%($TMP)) to store temporary files. The installer does not support non-English characters in
this path. If your default temp directory contains unsupported characters, you must change the path
to contain only English characters before installation. You can reset the path after the installation
completes.
Installing the xPresso Plug-ins into the Extension
Manager
You can install the xPresso plug-ins into the Extension Manager so that you can disable the plug-ins
in InDesign when necessary. For example, you may want to disable the plug-in to create files that can
be shared with non-xPresso installations of InDesign.
If you did not install the xPresso plug-ins into the Extension Manager, there is no easy way to disable
the xPresso for Adobe InDesign plug-ins. However, many organizations do not need to disable the
plug-ins. Check with your organization to see if it is necessary to disable the plug-ins. If you are not
going to disable the plug-ins, select No on the xPresso Plugin page during installation. See detailed
installation steps in Installing on Windows, page 142 and Installing on Macintosh, page 142.
Installing the xPresso plug-ins into the Adobe Extension Manager (selecting Yes on the xPresso
Plugin page) will take some time to complete. The installation process may seem hung or stalled,
however, it is still processing. The Installation Complete page appears after the process is finished.
If you selected Yes on the xPresso Plugin page in a previous installation of xPresso for Adobe
InDesign CS 6, and you want to select No in a subsequent installation, complete the following steps to
ensure the availability of xPresso in InDesign:
1.
Uninstall xPresso for Adobe InDesign manually. See for detailed instructions.
2.
Locate the PlugInConfig.txt file in either of the following directories:
• On Windows: Your_drive:Users\Username\AppData\Roaming\Adobe\InDesign
\Version 8.0\Locale
• On Macintosh: User_home_directory/Library/Preferences/Adobe
InDesign/Version 8.0/Locale
where Locale is a locale-specific directory. For example, en_US is for English.
3.
Remove the lines of xPresso plug-ins in PlugInConfig.txt.
4.
Reinstall xPresso for Adobe InDesign.
If you do not want to install xPresso plug-ins into the Extension Manager during the installation
process, but want the ability to disable the plug-ins, you can use a manual process to install the
plug-in components at a later time. Refer to the Adobe Online Help to install plug-ins manually.
141
Installing on Windows
Ensure that you have read the information in Before You Install, page 140.
The xPresso for Adobe InDesign installation uses a step-by-step wizard. If you are installing a
non-English version of xPresso for Adobe InDesign, use these steps to install the English version,
and then follow the steps in Installing a Language Pack for xPresso for Adobe InDesign, page 192
to install the correct language pack.
Note: If you are installing over a previous xPresso for Adobe InDesign installation, make sure that
InDesign is closed before starting the installation process.
To Install xPresso for Adobe InDesign on Windows
1.
Navigate to the \Client\Windows directory in the xPression installation package. Double-click
xPresso_for_InDesign_Install_Windows.exe to start the installation wizard.
2.
Follow the installation wizard and provide necessary information.
When the xPresso Plugin page appears, note the following things:
Note:
• Refer to Installing the xPresso Plug-ins into the Extension Manager, page 141 for information
on deciding whether to install the xPresso plug-ins into the Adobe Extension Manager.
• If you selected Yes in a previous installation of xPresso for Adobe InDesign CS6, and you want
to select No this time, you must uninstall xPresso first and follow the instructions inInstalling
the xPresso Plug-ins into the Extension Manager, page 141.
3.
When you complete the installation, decide whether to install a language pack for a non-English
version. If yes, follow the steps in Installing a Language Pack for xPresso for Adobe InDesign,
page 192. If not, move on to Registering Your Software, page 144.
Installing on Macintosh
This section includes the detailed steps to install xPresso for Adobe InDesign on a Macintosh
platform. Ensure that you have read the information in Before You Install, page 140.
Note: Installing xPresso for multiple versions of InDesign on the same computer is not supported.
About the Java Environment
xPresso for Adobe InDesign requires Sun Java 2 Platform, Standard Edition (J2SE) version 1.6 or
higher version installed on the machine before you run the xPresso for Adobe InDesign installation
program.
You can check which version of JDK is installed on your machine by following these steps:
1.
Navigate to the Applications/Utilities folder and open Terminal.
2.
From the File menu, select New Shell.
142
3.
java -version
You should see something similar to the following image, which shows an example of the
terminal display after entering the Java version command.
If your Macintosh machine has multiple version of JDK installed, you can run the installer through
the command line to specify which version you want the software installed with, for example:
xPresso Install.app/Contents/MacOS$ ./xPresso\ Install LAX_VM /user/bin/java
where /user/bin/java is the location of your JDK.
Another option is to remove the other versions of the JDK from the system. You can do this by
simply moving the other version files to a different directory. Ensure that if you do this, no other
applications running on your system require the other versions.
To Move Other Java Versions
1.
Create a new folder to store the other Java versions. Do not delete these versions in case you
need to restore them later.
2.
Open the following folders in order: System, Library, Frameworks, JavaVM.framework, and
Versions.
3.
Move all the unsupported Java versions to the new folder you created in Step 1.
Performing a Macintosh Installation
The xPresso for Adobe InDesign installation uses a step-by-step wizard. If you are installing a
non-English version of xPresso for Adobe InDesign, use these steps to install the English version,
and then follow the steps in Installing a Language Pack for xPresso for Adobe InDesign, page 192
to install the correct language pack.
Note:
• Before installing, ensure that the account you are logged in with has write permission to these
folders: /Library and /Library/Frameworks. If not, you will see a message on the final
installer page that the installation completed with errors, and xPresso for Adobe InDesign will
not be completely installed.
• If you encounter the “.app is damaged and can’t be opened” error, go to System Preferences >
Security & Privacy > Allow apps downloaded from: and select Anywhere.
To Install xPresso for Adobe InDesign on Macintosh
1.
Navigate to the /Client/Macintosh directory in the xPression installation package.
Double-click xPresso_for_InDesign_Install_Mac. An authentication box appears for you to
provide your user name and password.
2.
Follow the installation wizard and provide necessary information.
When the xPresso Plugin page appears, note the following things:
143
Note:
• Refer to Installing the xPresso Plug-ins into the Extension Manager, page 141 for information
on deciding whether to install the xPresso plug-ins into the Adobe Extension Manager.
• If you selected Yes in a previous installation of xPresso for Adobe InDesign CS6, and you want
to select No this time, you must uninstall xPresso first and follow the instructions inInstalling
the xPresso Plug-ins into the Extension Manager, page 141.
3.
version. If yes, follow the steps in Installing a Language Pack for xPresso for Adobe InDesign,
page 192. If not, move on to Registering Your Software, page 144.
Multiple User Access to InDesign on Macintosh
On Macintosh systems where multiple users with individual logins require access to xPresso
for Adobe InDesign, it is highly recommended that the system administrator manually change
permission of the ’Indesign.app’ to allow some level of access to all users who may require access to
xPresso for Adobe InDesign. If permission is not provided, access to packages will be restricted.
This procedure is normally performed one time, during installation, by the installation engineer.
Once performed on a given system it need not be repeated. It should only be attempted by properly
qualified individuals.
To Provide Permission to the InDesign Application
1.
Open the Terminal window and navigate to the location of the Adobe InDesign
InDesign_version.app file, where InDesign_version can be CS6 or CC 2014, depending
on the version that you use.
2.
Run the following commands:
chmod 777 "Adobe InDesign InDesign_version.app"
The commands have the following effects:
• 777 allows any user(s) or Group(s) login to the system to launch Adobe InDesign CS[#].
• 2777 grants the process the same authority as the group of “Adobe InDesign CS[#].app” to
read and write from or to another file or folder, such as the ‘temp’ folder.
• 4777 grants the process the same authority as the owner of “Adobe InDesign CS[#].app” to
read and write from or to another file or folder, such as the ‘temp’ folder.
Note: The commands are case-sensitive and must be entered exactly as shown.
Before the xPresso for Adobe InDesign software can be used, it needs to be registered. Registration
on a Windows platform can be done while running the installer, or after the installation process is
complete. Registration on a Macintosh must be done after the installation process is complete. If you
completed registration while running the installer, you can skip this section.
144
The registration process requires that you launch xPresso for Adobe InDesign, obtain the request
code, submit the request code, receive your license key, and then apply your license key. Obtaining
your license key is done through an easy-to-use Web interface.
Note: EMC Document Sciences recommends that the user logged on at the time of registration
be a member of the Administrator group. Otherwise, the user may need to enter the license key
upon each logon. To avoid this inconvenience, the current user should have write permission to the
util.bin file.
To Register Your Software
1.
Launch xPresso for Adobe InDesign, and on the xPresso menu, click Register.
2.
3.
Document Sciences License generator page appears. The xPresso Product Activation page enables
you to submit your request code and receive your license key in an e-mail response.
4.
5.
Type your first and last name, telephone number and e-mail address. Your e-mail address must
match the domain addresses registered for your company. For example, a license key for EMC
Document Sciences may be sent to [email protected] but not [email protected].
6.
delivery. If your request was successfully sent, you’ll see a confirmation message.
7.
Copy the license key from the e-mail into the Register dialog box License Key field within the
xPresso for Adobe InDesign. Ensure that you copy the entire license key.
8.
9.
Click OK. The Register dialog box closes and your xPresso for Adobe InDesign software is
now ready for use.
Note: Ensure that the values in the User Name and Company fields in the Register dialog box use
characters from a single language. If either of the fields contains characters from more than one
language, the registration will fail and generate an error.
xPresso for Dreamweaver
xPresso for Dreamweaver has specific requirements for operation. For a list of hardware and software
requirements, see the System Requirements chapter of the xPression Release Notes.
• Installing on Windows, page 147
145
• Installing on Macintosh, page 148
Before You Install
Before you install xPresso for Dreamweaver, ensure that you have done the following things:
• Installed Adobe Dreamweaver and Extension Manager on the computer. Ensure that the versions
of Dreamweaver and Extension Manager match. For example, if you want to install xPresso for
Dreamweaver CC 2014, you must install Adobe Dreamweaver CC 2014 and Adobe Extension
Manager CC.
• Uninstalled any previous versions of xPresso for Dreamweaver. See for removing xPresso for
Dreamweaver from your computer.
• Obtained the following information:
— Serial Number—The serial number is specific to your company and the xPresso client
applications purchased, specifying a certain number of licenses for each application. EMC
provides the serial number to your company or administrator along with the installation files.
— Request Code—The request code is specific to the machine upon which you run the xPresso
— License Key—The license key is granted to you from the EMC Document Sciences self-service
activation application or manually from EMC Licensing ([email protected]). The license
key’s term of validity is set by the serial number and the master agreement with your company.
Requirement for Windows Users
Before you attempt to install the software, ensure that the installing user account is configured
to notify you when software attempts to make changes to your computer. To verify this setting,
complete the following steps:
1.
Open the Control Panel and click the User Accounts link.
2.
Click Change User Account Control Settings.
3.
Ensure that this setting is not set to “Never notify”. The setting must be set to allow notification.
Choose Notify me only when programs try to make changes to my computer
(do not dim my desktop), Default — Notify me only when programs try to
make changes to my computer, or Always notify me.
4.
Click OK when finished.
146
About Dreamweaver Versions
Refer to xPression Release Notes for the supported Adobe Dreamweaver versions. Installing xPresso
for multiple versions of Dreamweaver on the same computer is not supported.
If you want to install xPresso for Adobe Dreamweaver CC 2014.1, be aware that xPression only
supports the 32-bit version of Adobe Dreamweaver CC 2014.1 on Windows platforms. If you have
installed Adobe Creative Cloud, do not use the Creative Cloud to update Dreamweaver directly,
because Adobe Creative Cloud does not support installing the 32-bit version on a 64-bit Windows
system.
To install Adobe Dreamweaver CC 2014 on a Macintosh, EMC recommends you to download the
installer from Adobe website manually.
Supported Data Types
xPresso for Dreamweaver and the xPression Server support industry standard XML data sources and
data schema files for your variable data input. Your variable records can all be contained in a single
XML file or broken out into separate XML files. If you have multiple XML files, store them all in the
same directory, and in a location that xPresso for Dreamweaver can access. Each of your XML files for
a particular document must be compatible with the schema used to create the document.
xPresso for Dreamweaver supports the following data types: String, Boolean (true/false), DateTime,
Date (format: YYYY-MM-DD), Time, Integer, Double, and Float.
(%TMP%($TMP)) to store temporary files. The installer does not support non-English characters in
this path. If your default temp directory contains unsupported characters, you must change the
path to one that contains only English characters before installation. You can reset the path after
the installation completes.
Installing on Windows
Installing xPresso for Dreamweaver is guided by a step-by-step wizard. If you are installing a
non-English version of xPresso for Dreamweaver, use the steps in this section to install the English
version, and then follow the steps in Installing a Language Pack for xPresso for Dreamweaver, page
193 to install the correct language pack.
Note:
• When installing xPresso for Dreamweaver on a system using Chinese language settings, you
may see a question mark (?) within the Chinese text. This is an issue with the InstallAnywhere
147
software that is used to create the installation program, and not an issue with the xPresso for
Dreamweaver installation program itself.
• When you install xPresso for Dreamweaver on a computer that has an existing version, remove
the following folder before the installation. Otherwise, the Dreamweaver menu items may be
displayed incorrectly.
Your_drive:\Users\Username\AppData\Roaming\Adobe\Dreamweaver_version\
LanguageID\Configuration
To Install xPresso for Dreamweaver on Windows
1.
Navigate to the \Client\Windows directory in your installation package, and double-click
xPresso_for_Dreamweaver_Install_Windows.exe to start the installation wizard.
2.
Follow the wizard and provide necessary information.
Note: On the User Information page, ensure that both entries contain characters from a single
language; entries that use characters from more than one language will cause an error when
registering. The square brace characters ([]) and the equal sign (=) are not supported in the
Company Name and User Name fields.
3.
version. If yes, follow the steps in Installing a Language Pack for xPresso for Dreamweaver, page
193. Otherwise, move on to Registering Your Software, page 149.
Installing on Macintosh
This section includes the detailed steps to install xPresso for Dreamweaver on a Macintosh platform.
Installing xPresso for Dreamweaver is guided by a step-by-step wizard. If you are installing a
non-English version of xPresso for Dreamweaver, use the steps in this section to install the English
version, and then follow the steps in Installing a Language Pack for xPresso for Dreamweaver, page
193 to install the correct language pack.
Note:
• Before installing, ensure that the account you are logged in with has write permission to these
folders: /Library and /Library/Frameworks. If not, you will see a message on the final
installation page that the installation completed with errors, and xPresso for Dreamweaver will
not be completely installed.
• When you install xPresso for Dreamweaver on a computer that has an existing version, remove
the following folder before the installation. Otherwise, the Dreamweaver menu items may be
displayed incorrectly.
Users/Username/Library/Application Support/Adobe/Dreamweaver_version
/LanguageID/Configuration
If the Users/Username/Library directory is invisible, click Go > Go to Folder via Macintosh
Finder, and type ~/Library to open the directory.
• If you encounter the “.app is damaged and can’t be opened” error, go to System Preferences >
Security & Privacy > Allow apps downloaded from: and select Anywhere.
148
To Install xPresso for Dreamweaver on Macintosh
1.
Navigate to the /Client/Macintosh directory in your installation package, and
double-click xPresso_for_Dreamweaver_Install_MacOSX.zip. Then Double-click
xPresso_Install to start the installation wizard.
2.
Follow the wizard and provide necessary information.
Note: On the User Information page, ensure that both entries contain characters from a single
language; entries that use characters from more than one language will cause an error when
registering. The square brace characters ([]) and the equal sign (=) are not supported in the
Company Name and User Name fields.
3.
version. If yes, follow the steps in Installing a Language Pack for xPresso for Dreamweaver, page
193. Otherwise, move on to Registering Your Software, page 149.
Before the xPresso for Dreamweaver software can be used, it needs to be registered. Registration
on a Windows platform can be done while running the installer, or after the installation process is
complete. Registration on a Macintosh must be done after the installation process is complete. If you
completed registration while running the installer, you can skip this section.
The registration process requires that you launch xPresso for Dreamweaver, obtain the request
code, submit the request code, receive your license key, and then apply your license key. Obtaining
your license key is done through a web interface.
Note: EMC Document Sciences recommends that the user logged on at the time of registration be a
member of the Administrator group.
To Register Your Software
1.
Launch xPresso for Dreamweaver. On the xPresso menu, click Register.
2.
3.
Document Sciences License generator page appears. The xPresso Product Activation page enables
you to submit your request code and receive your license key in an e-mail response.
4.
5.
Type your first and last name, telephone number and e-mail address. Your e-mail address must
match the domain addresses registered for your company. For example, a license key for EMC
Document Sciences may be sent to [email protected] but not [email protected].
6.
delivery. If your request was successfully processed, a confirmation message appears.
7.
Copy the license key from the e-mail into the Register dialog box License Key field within the
xPresso for Dreamweaver. Ensure that you copy the entire license key.
149
8.
9.
Click OK. The Register dialog box closes and your xPresso for Dreamweaver software is now
ready for use.
Note: Ensure that the values in the User Name and Company fields in the Register dialog box use
characters from a single language. If either of the fields contains characters from more than one
language, the registration will fail and generate an error.
Managing Certificates of HTTPS Servers
imported. Manage the certificates from the command line using xCertMgr.bat or xCertMgr.sh
in the following locations:
• xDesign: xDesign_Installation_Directory\bin
• xPresso for Word: xPresso_for_Word_Installation_Directory/Properties
• xPresso for Adobe InDesign: Adobe_InDesign_Installation_Directory on Windows or
Adobe_InDesign_Installation_Directory/xPresso on Macintosh
• xPresso for Dreamweaver: Adobe_Dreamweaver_Installation_Directory on Windows or
Adobe_Dreamweaver_Installation_Directory/xPresso on Macintosh
You can import a new certificate, delete an existing certificate, and list all the imported certificates.
The certificates that you want to import must meet the following requirements:
• The certificates to import must be X.509 certificates.
• The whole certificate chain (from the root certificate to the certificate of the server) must be
imported
• Certificates for different servers must be of different names. The certificate file name (with
extension) prefixed with “xdesign_” will be used as the alias for the certificate.
• The file name of a certificate must consist of standard English letters (A-Z, upper or lower case),
digits (0–9), or underscores.
You must have Administrator privileges to run the following commands from the command line:
• To import a certificate, use one of the following commands according to your system:
XCERTMGR.BAT -import certificate_file_path
XCERTMGR.sh -import certificate_file_path
where certificate_file_path is the full file path of your certificate.
Note: If a security warning appears asking whether you want to install the certificate, click Yes to
continue.
• To delete a certificate, use one of the following commands according to your system:
XCERTMGR.BAT -delete certificate_alias
XCERTMGR.sh -delete certificate_alias
• To list imported certificates, use one of the following commands according to your system:
XCERTMGR.BAT -list
XCERTMGR.sh -list
150
Note: If you install xPresso for Adobe InDesign and xPresso for Dreamweaver on the same Macintosh
workstation, specify different file names for a certificate when importing it for xPresso for Adobe
InDesign and for xPresso for Dreamweaver.
Configuring xResponse
See the xPression Release Notes for complete information about the supported and required
components to run xResponse, and then complete the following additional configurations:
• Install .NET 4.0 for Microsoft Word. The application provides a link to the download for this
component. When you install .NET, ensure that you restart Internet Explorer
• Configure Internet Explorer settings
• Configure HTTPS server certificates. Contact your system administrator who installs xDesign
to get the xCertMgr.bat and CertManager.exe files, and then following the instructions in
Managing Certificates of HTTPS Servers, page 150.
• Configure xResponse user access
• Set Microsoft Word macro security no higher than ’High’
• Install VBA
• Configure eCor.properties
Internet Explorer Settings
Automatically detect settings in Microsoft Internet Explorer’s Local Area Network (LAN) Settings
should NOT be selected. Significant performance degradation for xEditor has been noted when this
option is selected. It will be noted as a Warning in the xEditor log if selected.
When using Internet Explorer, you must add the xPression server to the Local intranet list if the
server is on the local intranet, or to Trusted sites list if the sever is not on the local intranet.
To add xPression server to the Local Intranet or Trusted Sites:
1.
In Internet Explorer, open the Tools menu and click Internet Options.
2.
On the Security tab, click Local intranet if the xPression server is on the local intranet, or Trusted
sites if it is not.
3.
Click Sites.
4.
If you are adding the server to Local intranet, click Advanced.
5.
Type the URL of the xPression server in Add this website to the zone. For example,
http://127.0.0.1 or http://xpressionserver. Note that you can add an entry for
both IP address and server name format, and this provides some additional assurance that a
connection will be established.
6.
Click Add. The xPression server is added to the list.
7.
Click Close or OK at each dialog box, as appropriate, to close all open dialog boxes.
151
xResponse User Access
The user must have read, write, and create access to the EMC Document Sciences directory.
xEditor needs to write log and other files to this location. You can find this folder in
Your_drive:\Users\username\AppData\Roaming\EMC Document Sciences
Installing VBA
This section applies to Microsoft Word users only. In some cases, Visual Basic for Applications (VBA)
is not installed by default. xEditor requires VBA when using Microsoft Word. You must install
VBA manually if it is not installed by default.
To Verify and Install VBA
1.
Open Add or Remove Programs from Microsoft Windows Control Panel. The UI varies
somewhat depending on the operating system version. Refer to the Microsoft Windows
documentation for information on using Control Panel and the Add or Remove Programs feature.
2.
Locate and select the Microsoft Office entry and click Change. The installation wizard opens.
3.
On the Change Your Installation step select Add or Remove Features and then click Continue.
4.
Expand the Office Shared Features node.
5.
Locate the Visual Basic for Applications node. If the node indicates that VBA is not installed, click
the node and select Run from My Computer and then click Continue.
6.
Click Close to close the installation wizard. Close Windows Control Panel.
eCor.properties Configuration
If you want to use xDesign Online Editor and port 80 for xResponse, locate the HtmlTempURI
property in the eCor.properties file and remove the port part, “:80”, from the URL.
Configuring xRevise
See the xPression Release Notes for complete information about the supported and required
components needed to run xRevise, and then complete the following additional configurations:
• Configure Internet Explorer settings. xRevise has the same requirements with xResponse. See
Internet Explorer Settings, page 151 for detailed information.
• Configure HTTPS server certificates. Contact your system administrator who installs xDesign
to get the xCertMgr.bat and CertManager.exe files, and then following the instructions in
Managing Certificates of HTTPS Servers, page 150.
• Configure xRevise user access.
152
• Install VBA. See Installing VBA, page 152 for detailed information.
• Configure application startup order.
xRevise User Access
The user must have read, write, and create access to the EMC Document Sciences directory. xEditor
needs to write log and other files to this location. You do not need to enable cookies or Java to use
xEditor. You can find this folder in Your_drive:\Users\username\AppData\Roaming\EMC
Document Sciences.
Running xRevise on a non-xDesign Machine
If you intend to run xRevise on a machine that does not have xDesign installed on it, you must
complete the following steps after upgrading:
• You must update your document versions for all xRevise documents
• Any xRevise work items created before the upgrade should be deleted and recreated
Configuring Application Startup Order
This step applies to only WebSphere environments. Set the xRevise application startup order to 2. It
must start after the xPression application. Complete these steps:
1.
Start the WebSphere administrative console.
2.
Click Application Servers, then click the link for your server (server1 by default).
3.
Click Installed Applications and then click xPressionRevise from the list.
4.
Click Startup Behavior.
5.
In the Startup Order list, change the value to 2 and click OK.
6.
Save your changes to the Master configuration.
xEditor
xEditor must be installed on the client machine. Installation is automatic the first time xEditor is
called. Installation is required once per machine only, even if multiple applications with different
xEditor configurations are used on the same machine. The correct configuration for the calling
application will be used automatically.
153
• About Smart Client Installation, page 154
• Access Rights to Install xEditor, page 154
• Preparing Your Environment, page 155
• Installing xEditor, page 156
• Pushing the xEditor Installation From the Server, page 157
• Verifying the Installation, page 157
About Smart Client Installation
xResponse or xRevise uses a Smart Client to open xEditor when you select a work item from the
workspace. A “Smart Client” in an application environment that delivers an application over an
HTTP connection. It provides automated installations and updates with minimal user interaction.
Smart Client runs every time a document is opened for editing with xEditor. Smart Client is based
on Microsoft .NET technology. The Smart Client ensures that the appropriate version of xEditor is
installed, ready to use, and presents the correct feature set.
Smart Client may determine that the xEditor versions on the client and server are not the same. If the
client version is newer, the option to downgrade to the server version is offered; if the client version is
older, the option to upgrade is offered. xEditor will offer to upgrade or downgrade the client version
so that it matches the xEditor version used on the server. When upgrading or downgrading, the
Smart Client only updates the relevant components and does not perform a full installation.
To avoid potential compatibility issues, the xEditor version on the client must match the xEditor
version on the server. If you choose not to upgrade or downgrade, xEditor will not launch.
Access Rights to Install xEditor
If you are a system administrator, be aware that the user who installs xEditor on a client computer
must have Administrative rights. If you are pushing an xEditor installation from the server, ensure
that you also push the uninstallation of the previous version. Normally, the startup application
detects if there is an existing version of xEditor on the system. When pushing the installation from the
server, you are bypassing this startup application.
If you are an xEditor user from a client computer, xPression runs the automatic installer for xEditor
when you try to open xEditor for the first time. The xEditor installation is drawn from the xPression
Server. In some environments, you may not have the permissions to conduct the installation. In this
case, xEditor can be pushed to the client computer by your administrator or any qualified person with
appropriate access. The xEditor installer is stored in the server-deployed xPression_Revise.war
and xPression_Response.war files. The method for installing depends on your network
environment.
Note: If the installation, upgrade, or startup of xEditor fails, uninstall and reinstall xEditor manually.
154
Preparing Your Environment
To ensure your environment is ready for xEditor, review the following topics:
• Java Runtime Environment, page 155
• Microsoft .NET Framework, page 155
• Install VBA, page 155
• Internet Explorer Settings, page 156
• Adobe PDFMaker, page 156
Java Runtime Environment
In some cases, you may need to install the Java Runtime Environment (JRE) on your client machines.
If you have problems displaying the Microsoft Word editing window, download JRE from the Sun
Microsystems website and install it on your client machine. See the xPression Release Notes for the
supported JDK version for xResponse and xRevise.
Microsoft .NET Framework
In many cases, Microsoft .NET Framework has already been installed. If .NET is not present,
xResponse or xRevise will display a message with a link to a download site where you can obtain
the installation package for .NET Framework. If you receive this message, download the .NET
Framework package and follow the installation instructions provided by Microsoft.
After installing .NET Framework successfully, ensure that you log off xResponse or xRevise, restart
Internet Explorer, and log on to xResponse or xRevise again to open the work items.
Note: If the installation of xEditor fails and you get an error about VSTO (Microsoft Visual Studio
Tools for Office Runtime), use System Manager to install .NET Framework 3.5.1-Features for
Microsoft Word 2010 or .NET Framework 4.0-Features for Microsoft Word 2013, uninstall VSTO,
and then install xEditor again.
Install VBA
xEditor requires VBA when using Microsoft Office Word. In installations where a version of
Microsoft Office does not install VBA by default, you must install VBA manually. If VBA is not
installed, an error will occur when attempting to use xEditor with Microsoft Word. See Installing
VBA, page 152 for detailed steps.
155
Internet Explorer Settings
Automatically detect settings in Microsoft Internet Explorer’s Local Area Network (LAN) Settings
should NOT be selected. Significant performance degradation for xEditor has been noted when this
option is selected. It will be noted as a Warning in the xEditor log if selected.
You do not need to enable cookies or Java to use xEditor.
Enable Run .NET Framework-reliant components not signed with Authenticode in the Certificate
Manager. xEditor is a signed .NET application but cannot run successfully when this setting is false
(disabled). In some organizations security policy does not allow this setting to be enabled. In these
cases it is necessary to manually apply the EMC digital certificate to the trusted area. When the EMC
digital certificate is applied xEditor is trusted and can run successfully.
To Apply the Digital Certificate
1.
Obtain the certificate file.
2.
Open Windows Explorer and locate the certificate file. The file has a .p7b extension.
3.
Right-click the file and select Install Certificate to open the Certificate Import Wizard and then
click Next.
4.
Input the password for the certificate and then click Next.
5.
Select Place all certificates in the following store and then click Browse to open the Select
Certificate Store dialog box.
6.
Select Trusted Root Certification Authorities from the tree view and then click OK.
7.
Reopen the Select Certificate Store dialog box as in Step 5 and select Trusted Publisher from the
tree view and then click OK.
8.
On the Certificate Import Wizard, Certificate Store step, click Next.
9.
Click Finish to complete the installation and close the Certificate Import Wizard.
Adobe PDFMaker
xEditor cannot exist on a system in which Word has the Adobe Acrobat PDFMaker add-in for Acrobat
9 enabled. This is an issue with the Adobe add-in, and not xEditor. The add-in must be disabled
for xEditor to function.
Installing xEditor
When the xPression Editor Startup message appears, click Install to start the installation. Depending
on your Microsoft Word macro security setting, you may receive a Security Warning that
xEditor.docm contains macros. xEditor uses macros to override some Word functions, so click Enable
Macros if you receive this message. When the xEditor Setup Wizard appears, follow the steps in the
wizard and provide necessary information to complete the installation.
156
xEditor will appear in the Windows Add and Remove Programs list in Control Panel, where you can
remove xEditor if necessary. If you open a document that needs xEditor after uninstalling the editor,
Smart Client will initiate the installation process.
The initial installation adds a shortcut to ALL USERS\start menu\programs\startup. This queues a
pre-WIP version of xEditor when the machine starts up. This reduces the amount of time required for
xEditor to open a work item. There will be an instance of WINWORD.EXE running, with all required
supporting software. This instance appears in Task Manager and can be shut down, but if it is shut
down, xEditor will take longer to open work items than would otherwise be the case.
The installation applies to both xRevise and xResponse, regardless of which one you were using when
you started the installation.
Note: Whenever xEditor starts, it creates a temporary configuration file, config.txt, on the client.
This file is deleted after use unless the installation runs in debug mode. It is strictly for internal and
session-specific usage, and should not be modified.
Pushing the xEditor Installation From the Server
The xEditor installation is drawn from the xPression server. In some environments, client machines
lack the permissions to conduct the installation as described above. In this case, xEditor can be pushed
to the client machine by the network administrator or any qualified person with appropriate access.
When an installation is pushed, it does not have the capability to detect a previous version. Therefore,
if a previous version exists on the target machine, you must push the uninstallation of the previous
version, before pushing the new installation.
The xEditor installer contains two ZIP files, xEditor2010Installer.zip and
xEditor2013Installer.zip depending on your Word version, which are located in the
server-deployed xPression_Revise.war and xPression_Response.war files. The method for
installing depends on your network environment.
Verifying the Installation
To verify a client installation, complete the following steps:
1.
Ensure that the .NET components are enabled.
2.
In Internet Explorer, open the Tools menu, click Internet Options, point to Security, and then
click Trusted Sites. Ensure that the xPression server is included.
3.
Open Internet Explorer. On the Tools menu, click Internet Options. On the General tab, click
Delete to delete temporary files and cookies.
4.
Open a work item in xEditor.
5.
Use Internet Explorer to open xRevise, then change the URL to http://<[server]:[port]>/xRevise
/services. Substitute your actual server name and port number in the indicated location. Ensure
that the available services are appropriate.
157
About Deploying xPressForms
xPressForms is a Web-based administration interface used for the creation, management, and
composition of forms. xPressForms supports pre-built forms from the most popular bureaus: NCCI,
ISO, AAIS, and ACORD. It enables the authoring or customizing of forms of all types, using a
standardized, flexible XML schema.
xPressForms can be easily integrated into a variety of Admin systems. Along with the xPressForms
interface, you get a well-defined process for initial and maintenance deliveries, including bi-weekly
delivery of all new and updated forms.
The installation of xPression deploys the necessary files for xPressForms automatically. You can do
the following things after that:
• Validating Properties Files, page 158
• Deploying xPressForms Environment, page 158
Validating Properties Files
The xPressionHome\Log4j.isc.config.xml file contains properties for the following log files.
You can modify the file paths as appropriate for your environment.
• FILE_LOG — xPressForms.log
• FILE_LOG_CATALOG — xCatalog.log
• FILE_LOG_SMARTCLIENT — For SmartClient framework log.
Deploying xPressForms Environment
You must deploy the xPressForms environment before you can use xPressForms:
1.
Start xPression.
2.
Log on to xAdmin.
3.
Import the following document PDPs from xPressionHome/Samples :
• xPressForms_Forms_Setup_PDP.zip
• xPressForms_Masters_Setup_PDP.zip
• xPressForms_PreviewOutput_Setup_PDP.zip
4.
158
Specify the read/write permissions for the xpression user on the xPressForms and
xPressForms_Masters categories.
About xPression Adapter
The xAdapter uses any combination of real-time integration, near-time integration, or batch
integration models to collect and merge XML files for later processing by the Batch capabilities of
xPression. Configuration steps for the xAdapter application are integrated into the configuration
steps for your application server.
EMC Document Sciences provides two versions of the xAdapter application: one with a JMS listener
and one without.
If you are using the xPression Adapter, see the following topics:
• Configuring WebSphere MQ, page 159
• Configuring xPression Adapter for WebLogic, page 165
Configuring WebSphere MQ
If you plan to deploy the JMS-enabled xAdapter along with your xPression Server, you must first
configure WebSphere MQ.
Note: If using Websphere MQ as the JMS server for xAdapter, ensure that you install the "Java
Messaging" feature when you install Websphere MQ. This feature includes Java Messaging Support
and is needed for messaging using Java. Also, set the MQ_INSTALL_ROOT variable to the value
of the WebSphere MQ install path.
Add Queues to WebSphere MQ 5.3
To add queues to WebSphere MQ:
1.
Start WebSphere MQ Explorer.
2.
In the tree pane, expand the WebSphere MQ item. Right-click Queue Managers, select New,
and click Queue Manager.
3.
The Create Queue Manager wizard appears. Supply the following values.
Option
Value
Queue Manager
xPressionQueueManager
Make this the default queue
manager
Leave unselected
Def. Transmission Queue
xPress_transmission_queue
Dead Letter Queue
xPress_deadletter_queue
Max Handle Limit
Leave as default
Trigger Interval
Leave as default
Max Uncommitted Msgs
Leave as default
Click Next.
159
4.
In Step 2 of the wizard, keep the defaults and click Next.
5.
In Step 3 of the wizard, select Start Queue Manager and then click Next.
6.
In Step 4 of the wizard, select the Create listener configured for TCP/IP checkbox. In the Listen
on port number box, type 1414 and click Finish.
7.
The new queue manager is created and the wizard closes. In MQ Explorer, expand Queue
Managers and expand the newly-created xPressionQueueManager.
Right-click Queues, select New, and click Local Queue.
8.
9.
The Create Local Queue dialog box appears. Supply the following values and click OK.
Option
Value
Queue Name
InputQueue
Type
Leave as default
Description
Leave as default
Put Messages
Leave as default
Get Messages
Leave as default
Default Priority
Leave as default
Default Persistence
Select Persistent from the drop-down box. This is a
recommended value. If necessary, you may use Default
Persistence.
Scope
Leave as default
Usage
Leave as default
Create three more queues by repeating steps 7-8. Use the following names for the queues:
• InputQueue1
• OutputQueue
• OutputQueue1s
When complete the xPressionQueueManager will have four queues.
Configure the JMS Provider
For adapters that support JMS capabilities, configure the JMS Provider in the WebSphere
administrative console by performing the following steps:
1.
In the let pane, expand Resources, expand JMS, and click JMS Providers.
2.
The JMS providers page displays all existing JMS providers. Click WebSphere MQ messaging
provider.
3.
In the Additional Properties section, click Queue connection factories.
4.
At the "WebSphere MQ messaging provider" page, click New.
160
5.
The Configuration wizard appears. Add the following values to “Step 1: Configure basic
attributes”:
Field
Value
Name
AdapterQueueConFactory
JNDI Name
jms/AdapterQueueConFactory
Description
xAdapter factory
Category
Leave as default
Click Next.
6.
At the “Step 2: Select connection method” page, select Enter all the required information into
this wizard and click Next.
7.
At the “Step 2.1: Supply queue connection details” page, type xPressionQueueManager and
click Next.
8.
At the “Step 2.2: Enter connection details” page, supply the following values.
Field
Value
Transport
Select Client from the list.
Hostname
Supply the hostname or IP address.
Port
1414
Server connection channel
Type SYSTEM.DEF.SVRCONN.
Click Next.
9.
Click Test Connection. The admin console should report a successful connection. Click Next
then click Finish.
10. The WebSphere MQ messaging provider page appears and the AdapterQueueConFactory now
appears in the list.
11. Click Save.
12. In the left pane, click Queues.
13. On the Queues page, click New.
14. The Select JNS resource provider page appears. Select WebSphere MQ messaging provider and
click OK.
15. The Configuration page appears. Supply the following values.
Field
Value
Name
AdapterQueue
JNDI name
jms/AdapterQueue
Queue name
InputQueue
Queue manager or Queue sharing
group name
Click OK.
161
16. AdapterQueue now appears in the list. Click Save.
17. Click AdapterQueue from the list.
18. In the Additional Properties section, click Advanced Properties.
19. In the General Properties section, in the Persistence list, select WebSphere MQ persistent.
20. Click OK, then click Save.
21. Click AdapterQueue from the list.
22. In the Additional Properties section, click WebSphere MQ connection properties.
23. In the General Properties section, supply the following values.
Field
Value
Queue manager host
Supply the host name or IP address.
Queue manager port
1414
Click OK, then click Save.
24. Click New.
click OK.
Field
Value
Name
AdapterQueue1
JNDI name
jms/AdapterQueue1
Queue name
InputQueue1
group name
Click OK.
27. AdapterQueue1 now appears in the list. Click Save.
28. Click AdapterQueue1 from the list.
32. Click AdapterQueue1 from the list.
Field
Value
Queue manager host
Queue manager port
1414
162
35. Click New.
click OK.
Field
Value
Name
AdapterResponseQueue
JNDI name
jms/AdapterResponseQueue
Queue name
OutputQueue
group name
Click OK.
38. AdapterResponseQueue now appears in the list. Click Save.
39. Click AdapterResponseQueue from the list.
43. Click AdapterResponseQueue from the list.
Field
Value
Queue manager host
Queue manager port
1414
46. Click New.
click OK.
Field
Value
Name
AdapterResponseQueue1
JNDI name
jms/AdapterResponseQueue1
Queue name
OutputQueue1
group name
Click OK.
49. AdapterResponseQueue now appears in the list. Click Save.
163
50. Click AdapterResponseQueue1 from the list.
54. Click AdapterResponseQueue1 from the list.
Field
Value
Queue manager host
Queue manager port
1414
57. In the left pane, expand Servers, Server Types, and click WebSphere application servers.
58. On the Application servers page click server1.
59. In the Communications section, expand Messaging and click Message Listener Service.
60. In the Additional Properties section, click Listener Port.
61. Click New.
62. In the General Properties section supply the following values.
Field
Value
Name
AdapterListenport
Initial State
Started
Description
Adapter Listen Port
Connection factory JNDI name
Destination JNDI name
jms/AdapterQueue
Maximum sessions
2
63. AdapterListenport appears in the list.
64. Click New.
65. In the General Properties section supply the following values.
164
Field
Value
Name
AdapterListenport1
Initial State
Started
Description
Adapter Listen Port1
Connection factory JNDI name
Field
Value
Destination JNDI name
jms/AdapterQueue1
Maximum sessions
2
Configuring xPression Adapter for WebLogic
To configure the adapter for WebLogic, ensure you deploy the proper enterprise archive files
according to the following steps:
• Extract the xPression Enterprise Archive Files, page 94
• Starting the Enterprise Archive Files, page 120
Using XQuery Outside of xPression
You can install and run XQuery outside of xPression. xPression uses the DataDirect XML library to
provide capabilities such as XQuery execution and conversion from non-XML data to XML data.
EMC Document Sciences provides several tools to facilitate the development, testing, and tuning of
XQuery and XML conversions outside of the xPression environment for customers who prefer to
work directly with the DataDirect XML library. The tools provided by EMC Document Sciences are
virtually identical to those provided by DataDirect, except as noted.
These utilities require JDK 1.6 and higher versions.
XQuery Command Line Utility
The XQuery Command Line Utility enables users to execute XQuery through the command line. It
supports all options provided by the DataDirect XQuery command line utility, so refer to the Using
the Command Line Utility section of the DataDirect XQuery User’s Guide and Reference for details
on using the utility. The following items differ from the DataDirect® documentation when using
the EMC Document Sciences utility:
• This utility is found in D$ddxq.jar instead of ddxq.jar
• The class name is com.docscience.xquery.QueryConsole
• The JDBC URL should start with “jdbc:docscience:” instead of “jdbc:xquery:”
XML Converter Command Line Utility
The XML Converter™ Command Line Utility enables users to execute XML converters through
the command line. It supports all options provided by the DataDirect XML converter command
line utility, so refer to the Command Line Usage section of the DataDirect XML Converters User’s
165
Guide and Reference for details on using the utility. The following items differ from the DataDirect
documentation when using the EMC Document Sciences utility:
• This utility is found in D$XMLConverters.jar instead of xmlconverters.jar
• The class name is com.docscience.xmlconverter.ConverterConsole
Installing the Command Line Utilities
To run the utilities independently from the xPression Server, use the provided installer to deploy
them to a separate server. Installing the command line utilities to a separate server enables you to
do high volume batch data conversion that is not possible on the xPression Server. Be aware that
an independently installed XQuery cannot integrate with xAdmin and xDashboard for real-time
transactions. The standalone command line utilities are supported on all servers and platforms that
are supported for the xPression Server.
To install XQuery to a separate server:
1.
In your installation package, locate the XMLTools_Installation_scripts folder.
2.
In this folder you will find XMLTools_Install.jar. Copy this file to the server where you want to
install XQuery. Ensure you do not copy and install the file on your xPression Server.
3.
Open a command prompt and navigate to the directory where you copied the
XMLTools_Install.jar file.
4.
Start the installation wizard with the following command:
java -jar XMLTools_Install.jar
5.
The “Introduction” page appears. Click Next.
6.
The “License Agreement” page appears. Select I accept the terms of the License
Agreement and click Next.
7.
The “XMLTools Installation Folder” appears. Select a destination folder and click Next.
8.
The “Pre-Installation Summary” page appears. Click Install. The installer deploys the XQuery
software files and documentation in the specified directory.
Sample Commands
For complete instructions on how to use the utilities, read the command line utility documentation
provided in the /docs folder. Below you will find two simple examples:
java -cp <install_path>/libs/D$ddxq.jar com.docscience.xquery.QueryConsole
-jdbc "jdbc:docscience:oracle://10.32.220.85:1521;SID=xprorcl10;user=customer;
password=customer" -p -o output.xml rdb.xquery
java -jar <install_path>/libs/D$XMLConverters.jar /to /converter CSV /
166
in mydata.txt /out output.xml
167
168
Chapter 9
You can verify your installation both before and after installing any patches. Be sure to update your
software to the latest patched release so that your system is current with all important fixes that are
available.
At this point in the installation, you should have:
• Installed and configured your xPression database.
• Created and configured your application server, deployed your enterprise archive file, and
installed your xPression Server.
• Completed your installation steps.
• Installed the xPression client.
Step One: Check Basic Connectivity
Ensure you have started your xPression server. In this step, you will run some very basic tests
to ensure xPression was configured properly.
Examine Server Logs
Check your application server log files to ensure there were no errors during startup.
Access xAdmin
Ensure you can access xAdmin. If xAdmin does not start, you have made an error in your server
setup. You can access xAdmin from any web-enabled browser connected to your network. The URL
that you use to access xAdmin is case-sensitive as below:
http://serverName:httpPort/xAdmin
where serverName is the name of your application server machine. You can use localhost if you
are launching the browser from the application server machine.
169
httpPort is the HTTP port number of the xPression Server. You should have written down this port
number when configuring your application server. If you did not, you can also find this port number
in your application server admin console:
• WebLogic—In your WebLogic server console, expand Servers in the left console pane and click
the item for your xPression server. In the right console pane, click the General tab and locate the
setting for Listen Port, which is the xPression port number.
• WebSphere—See Set Host Alias, page 81.
• JBoss—This value is recorded in the server.xml located in the jbossweb.sar directory for
your server configuration. For example: <Jboss_Install_Dir>\server\default\deploy
\jbossweb.sar\server.xml
The value is listed as the Connector port under the jboss.web service.

<Connector address="${jboss.bind.address}" connectionTimeout="120000"
maxPostSize="0" port="8080" ...
When you access xAdmin for the first time, you will be required to supply licensing information
before you can proceed.
Supply Your License
Your xPression license agreement grants you a certain number of "seats” for the server, xPression
Batch, and client applications such as xDesign and xResponse. An xPression license key is linked
to the unique IP address of the computer on which the xPression application is installed. This
relationship is established during installation.
You can enter new license files through License Management. When your license expires, or if you
upgrade your license to include additional seats, you’ll be directed to supply a new license file in
the Enter New License box.
To update your license with a new license key file:
1.
Click Browse. Locate and select the license key file (license.xml).
2.
Click Open. The file path appears in the Select License File field.
3.
Click Save.
Access Locales
In xAdmin, click the System Management menu and click Locales. A list of locales should appear.
The locale list will show the locales currently available on your system. If you are able to see your list
of locales, then xPression is able to retrieve information from your xPression database.
170
Step Two: Import Sample Test Data
To continue your installation validation, import the sample applications delivered with xPression.
Use xPression Utilities to import the applications to your xPression database. Complete the following
steps:
1.
Locate the following server directory:
xPressionHome\Samples\
2.
In this directory, you will find:
• AUTOPAY1.xml
• AUTOPAY.xml
• AutoPayPDP_xPublish.pdpx
• AutoPDP.zip
3.
In xAdmin, click the Utilities menu and click Import. The Import page appears.
4.
Select The PDPX is on server side.
5.
Click Browse.
6.
Navigate to the following directory on your xPression Server: xPressionHome\Samples
If you used the xPublish-only installation files to install xPression, select AutoPayPDP_xPublish
.pdpx
If you used the CompuSet-enabled installation files to install xPression, select AutoPDP.zip.
7.
Click Start. xPression informs you if the import is successful or if there were errors. You can
check xPression.log and migration.log in xPressionHome directory for more details.
8.
On your xDesign computer, navigate to xPressionHome\Samples\
9.
Copy AUTOPAY1.xml and AUTOPAY.xml to the following directory:
<xPressionHome>\CustomerData
10. Log on to xAdmin, and ensure that the Customer Data Location for the AUTOPAY-XML Data
Source is set correctly.
Step Three: Configure Access Rights
In xAdmin, click the Category Management menu and click Categories. Complete the following
steps:
1.
Click the link for the Automatic Payment Letter category.
2.
When the category page appears, click the Access Rights tab.
3.
On the Access Rights tab, click View/Change for the xDesign application.
4.
Click Add to display a list of eligible users.
171
5.
When the list of user names appears, select a user name or group and click Add to move the
user name to the New Selected Users list. You are giving this user name or group access to
the documents in this category. Click Save.
6.
Select permissions for this user and click Save.
Caution: If xPression fails to show names in the eligible users list, then there is a problem with
your user authentication settings. If you are unable to add or remove users in access rights, then
your environment path was not properly configured.
Step Four: Test Assembly in xDesign
Start xDesign and attempt to log on using the user name you assigned privileges to in Step Three:
Configure Access Rights, page 171.
Caution: If xPression does not accept your user name, ensure that you typed the user name and
password correctly. If you are using a copy of xDesign that is deployed on an xPression Server,
you may need to alter your local security policy. See SiteMinder Authentication, page 30.
To test assemble in xDesign:
1.
Open a document from the Automatic Payment Category.
2.
Click the Preview tab.
3.
From the Document menu, select Generate XML.
4.
From the Document menu, use the Create Document Version feature to create a document
version. See the xDesign User Guide for more information about document versions.
5.
Select the first customer in the list, right-click and select Assemble. The document should
assemble and display several content items below the customer record you assembled. Right-click
again and select Publish Document.
6.
The document should publish successfully. To view the output, navigate to the following
directory: xPressionHome\Publish\Output
7.
If your PDF file is located in this directory, the test was successful.
172
Chapter 10
Integrating with Third-Party Software
You can integrate xPression with third-party software such as Documentum and FileNet. See the
following topics:
• Integrating with Documentum, page 173
• Integrating with FileNet, page 185
Integrating with Documentum
This section contains instructions for configuring your environment to enable integration between
your Documentum and xPression systems.
You must have a fully licensed and operational Documentum content server installed on your
network. You can install xPression on the same server as the Documentum content server or you can
install Documentum and xPression on different servers.
If you install the Documentum content server and xPression on different servers, you must install
the Documentum Foundation Classes on your xPression Server. These classes enable the xPression
Server to communicate with the remotely located Documentum content server. These classes are
available from Documentum.
Note: xPression does not support accessing the Documentum server using the HTTPS protocol.
Complete the following steps as necessary:
• Step One: Configure Documentum System User Name, page 174
• Step Two: Install Documentum Foundation Classes, page 174
• Step Three: Configure Application Server, page 174
• Step Four: Create an ECM Configuration, page 180
• Setting DFC Registry Mode for xPression Documentum Repository, page 180
• Installing the Sample Workflow, page 180
• After Updating an Activity Template, page 183
• Adding Formats for Archiving, page 184
• Upgrading the Sample Workflow, page 184
173
Step One: Configure Documentum System User Name
This step is required for xPression environments that need to access Documentum repositories,
including Documentum Edition Users. xPression is able to store archive output from the xPression
system in a Documentum Docbase. When you run a job that is configured to store archive output
in a Documentum Docbase, xPression logs on to the Documentum system using a system user
name and password.
You configure this user name and password through the ECM Configuration page in xAdmin.
The system user name and password must be a valid Documentum Docbase user account with
privileges to browse the Docbase object types. Ensure that this account is active before providing
the user name to xPression.
You can encrypt this password. If you want to enable encryption and your Documentum content
server is located on a different machine than the xPression server machine, you must configure an
operating system environment variable on the xPression Server machine. This variable must contain
the path to the Documentum encryption key. The key is installed by default with the Documentum
content server in the following location:
<Documentum_Install_Dir>\dba\secure\aek.key
where <Documentum_Install_Dir> is the location where you installed Documentum. On the
xPression Server machine, set up the following environment variable.
Variable Name: DM_CRYPTO_FILE Variable Value: <Documentum_Install_Dir>\dba\secure
\aek.key
On Windows machines, you can set environment variables by accessing the System Properties from
the Control Panel. On the System Properties page, select the Advanced tab and click Environment
Variables. To define your system user name and password, see the instructions in the System
Administrator’s Guide.
Step Two: Install Documentum Foundation Classes
including Documentum Edition Users. You must install the Documentum Foundation Classes
(DFC) runtime environment on your xPression Server. For full instructions, see the Documentum
Foundation Classes Installation Guide that came with your EMC Documentum software.
Step Three: Configure Application Server
including Documentum Edition Users.
• Adding Paths to Support xPression Batch, page 175
• Configuration Steps for WebSphere, page 175
• Configuration Steps for WebLogic, page 176
174
• Configuration Steps for JBoss, page 177
• Configuration Steps for Process Builder Users, page 179
Adding Paths to Support xPression Batch
To support publishing in batch mode, you must add two documentum paths to the
BatchRunner.properties file and the BatchRunner.bat (.sh for UNIX) file. Both files reside
in the xPressionHome directory. The changes to BatchRunner.properties support batch through
xDashboard and the BatchRunner.bat (.sh for UNIX) file changes support batch through the
command line.
1.
Add the necessary paths to your xPression BatchRunner.properties file by completing
a.
Locate the BatchRunner.properties file in the xPressionHome directory.
b. Open the BatchRunner.properties file for editing.
c.
Locate the xPression_Batch_Path section of the BatchRunner.properties file. For
example:
xPression_Batch_Path=
d. Add the path to the dctm.jar file. For example:
xPression_Batch_Path=C:/Program Files/Documentum/dctm.jar
e.
Add the path to the Documentum /config directory. For example:
xPression_Batch_Path=C:/Program Files/Documentum/dctm.jar;C:/Documentum/Config
f.
2.
Save your changes.
Add the necessary paths to your BatchRunner.bat (.sh for UNIX) file by completing the
following steps:
a.
Locate the BatchRunner.bat (.sh for UNIX) file in the xPressionHome directory.
b. Open the BatchRunner.bat file for editing.
c.
Locate the BATCH_CLASSPATH section of the file. For example:
BATCH_CLASSPATH=
d. Add the path to the dctm.jar file. For example:
BATCH_CLASSPATH=C:\Program Files\Documentum\dctm.jar
e.
Add the path to the Documentum /config directory. For example:
BATCH_CLASSPATH=C:\Program Files\Documentum\dctm.jar;C:\Documentum\Config
f.
3.
Save your changes.
Start the xPression server.
Configuration Steps for WebSphere
To configure your new xPression server:
175
1.
Expand Servers in the left pane of the administrative console expand Server Type and click
WebSphere Application Servers. By default, your xPression profile will contain a server named
server1. This server will appear in the Application servers list. Click the server1 hyperlink to edit
the configuration of the server. The configuration page appears.
2.
In the Server Infrastructure section, click the Java and Process Management item to expand it.
3.
In the Java and Process Management section, click Process Definition.
4.
Locate the Additional Properties section on the right side of the page and click Java Virtual
Machine.
5.
In the Classpath box, type the following paths. For Linux, place each classpath on a separate line.
For Windows, separate each path with a semi-colon. For UNIX and Linux systems, replace the
back slash (\) with a forward slash (/) in the path.
• C:\Documentum\config
• C:\Program Files\Documentum\dctm.jar
• C:\Program Files\Documentum\Shared\aspectjrt.jar
• Also, add the path to bpmutil.jar. This is the file you located in: Configuration Steps for
Process Builder Users, page 179.
6.
When finished, click OK and click OK again on the Process Definition page to return to the
xPression Server configuration page.
7.
Save your changes to the master configuration.
Configuration Steps for WebLogic
To add the classpaths, complete the following steps:
1.
Open startxPressionServer.sh with a text editor. This file resides in the following location:
<WebLogic_install_dir>/user_projects/domains/<domain_name>/bin
2.
Add the path to bpmutil.jar to the SET “JAVA_OPTS” line. This is the file you located in step
7 of Configuration Steps for Process Builder Users, page 179.
3.
If you did not configure Documentum settings while running the xPression installer, you must ,
add the Documentum classpath to the startxPressionServer.bat (.sh for UNIX users) file.
SET DCTM_CLASSPATH=
4.
Next, add the path to the Documentum /config directory. This folder is located in the
Documentum installation directory. For example:
SET DCTM_CLASSPATH=C:\Documentum\config
5.
Also, add the path to the Documentum JAR file. For example:
SET DCTM_CLASSPATH=C:\Documentum\config;C:\Program Files\Documentum\dctm.jar
6.
176
Configuration Steps for JBoss
To configure JBoss for Documentum users:
1.
Create the following folders in your JBoss installation directory:
<jboss_install_dir>/modules/com/documentum/main/
If these folders already exist, go to the next step.
2.
Copy the following Jar files to this directory:
• dfc.jar
• configservice-impl.jar
• configservice-api.jar
• DmcRecords.jar
• dms-client-api.jar
• jcifs-krb5-1.3.1.jar
• jsafeFIPS.jar (for Documentum pre-7.1 versions)
• krbutil.jar
• messageArchive.jar
• messageService.jar
• subscription.jar
• workflow.jar
• xtrim-api.jar
• xtrim-server.jar
• All-MB.jar
• bpmutil.jar
• certjFIPS.jar (for Documentum pre-7.1 versions)
• ci.jar
• collaboration.jar
• aspectjrt.jar
• certj.jar (for Documentum 7.1 and after)
• jcmFIPS.jar (for Documentum 7.1 and after)
• cryptojce.jar (for Documentum 7.1 and after)
• cryptojcommon.jar (for Documentum 7.1 and after)
3.
Next, open module.xml. This file is located in the same directory where as the copied Jar files.
4.
If you configured xPression for Documentum during the server installation process (see ), then
make sure the following code appears in the module.xml file.
If you did not configure xPression for Documentum during the server installation process, add
the following bold items to the module.xml file.
177
<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="com.documentum">
<resources>
<resource-root path="All-MB.jar"/>
<resource-root path="DmcRecords.jar"/>
<resource-root path="aspectjrt.jar"/>
<resource-root path="bpmutil.jar"/>
<resource-root path="certjFIPS.jar"/>
<resource-root path="ci.jar"/>
<resource-root path="collaboration.jar"/>
<resource-root path="configservice-api.jar"/>
<resource-root path="configservice-impl.jar"/>
<resource-root path="dfc.jar"/>
<resource-root path="dms-client-api.jar"/>
<resource-root path="jcifs-krb5-1.3.1.jar"/>
<resource-root path="jsafeFIPS.jar"/>
<resource-root path="krbutil.jar"/>
<resource-root path="messageArchive.jar"/>
<resource-root path="messageService.jar"/>
<resource-root path="subscription.jar"/>
<resource-root path="workflow.jar"/>
<resource-root path="xtrim-api.jar"/>
<resource-root path="xtrim-server.jar"/>
</resources>
<dependencies>
<module name="org.apache.log4j"/>
<module name="javax.transaction.api"/>
<module name="javax.xml.bind.api" />
<module name="javax.ws.rs.api" />
<module name="javax.inject.api" />
<module name="javax.xml.stream.api" />
<module name="org.apache.commons.lang" />
<module name="org.apache.commons.codec" />
<module name="javax.activation.api" />
<module name="javax.api"/>
<module name="org.apache.xerces"/>
</dependencies>
</module>
If you are using Documentum 7.1 or higher versions, add the following code to the module.xml
file.
<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="com.documentum">
<resources>
<resource-root path="All-MB.jar"/>
<resource-root path="DmcRecords.jar"/>
<resource-root path="aspectjrt.jar"/>
<resource-root path="bpmutil.jar"/>
<resource-root path="certj.jar"/>
<resource-root path="ci.jar"/>
<resource-root path="collaboration.jar"/>
<resource-root path="configservice-api.jar"/>
<resource-root path="configservice-impl.jar"/>
<resource-root path="cryptojce.jar"/>
<resource-root path="cryptojcommon.jar"/>
<resource-root path="dfc.jar"/>
<resource-root path="dms-client-api.jar"/>
<resource-root path="jcifs-krb5-1.3.1.jar"/>
<resource-root path="jcmFIPS.jar"/>
<resource-root path="krbutil.jar"/>
<resource-root path="messageArchive.jar"/>
<resource-root path="messageService.jar"/>
<resource-root path="subscription.jar"/>
178
<resource-root path="workflow.jar"/>
<resource-root path="xtrim-api.jar"/>
<resource-root path="xtrim-server.jar"/>
</resources>
<dependencies>
<module name="org.apache.log4j"/>
<module name="javax.transaction.api"/>
<module name="javax.xml.bind.api" />
<module name="javax.ws.rs.api" />
<module name="javax.inject.api" />
<module name="javax.xml.stream.api" />
<module name="org.apache.commons.lang" />
<module name="org.apache.commons.codec" />
<module name="javax.activation.api" />
<module name="javax.api"/>
<module name="org.apache.xerces"/>
</dependencies>
</module>
5.
6.
Open the following file:
<Jboss_Install_Dir>\standalone\configuration\xpression-standalone.xml
7.
In the “system-properties” section, add the following property:
<property name="dfc.properties.file" value=" <path>"
where <path> is the path and filename for your dfc.properties file. This file is located in your
Documentum “config” folder.
8.
If you configured xPression for Documentum during the server installation process, then make
sure the following code appears in the xpression-standalone.xml file.
If you did not configure xPression for Documentum during the server installation process, add
the following bold items to the xpression-standalone.xml file.
<subsystem xmlns="urn:jboss:domain:ee:1.0">
<global-modules>
<module name="com.documentum" slot="main"/>
</global-modules>
</subsystem>
9.
Configuration Steps for Process Builder Users
If you are planning to use Process Builder with xPression, locate the following files in your Process
Builder installation:
• bpm_infra.jar
• castor-1.1-xml.jar
• commons-jxpath-1.2.jar
• bpmutil.jar
These files are located on the machine that hosts Documentum Process Builder. If Process Builder is
installed on a different machine, you must copy these files to a location on your xPression Server
179
machine. If Process Builder is installed on your xPression Server machine, note the location for a
later step.
Step Four: Create an ECM Configuration
To enable xPression to store archive output in a Documentum Docbase, you must set up an ECM
Configuration for Documentum. You set up your an ECM Configuration from the xAdmin Resource
Management menu. In an ECM Configuration you must define a Documentum user name and
password, Docbase name (store name), and the archive path. For details on these options, see the
xAdmin User Guide.
Documentum Edition users must create an ECM configuration specifically for their Documentum
xPression Repository. Documentum Edition users can also create additional ECM Configurations that
enable them to pull resources from other docbases, but only the docbase defined as the Documentum
xPression Repository can be used for checking-in xPresso templates.
Setting DFC Registry Mode for xPression Documentum
Repository
If you use the xPression Documentum Repository on a 64-bit Windows system, make the following
change to the dfc.properties file for Documentum:
1.
Open your Documentum /config directory.
2.
Open the dfc.properties file for editing.
3.
Locate the dfc.registry.mode property and make sure the value is set to file. For example:
dfc.registry.mode=file
Installing the Sample Workflow
EMC Document Sciences provides a sample Workflow application that you can use with xPression.
The steps in this section describe how to install and use the sample workflow for the approval of
xPression documents. This sample application requires Documentum TaskSpace, Documentum
Process Builder, and Documentum Forms Builder.
Note: If you are using Documentum 6.6, you must perform a few upgrade steps after installing.
See Upgrading the Sample Workflow, page 184.
Deploying the Sample Application
Complete the following steps to deploy the sample application:
180
1.
Locate the following DAR files in your installation package: approve_xpression_doc.dar. Copy
the DAR file to a local temporary folder.
2.
Start the Documentum Composer DAR Installer. The DAR installer is located in your
composer directory, the same directory that contains eclipse.exe. By default, this directory is
\\<DCTM_install_dir>\product\6.5\install\composer\</DCTM_install_dir>
3.
Run the DAR installer. The DAR Installer page appears.
4.
In the *DAR box, supply the full path and file name of the approve_xpression_doc.dar file.
5.
Locate the Docbroker Details section. In the *Docbroker Host drop-down box, select the name
of the docbroker host. If no names appear in the list, type the name of your Docbroker Host or
Connection Broker.
6.
In the *Docbroker Port box appears, type the port number. By default, this number is 1489.
7.
Click Connect.
8.
Locate the Repository Details section. In the *Repository drop-down box, select the name of the
repository where you want to deploy the sample application.
9.
In the User Name box, type the user name for the repository.
10. In the Password box, type the password for the user name.
11. Click the Install button.
12. The DAR Installer will deploy the DAR file and display a success message when complete.
13. Click Close to close the DAR Installer. If you receive and error, ensure you are using a supported
version of the DAR Installer.
14. Next, locate xPressionAction.zip in your installation package. Extract the contents of this file
to the following directory:
//taskspace_home/custom/config/
For example: C:\Tomcat 6.0\webapps\taskspace\custom\config
15. Locate xPressionWFConnector.jar in your installation package. Copy this file to the following
directory:
//taskspace_home/WEB-INF/lib/
For example: C:\Tomcat 6.0\webapps\taskspace\WEB-INF\lib\
16. Restart the application server.
Next, configure the sample Workflow for your environment.
Configuring the Sample Workflow
Now that the sample workflow is installed on your system, you must configure the workflow for
your users and your server.
You must assign the doc_processor rule to any submitters or approvers that need to access the
xPression workflow in Process Builder. To assign users to the doc_processor role, complete the
following steps.
181
1.
Log in to Documentum Webtop using Administrator privileges.
2.
Expand the Administration item in the left pane.
3.
Expand the User Management item in the left pane.
4.
Click the Roles item in the left pane.
5.
In the right pane, double-click the doc_processor role.
6.
The right pane displays all existing users with the doc_processor role. To add a new user, click
the File menu and select Add Member(s).
7.
Webtop will display a list of all users in a column on the left and all doc_processor users in a
column on the right. Select a user from the left column and click the right-arrow button to move it
to the right column. Repeat this step for each user that will receive the doc_processor role.
8.
Click OK.
Next, update the sample workflow Process Properties.
1.
Log on to Process Builder as a user with the doc_processor role and connect to the repository
where the sample workflow was deployed (this is the repository where you deployed the DAR
file).
2.
Open the Workflow with xPression EE process located in the following folder:
/System/Applications/approve_xpression_doc/Process
The process definition appears.
3.
To perform the customization steps, you must first uninstall the process. Click the Uninstall
Template button.
4.
Access the Process Properties and click the Data tab.
5.
In the left pane, expand Process Data and Process Variables, and select xPressionUrl.
6.
The Variable Definition information for the xPressionUrl variable appears in the right pane. In
the Value box, type the URL for your xPression Server using the following syntax:
http://<server>:<port>
where <server> is the server name or IP address and <port> is the server port number.
7.
Click Apply.
8.
In the left pane, select xPressionUsername.
9.
Supply the user name for a user with xPression Design permissions.
10. Click Apply.
11. In the left pane, select xPressionPassword.
12. Supply the password for a user with xPression Design permissions.
13. Click OK.
Next, update the path to the WSDL file for all process tasks.
1.
Right-click the set lifecycle as "submitted” task and select Activity Inspector.
2.
Click the Web Service Configuration tab.
182
3.
In the URL Path to the WSDL File box, change the server and port number to the server and port
number of your xPression Server. If the server is accessible through SSL, change the protocol to
https.
4.
Perform these steps for the following tasks:
• workflow start
• set lifecycle status as "approved”
• set lifecycle status as "rejected”
• document approved
• document rejected
Next, define your approver.
1.
Right-click the Approver review the document step and select Activity Inspector.
2.
Select the Performer tab.
3.
Click the Select Performer button to select a specific user from the repository.
4.
Click OK.
Run the Sample Workflow
To run the sample workflow, complete the following steps:
1.
Open Internet Explorer.
2.
Access the workflow application at the following URL:
http://<server>:<port>/taskspace?appname=approve_xpression_doc
3.
Log in as the submitter.
4.
Select the Process tab.
5.
The Select Document page appears. Select a document from the list.
6.
Click Submit.
7.
Log out of Taskspace and log back in as the approver.
8.
Select a customer key from the list.
9.
Click Preview to preview the document.
10. Click Approve or Reject.
After Updating an Activity Template
Anytime you perform an update that provides changes for your activity templates, you must clear the
Tomcat server and Documentum client cache.
183
1.
Stop the Method server and the docbase.
2.
Clear the documentum cache. The cache folder can usually be found in the Documentum
installation folder. For example:
C:\Documentum\cache
3.
Clear the method server cache. Use your Documentum documentation to locate this cache file.
4.
Start the docbase.
5.
Start the Method Server.
6.
Clear the Tomcat cache. This cache can usually be found in the Tomcat folder/ For example:
C:\Tomcat55\documentum\cache
Adding Formats for Archiving
If you are creating xPression output in the Microsoft Word .doc or .docx format and intend to archive
that output on a Documentum Docbase, you must configure Documentum to accept the DOC and
DOCX formats. To configure Documentum:
1.
Login to Documentum DA.
2.
Navigate to Administration > Formats to access the Formats list page.
3.
Select File > New > Format to access the New Format - Info page.
4.
Complete the properties for the new format. The only properties that are required for xPression
are the Name and Default File Extension properties.
5.
Click OK to save the new format or Cancel to exit without saving the changes. The system
displays the Formats list page.
Upgrading the Sample Workflow
If you want to use the sample workflow on any supported version of Documentum 6.6 or higher,
you must upgrade the "Approve_xpression_doc” sample files to work with the current xPression
version. To upgrade, complete the following steps:
1.
Access your taskspace application using the following URL:
http://<server>:<port>/taskspace?appname=approve_xpression_doc
2.
Log in as the ts_designer user.
3.
Click the Configuration tab.
4.
Click Synchronize Definition Files.
5.
Next, log on to Documentum Administrator (DA).
6.
Browse to the following location:
/System/Applications/approve_xpression_doc/Actions
184
7.
Export ts_plain_actions.xml to a local folder.
8.
Check out ts_plain_actions.xml.
9.
Open ts_plain_actions.xml for editing.
10. At the end of the file, add the following text:

<plain-action id="previewXPressionDoc" desc="Preview
xPression Doc"/>
11. Save the changes and check the file back in to DA. Ensure that you check the file in as the same
version, otherwise your changes will not be saved.
Integrating with FileNet
This section contains instructions for configuring your environment to enable integration between
your FileNet and xPression systems. Filenet integration is not supported on JBoss 7.x.
FileNet is an Enterprise Content Management system (ECM). xPression supports two ECMs: FileNet
P8 and Documentum. FileNet can be used to archive images and PDF documents that you can
use as external content in your documents. You can use multiple FileNet archives, and you can
use FileNet along with Documentum.
xPression does not directly support online archiving with FileNet. xPression supports exporting
archive index files in the FileNet Capture, FileNet HPII, and Generic Index formats. FileNet provides
robust utilities that allow you to capture content from xPression using these archive outputs. Refer to
the Administering the xPression Server guide for more information on archive output formats, and to
your FileNet documentation for more information on the FileNet utilities.
• Implementing FileNet, page 185
• Configuring FileNet in xAdmin, page 187
Implementing FileNet
Use the following instructions:
• Configurations for JBoss, page 185
• Configurations for WebLogic, page 186
• Configurations for WebSphere, page 187
Configurations for JBoss
You must move some jar files into your xPression.ear directory. Copy the following jar files:
• jace.jar
• stax-api.jar
185
• xlxpScanner.jar
• xlxpScannerUtils.jar
By default, these files can be found at <Filenet_Install_Path>/AE/CE_API/lib. However, your location
may be different if you installed to a non-default location. Copy the files for your FileNet version into
your xPression.ear directory. Do not "cut and paste” the jar files into the xPression.ear directory. The
jar files must reside in both locations.
You must edit the login-config.xml file. This file is located in the following directory:
<JBoss_install_dir>/server/<server_dir>/conf
Open the file and add the following text:
<application-policy name="FileNetP8WSI">
<authentication>
<login-module code'"com.filenet.api.util.WSILoginModule" flag="required"/>
</authentication>
</application-policy>
Configurations for WebLogic
You must move some jar files into your xPression.ear directory. We will supply the default location for
these files, but the location on your system may be different if you installed to a non-default location.
1.
Copy the following jar files:
• jace.jar — can be found at FileNet_Install_Path/AE/CE_API/lib
• soap.jar — can be found at FileNet_Install_Path/AE/workplace/WEB-INF/lib
• javaapi.jar — can be found at FileNet_Install_Path/AE/CE_API/lib2
• xlxpScanner.jar — can be found at FileNet_Install_Path/AE/CE_API/lib
• xlxpScannerUtils.jar — can be found at FileNet_Install_Path/AE/CE_API/lib
2.
Navigate to the following location: WebLogic_install_dir/user_projects/domains
/DomainName/. At this location, create the following file: jaas.conf.WSI. Open the new file
and add the following text:
FileNetP8WSI {
com.filenet.api.util.WSILoginModule required;
};
Save the changes and shutdown the WebLogic application server.
3.
Next, locate the setDomainEnv file for your server (setDomainEnv.sh for UNIX or
setDomainEnv.bat for Windows). By default, this file is located at WebLogic_install_dir/user
_projects/domains/domain_name/bin.
4.
Open setDomainEnv for editing.
5.
Add the following line to the list of options for the JVM:
"-Djava.security.auth.login.config=WebLogic_install_dir/user_projects
/domains/domain_name/jaas.conf.WSI"
6.
186
Locate the startxPressionServer file (startxPressionServer.cmd for Windows,
startxPressionServer.sh for UNIX) at the following location: WebLogic_install_dir/user_projects
/domains/domain_name/bin.
7.
Open the file for editing and locate the "SET CLASSPATH=” statement. To the end of this
statement, append the path to the jar files you copied in step 1. Separate each path with a
semi-colon.
8.
9.
Navigate to your xPressionHome directory. Locate Batchrunner.bat and open the file for editing.
10. Locate the "SET BATCH_CLASSPATH=” statement. To the end of this statement, append the path
to the jar files you copied in step 1. Separate each path with a semi-colon.
11. Save and close the file and restart the application server.
Configurations for WebSphere
You must move the jar files into your xPression.ear directory. We will supply the default location for
these files, but the location on your system may be different if you installed to a non-default location.
Copy the files for your FileNet version into your xPression.ear directory. Do not "cut and paste” the
jar files into the xPression.ear directory. The jar files must reside in both locations.
1.
Copy the following jar files:
• jace.jar — can be found at <FileNet_Install_Path>/AE/CE_API/lib
• stax-api.jar — can be found at <FileNet_Install_Path>/AE/CE_API/lib
• javaai.jar — can be found at <FileNet_Install_Path>/AE/CE_API/lib2
• xlxpScanner.jar — can be found at <FileNet_Install_Path>/AE/CE_API/lib
• xlxpScannerUtils.jar — can be found at <FileNet_Install_Path>/AE/CE_API/lib
2.
Start the WebSphere Administrative Console.
3.
Click Security in the left pane.
4.
Click Global security, then click Java Authorization and Authentication Service. Click
Application Logins and select FileNetP8WSI from the list.
5.
If FileNetP8WSI does not appear in the list, click Application Logins and select New.
6.
Create a new entry name FileNetP8WSI and click Apply.
7.
Click JAAS Login Modules.
8.
Click New and add a new entry named com.filenet.api.util.WSILoginModule.
9.
Select the REQUIRED Authentication Strategy and click OK.
10. Save your changes and restart the server.
Configuring FileNet in xAdmin
Next, you must configure FileNet in xAdmin. In the Resource Management xAdmin menu you can
set up your ECM Server and ECM Configuration.
187
Setting Up the FileNet ECM Server
To set up your ECM Server, click ECM Server from the Resource Management page. You must
provide a descriptive name for the ECM Server, provide the server domain address, and Webservices
port. For details about these options, see ECM Server in the xAdmin User Guide.
Setting Up the Filenet ECM Configuation
To set up your ECM Configuration, click ECM Configuration from the Resource Management page.
You must supply a descriptive name for your configuration, a FileNet user name and password, and
you must associate the configuration with an ECM Server configuration.
188
Chapter 11
Non-English versions of the xPression Sever are accessed through language packs. To use a
non-English version of the software, request a language pack from your sales representative.
• Installing a Language Pack for the Server, page 189
• Installing a Language Pack for xDesign, page 191
• Installing a Language Pack for xPresso for Word, page 191
• Installing a Language Pack for xPresso for Adobe InDesign, page 192
• Installing a Language Pack for xPresso for Dreamweaver, page 193
• Setting the Internet Explorer Language for xPresso Clients, page 195
Installing a Language Pack for the Server
Installing a language pack requires steps to be performed both on the server and on the client
machines that will be using xDashboard, xResponse, and xRevise.
On the Server
The language pack files must be copied into specific application server directories. Once the files
are in place, and the client is properly set up, then you can access xDashboard, xResponse, and
xRevise in the language of your choice.
To install a language pack on the server:
1.
Stop the xPression server.
2.
Unzip the language pack ZIP file, LangagePack_EE_languageID.zip, to a temporary location. This
will deploy three folders: xDashboard, xRevise, and xResponse.
3.
From the temporary xDashboard/xPression.ear/xPression_Report.war created in step 2 copy the
html and WEB-INF folders.
4.
Paste the folders to the existing <Deployed_xPression.ear>/xPression_Report folder. These folders
already exist, so allow the new files to replace the existing files when prompted.
189
5.
From the temporary xRevise/xPression.ear/xPression_Revise.war created in step 2 copy the
html and WEB-INF folders.
6.
Paste the folders to the existing <Deployed_xPression.ear>/xPression_Revise folder. These folders
already exist, so allow the new files to replace the existing files when prompted.
7.
From the temporary xResponse/xPression.ear/xPression_Response.war created in step 2 copy
the "WebHelp_language” and "WEB-INF” folders. If you are using the xDesign Online Editor,
also copy the /html subdirectory.
8.
Paste the folders to the existing <Deployed_xPression.ear>/xPression_Response.war folder. These
folders already exist, so allow the new files to replace the existing files when prompted.
9.
Restart the xPression server.
Note: The names of language pack folders are case-sensitive. If you have an existing folder with a
name of wrong upper/lower case, delete the folder and paste the correct folder. For example, if
there is a WebHelp_zh_cn folder, you have to delete the folder, and then copy and paste the correct
WebHelp_zh_CN folder.
On the Client
Once you have placed the language pack on the server in the correct location, you’ll need to configure
Internet Explorer on the client machines that will be using xDashboard, xResponse, and xRevise
to access the server.
To configure Internet Explorer:
1.
Launch Internet Explorer.
2.
Select Internet Options from the Internet Explorer Tools menu. The Internet Options dialog
box appears.
3.
Click Languages. The Language Preferences dialog box appears.
4.
Click Add. The Add Language dialog box appears.
5.
Select the language that matches the language pack you placed on the server and click OK.
Ensure that the language appears first in the list of languages on the Language Preferences dialog
box. The first language in the list is the default language to be used. Use the Move Up and Move
Down buttons to reorder the list, if necessary.
• For a Spanish language interface, choose Spanish (International Sort)[es-ES].
• For a German language interface, choose German (Germany) [de-DE].
• For a French language interface, choose French (France) [fr-FR].
• For a Italian language interface, choose Italian (Italy) [it-IT].
• For a Brazilian Portuguese interface, choose Brazilian Portuguese [pt-BR]
6.
Click OK, and then click OK again to close the Internet Options dialog box.
7.
Type the URL for xDashboard, xResponse, or xRevise to launch the application. The login page
should appear in the language you specified.
8.
Repeat these steps on all clients machines that will access the applications.
190
Installing a Language Pack for xDesign
To install a language pack:
1.
Ensure xDesign is not running.
2.
Download the required LanguagePack_xDesign_LanguageID.zip file. For example, the French
language pack is called LanguagePack_xDesign_fr.zip
3.
Extract the entire contents of the zip file into the xDesign installation directory. Ensure that
the Use folder names check box is selected.
4.
Copy all of the files and sub-directories in the language pack /bin folder into the /bin folder
located in your xDesign installation directory.
5.
Copy the /Lang folder into the /bin folder located in your xDesign installation directory.
To use a non–English user interface, set the locale on your local machine to the non–English locale.
You can set your locales from the Windows Control Panel in the Regional and Language Options
application.
To configure your locale for a specific language:
1.
Click the Regional Options tab.
2.
Select your desired language from the list in the Standards and formats section. For Chinese
language, choose "Chinese (PRC)”. For Spanish, choose "Spanish (International Sort)[es-ES]".
3.
In the Location section, select your current location from the list.
4.
On the Languages tab, click Details and ensure your language appears in the Installed Services
box. Also on the Languages tab, if you are using the Chinese language, ensure that you select the
Install files for East Asian languages option.
5.
On the Advanced tab, ensure your language is selected in the Language for non-Unicode
programs and that the code pages for your language are selected and click OK.
6.
Restart your computer when prompted.
Installing a Language Pack for xPresso for
Word
To install a language pack:
1.
Ensure that Word is not running.
2.
Download the required LanguagePack_xWord_LanguageID.zip file. For example, the French
language pack would be called LanguagePack_xWord_fr.zip.
3.
Extract all the files in the zip into a folder. There should be two folders when the files are
extracted, one called Config, and one called Langs.
4.
Open the Langs folder, and copy the languageID_languageID.resx file. For example, for French,
the file would be fr_fr.resx.
5.
Navigate to [xPresso for Word Installation Directory]\xPresso\Unity Designer\Langs, and
paste the languageID_languageID.resx file.
191
6.
Open the Langs folder, open the winhelp folder, and copy the docsci_LanguageID_word.chm file.
7.
Navigate to [xPresso for Word Installation Directory]\xPresso\Unity Designer\Help, and paste
the docsci_LanguageID_word.chm file.
8.
Open the Config folder in the extracted files, and copy the resource_languageID_languageID.cfg
file. For example, for French, the file would be resource_fr_fr.cfg.
9.
For 32–bit environments, navigate to [Drive:]\Program Files\Common Files\xPresso\[version#]
\ECMConnector\config, and paste the resource_languageID_languageID.cfg file.
For 64–bit environments, navigate to [Drive:]\Program Files (x86)\Common Files\xPresso
\[version#]\ECMConnector\config, and paste the resource_languageID_languageID.cfg file.
Note: In order for system messages to display in the correct language, you must also install the
appropriate .NET Framework language pack from Microsoft.
Adobe InDesign
When a language pack is installed, some English language files are overwritten. It is recommended
that you back up these files before installing the language pack to enable you to restore your
installation to English if necessary later. Back up the following files and directories:
• On Windows:
— InDesign_Installation_Direcotry\Plug-ins\xPresso\LanguagePack.pln
— InDesign_Installation_Direcotry\Plug-ins\xPresso\(LanguagePack
Resources)
— Program_Files_folder\xPresso\xPresso_version\xPresso for
InDesign\InDesign_version\xPressoHelp (entire directory), where
Program_Files_folder is the Program Files folder on a 32-bit system or the Program Files
(x86) folder on a 64-bit system.
• On Macintosh:
— InDesign_Installation_Direcotry/Plug-ins/xPresso/LanguagePack
.InDesignPlugin
— InDesign_Installation_Direcotry/xPressoHelp
To Install a Language Pack
1.
Ensure that InDesign is not running.
2.
Download the required LanguagePack_xINDD_LanguageID.zip file. For example, the
French language pack is called LanguagePack_xINDD_fr.zip.
3.
Unzip the file into a temporary directory. Three folders should appear in the temporary directory:
Plug-Ins, xPresso, and xPressoHelp.
4.
Browse to temp\Plug-Ins\xPresso\Your_platform, where temp is the temporary folder
for the unzipped language pack.
5.
Copy the (LanguagePack Resources) folder and the LanguagePack.pln file for Windows,
or the LanguagePack.InDesignPlugin file for Macintosh.
192
6.
Browse to the InDesign_Installation_Directory\Plug-Ins\xPresso directory and
paste the files. Click OK to overwrite any existing files.
7.
Browse to temp\xPresso\ECMConnector\config.
8.
Copy the resource_LanguageID_CountryID.cfg file. For example, for French, the file
is called resource_fr_fr.cfg.
9.
Browse to Program_Files_folder\Common Files\xPresso\Version_number
\ECMConnector\config on Windows or InDesign_Installation_Direcotry/xPresso
/ECMConnector/config on Macintosh, and paste the file.
10. Browse to temp\xPressoHelp\.
For a Windows system, copy the temp\xPressoHelp\docsci_indesign.chm file and
paste it to the Program_Files_folder\xPresso\Version_number\xPresso for
InDesign\InDesign_version\xPressoHelp\Help folder.
For a Macintosh system, copy all the files in the temp/xPressoHelp/machelp folder and paste
them to InDesign_Installation_Direcotry/xPressoHelp/Help.
11. Click OK to overwrite any existing files.
12. Delete the temp folder in which you extracted the ZIP file.
Dreamweaver
When a language pack is installed, some English language files are overwritten. It is recommended
that you back up these files before installing the language pack to enable you to restore your
installation to English if necessary later.
Back up the following files and directories:
• \Users\[user]\AppData\Roaming\Adobe\Dreamweaver_version\en_US
\Configuration\Menus\Menus.xml
• \Program Files\Adobe\Dreamweaver_version\configuration\Strings
\xPressoStrings.xml
• \Users\[user]\AppData\Roaming\Adobe\Dreamweaver_version\en_US
\Configuration\Objects\insertbar.xml
• \Program Files\Common Files\xPresso\version_number\ECMConnector\config
\resource_en_us.cfg
• \Program Files \xPresso\version_number\xPresso for Dreamweaver
\Dreamweaver_version\WebHelp\en-us (entire directory)
where Dreamweaver_version can be Adobe Dreamweaver CS6 or Adobe Dreamweaver CC 2014.
To Install a Language Pack
1.
Ensure Dreamweaver is not running.
2.
Back up the files and directories listed at the beginning of this section.
193
3.
Download the required language pack with the name LanguagePack_xDW_LanguageID.zip. For
example, the French language pack is named LanguagePack_xDW_fr.zip.
4.
Unzip the file into a temporary directory. Three folders should appear in the temp directory:
config, configuration, and xPresso.
5.
Browse to temp\configuration and copy all the files and folders within the folder, where
temp is the folder that you unzip the language pack.
6.
Browse to Drive:\Users\username\AppData\Roaming\Adobe\Dreamweaver_version
\LanguageID\Configuration, and paste the files. Click OK to overwrite any existing files.
7.
Browse to temp\configuration and copy the Strings folder.
8.
Browse to C:\Program Files\Adobe\Adobe Dreamweaver CS[#]\configuration and paste the
files. Click OK to overwrite any existing files.
9.
Browse to [temp]\xPresso\winhelp and copy the docsci_dreamweaver.chm file.
10. Paste the file to [Drive:]\Program Files\xPresso\[version#]\xPresso for Dreamweaver\ CS[#]
\WebHelp.
11. Browse to [temp]\config and copy the resource_languageID_languageID.cfg file. For example,
for French, the file is called resource_fr_fr.cfg.
12. Browse to [Drive:]\Program Files\Common Files\xPresso\[version#]\ECMConnector\config, and
paste the resource_languageID_languageID.cfg.
13. Verify that the following files were extracted into the correct directories.
File
Directory
Menus.xml
\Users\[user]\AppData\Roaming\Adobe\Dreamweaver
CS[#]\en_US\Configuration\Menus
xPressoStrings.xml
\Program Files\Adobe\Adobe Dreamweaver CS[#]
\configuration\Strings
insertbar.xml
\Users\[user]\AppData\Roaming\Adobe\Dreamweaver
CS[#]\en_US\Configuration\Objects
resource_languageID
_languageID.cfg
\Program Files\Common Files\xPresso\[version#]
\ECMConnector\config
Online Help Files
\Program Files \xPresso\[version#]\xPresso for Dreamweaver
CS[#]\WebHelp\[LanguageID]
Note: If you install a different language pack over an existing one on a Windows machine,
you need to delete the Menus.xbk file and the Cache folder located in the \Documents and
Settings\[user]\Application Data\Adobe\Dreamweaver CS[#]\en_US\Configuration\Menus
directory before starting Dreamweaver. This clears the cache and ensures that the correct language
appears in the interface.
194
Setting the Internet Explorer Language for
xPresso Clients
The online help provided with xPresso client applications is displayed in a Web browser. If you are
using Internet Explorer, ensure that the locale is set correctly in order to display the help in the
appropriate language.
To set the Internet Explorer language:
1.
Open Internet Explorer.
2.
From the IE Tools menu, select Internet Options. The Internet Options dialog box appears.
3.
Click Language. The Language Preferences dialog box appears.
4.
Click Add. The Add Language dialog box appears.
5.
Select the appropriate language. Ensure that you select the correct language:
• Spanish (International Sort)[es-ES]
• German (Germany) [de-DE]
• French (France) [fr-FR]
• Italian (Italy) [it-IT]
• Chinese (PRC)
6.
Click OK. Ensure that the language appears first in the list of languages on the Language
Preferences dialog box. The first language in the list is the default language to be used. Use the
Move Up and Move Down buttons to reorder the list, if necessary.
7.
Close the Internet Options dialog box.
195
196
Chapter 12
Uninstalling, Reinstalling, and
Removing xPression
This chapter provides instructions for uninstalling, reinstalling, and removing xPression. See the
following topics:
• Uninstall, Reinstall, and Remove, page 197
• Uninstalling xPression Server, page 197
• Uninstalling xPresso Client Applications, page 199
• Modifying, Repairing, or Removing xDesign, page 199
• Reinstalling xPression Server, page 200
• Removing xPression Completely, page 200
Uninstall, Reinstall, and Remove
The term uninstall refers to running the uninstallation program for xPression Server or client
applications.
The term reinstall refers to a function of the xPression Server or client installation programs. Once
the xPression Server or a client application has been installed in a particular location, any additional
attempts to run the installation in the same location will cause the wizard to run in Reinstallation
mode. Reinstallation mode enables you to completely or partially reinstall the current server. The
reinstallation process will overwrite existing files and directories. Ensure that you back up your
previous installation before proceeding.
The term remove refers to the complete removal of xPression and its component from your
environment.
Uninstalling xPression Server
To uninstall xPression Server, complete the following steps:
1.
Preparations for Uninstalling xPression Server on Windows, page 198
2.
Undeploy Enterprise Archive Files, page 198
197
3.
Uninstall the Server, page 198
Preparations for Uninstalling xPression Server on
Windows
If you need to uninstall the server on Windows systems, you must first add the JAVA path to the
USER PATH variable by doing the following steps:
1.
Right-click My Computer and select Properties.
2.
Click the Advanced tab.
3.
Click Environment Variables.
4.
In the User variables section, verify if there is a variable for PATH. If not, click New to create a
variable named PATH. Add the path to your Java /bin directory as the PATH value.
Undeploy Enterprise Archive Files
Uninstall your existing xPression enterprise archive files by using one of the following methods
for your application server:
• WebSphere—Undeploy the xPression enterprise archive files using the administrative server
console. Once the .ear file has been undeployed, ensure the xPression.ear directory is removed.
• WebLogic—Undeploy the xPression enterprise archive files using the administrative server
console. Once the .ear file has been undeployed, ensure the xPression.ear directory is removed.
Remove the server temp directory or delete all the files in this directory. The server temp directory
is located under: ../Domain/..Server/.wlnotdelete/
• JBoss—Remove the xPression EAR folder from the deploy directory, and then delete the contents
of the following directories:
— jboss_install_dir\server\xPression_Server_dir\TMP
— jboss_install_dir\server\xPression_Server_dir\WORK
Uninstall the Server
To uninstall the xPression Server, run the Uninstall_xPression_Server.exe or
uninstaller.bin file in the xPressionHome\UninstallerData directory.
Ensure that you remove any files stranded in your xPressionHome directory.
198
Uninstalling xPresso Client Applications
To remove your xPression client applications on a Windows system, use the uninstallation program
via Windows Control Panel. EMC Document Sciences highly recommends you to restart your system
after the uninstallation. Not restarting may result in errors when starting a new installation.
For uninstallation on Macintosh, see the following procedure:
To Uninstall xPresso on Macintosh
1.
Navigate to InDesign_directory/xPresso/UninstallerData for xPresso for Adobe
InDesign, or Dreamweaver_directory/xPresso/UninstallerData for xPresso for
Dreamweaver.
2.
Double-click Uninstall_xPresso_for_InDesign or Uninstall_xPresso_for
_Dreamweaver. The uninstallation wizard appears.
3.
Follow the instructions in the wizard to uninstall xPresso for Adobe InDesign or xPresso for
Dreamweaver.
Modifying, Repairing, or Removing xDesign
To modify, repair, or remove xDesign, use the Windows Add/Remove Programs Utility on the
computer where xDesign is installed:
• Modify—Select Modify when you want to individually add or remove components from your
xDesign installation.
• Repair—Select Repair when you want to reinstall all the components, files, and user-defined
settings that were installed by the previous installation.
• Remove—Select Remove when you want to uninstall xDesign.
Before reinstalling xDesign, ensure you have removed any unneeded stray files from the directory
where you installed xDesign. If you modify your current installation by adding features or repairing
your installation, xPression may make backup copies of files that may have been altered or updated
since the last installation. Specifically, xPression may make backup copies of your template (.dot)
and com2ejbbridge.properties file and store them in the Backup folder. You must copy these files
back to their respective directories:
• Template—xPressionHome\Design\Template
• com2ejbbridge.Properies—xPressionHome
199
Reinstalling xPression Server
The Reinstallation mode of the xPression Server installation wizard enables you to completely or
partially reinstall the xPression Server.
• Complete Reinstall—A complete reinstall overwrites all files and all settings on the current server.
This option does not “update” the server with new files, it overwrites all your current server files
with the original files installed during the initial installation.
• Partial Reinstall—A partial reinstall enables you to overwrite some of the original server files
installed during the initial installation, while preserving settings specific to your environment.
The following files are preserved:
— com2ejbbridge.properties—Retains the designation of RMI or Servlet mode.
— contentrepository.properties—Retains data source settings.
— servers.xml—Retains the connection information for the xPression servers.
— MigrationServer.xml—Retains the connection information for the xPression servers.
To reinstall your xPression Server, start the xPression Server installation program and use the
instructions in the reinstallation wizard for your application server type.
Removing xPression Completely
To remove xPression from your system completely, perform the following steps:
1.
Undeploy the enterprise archive files
Use the facilities in the administrative console for your application server to remove the xPression
Enterprise applications. For JBoss servers, remove the xPression EAR folder from the deploy
directory. See Undeploy Enterprise Archive Files, page 198 for detailed information.
2.
Stop the application server
This step is very important. If you do not stop your server prior to uninstalling the xPression
Server, the uninstallation program will leave stranded files on your system.
Ensure that you remove any stranded enterprise application files on your server. Navigate to
the server directory where the enterprise applications are deployed and remove all stranded
xPression files.
3.
Uninstall the xPression Server
See Uninstall the Server, page 198 for detailed instructions.
4.
Remove the xPression Server from your application server
• For WebSphere, use the administrative console to remove the xPression application server.
When finished, save the changes to your configuration.
• For WebLogic, remove your WebLogic domain and configuration.
• For JBoss, delete the xPression Server directory.
5.
200
Uninstall client applications
Uninstall the client applications on each computer. For xPresso, see Uninstalling xPresso Client
Applications, page 199. For xDesign, see Modifying, Repairing, or Removing xDesign, page 199.
6.
Remove the xPression database
The removal of your xPression database should be performed by your database administrator.
Your database administrator can remove the entire xPression database, or delete all the tables
installed under the xPression database user.
201
202
Chapter 13
Upgrading xPression
The term upgrade refers to the process of moving from one version of the software to another version.
Typically this process includes removing and replacing xPression components. This process may
also require customized steps if you are starting from certain versions. For detailed instructions on
upgrading xPression, see the xPression Upgrade Guide.
203
Upgrading xPression
204
Chapter 14
Troubleshooting
This chapter provides information on possible issues that you may encounter during installation. See
the troubleshooting topics for the following components:
• xPression Server, page 205
• xDesign, page 208
• xPresso for Word, page 209
• Presso for Adobe InDesign, page 211
• xEditor, page 212
xPression Server
Errors During Start Up
If you receive the following error (or similar error) during server startup, the problem may be that
your {PATH} variable precedes your JDK path and references and older JDK version.
23:45:10,546 WARN [Utils] Exception extracting jars into temporary
directory : java.io.FileNotFoundException: D:\jboss_x4\server\default\.\
deploy\xPression.ear\xPRS_xFramework.war\WEB-INF (Access is denied) :
switching to alternate class loading mechanism
23:45:10,546 INFO [JAXWSDeployer] Deploying Exception Occured with
java.io.FileNotFoundException: D:\jboss_x4\server\default\.\deploy\
xPression.ear\xPRS_xFramework.war\WEB-INF (Access is denied)
java.lang.RuntimeException: java.io.FileNotFoundException:
D:\jboss_x4\server\default\.\deploy\xPression.ear\xPRS_xFramework.war\WEB-INF
(Access is denied)
To resolve the problem, move the {PATH} variable to the end of the statement. For example:
export PATH=${xPressionHome}/Drivers:${JAVA_HOME}/bin:${JAVA_HOME}/jre/lib/
i386/client:${JAVA_HOME}/jre/lib:${PATH}
205
Troubleshooting
The Installer Cannot Access JVM
If the xPression Server installer has trouble accessing the JVM installed on your system, you can force
the program to recognize your JVM as long as the JVM is version 1.4 or higher. To accomplish this,
you must start the program from the command line.
For UNIX systems, type one of the following commands from the command line:
• To install xPression:
xPression_Server_Install.bin LAX_VM JVM_path
• To uninstall xPression:
Uninstall_xPression_Server LAX_VM JVM_path
where JVM_path is the path to your JVM. For example: /opt/WebSphere/AppServer/java
/bin/java
For Windows systems, type one of the following commands from the command line:
• To install xPression:
xPression_Server_Install_Windows.exe LAX_VM JVM_path
• To uninstall xPression:
Uninstall_xPression_Server.exe LAX_VM JVM_path
where JVM_path is the path to your JVM. For example: C:\WebSphere\AppServer\java
\bin\java.exe
Cannot Start the Server on JBoss
If you are unable to start the server, it may be due to an abnormal server error. JBoss deploys
the EAR each time it is started. If there is a failure, JBoss will rename the marker file to
xPression.ear.undeployed.
To determine if this is cause of the failure, check the console messages during startup. The
xPression.ear file auto deploys when the JBoss server starts. For a successful startup, you should
see the following messages:
15:30:58,777 INFO [org.jboss.as.server.deployment] (MSC service thread 1-3)
JBAS015876: Starting deployment of "xPression.ear"
When finished, the console will show:
15:31:07,920 INFO [org.jboss.as.server] (DeploymentScanner-threads - 2)
JBAS018559: Deployed "xPression.ear"
If these messages do not appear, complete the following steps to redeploy the EAR file:
To Redeploy the EAR File on JBoss
1.
Locate the following folder in the JBoss installation directory:
<JBoss_install_dir>/Final/standalone/deployments/
206
Troubleshooting
2.
Locate a file named xPression.ear.undeployed.
3.
Change the name to xPression.ear.dodeploy. The EAR file will be deployed automatically
after the name change.
xDashboard Log On Page Not Displayed
If you try to access xDashboard and you get an error instead of the log on page, there are a couple
of things you should check. There are two different messages that may appear, each signalling
a different problem:
• HTTP Status 404 Error—This error occurs when the application server is running, but it can’t
access the application using the URL you entered. Ensure that you typed the URL correctly.
• The Page Cannot be Displayed Error—This error occurs when the xPRS Server is not running
and you try to access xDashboard. Ensure that you started your application server, and that it
is running.
Error While Attempting to Connect to xAdmin
If you receive the following errors while attempting to connect to xAdmin, xPression is unable to
connect to your xPression database.
3134 LicenseControllerSL EJB’s JNDI Name cannot be found.
3135 Unable to conduct the license check because the xPression database
could not be accessed.
Ensure that your xPression database is running properly, and that you have correctly configured the
database according to the instructions in this guide.
xResponse xPression Database Error with DB2
You may receive the following errors after attempting to publish documents from xResponse. This
error has been known to occur in DB2 when attempting to publish several documents consecutively:
"Response Could Not Connect To CR"
You may also encounter this error
2005-10-12 20:20:55 [Servlet.Engine.Transports : 1] 103346 ERROR root ----------------------------------------UEID : 2090941197
ErrorCode : 6163
ErrorMessage : Database syntax error :{0}.
StackTrace : COM.ibm.db2.jdbc.DB2Exception: [IBM][CLI Driver] CLI0125E
Function sequence error. SQLSTATE=HY010 at COM.ibm.db2.jdbc.app.
SQLExceptionGenerator.throw_SQLException(SQLExceptionGenerator.java:260) at
COM.ibm.db2.jdbc.app.SQLExceptionGenerator.throw_SQLException
(SQLExceptionGenerator.java:197) at COM.ibm.db2.jdbc.app.SQLExceptionGenerator.
check_return_code(SQLExceptionGenerator.java:448) at COM.ibm.db2.jdbc.app.
DB2PreparedStatement.execute2(DB2PreparedStatement.java:1247)
207
Troubleshooting
To resolve this error, you must add a few properties to your WebSphere data source configuration.
In the WebSphere administrative console, navigate to the Additional Properties section of your
xPression_CR data source. This page is found at the following location:
DB2 JDBC Provider > Data Sources > xPression_CR
In the Additional Properties section, click Custom Properties. Add the following two custom
properties:
Name: cachehold Value: 1
Name: cursorhold Value: 1
Save your changes and update your Web Server Plug-in.
DB2 Error When Deleting or Updating Very Large
Document
If you are trying to delete or update the document version of a very large document, DB2 may
create the following error:
2005-08-10 07:12:03 [Servlet.Engine.Transports : 1] 295921 ERROR root ----------------------------------------UEID
: 1029260592
ErrorCode
: 6163
ErrorMessage : Database syntax error :{0}.
StackTrace
: COM.ibm.db2.jdbc.DB2Exception: [IBM][CLI Driver][DB2/NT]
SQL0429N The maximum number of concurrent LOB locators has been exceeded.
SQLSTATE=54028
This is a known DB2 issue. To bypass this error, you must disable the DB2 cache mechanism by
adding the following text to your db2cli.ini file:
[common] PATCH2=50
Disabling the DB2 cache mechanism in this way will degrade the performance of your database. This
step should only be used if you are receiving this error while working with a large document. After
deleting the document or updating the document version, revert back to your original db2cli.ini file.
xDesign
Enabling Access Keys
Access keys are keystroke shortcuts that enable you to access xPression menu items without using a
mouse. If access keys are not working on your machine, they may have been disabled.
To enable access keys:
1.
In the Windows Control Panel, double-click Display.
2.
Click the Effects tab and clear the Hide Keyboard navigation indicators until I use the ALT
key check box.
208
Troubleshooting
3.
Click OK.
5981 Error
5981 error, Module:MSWORD, Procedure:CreateHTMLTemplate
The problem is caused when you unregister any of the .dll files that the xPression Word template is
dependent on. These files are:
• DSCRI.dll
• DSCCRUTL.dll
• CSETWIZARD.dll
• DSCIMGUTL.dll
• DSCDDG.dll
To reregister the files, repair the installation.
xPresso for Word
Enabling the xPresso COM Add-in
If you have completed all the installation steps, and you don’t see the xPresso tab in the Word
interface, you may need to enable the xPresso COM add-in. The add-in may also become disabled
after applying a Microsoft update to your Word installation, or if Word crashes.
To enable the add-in:
1.
Click the File tab on the Word Ribbon.
2.
Click Options. The Word Options dialog box appears.
3.
Click Add-Ins on the left-hand menu. The Add-ins page displays information about the currently
installed add-ins.
4.
Select Disabled Items from the Manage drop-down list, located at the bottom of the dialog box.
5.
Click Go. The Disabled Items dialog box appears.
6.
Select xPresso for Word and click Enable. If xPresso for Word isn’t listed, click Close.
7.
Select COM Add-ins from the Manage drop-down list and click Go. The COM Add-ins dialog
opens.
8.
Select xPresso for Word in the Add-Ins available list, and click OK. The xPresso for Word
interface item should now appear in the Word interface.
209
Troubleshooting
Current Installation No Longer Functions
If you have a current installation of xPresso for Word that no longer functions, it may be because
another xPresso client residing on the same machine was uninstalled. If the common files were
removed during the uninstallation process, xPresso for Word will no longer function. Reinstall
xPresso for Word to fix the issue.
Substituting Font Not Found
If xPresso for Word generates an error similar to “The substituting font “Courier New” can not
be found” during the preview process, check the TtfFontPath setting in the xPRSConfig.xml
file, and ensure it is set to the system font directory on your machine. The default setting is
C:\WINDOWS\Fonts; however, if, for example, your system is Windows NT, it should be set
to C:\WINNT\Fonts.
To change the TtfFontPath setting:
1.
Close Microsoft Word completely.
2.
Browse to the Configure directory. See the xPresso for Word User Guide for information about
the location of the directory.
3.
Open xPRSConfig.xml in an editor, such as Notepad.
4.
Locate the entry: <prop name=“TtfFontPath” type=“List” value=“C:\WINDOWS\Fonts\”
limit=“DIR” visible=“true” />
5.
Change the value to the location of the system font directory on the installation machine. For
example:
<prop name=“TtfFontPath” type=“List” value=“C:\WINNT\Fonts\” limit=“DIR”
visible=“true” />
6.
Save and close the xPRSConfig.xml file.
7.
Launch Microsoft Word to register the change with xPresso for Word.
Corda Builder Not Launching
Corda Builder may not run after applying an update to the Java Runtime Environment (JRE). When
Sun Microsystems provides updates to the JRE, they may change the installation directory. When
this occurs, Corda Builder will not run, and will not provide an error message. To correct this,
change the JRE path in CordaBuilder.properties.
To update the JRE path:
1.
Open CordaBuilder.properties, located in C:\xPressoCharts\Builder by default, for editing.
2.
Locate the path statement, which resembles this:
Application.java.home=C\:\\Program Files\\Java\\jre1.6
The path may be different depending on the installation location and version.
210
Troubleshooting
3.
Correct the entry so that it reflects the new JRE path.
4.
Save the CordaBuilder.properties file.
Presso for Adobe InDesign
If you encounter an issue during the installation of the xPresso for Adobe InDesign client, information
in this section may help you determine the cause and fix the problem.
Valid License Being Called Invalid
If you encounter an issue where a license you know is valid is not being accepted as valid by the
xPresso for Adobe InDesign installation program, you may have a problem with your temporary
directory.
It is possible for the installer to be unable to run programs contained in your temporary folder.
This may be caused by the temp folder variable pointing to a non-existent directory. Setting your
environment variable “temp” and “tmp” user variables to “%SystemRoot%\TEMP” may solve
the problem.
To identify whether the problem you are encountering is caused by the temp folder issue, you can
press the CTRL key continually during the installation process and watch the messages that appear.
If you see a message stating that running “forinstall.exe” failed with an error number of 2, the temp
folder issue may be causing your problem.
Current Installation No Longer Functions
If you have a current installation of xPresso for Adobe InDesign that no longer functions, it may be
because another xPresso client residing on the same machine was uninstalled. If the common files
were removed during the uninstallation process, xPresso for Adobe InDesign will no longer function.
Reinstall xPresso for Adobe InDesign to fix the issue.
Corda Builder Not Launching
Corda Builder may not run after applying an update to the Java Runtime Environment (JRE). When
Sun Microsystems provides updates to the JRE, they may change the installation directory. When
this occurs, Corda Builder will not run, and will not provide an error message. To correct this,
change the JRE path in CordaBuilder.properties.
To Update the JRE Path
1.
Open CordaBuilder.properties, located in C:\xPressoCharts\Builder by default, for editing.
2.
Locate the path statement, which resembles this:
211
Troubleshooting
Application.java.home=C\:\\Program Files\\Java\\jre1.6
The path may be different depending on the installation location and version.
3.
Correct the entry so that it reflects the new JRE path.
4.
Save the CordaBuilder.properties file.
xEditor
Unable to Reinstall xEditor
In some installations that include certain Microsoft VSTOR and related components, xEditor will not
reinstall after being uninstalled. To correct this condition, perform the following:
1.
On the development machine locate the file %ProgramFiles%\Microsoft SDKs\Windows\v6.0A
\Bootstrapper\Packages\VSTOR30\product.xml
2.
Replace the element <RegistryCheck Property="VSTORuntimeInstalled" Key="HKLM
\SOFTWARE\Microsoft\VSTO Runtime Setup\v9.0.21022" Value="Install"/> with
<MsiProductCheck Property="VSTORuntimeInstalled" Product="{8FB53850-246A-3507-8ADE
-0060093FFEA6}"/>
3.
Alter the element <BypassIf Property="VSTORuntimeInstalled" Compare
="ValueGreaterThanOrEqualTo" Value="1"/> to be <BypassIf Property="VSTORuntimeInstalled"
Compare="ValueGreaterThanOrEqualTo" Value="3"/>
For more information on this issue, refer to the MSDN blog posting at http://blogs.msdn.com/b/vsto
/archive/2009/02/07/vsto-runtime-bootstrapper-package-failure-causes-deployed-customization
-installation-to-fail-aaron-cathcart.aspx.
212
Chapter 15
Documentum Edition is a specific, separately licensed configuration of the Enterprise Edition, which
enables you to use a single, predefined Documentum Docbase as the xPression repository. This
repository is known as the Documentum xPression Repository. Documentum Edition enables you to:
• Perform online check-in and check-out of xPresso templates from a Documentum repository.
• Store, manage, and version xPresso variable lists, document property lists, and document
templates in your Documentum xPression Repository.
• Access any stored version of your xPresso templates and XML from your Documentum xPression
Repository.
If you are using Documentum Edition, complete the following configuration steps:
• Ensure you have successfully installed a supported version of Documentum. Check the xPression
Release Notes for a complete list of supported versions.
• Ensure you have completed the xPression installation steps in this guide, including Chapter 9,
Verifying Your Installation.
• Ensure you have successfully installed your xPresso application.
• Configure xPression for Documentum.
• Deploy Documentum Edition DAR File.
• Create ECM Configuration.
• Define Documentum Users and Roles.
Configure xPression for Documentum
To configure xPression to use Documentum, ensure that you complete steps 1–3 from the Integrating
with Documentum, page 173 chapter.
• Step One: Configure Documentum System User Name, page 174
• Step Two: Install Documentum Foundation Classes, page 174
• Step Three: Configure Application Server, page 174
If you are planning to store DOCX output in a Documentum Repository, complete the steps in
Adding Formats for Archiving, page 184. If you are using Documentum Workflow, see Installing
213
the Sample Workflow, page 180, After Updating an Activity Template, page 183, and Upgrading the
Sample Workflow, page 184.
Deploy Documentum Edition DAR File
In this step, you must deploy the xPressionDocumentumSupport.dar file to the Documentum docbase
that you intend to use as your Documentum xPression Repository. Complete the following steps:
1.
Locate the DAR files in your installation package and copy the it to a local temporary folder.
2.
Start the Documentum Composer DAR Installer. The DAR installer is located in your
composer directory, the same directory that contains eclipse.exe. By default, this directory is
\\<DCTM_install_dir>\product\6.5\install\composer\</DCTM_install_dir>
3.
Run the DAR installer. The DAR Installer page appears.
4.
In the *DAR box, supply the full path and file name of the xPressionDocumentumSupport.dar
file.
5.
Locate the Docbroker Details section. In the *Docbroker Host drop-down box, select the name
of the docbroker host. If no names appear in the list, type the name of your Docbroker Host or
Connection Broker.
6.
In the *Docbroker Port box appears, type the port number. By default, this number is 1489.
7.
Click Connect.
8.
Locate the Repository Details section. In the *Repository drop-down box, select the name of the
repository where you want to deploy the sample application. This must be the docbase that you
intend to use as the Documentum xPression Repository. This is the repository where you will
check-in xPresso templates and it will function as your xPression repository. Although you will
be able to use other docbases with xPression, only this docbase can function as the Documentum
xPression Repository.
9.
In the User Name box, type a user name for the repository.
10. In the Password box, type the password for the user name.
11. Click the Install button.
12. The DAR Installer will deploy the DAR file and display a success message when complete.
13. Click Close to close the DAR Installer. If you receive and error, ensure you are using a supported
version of the DAR Installer.
14. Restart the application server.
Create ECM Configuration
xPression Documentum Edition requires that you create an ECM Configuration named Documentum
xPression Repository to connect to the Documentum repository where you will check-in
your xPresso document templates and objects. Documentum Edition supports the use of only
214
one Documentum xPression Repository. If your ECM Configuration is not named Documentum
xPression Repository, the Documentum Edition features will be unavailable.
Log on to xAdmin and create the Documentum xPression Repository. For more information about
creating ECM Configurations, see the xAdmin User Guide.
Define Documentum Users and Roles
Log on to Documentum Administrator and create users for the docbase that is defined as your
Documenutm xPression Repository. This is the docbase where you previously deployed the
xPressionDocumentumSupport.dar file in Deploy Documentum Edition DAR File, page 214. The
Documentum user must also be authorized to access the xPression Server. The user name should
exist on both the xPression Server and the Documentum Repository, and the password should be
the same on both systems.
xPression uses the xpression_designer and xpression_dashboard roles. The xpression_designer role
enables the user to access the Documentum xPression Repository from an xPresso client application.
The xpression_dashboard role enables the user to access the Documentum xPression Repository
from xDashboard. Your user can have one or both of these roles. xPresso users do not need the
xpression_designer or xpression_dashboard roles to access resources in other Documentum docbases.
These roles only enable access to the Documentum xPression Repository.
215

Configure xPression Server

Transcription

Similar documents

XPression Prime Cutsheet

RH March.indd - Zancor Homes

the Brochure!

REVEILLE MONITORS HEALTH AND PERFORMANCE OF EMC

Installing ANSYS 15 Mount the iso files using Virtual Clone

Atlantis Energy Systems Inc.

This review page is supported in part by the sponsor

User`s Manual - Triangle Reprographics

Coffing EC3 Manual

Upofloor XQZ Brochure